Who Am I

Get current identity and permissions

Changed on

Retrieve the authenticated caller's own identity, API key scope, organization role, and resolved per-model permissions. Useful for allowing a caller to determine if they can execute a specific action without attempting it. Pass modelId to scope rolesByModel to specific models.

This endpoint can be used by any user with a valid API key.

get/v1/whoami

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/whoami
  • Auth
    • HTTP bearer
    • or HTTP bearer

Query parameters

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

Optional model filter. A single model ID or a comma-separated list.

When provided, rolesByModel in the response will contain 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.

  • user - Personal Access Token. This is a user-scoped key (PAT/OAuth) that acts as a single user and cannot use SCIM, regardless of the user's organization role.
  • organization - Organization API key
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"
}

Changes