Sm_PolicyApi_AddAffiliate()

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

Sm_PolicyApi_AddAffiliate()

Creates a new or updates an existing affiliate object. This function will also retrieve the PropertyCollection object based on the AffiliateDomain OID.

Type

Federation function

Syntax

int SM_EXTERN Sm_PolicyApi_AddAffiliate (
   void*                       pSessionHandle,
   Sm_PolicyApi_Affiliate_t*   pstructAffiliate,
   const bool                  bUpdate
);

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.
pstructAffiliate	I	A pointer to a completely filled-in affiliate structure.
bUpdate	I	A flag to indicate that if an existing object is found, it should be updated.

Parameter

I/O

Description

pSessionHandle

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

pstructAffiliate

A pointer to a completely filled-in affiliate structure.

bUpdate

A flag to indicate that if an existing object is found, it should be updated.

Remarks

This function creates affiliate objects that are based on the artifact profile or the POST profile (see the Sm_PolicyApi_Affiliate_t field SAMLProfile). Creating an affiliate object based on the POST profile requires an API version of at least SM_POLICY_API_VERSION_6_0_2. If an earlier version is involved, the POST profile request is ignored (along with any POST-specific fields in Sm_PolicyApi_Affiliate_t) and an attempt is made to create an affiliate object based on the artifact profile.

Returns

Sm_PolicyApi_Success. The affiliate was created successfully.
Sm_PolicyApi_Failure. The affiliate was not created 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 create an affiliate.
Sm_PolicyApi_DomainNotFound. The affiliate domain OID was not found.
Sm_PolicyApi_DomainNotAffiliate. The domain is not an affiliate domain.