identity

Who am I: identity + org role + role-derived capabilities + token scopes

get/me

Request

  • Base URL: https://api.letsship.ai/v1
  • URL: https://api.letsship.ai/v1/me
  • Auth: none declared

Response

Caller identity

principalType'cookie' | 'user' | 'service' | 'system' | 'agent' required

agent: a self-registered agent nobody has claimed yet. It has no user, org, role or scopes, and reaches only /me and /scopes until a person claims it.

userIdstring nullable required
orgIdstring nullable required
role'owner' | 'admin' | 'member' nullable required
capabilitiesCapability[] required
scopesstring[] required
projectIdstring nullable required

The project this credential is bound to, or null when it is org-wide. A bound token can read and act only on that project, and on nothing org-wide - so a caller can see the boundary it works within rather than discovering it through a 404.

Example response

{
  "principalType": "user",
  "userId": "user_9b8e2a3f3c4d4e5f9a8b",
  "orgId": "org_7c1f2a",
  "role": "admin",
  "capabilities": [
    "pipeline:control",
    "config:write"
  ],
  "scopes": [
    "projects:read",
    "missions:run"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.