Defender 5.11 - Administration Guide

AddPayload method

Allows RADIUS payload attributes to be added to the authentication request. Typically this method is used when the authenticating server or an intermediary requires additional information about the authenticating party.

The structure used to pass data to this function is defined below:

struct RADIUSPayloadAttribute

{

   DWORD vendorId;

   unsigned char type;

   unsigned char length;

   unsigned char data[253];

};

C++ syntax
public : HRESULT AddPayload(struct RADIUSPayloadAttribute *payload)

C# syntax
void AddPayload(ref RADIUSPayloadAttribute payload);

Parameters

payload  Application specific payload data as a struct RADIUSPayloadAttribute.

Return value

Always returns S_OK.

GetGridData method

After an authentication request this method can be called to determine whether a user has a grid available and the state of that grid.

C++ syntax
public : HRESULT GetGridData(BSTR *grid, VARIANT_BOOL *isRegistrationGrid, VARIANT_BOOL *isGrIDsureOnly, VARIANT_BOOL *hasGrid);

C# syntax
bool GetGridData(out string grid, out bool isRegistrationGrid, out bool isGrIDsureOnly);

Parameters

• grid  A string containing the values for the grid.
• isRegistrationGrid  Returns TRUE if the user has not yet registered a PIP.
• isGrIDsureOnly  Returns TRUE if the user only has a GrIDsure token.
• hasGrid  Returns TRUE if a grid is available.

Return value

Always returns S_OK.

GetAuthenticationImage method

After an authentication request this function can be called to obtain a bitmap of the grid.

C++ syntax
public : HRESULT GetAuthenticationImage(VARIANT *imageData);

C# syntax
object GetAuthenticationImage();

Parameters

imageData  A byte array containing a bitmap of the grid.

Return value

Returns S_OK if successful.

SetGridResetPIPAttribute method

Call this function before an authentication request to add a RADIUS payload attribute to inform the DSS that the user's GrIDsure PIP should be changed.

C++ syntax
public : HRESULT SetGridResetPIPAttribute(void);

C# syntax
void SetGridResetPIPAttribute();

Parameters

None

Return value

Always returns S_OK