Sm_PolicyApi_GetSAMLAffiliationById()

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

Sm_PolicyApi_GetSAMLAffiliationById()

Retrieves the SAML affiliation specified by its unique affiliation identifier (URI).

Type

SAML 2.0 Configuration function, global scope.

Syntax

int SM_EXTERN Sm_PolicyApi_GetSAMLAffiliationById
(
   void*                               pSessionHandle,
   const char*                         pszAffiliationID,
   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.
pszAffiliationID	I	A null-terminated string containing the unique affiliation identifier of an existing SAML affiliation. The affiliation identifier is specified in SAML_KEY_AFFILIATION_ID.
ppstruct Affiliation	O	The address of a pointer to a SAML affiliation 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.

pszAffiliationID

A null-terminated string containing the unique affiliation identifier of an existing SAML affiliation.

The affiliation identifier is specified in SAML_KEY_AFFILIATION_ID.

ppstruct
Affiliation

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.