Sm_PolicyApi_RemoveAdminFromAffiliateDomain()

Removes an administrator from an affiliate domain.
sm1252sp1
Removes an administrator from an affiliate domain.
Type
Federation function
Syntax
int SM_EXTERN Sm_PolicyApi_RemoveAdminFromAffiliateDomain (
void*pSessionHandle,
const char*pszAdminOid,
const char*pszAffiliateDomainOid
);
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.
pszAdminOid
I
A null-terminated string containing the object identifier of an existing administrator.
pszAffiliate
DomainOid
I
A null-terminated string containing the object identifier of an existing affiliate domain.
Returns
  • Sm_PolicyApi_Success. The administrator was removed from the affiliate domain.
  • Sm_PolicyApi_Failure. The administrator was not removed from the affiliate domain.
  • 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 an administrator from an affiliate domain.
  • Sm_PolicyApi_InvalidOID. The affiliate domain OID was not found during an update.
  • Sm_PolicyApi_NotFound. The administrator object identifier could not be found in the affiliate domain collection.