Sm_PolicyApi_RemoveUsersFromAffiliate()

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

Sm_PolicyApi_RemoveUsersFromAffiliate()

Removes a user directory entry from an affiliate.

Type

Federation function

Syntax

int SM_EXTERN Sm_PolicyApi_RemoveUsersFromAffiliate (
   void*        pSessionHandle,
   const char*  pszAffiliateOid,
   const char*  pszUserPolicyOid
);

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.
pszAffiliateOid	I	A null-terminated string containing the object identifier of an existing affiliate.
pszUserPolicyOid	I	A null-terminated string containing the object identifier of an existing policy user.

Returns

Sm_PolicyApi_Success. The user was removed successfully.
Sm_PolicyApi_Failure. The user was 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 affiliate OID or user policy OID was not found.