Sm_PolicyApi_GetAllSAMLServiceProviders()

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

Sm_PolicyApi_GetAllSAMLServiceProviders()

Retrieves all the Service Providers in the specified affiliate domain.

Type

SAML 2.0 Configuration function, domain scope.

Syntax

int SM_EXTERN Sm_PolicyApi_GetAllSAMLServiceProviders
(
   void*                             pSessionHandle,
   const char*                       pszAffiliateDomainOid,
   Sm_PolicyApi_SAMLSP_t**           ppstructSAMLSPs
);

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.
pszAffiliate DomainOid	I	A null-terminated string containing the object identifier of an existing affiliate domain.
ppstructSAMLSPs	O	The address of a pointer to Service Provider structures.

Returns

Sm_PolicyApi_Success. Service Providers were retrieved successfully.
Sm_PolicyApi_Failure. Service Providers were 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 retrieve Service Providers.
Sm_PolicyApi_InvalidOID. The affiliate domain object identifier was not found.