Sm_PolicyApi_GetSAMLServiceProviderUsers()

Retrieves the user directory entries associated with the specified Service Provider.
casso10
Retrieves the user directory entries associated with the specified Service Provider.
Type
SAML 2.0 Configuration function, domain scope.
Syntax
int SM_EXTERN Sm_PolicyApi_GetSAMLServiceProviderUsers
(
void*pSessionHandle,
const char*pszProviderOid,
const char*pszUserDirOid,
Sm_PolicyApi_User_t**ppStructUsers
);
Parameter
I/O
Description
pSessionHandle
I
A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.
pszProviderOid
I
A null-terminated string containing the policy store object identifier of an existing Service Provider.
pszUserDirOid
I
A null-terminated string containing the policy store object identifier of an existing user.
ppStructUsers
O
The address of a pointer to user structures.
Returns
  • Sm_PolicyApi_Success. The users were retrieved successfully.
  • Sm_PolicyApi_Failure. The users were not retrieved successfully.
  • Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
  • Sm_PolicyApi_NoSession. There is no valid administrator session.
  • Sm_PolicyApi_NoPrivilege. The administrator does not have the privilege to retrieve users.
  • Sm_PolicyApi_InvalidOid. The affiliate OID was not found.