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

Sm_PolicyApi_RemoveUsersFromWSFEDResourcePartner()

Dissociates a user directory entry from WS-Federation Resource Partner.

Syntax

int SM_EXTERN Sm_PolicyApi_RemoveUsersFromWSFEDResourcePartner (
        void* pSessionHandle,
        const char * pszProviderOid,
        const char * pszUserPolicyOid
);

Parameters

• pSessionHandle

  [in] A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.

• pszProviderOid

  [in] A null-terminated string containing the object identifier of an existing WS-Federation Resource Partner.

• pszUserPolicyOid

  [in] A null-terminated string containing the object identifier of an existing policy user.

Return Values

• Sm_PolicyApi_Success. The user directory was removed a successfully.
• Sm_PolicyApi_Failure. The user directory 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 Resource Partner OID was not found.