Sm_PolicyApi_AddAssertionConsumerServiceToSAMLSP

Programming Guides › Programming Guide for C › Policy Management API Guidance › Function Declarations for the Policy Management API › Sm_PolicyApi_AddAssertionConsumerServiceToSAMLSP

Sm_PolicyApi_AddAssertionConsumerServiceToSAMLSP

Adds a new indexed endpoint, which includes an index, binding, and an Assertion Consumer Service URL, to the Service Provider.

Note: An existing indexed endpoint reference cannot be modified.

Type

Federation function

Syntax

int SM_EXTERN Sm_PolicyApi_AddAssertionConsumerServiceToSAMLSP (
   void*                               pSessionHandle,
   const Sm_PolicyApi_SAMLSPAssertionConsumerService_t* 
                pstructSAMLSPAssertionConsumerService,
   const char*                         pszSAMLSPOid
);

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.
pstructSAMLSPAssertion ConsumerService	I	A pointer to an Assertion Consumer Service structure.
pszSAMLSPOid	I	A pointer to a string containing the OID of the Service Provider.

Returns

Sm_PolicyApi_Success. The Assertion Consumer Service was added successfully.
Sm_PolicyApi_Failure - The Assertion Consumer Service was not added successfully.
Sm_PolicyApi_ACSDuplicateIndex - There is already an Assertion Consumer Service assigned to thei Service Provider with the same index value.
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 Assertion Consumer Service.

Remarks

The following fields of the Sm_PolicyApi_SAMLSPAssertionConsumerService_t structure are evaluated:

The value of the index is a unique positive integer, less than 65535,
The Assertion Consumer URL starts with http:// or https://.
The binding is either HTTP-Post or HTTP_Artifact.