The user object

⚠️

Preview — this feature is being built; the design below is the spec.

The user object as the API returns it. Every field below appears in every response that returns this object; fields with no value are null rather than missing.

Example

{
  "id": "user_01J9Y0A2C4E6G8J0L2N4",
  "type": "user",
  "email": "dana@example.com",
  "name": "Dana Lee",
  "role": "developer",
  "status": "active",
  "mfa_enabled": true,
  "workspaces": [
    {
      "workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
      "role": "workspace_developer"
    }
  ],
  "api_key_count": 3,
  "joined_at": "2026-02-10T14:00:00Z",
  "last_active_at": "2026-11-05T08:41:00Z"
}

Fields

Field	Type	Description
`id`	string	Unique id of this object.
`type`	string	The object type, always `user`.
`email`	string	Email address.
`name`	string	Name shown in the Console and in reports.
`role`	string	`primary_owner`, `owner`, `administrator`, `developer` or `custom`.
`status`	string	`active`, `suspended` or `removed`.
`mfa_enabled`	boolean	See the endpoint pages below.
`workspaces`	array	Nested detail; see the endpoint pages below.
`api_key_count`	integer	Active inference keys they created; these stop working if the member is suspended or removed.
`joined_at`	string	See the endpoint pages below.
`last_active_at`	string	Latest sign-in or authenticated request, updated at most hourly.

Returned by

tunnel_certificate user_profile

Was this page helpful?