Sm_PolicyApi_AddSAMLAffiliation()

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

Sm_PolicyApi_AddSAMLAffiliation()

Adds a new SAML affiliation object or modifies an existing one.

Type

SAML 2.0 Configuration function, global scope.

Syntax

int SM_EXTERN Sm_PolicyApi_AddSAMLAffiliation (
   void*                              pSessionHandle,
   Sm_PolicyApi_SAMLAffiliation_t*    pstructAffiliation,
   const bool                         bUpdate,
   char**                             pszErrMsg
);

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.
pstructAffiliation	I	A pointer to a completed SAML affiliation structure.
bUpdate	I	Specifies whether an update operation should be performed on an existing object.
pszErrMsg	O	String containing an error message if the affiliation is not added or updated successfully. The Policy Management API allocates memory for this parameter dynamically. It is the responsibility of the custom application to free it using a standard C call. If Sm_PolicyApi_MissingProperty or Sm_PolicyApi_InvalidProp are returned, this field contains the name of the property that is missing or invalid.

Returns

Sm_PolicyApi_Success. The operation was successful.
Sm_PolicyApi_Failure. The operation was not successful.
Sm_PolicyApi_InvalidProp. A specified property is invalid. The property name is returned in pszErrMsg.
Sm_PolicyApi_MissingProperty. A required property was not specified. The property name is returned in pszErrMsg.
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 a SAML affiliation.
Sm_PolicyApi_InsufficientData. Required properties for configuring the SAML affiliation were missing.

Email CA about this topic