Available authentication methods

GET /users/auth/methods
Basic auth Api key

Provides information about available authentication methods.

Responses

  • 200 application/json

    Available authentication methods response

    Hide response attributes Show response attributes object
    • 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 array[object] Required

      Lists details for the available single sign-on methods.

      Hide sso_methods attributes Show sso_methods attributes object

      Specifies the authentication methods that are enabled on the Elasticsearch cluster. NOTE: When all fields are false, only the Platform admin and Platform viewer are available.

      • sso_type string Required

        Indicates the protocol of the single sign-on method.

        Value is saml.

      • name string Required

        The friendly name of the single sign-on method.

      • url string Required

        The URL to initiate the single sign-on login.
GET /users/auth/methods 
curl \
 --request GET 'https://{{hostname}}/api/v1/users/auth/methods' \
 --user "username:password"