Sm_PolicyApi_GetSAMLServiceProvider()
Retrieves the Service Provider specified by its object identifier in the policy store.
casso127
Retrieves the Service Provider specified by its object identifier in the policy store.
Type
SAML 2.0 Configuration function, domain scope.
Syntax
int SM_EXTERN Sm_PolicyApi_GetSAMLServiceProvider(void*pSessionHandle,const char*pszProviderOid,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. |
pszProviderOid
| I | A null-terminated string containing the policy store object identifier of an existing Service Provider. |
ppstructSAMLSP
| O | 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.