Initiate SAML protocol
editInitiate SAML protocol
editCalls 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.
Request
editGET /api/v1/users/auth/saml/_init
Query parameters
editName | Type | Required | Description |
---|---|---|---|
|
|
N |
An optional relay state that is sent back to the client after the user is authenticated |
Responses
edit-
302
-
Redirects the client to the identity provider with a SAML authentication request
-
501
-
The administrator needs to configure the authentication cluster. (code:
authc.no_authentication_cluster
)Headers
-
x-cloud-error-codes
(string
; allowed values: [authc.no_authentication_cluster
]) - The error codes associated with the response
-
-
502
-
The authentication cluster failed to process the request. The response body contains details about the error. (code:
authc.authentication_cluster_error
)Headers
-
x-cloud-error-codes
(string
; allowed values: [authc.authentication_cluster_error
]) - The error codes associated with the response
-
Request example
editcurl -XGET https://{{hostname}}/api/v1/users/auth/saml/_init \ -H "Authorization: ApiKey $ECE_API_KEY"