Get a user by id

GET

/v1/identity/users/{userId}

curl --request GET \
  --url https://example.com/v1/identity/users/example \
  --header 'Authorization: Bearer <token>'

• Same-origin — path relative to the deployment root.

A tenant admin, or the person themselves.

Authorizations

• bearerAuth

Parameters

Path Parameters

userId

required

string

>= 1 characters

Responses

200

User record.

Media typeapplication/json

Tenant-scoped user record (admin plane). primaryEmail may be redacted on the wire based on tenant policy (the routes treat it as opaque). metadata is free-form JSON — deployments carry IdP claims / provisioning source / roles here.

object

userId

required

string

tenantId

required

string format: uuid

primaryEmail

string

displayName

string

createdAt

required

string format: date-time

lastActiveAt

string format: date-time

unregisteredAt

When they were removed from the tenant (POST /v1/identity/users/{userId}/unregister); absent while they are here.

string format: date-time

metadata

object

key

additional properties

any

grants

The person’s grants: only on GET /v1/identity/users?include=grants, and only from a runtime that reads grants.

object

userId

required

string

tenantAdmin

Whether the person is a tenant admin. Absent when the runtime has no authorization store: nothing grants it then.

boolean

tenantMember

Whether the person is a tenant member: they read the tenant’s settings (providers, policies, adapters, signing keys, deployments), not its projects. A person is one from being added. Absent when the runtime has no authorization store, or doesn’t report it.

boolean

projects

required

Direct project memberships.

Array<object>

A person’s direct role on a project.

object

projectId

required

string

role

required

Role on a project, as read. member is only read, on a role given before it was retired: it grants what viewer does, and writes refuse it.

string

Allowed values: viewer editor owner admin member

teams

required

Team memberships.

Array<object>

A person’s role in a team.

object

teamId

required

string

role

required

Role on a team membership.

string

Allowed values: member admin

reviewer

A person’s active entry on the reviewer roster.

object

role

required

Reviewer role class. Hierarchy: standard < senior < admin.

string

Allowed values: standard senior admin

Example

{
  "grants": {
    "projects": [
      {
        "role": "viewer"
      }
    ],
    "teams": [
      {
        "role": "member"
      }
    ],
    "reviewer": {
      "role": "standard"
    }
  }
}

401

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

403

Someone else’s record, and not a tenant admin.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

No user with that id under this tenant.

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string

message

required

string

details

Optional, kind-specific.

object

key

additional properties

any

requestId

required

Server-assigned request id; also echoed via X-Request-Id header.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

See also

• GET /v1/identity/users: List users in the tenant
• POST /v1/identity/users: Add a person
• GET /v1/identity/users/{userId}/sessions: List active sessions for a user
• POST /v1/identity/users/{userId}/unregister: Remove a person
• Every error code