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

Sm_PolicyApi_AddMessageConsumerPluginToSAML1xScheme()

Adds or updates a message consumer plugin setting to a SAML 1.x authentication scheme.

Syntax

int SM_EXTERN Sm_PolicyApi_AddMessageConsumerPluginToSAML1xScheme(
   void*    pHandle,
   char*    pszSchemeOID,
   char*    pluginClass,
   char*    pluginParam                        
);

Parameters

phandle

[in] A pointer to an internal Policy Management API data structure. The structure holds information about the administrator session and the client session.

pszSchemeOid

[in] A pointer to the OID of the authentication scheme that is being updated.

pluginClass

[in] A pointer to the name of the message consumer plugin class to be set.

pluginParam

[in] A pointer to the parameters of the message consumer plugin class to be set.

Returns

• Sm_PolicyApi_Success. The action was completed successfully.
• Sm_PolicyApi_Failure. The action was unsuccessful.
• Sm_PolicyApi_InvalidHandle. There was no valid initialization prior to this call.
• Sm_PolicyApi_SchemeNotFound. The authentication scheme corresponding to the OID was not found, or was not a SAML 1.x authentication scheme.
• Sm_PolicyApi_InvalidOid. The OID of the authentication scheme is NULL.