Sm_PolicyApi_GetSAMLScheme()

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

Sm_PolicyApi_GetSAMLScheme()

Retrieves information about a SAML 2.0 authentication scheme and the metadata properties of the associated Identity Provider.

Type

SAML 2.0 Configuration function, global scope.

Syntax

int SM_EXTERN Sm_PolicyApi_GetSAMLScheme
(
   void*                                  pHandle,
   const char*                            pszSchemeOid,
   Sm_PolicyApi_Scheme_t**                ppstructScheme,
   Sm_PolicyApi_SAMLProviderProp_t**      ppProps
);

Parameter	I/O	Description
pHandle	I	A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.
pszSchemeOid	I	A null-terminated string containing the object identifier of an existing SAML authentication scheme.
ppstructScheme	O	The address of a pointer to a SAML authentication scheme structure.
ppProps	O	The address of a pointer to a SAML 2.0 metadata properties structure. For information about these properties, see SAML 2.0 Authentication Scheme Properties.

Returns

Sm_PolicyApi_Success. The authentication scheme was retrieved successfully.
Sm_PolicyApi_Failure. The authentication scheme 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 an authentication scheme.
Sm_PolicyApi_InvalidOID. The authentication scheme OID was not found.

Email CA about this topic