Current account

GET

/api/v1/auth/me

const url = 'https://example.com/api/v1/auth/me';
const options = {method: 'GET', headers: {cookie: 'ttx_access_token=<ttx_access_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/auth/me \
  --cookie ttx_access_token=<ttx_access_token>

The signed-in account, with its roles and session.

Authorizations

sessionCookie

Responses

200

Successful Response

application/json

AuthMeResponse

object

avatar_kind

required

Any of:

string
null

string

Allowed values: preset upload

avatar_value

required

Any of:

string
null

string

backup_codes_remaining

required

Backup Codes Remaining

integer

can_found_organization

required

Can Found Organization

boolean

default_organization_id

required

Any of:

string
null

string format: uuid

default_role

required

Any of:

string
null

string

Allowed values: program_manager planner controller facilitator evaluator observer player

default_ttx_id

required

Any of:

string
null

string format: uuid

email

required

Email

string

email_mfa_available

required

Email Mfa Available

boolean

email_mfa_enabled

required

Email Mfa Enabled

boolean

email_reconfirm_deadline

Any of:

string
null

string format: date-time

email_reconfirmation_overdue

Email Reconfirmation Overdue

boolean

email_verification_pending

required

Email Verification Pending

boolean

full_name

required

Full Name

string

has_password

required

Has Password

boolean

required

string format: uuid

is_instance_admin

required

Is Instance Admin

boolean

is_last_instance_admin

required

Is Last Instance Admin

boolean

is_planner

required

Is Planner

boolean

is_program_manager

required

Is Program Manager

boolean

legal_acceptance_pending

required

Legal Acceptance Pending

Array<object>

LegalPendingRead

object

kind

required

LegalDocumentKind

The legal documents a deployment’s operator publishes for its users (Platform), accepted together at signup.

string

Allowed values: terms privacy

updated

required

Updated

boolean

version

required

Version

integer

mfa_mandated

Mfa Mandated

boolean

mfa_methods

required

Mfa Methods

Array<string>

Allowed values: totp email backup_code

mfa_preferred

required

Any of:

string
null

string

Allowed values: totp email

password_change_reason

Any of:

string
null

string

Allowed values: reset expired

password_change_required

required

Password Change Required

boolean

password_min_length

Password Min Length

integer

default: 8

session

required

SessionInfo

The current session’s timeouts, so the client can warn before the soft timeout and announce the hard one.

object

absolute_expires_at

required

Absolute Expires At

string format: date-time

authenticated_at

required

Authenticated At

string format: date-time

idle_expires_at

required

Idle Expires At

string format: date-time

idle_timeout_minutes

required

Idle Timeout Minutes

integer

mfa_source

Any of:

string
null

string

Allowed value: provider

step_up_minutes

required

Step Up Minutes

integer

sso_linked

required

Sso Linked

boolean

sso_provider

required

Any of:

string
null

string

totp_enabled

required

Totp Enabled

boolean

Example

{
  "avatar_kind": "preset",
  "default_role": "program_manager",
  "email_reconfirmation_overdue": false,
  "legal_acceptance_pending": [
    {
      "kind": "terms"
    }
  ],
  "mfa_mandated": false,
  "mfa_methods": [
    "totp"
  ],
  "mfa_preferred": "totp",
  "password_change_reason": "reset",
  "password_min_length": 8,
  "session": {
    "mfa_source": "provider"
  }
}