Sm_PolicyApi_GetAllSAMLSPAssertionConsumerService()

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

Sm_PolicyApi_GetAllSAMLSPAssertionConsumerService()

Retrieves a list of all the Assertion Consumer Services currently in the policy store.

Note: The list of Assertion Consumer Service structures that is returned by this function must be freed using the Sm_PolicyApi_FreeMemory function.

Type

Federation Security Services function

Syntax

int SM_EXTERN Sm_PolicyApi_GetAllSAMLSPAssertionConsumerService(
   void* pSessionHandle,
   const Sm_PolicyApi_SAMLSPAssertionConsumerService_t** 
                ppstructSAMLSPAssertionConsumerService,
   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.
ppstructSAMLSPAssertion ConsumerServiceAttr	I	A pointer to an array of Assertion Consumer Service structures.
pszSAMLSPOid	I	A pointer to a string containing the OID of the Service Provider.

Returns

Sm_PolicyApi_Success. The array of Assertion Consumer Services was retrieved successfully.
Sm_PolicyApi_Failure - The array of Assertion Consumer Services was not retrieved 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 remove Attributes from a SAML Service Provider.

Email CA about this topic