Programming Guides › Programming Guide for C › Policy Management API Guidance › Function Declarations for the Policy Management API › Sm_PolicyAPI_AddTargetConfigToSAML1xScheme

Sm_PolicyAPI_AddTargetConfigToSAML1xScheme

Adds a default target configuration setting in a SAML 1.x authentication scheme.

Syntax

The Sm_PolicyApi_AddTargetConfigToSAML1xScheme function has the following syntax:

int SM_EXTERN Sm_PolicyApi_AddTargetConfigToSAML1xScheme(
        void*        pHandle,
        const char*  pszSchemeOid,
        const char*  pszURL,
        int         iQPOverridesTarget
);

Parameters

The Sm_PolicyApi_AddTargetConfigToSAML1xScheme function accepts the following 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 null-terminated string containing the object identifier of the authentication scheme being updated.

pszURL

[in] A pointer to a valid default target configuration URL.

iQPOverrides Target

[in] An integer specifying the value specified in the 'Query parameter override Default Target' check box.

Valid values for iQPOverridesTarget are:

• 0 specifies that the query parameter does not override the target.
• 1 specifies that the query parameter overrides the target.

Return Values

The Sm_PolicyApi_AddTargetConfigToSAML1xScheme function returns one of the following values:

• 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.