Sm_PolicyApi_ODBCQueryScheme

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

Sm_PolicyApi_ODBCQueryScheme_t

Defines a SiteMinder ODBC Query Scheme object.

Syntax

typedef struct Sm_PolicyApi_ODBCQueryScheme_s
{
   int iStructId;
   char pszOid[BFSIZE];
   char pszName[BFSIZE];                    /* Required */
   char pszDesc[BFSIZE];
   char pszQueryEnumerate[BFSIZE];          /* Required */
   char pszQueryGetObjInfo[BFSIZE];         /* Required */
   char pszQueryLookup[BFSIZE];             /* Required */
   char pszQueryInitUser[BFSIZE];           /* Required */
   char pszQueryAuthenticateUser[BFSIZE];   /* Required */
   char pszQueryGetUserProp[BFSIZE];        /* Required */
   char pszQuerySetUserProp[BFSIZE];        /* Required */
   char pszQueryGetUserProps[BFSIZE];       /* Required */
   char pszQueryLookupUser[BFSIZE];         /* Required */
   char pszQueryGetGroups[BFSIZE];          /* Required */
   char pszQueryIsGroupMember[BFSIZE];      /* Required */
   char pszQueryGetGroupProp[BFSIZE];       /* Required */
   char pszQuerySetGroupProp[BFSIZE];       /* Required */
   char pszQueryGetGroupProps[BFSIZE];      /* Required */
   char pszQueryLookupGroup [BFSIZE];       /* Required */
   char pszQuerySetPassword [BFSIZE];       /* Required */
   struct Sm_PolicyApi_ODBCQueryScheme_s* next;
} Sm_PolicyApi_ODBCQueryScheme_t;

Field	Description
iStructId	ODBC Query Scheme data structure ID, defined in Sm_PolicyApi_Structs_t.
pszOid	The object identifier of the ODBC Query Scheme object.
pszName	Name of the ODBC Query Scheme.
pszDesc	Brief description of the ODBC Query Scheme.
pszQueryEnumerate	Query that lists the names of user objects in the directory.
pszQueryGetObjInfo	Query that fetches the class of the object.
pszQueryLookup	Query that returns objects based on an attribute specified in a group table.
pszQueryInitUser	Query that determines if a user with a given name exists in the database.
pszQueryAuthenticateUser	Query that retrieves a password from a user.
pszQueryGetUserProp	Query that retrieves the value of a user property. The property must be one of the properties listed with pszQueryGetUserProps.
pszQuerySetUserProp	Query that sets the value of a user property. The property must be one of the properties listed in pszQueryGetUserProps.
pszQueryGetUserProps	Query that returns a comma-separated list of user attributes that reside in the same table as the user name.
pszQueryLookupUser	Query that retrieves a user name using an attribute of the user table.
pszQueryGetGroups	Query that retrieves the names of the groups of which the user is a member.
pszQueryIsGroupMember	Query that identifies the group membership of a particular user.
pszQueryGetGroupProp	Query that returns the value of a property defined in pszQueryGetGroupProps
pszQuerySetGroupProp	Query that sets the value of a group property. The property must be one of the properties listed in pszQueryGetGroupProps.
pszQueryGetGroupProps	Query that returns a comma-separated list of group attributes.
pszQueryLookupGroup	Query that retrieves a group name using an attribute of the group table.
pszQuerySetPassword	Query that changes a user password.
next	Pointer to the next ODBC query scheme structure.