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
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

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

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response

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

application/json
errors object[] required

A list of errors that occurred in the failing request

code string required

A structured code representing the error type that occurred

message string required

A human readable message describing the error that occurred

fields string[]

If the error can be tied to a specific field or fields in the user request, this lists those fields

Response headers

x-cloud-error-codes enum

The error codes associated with the response