Skip to main content
GET
Describe the calling credential's current actor and operation prerequisites
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

Returns what this request carries: who the credential is, which org unit it acts within, the permissions it holds after they are narrowed by its key or token scopes, where those permissions come from, and what each documented operation requires. Use it to tell a missing grant apart from a denial at a particular resource before you call an operation.

Authorization

GET /api/v2/actor requires no permission. Any Platform API credential can call it: a platform API key, a person-bound MCP key, or an External Application access token. Every fact it returns is about the caller. The endpoint takes no identifier. There is no path segment, no query parameter and no body. A request that sends any query parameter or a body is refused with 400 and code bad_request, so there is no way to ask about another key, app or person. A Personal key’s answer names the person it acts for, read from the key itself, never from the request. A missing, revoked or expired credential receives the usual 401, with no discovery data.

Response

Each entry in operations has: POST /api/v2/governance/actOnHumanTask, POST /api/v2/governance/completeHumanTask and POST /api/v2/governance/attachHumanTaskOutputFile are scope-gated: they require no role permission, so their requiredPermissions is empty, but the credential’s scopes must reach approvals:approve.
permissionSatisfied is advisory. It does not mean the operation will succeed on a particular resource: the operation re-authenticates your credential and checks the target’s current home, company and policy when you call it. resourceCheckRequired: false is not a resource authorization either. Do not cache this response as an authorization decision.
An operation with personRequired: true always reports permissionSatisfied: false: it needs a permission this credential’s kind can never hold. No operation decides an approval yet (a person decides in Forge Console, Slack or email). To hand a held run to a person, read its status with GET /api/v2/runs/getTrustStatus and give that person its handoff. The response never includes role ids, grant records, key material or raw token claims. Operations under a path prefix and operations not yet in the OpenAPI document are not listed.

Example

The example shows two of the operations; a real response lists every documented operation that requires a permission. MCP clients read it with the forge_get_current_actor tool: by default a summary with operation counts, one page of operations with detail: "operations", and this response’s data exactly with detail: "full".

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Response

The calling credential's current actor

data
object
required
meta
object
required