Initiate SAML protocol

  • GET /users/auth/saml/_init
Auth

Calls the authentication cluster to initiate SAML Single Sign-on (Web Browser SSO profile) protocol and redirects the user to the identity provider for authentication. The authentication cluster must be configured prior to initiation.

Query parameters

state string

An optional relay state that is sent back to the client after the user is authenticated

realm string

An optional SAML realm to use for authentication

Responses

Redirects the client to the identity provider with a SAML authentication request

application/json

Response Type: object

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