Sm_PolicyApi_RemoveAttributeFromSAMLSP()

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

Sm_PolicyApi_RemoveAttributeFromSAMLSP()

Removes the specified SAML attribute from the Service Provider.

Type

SAML 2.0 Configuration function, domain scope.

Syntax

int SM_EXTERN Sm_PolicyApi_RemoveAttributeFromSAMLSP
(
   void*                               pHandle,
   const Sm_PolicyApi_SAMLSPAttr_t*    pstructSAMLSPAttr,
   const char*                         pszSAMLSPOid
);

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.
pstructSAMLSPAttr	I	A pointer to a SAML attribute structure
pszSAMLSPOid	I	The Service Provider's object identifier in the policy store.

Returns

Sm_PolicyApi_Success. The attribute was removed successfully.
Sm_PolicyApi_Failure. The attribute was not removed 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 remove an SAML attribute from a Service Provider.
Sm_PolicyApi_NoSuchAttribute. No attribute exists with the Name and NameFormat provided.

Email CA about this topic