Sm_PolicyApi_AddAttributeToSAMLSP()

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

Sm_PolicyApi_AddAttributeToSAMLSP()

Defines a SAML 2.0 attribute for the Service Provider.

A SAML 2.0 attribute contains information about a principal who is trying to access a resource on the Service Provider-for example, the principal's user DN.

The defined attribute is included in an attribute statement for all SAML 2.0 assertions that are produced for the Service Provider.

Type

SAML 2.0 Configuration function, domain scope.

Syntax

int SM_EXTERN Sm_PolicyApi_AddAttributeToSAMLSP (
   void*                                pHandle,
   const Sm_PolicyApi_SAMLSPAttr_t*     pstructSAMLSPAttr,
   const char*                          pszSAMLSPOid
);

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.
pstructSAMLSPAttr	I	A pointer to a completely filled-in attribute structure.
pszSAMLSPOid		A null-terminated string containing the object identifier of an existing Service Provider.

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 Service Provider.
Sm_PolicyApi_DuplicateAttribute. An attribute already exists with the same Name and NameFormat.

Email CA about this topic