This API resource supports the qq sso_login command. Begin an interactive SAML single sign-on (SSO) authentication process for the cluster. Return the login_id and login_url strings required for the user to complete the authentication process. If SSO is not enabled on the cluster, return saml_not_configured_error. To complete in-browser authentication, the caller must pass the login_url parameter to the user. The caller must use the login_id parameter to poll the retrieve-saml-login API for SAML SSO credentials until the user completes the authentication process in the browser, or until the 5-minute limit elapses.
Parameters
This resource has no parameters.
Response
Codes
Code
Description
200
Return value on success
Schema
{"description":"api_saml_login_info","type":"object","properties":{"login_id":{"description":"The unique identifier for the pending login. Use the login_id with the check-saml-login API.","type":"string"},"login_url":{"description":"The login URL to present to the user. To complete the authentication process, the user must open the login URL in a browser.","type":"string"}}}