Initiate SAML protocoledit
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.
Requestedit
GET /api/v1/users/auth/saml/_init
Query parametersedit
| Name | Type | Required | Description |
|---|---|---|---|
|
|
N |
An optional relay state that is sent back to the client after the user is authenticated |
Responsesedit
-
302 -
(
EmptyResponse) Redirects the client to the identity provider with a SAML authentication request -
501 -
(
BasicFailedReply) You need to configure the authentication cluster. (code:authc.no_authentication_cluster) -
502 -
(
BasicFailedReply) The authentication cluster failed to process the request. The response body contains details about the error. (code:authc.authentication_cluster_error)
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XGET {{hostname}}/api/v1/users/auth/saml/_init \
-u $CLOUD_USER:$CLOUD_KEY