Sm_PolicyApi_RemoveUsersFromSAMLServiceProvider()

Programming Guides › Programming Guide for C › Policy Management API Guidance › Function Declarations for the Policy Management API › Sm_PolicyApi_RemoveUsersFromSAMLServiceProvider()

Sm_PolicyApi_RemoveUsersFromSAMLServiceProvider()

Removes the specified users from the Service Provider.

Type

SAML 2.0 Configuration function, domain scope.

Syntax

int SM_EXTERN Sm_PolicyApi_AddUsersToSAMLServiceProvider
(
   void*                             pSessionHandle,
   const char*                       pszProviderOid,
   Sm_PolicyApi_User_t*              pStructUsers,
   int                               iPolicyFlags
);

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 Service Provider's object identifier.
pStructUsers	I	The users to remove from the Service Provider.
iPolicyFlags	I	A bit field that indicates whether: The policy created for the SAML Service Provider includes a user The policy should be applied recursively

Returns

Sm_PolicyApi_Success. The users were removed successfully.
Sm_PolicyApi_Failure. The users were not removed 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 remove a user.
Sm_PolicyApi_InvalidOid. The Service Provider OID was not found.