Sm_PolicyApi_AddAttributeToSAMLScheme()

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

Sm_PolicyApi_AddAttributeToSAMLScheme()

Adds an attribute, which can be requested from the configured Attribute Service, to a SAML 2.0 authentication scheme.

Syntax

int SM_EXTERN Sm_PolicyApi_AddAttributeToSAMLScheme(
   void*                                pHandle,
   const Sm_PolicyApi_Scheme_t*         pstructScheme,
   const Sm_PolicyApi_SAMLRequesterAttr_t*     pAttr
);

Parameter	I/O	Description
pHandle	I	A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.
pstructScheme	I	A pointer to a completely filled-in structure for a SAML 2.0 Scheme.
pAttr	I	A pointer to the Sm_PolicyApi_SAMLRequesterAttr_t structure containing the attribute to be added.

Returns

Sm_PolicyApi_Success. The attribute was added successfully.
Sm_PolicyApi_Failure. The attribute was not added 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 add an attribute to a SAML Requester.
Sm_PolicyApi_SAMLIDP_IncorrectParameters. Supplied SAML provided properties are incomplete or incorrect.
Sm_PolicyApi_DuplicateAttribute. An attribute already exists with the same Name and NameFormat.