Sm_PolicyApi_GetAllSAMLSPAttributes()

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

Sm_PolicyApi_GetAllSAMLSPAttributes()

Retrieves all the attributes associated with the specified Service Provider.

Type

SAML 2.0 Configuration function, domain scope.

Syntax

int SM_EXTERN Sm_PolicyApi_GetAllSAMLSPAttributes
(
   void*                              pHandle,
   const char*                        pszSAMLSPOid,
   Sm_PolicyApi_SAMLSPAttr_t**        ppstructSAMLSPAttr
);

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.
pszSAMLSPOid	I	A null-terminated string containing the object identifier of an existing Service Provider.
ppstructSAML SPAttr	O	The address of a pointer to attribute structures.

Returns

Sm_PolicyApi_Success. The attributes were retrieved successfully.
Sm_PolicyApi_Failure. The attributes 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 attributes from a SAML Service Provider.