Sm_PolicyApi_GetSAMLAffiliation()

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

Sm_PolicyApi_GetSAMLAffiliation()

Retrieves the SAML affiliation specified by its object identifier in the policy store.

Type

SAML 2.0 Configuration function, global scope.

Syntax

int SM_EXTERN Sm_PolicyApi_GetSAMLAffiliation
(
   void*                               pSessionHandle,
   const char*                         pszAffiliationOid,
   Sm_PolicyApi_SAMLAffiliation_t**    ppstructAffiliation
);

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.
pszAffiliationOid	I	A null-terminated string containing the policy store object identifier of an existing SAML affiliation.
ppstruct Affiliation	O	The address of a pointer to a SAML affiliation structure.

Returns

Sm_PolicyApi_Success. The SAML affiliation was retrieved successfully.
Sm_PolicyApi_Failure. The SAML affiliation 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 SAML affiliation.
Sm_PolicyApi_InvalidOID. The SAML affiliation OID was not found.