1. Docs
  2. API Reference
  3. SelectAccountResponseDto

SelectAccountResponseDto

Example

JSON
{
  "mfa_enrollment_pending": false,
  "grace_expires_at": "2026-04-20T12:00:00.000Z",
  "requires_mfa_enrollment": false,
  "mfa_enrollment": {
    "enrollment_token": "string",
    "available_factors": [
      "totp"
    ],
    "totp": {
      "otpauth_uri": "string",
      "manual_entry_key": "string"
    }
  },
  "requires_mfa_challenge": false,
  "mfa_challenge": {
    "challenge_token": "string",
    "available_factors": [
      "totp"
    ],
    "expires_at": "2026-04-20T12:00:00.000Z"
  },
  "access_token": "string",
  "token_type": "string",
  "expires_in": 0,
  "account": {
    "id": "string",
    "name": "string",
    "slug": "string"
  },
  "application": {
    "id": "string",
    "name": "string",
    "slug": "string"
  },
  "default_environment_slug": "string"
}

Properties

12 properties 1 required

mfa_enrollment_pending boolean Optional

True when the Account requires a second factor, the administrator holds none, and the grace window still has time. The session is issued; nudge the person to enroll before `grace_expires_at`.

grace_expires_at string Optional

Deadline by which the administrator must enroll a factor; after it, entering the Account issues no session and answers `requires_mfa_enrollment` instead.

format: date-time
requires_mfa_enrollment boolean Optional

True when the Account requires a second factor, the administrator holds none, and no grace remains. No session is issued; enroll a first factor via `/v1/auth/login/mfa-enroll/*` with `mfa_enrollment.enrollment_token`.

mfa_enrollment UserMfaEnrollmentPromptDto Optional
requires_mfa_challenge boolean Optional

True when the administrator holds a factor the session has not answered (an SSO sign-in into an Account whose `after_sso` is `require`). Answer `mfa_challenge` at `/v1/auth/mfa/challenge/*`; the session returned is bound to this Account.

mfa_challenge UserMfaChallengePromptDto Optional
access_token string Optional
token_type string Optional
expires_in number Required
account AuthAccountSummaryDto Optional
application AuthApplicationDto Optional
default_environment_slug string Optional
Was this page helpful?

Tell us how we can improve this guide.

Canopy