Skip to main content
GET
Get a company's access inventory
The Console’s company access inventory for one company (orgUnitId): the role grants that reach it (grantSource: the company, a parent company or the platform), the workflow versions allowed to act for it, and the credentials it can use. The credentials are listed only when your credential’s scopes reach credentials:read and your role grants also hold it at the deployment root; otherwise that population is unavailable with reason credentials_read_required. Each population carries its coverage: partial when its 500-row read cap was reached, unavailable when the company cannot be placed. People are listed by id, never by name; agents, keys and apps by name. Who gave a grant and why are never returned. Your role grants, narrowed by your credential’s scopes, must hold grants:read at your acting organization and again at the deployment root; otherwise the call is 403 permission_denied naming grants:read, with a recorded decisionId.

Paging

The three populations page together. Each page holds up to limit rows of each (default 8, at most 50; a larger value is 400 too_big), in a stable order: role grants by holder, role and scope; workflow grants and credentials by id. A population with rows still to come has coverage partial with reason pagination_remaining, unless its read already said why it is partial; a population that ended on an earlier page returns no rows. While meta.hasMore is true, pass meta.nextCursor as cursor with the same orgUnitId. Each page is cut from the whole inventory your credential may read, so every page applies the same rules. A cursor for another company or route is 400 Invalid cursor.

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.

Query Parameters

orgUnitId
string
required

The company to inventory.

Minimum string length: 1
limit
integer
default:8

Rows of each population per page (default 8). A value above 50 is 400 too_big; anything but a positive integer is 400 Invalid: limit.

Required range: 1 <= x <= 50
cursor
string

The previous page's meta.nextCursor, with the other parameters unchanged; any other value is 400 Invalid cursor.

Minimum string length: 1

Response

The inventory

data
object
required

One company's access inventory: the role grants that reach it (from the company, a parent company or the platform), the workflow versions allowed to act for it, and the credentials it can use, each with its coverage. People are listed by id with no name; agents, keys and apps by name. Who gave a grant and why are never returned.

meta
object
required