Available authentication methods

GET /users/auth/methods

Auth

Provides information about available authentication methods.

Response

Available authentication methods response

application/json

password boolean required: Indicates that username and password authentication is available.
saml boolean required: Indicates that SAML single sign-on authentication is available.
openid boolean required: Warning

This endpoint is deprecated and scheduled to be removed in the next major version. This field is no longer used and will always be false.
sso_methods object[] required: Lists details for the available single sign-on methods.

View as Markdown

Examples

Request curl 1 / 1 language

curl Shell

curl -X GET "${API_URL}/users/auth/methods" \
  -u "${USERNAME}:${PASSWORD}"

Generated from the API spec

Response

{
  "password": false,
  "saml": false,
  "openid": false,
  "sso_methods": [
    {
      "sso_type": "saml",
      "name": "string",
      "url": "string"
    }
  ]
}

Generated from the API spec