Troupeby AliveDocsSign in

Reference

Scopes

A caller must hold every scope a procedure lists (AND). A missing or invalid credential is UNAUTHENTICATED; a valid one without the scopes is FORBIDDEN, naming all the required scopes at once. Some procedures need one more scope for part of their input; their summaries say so. Index.

ScopeGrantsProcedures that require it
account:readRead your own account and sign-in sessions; a user principal onlyaccount.sessions, account.grants, invitations.received
account:writeChange your own account, revoke your sessions, create orgs; a user principal onlyaccount.revokeSession, account.reauthenticate, account.revokeGrant, orgs.create, members.leave, invitations.accept
org:readRead an org and its membersorgs.get, members.list, invitations.list
org:manageChange an org, its members and its invitationsorgs.update, orgs.setPlacementScope, members.updateRole, members.remove, invitations.create, invitations.revoke, quotas.setProject, issuers.create, issuers.list, issuers.update, issuers.suspend, issuers.remove, connections.create, connections.list, connections.remove, credentials.uploadAscKey, credentials.createAndroidKeystore, credentials.uploadAndroidKeystore, credentials.rotate, credentials.updateAllowList, credentials.delete
projects:readRead an org's projectsprojects.list, projects.get, projects.resolve
projects:writeCreate, change and archive projectsprojects.create, projects.update, projects.archive, projects.ensure
keys:readList an org's API keyskeys.list
keys:writeCreate and revoke API keyskeys.create, keys.revoke
usage:readRead an org's usageusage.get, quotas.get
builds:readRead builds and follow their logsbuilds.get, builds.list, builds.logs
builds:writeStart and cancel builds, and upload their sourcesbuilds.create, builds.cancel, uploads.grant, uploads.complete
artifacts:readRead artifacts and mint their download URLsartifacts.list, artifacts.get, artifacts.download
artifacts:writeUpload artifacts (later rounds)—
signing:useRead signing credentials' metadata and name one in a store buildcredentials.list, credentials.get
admin:readStaff only, on the admin origin—
admin:writeStaff only, on the admin origin—

public (no credential): none.

session (any authenticated principal): account.get, orgs.list.

Trust-class (locally only the runtime owner token; in the cloud only an interactive user session re-authenticated within 15 minutes; never an API key or an MCP token): orgs.setPlacementScope, members.updateRole, members.remove, invitations.create, keys.create, issuers.create, issuers.update, connections.create, credentials.uploadAscKey, credentials.createAndroidKeystore, credentials.uploadAndroidKeystore, credentials.rotate, credentials.updateAllowList, credentials.delete.

esc

    Type to search every page, the protocol reference and the cloud API.