Sm_PolicyApi_AddUserDirToAffiliateDomain()

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

Sm_PolicyApi_AddUserDirToAffiliateDomain()

Adds a user directory to an existing affiliate domain.

Type

Federation Security Services function.

Syntax

int SM_EXTERN Sm_PolicyApi_AddUserDirToAffiliateDomain (
   void*         pSessionHandle,
   const char*   pszUserDirOid,
   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.
pszUserDirOid	I	A null-terminated string containing the object identifier of an existing user directory.
pszAffiliate DomainOid	I	A null-terminated string containing the object identifier of an existing affiliate domain.

Returns

Sm_PolicyApi_Success. The user directory was added to the affiliate domain successfully.
Sm_PolicyApi_Failure. The user directory was not added to the affiliate domain.
Sm_PolicyApi_NoSession. There is no valid administrator session.
Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
Sm_PolicyApi_NoPrivilege. The administrator does not have the privilege to add a user directory to an affiliate domain.
Sm_PolicyApi_InvalidOid. The affiliate domain OID or user directory OID was not found during an update.
Sm_PolicyApi_DuplicateEntry. The user directory exists in the user directory collection of the domain.

Email CA about this topic