Sign in

v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB
Whoami

Get current identity and permissions (whoami)

Returns the authenticated caller's own identity, API key scope, organization role, and resolved per-model permissions. Self-scoped and available to non-admins: it lets a caller decide whether an action is permitted without attempting it. Pass modelId to scope rolesByModel to specific models.

get/api/v1/whoami

Query parameters

modelIdstring

Optional model filter. A single model id or a comma-separated list. When provided, rolesByModel contains only these models. When omitted, models the caller can access are returned (up to a limit; see rolesByModelTruncated).

Example:550e8400-e29b-41d4-a716-446655440000

Optional model filter. A single model id or a comma-separated list. When provided, rolesByModel contains only these models. When omitted, models the caller can access are returned (up to a limit; see rolesByModelTruncated).

Response

Caller's identity, key scope, org role, and per-model permissions

keyScope'user' | 'organization' required

Scope of the API key in use. A separate axis from role: a user-scoped key (PAT/OAuth) acts as a single user and cannot use SCIM, regardless of the user's org role.

orgRole'MEMBER' | 'ORG_ADMIN' required

The caller's organization role.

rolesByModelobject required

Resolved role and effective permissions per model, keyed by model id. Connection role resolves per shared model, so this is per-model rather than a single global role.

rolesByModelTruncatedboolean

Present and true when rolesByModel was truncated because the caller can access more models than the unfiltered limit. Pass a modelId filter to retrieve specific models.

Example response

{
  "orgRole": "MEMBER"
}