Endpoint

/v1/session/retrieve-saml-login

POST

This API resource supports the qq sso_login command.Check the status of the in-progress SAML single sign-on (SSO) authentication process that start-saml-login begins. When a user completes the authentication process, return the bearer_token with which a user can perform subsequent API requests. When the caller retrieves the bearer_token, future calls with the same saml_login_id return the 404 Not Found error. If authentication for login_id is pending, instruct the caller to check again later by returning an empty bearer_token. If the login_id has expired within the 5-minute limit, return the 401 Unauthorized error. If the caller has already retrieved the login-id, return the 404 Not Found error.If the provided verification code mismatches with the expected code, return the 400 Bad Request error.

Parameters

This resource has no parameters.

Request

Schema

{
  "description": "saml_login_verification",
  "type": "object",
  "properties": {
    "login_id": {
      "description": "A unique, Qumulo-generated login_id associated with a SAML SSO authentication session.",
      "type": "string"
    },
    "verification_code": {
      "description": "A one-time security code that helps ensure that the SAML SSO authentication session is user-initiated.",
      "type": "string"
    }
  }
}

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "credentials",
  "type": "object",
  "properties": {
    "bearer_token": {
      "description": "bearer_token",
      "type": "string"
    }
  }
}