Previous Topic: SmDirGetUserProperties()Next Topic: SmDirInit()

Programming Guides › Programming Guide for C › Directory API Guidance › Directory API Reference › SmDirGetUserRoles()

SmDirGetUserRoles()

The SiteMinder Policy Server calls SmDirGetUserRoles() so that you can retrieve the roles to which a user belongs.

SiteMinder calls SmDirFreeStringArray() to free the lpszRoles array.

Syntax

int SM_EXTERN SmDirGetUserRoles (
   const Sm_Api_Context_t*  lpApiContext,
   void*                    pHandle,
   void*                    pInstanceHandle,
   const char*              lpszUserDN,
   char***                  lpszRoles
);

Parameter

I/O

Description

lpApiContext

I

Pointer to the API context structure.

pHandle

I

The address of the pointer returned by SmDirInit().

pInstanceHandle

I

The address of a pointer to the user instance handle.

lpszUserDN

I

Buffer containing the user DN whose roles has to be retrieved.

lpszRoles

O

A list of roles associated with the user in lpszUserDN.

Returns

Returns 0 if successful or -1 if not successful.