Sm_PolicyApi_Agent

Programming Guides › Programming Guide for C › Policy Management API Guidance › Policy Management API Data Structures › Sm_PolicyApi_Agent_t

Sm_PolicyApi_Agent_t

Defines a SiteMinder Agent object.

Syntax

typedef struct Sm_PolicyApi_Agent_s
{
   int iStructId;
   char pszOid[BFSIZE];
   char pszName[BFSIZE];                     /* Required */
   char pszDesc[BFSIZE];
   char pszIpAddr[BFSIZE];
   char pszSecret[BFSIZE];
   char pszAgentTypeOid[BFSIZE];             /* Required */
   int nRealmHintAttrId;                     /* Required */
   struct Sm_PolicyApi_Agent_s* next;
} Sm_PolicyApi_Agent_t;

Field	Description
iStructId	Agent data structure ID, defined in Sm_PolicyApi_Structs_t.
pszOid	The object identifier of the agent object.
pszName	Name of the agent. Agent names are converted to lower case when written to the policy store.
pszDesc	Brief description of the agent.
pszIpAddr	IP address of the server on which the agent resides.
pszSecret	A shared secret known to two parties for the purpose of establishing secure data exchange. If a shared secret is provided, the agent is considered to be a SiteMinder version 4.x agent. If a shared secret is not provided, the agent is considered to be a SiteMinder version 5.x or 6.0 agent.
pszAgentTypeOid	Type of agent.
nRealmHintAttrId	The hint attribute is a RADIUS attribute that is sent by the RADIUS client device.
next	Pointer to the next agent structure.