Sm_PolicyApi_RemoveAssertionConsumerServiceFromSAMLSP()

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

Sm_PolicyApi_RemoveAssertionConsumerServiceFromSAMLSP()

Removes an existing indexed endpoint reference to an Assertion Consumer Service from the policy store. The index, binding type, and Assertion Consumer Service URL must match an existing Assertion Consumer Service.

Type

Federation function

Syntax

int SM_EXTERN Sm_PolicyApi_RemoveAssertionConsumerServiceToSAMLSP (
   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.
pstructSAMLAssertionConsumerService	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 removed successfully.
Sm_PolicyApi_Failure - The Assertion Consumer Service was not removed successfully.
Sm_PolicyApi_ACSIndexedEndpointNotFound - There is no Assertion Consumer Service that matches the Assertion Consumer Service to be removed..
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 remove Attributes from a SAML Service Provider.