Sm_PolicyApi_GetSAMLServiceProviderById()

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

Sm_PolicyApi_GetSAMLServiceProviderById()

Retrieves the Service Provider specified by its unique provider identifier.

Type

SAML 2.0 Configuration function, domain scope

Syntax

int SM_EXTERN Sm_PolicyApi_GetSAMLServiceProvider
(
   void*                             pSessionHandle,
   const char*                       pszProviderId,
   Sm_PolicyApi_SAMLSP_t**           pstructSAMLSP
);

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.
pszProviderId	I	A null-terminated string containing the unique provider identifier of an existing Service Provider. The provider identifier is specified in SAML_KEY_SPID.
ppstructSAMLSP	O	The address of a pointer to a Service Provider structure.

Parameter

I/O

Description

pSessionHandle

A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.

pszProviderId

A null-terminated string containing the unique provider identifier of an existing Service Provider.

The provider identifier is specified in SAML_KEY_SPID.

ppstructSAMLSP

The address of a pointer to a Service Provider structure.

Returns

Sm_PolicyApi_Success. The Service Provider was retrieved successfully.
Sm_PolicyApi_Failure. The Service Provider 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 retrieve a Service Provider.
Sm_PolicyApi_InvalidOID. The Service Provider OID was not found.
Sm_PolicyApi_DomainNotAffiliate. The domain is not an affiliate domain.

Email CA about this topic