Sm_PolicyApi_Scheme

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

Sm_PolicyApi_Scheme_t

Defines a SiteMinder authentication scheme object.

Syntax

typedef struct Sm_PolicyApi_Scheme_s
{
   int iStructId;
   char pszOid[BFSIZE];
   char pszName[BFSIZE];                    /* Required */
   char pszDesc[BFSIZE];
   int nLevel;                              /* Required */
   char pszLib[BFSIZE];
   char pszParam[BFSIZE];
   char pszSecret[BFSIZE];
   bool bIsTemplate;
   bool bIsUsedbyAdmin;
   Sm_Api_SchemeType_t nType;               /* Required */
   bool bAllowSaveCreds;                    /* Required */
   bool bIsRadius;                          /* Required */
   bool bIgnorePwCheck;                     /* Required */
   struct Sm_PolicyApi_Scheme_s* next;
} Sm_PolicyApi_Scheme_t;

Field	Description
iStructId	Authentication scheme data structure ID, defined in Sm_PolicyApi_Structs_t.
pszOid	The object identifier of the authentication scheme object.
pszName	Name of the authentication scheme.
pszDesc	Brief description of the authentication scheme.
nLevel	The protection level of the authentication scheme. The level may vary from 1 through 1000. The higher the number, the more secure is the scheme. With Anonymous authentication schemes, set this value to 0.
pszLib	The name of the shared library that implements the custom authentication scheme.
pszParam	Information that is passed on to the custom authentication scheme.
pszSecret	A shared secret known to two parties for the purpose of establishing secure data exchange. This information is passed on to the custom authentication scheme.
bIsTemplate	Flag to indicate whether the authentication scheme is a template. Note: Setting an authentication scheme as a template with the C Policy Management API is deprecated in SDK v6.0 SP3.
bIsUsedbyAdmin	Flag to indicate if the custom authentication scheme can be used to authenticate administrators.
nType	The type of the authentication scheme, defined in Sm_Api_SchemeType_t.
bAllowSaveCreds	Flag to allow user credentials to be saved.
bIsRadius	Flag to indicate if the scheme is of type Radius.
bIgnorePwCheck	If this flag is set to true, password policies for the authentication scheme will be disabled.
next	Pointer to the next Scheme structure.