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

Sm_PolicyAPI_GetRedirectURLFromSAML1xScheme()

Retrieves a redirect URL setting from a SAML 1.x authentication scheme.

Syntax

int SM_EXTERN Sm_PolicyApi_GetRedirectURLFromSAML1xScheme(
        void*        pSessionHandle,
        const char*  pszSchemeOid,
        int          iTypeURL,
        char**       URL,
        int          &redirectMode
);

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.

• iTypeUrl

  [in] An integer specifying the type of redirect URL, defined in Sm_PolicyAPI_SAML1_STATUS_REDIRECT_URL_TYPE_t as follows:

  • Sm_PolicyAPI_SAML1_STATUS_REDIRECT_URL_USER_NOT_FOUND_TYPE = 0
  • Sm_PolicyAPI_SAML1_STATUS_REDIRECT_URL_INVALID_SSO = 1
  • Sm_PolicyAPI_SAML1_STATUS_REDIRECT_URL_UNACCEPTABLE_USER_CREDENTIALS = 2
• URL

  [out] A pointer to the redirect URL from the authentication scheme

• redirectMode

  [out] An integer specifying the input redirect mode, which is either 0 for 302 No Data, or 1 for Http-Post.

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