Sm_PolicyApi_GetTargetConfigFromSAML1xScheme

Retrieves a target configuration setting from a SAML 1.x authentication scheme.
casso127
Retrieves a target configuration setting from a SAML 1.x authentication scheme.
Syntax
The Sm_PolicyApi_GetTargetConfigFromSAML1xScheme function has the following syntax:
int SM_EXTERN Sm_PolicyApi_GetTargetConfigFromSAML1xScheme(
        void*        pHandle,
        const char*  pszSchemeOid,
        char**       pszDefaultTarget,
        int*         iQPOverridesTarget
);
Parameters
The Sm_PolicyApi_GetTargetConfigFromSAML1xScheme function accepts the following parameters:
  • pSessionHandle
    [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.
  • pszDefaultTarget
    [out] Specifies the target configuration. The calling program must free up this memory by calling the Sm_PolicyApi_FreeMemory() function.
  • iQPOverridesTarget
    [out] Specifies the value of the 'Query parameter override Default Target' check box. The calling program is responsible for passing allocated memory.
Return Values
The Sm_PolicyApi_GetTargetConfigFromSAML1xScheme 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.