SAML callback

POST /users/auth/saml/_callback

Auth

Accepts a callback request from an identity provider and authenticates the user.

Request body

SAMLResponse string required: A message issued by the identity provider to the service provider
RelayState string: The optional relay state that the API (service provider) sent to the identity provider.

Responses

Redirects to the UI endpoint with an authorization token in the fragment and the relay state, if it was specified during the initialization.

application/json

Response Type: object

The supplied SAML response is invalid. (code: root.unauthenticated)

application/json

The administrator needs to configure the authentication cluster. (code: authc.no_authentication_cluster)

application/json

The authentication cluster failed to process the request. The response body contains details about the error. (code: authc.authentication_cluster_error)

application/json

Examples

Request curl 1 / 1 language

curl Shell

curl -X POST "${API_URL}/users/auth/saml/_callback" \
  -u "${USERNAME}:${PASSWORD}"

Generated from the API spec

Response

{}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec

SAML callback

Request body

Responses

Response headers

Response headers

Response headers