API by area

Roles and permissions

133 endpoints. Paths are relative to https://api.sandscale.dev; values in braces are ones you fill in.

API reference · Authentication · Errors

MethodPathWhat it does
GET/api/v1/access/account-rolesList account roles
GET/api/v1/access/activationsList activations
POST/api/v1/access/activationsCreate an activation
GET/api/v1/access/activations/{id}Get one activation
POST/api/v1/access/activations/{id}/endEnd an activation
POST/api/v1/access/activations/{id}/reviewReview an activation
POST/api/v1/access/batch-checkCreate a batch check
GET/api/v1/access/bindingsList bindings
POST/api/v1/access/bindingsCreate a binding
GET/api/v1/access/bindings/{id}Get one binding
PUT/api/v1/access/bindings/{id}Replace one binding
DELETE/api/v1/access/bindings/{id}Delete one binding
GET/api/v1/access/ceilingsList ceilings
POST/api/v1/access/ceilingsCreate a ceiling
GET/api/v1/access/ceilings/{id}Get one ceiling
PUT/api/v1/access/ceilings/{id}Replace one ceiling
DELETE/api/v1/access/ceilings/{id}Delete one ceiling
POST/api/v1/access/checkCreate a check
GET/api/v1/access/classification/nodes/{node_id}Get one node
GET/api/v1/access/classification/objectsList objects
GET/api/v1/access/classification/objects/{type}/{id}Get one {type}
PUT/api/v1/access/classification/objects/{type}/{id}Replace one {type}
DELETE/api/v1/access/classification/objects/{type}/{id}Delete one {type}
GET/api/v1/access/classification/schemeList scheme
PUT/api/v1/access/classification/schemeSet scheme
GET/api/v1/access/clearancesList clearances
POST/api/v1/access/clearancesCreate a clearance
GET/api/v1/access/clearances/{id}Get one clearance
DELETE/api/v1/access/clearances/{id}Delete one clearance
GET/api/v1/access/declassificationsList declassifications
POST/api/v1/access/declassificationsCreate a declassification
GET/api/v1/access/declassifications/{id}Get one declassification
GET/api/v1/access/deny-policiesList deny policies
POST/api/v1/access/deny-policiesCreate a deny policy
GET/api/v1/access/deny-policies/{id}Get one deny policy
PUT/api/v1/access/deny-policies/{id}Replace one deny policy
DELETE/api/v1/access/deny-policies/{id}Delete one deny policy
POST/api/v1/access/deny-policies/presetsCreate a preset
GET/api/v1/access/disabled-usersList disabled users
POST/api/v1/access/disabled-users/{user_id}/enableEnable a disabled user
GET/api/v1/access/effective-permissionsList effective permissions
POST/api/v1/access/explainCreate an explain
GET/api/v1/access/host-access/settingsList settings
PUT/api/v1/access/host-access/settingsSet settings
GET/api/v1/access/host-rulesList host rules
POST/api/v1/access/host-rulesCreate a host rule
GET/api/v1/access/host-rules/{id}Get one host rule
PUT/api/v1/access/host-rules/{id}Replace one host rule
DELETE/api/v1/access/host-rules/{id}Delete one host rule
GET/api/v1/access/legacy-confirmationsList legacy confirmations
GET/api/v1/access/me/eligibilityLists the caller's eligible bindings with what activating each one takes.
POST/api/v1/access/me/explainCreate an explain
GET/api/v1/access/me/resource-requestsList resource requests
GET/api/v1/access/me/shared-resourcesList shared resources
GET/api/v1/access/network-zonesList network zones
PUT/api/v1/access/network-zonesSet network zones
GET/api/v1/access/nodesList nodes
GET/api/v1/access/nodes/{node_id}/delegationDelegation of a node
PUT/api/v1/access/nodes/{node_id}/delegationSet the delegation of a node
DELETE/api/v1/access/nodes/{node_id}/delegationDelete the delegation of a node
GET/api/v1/access/principalsList principals
GET/api/v1/access/principals/{type}/{id}/permissionsThe effective permissions on ?node_id= (the organization node by default).
GET/api/v1/access/principals/{type}/{id}/resourcesThe objects the principal holds access on (?type= repeats, ?level= the least level).
POST/api/v1/access/resource-requests/{id}/approveApprove a resource request
POST/api/v1/access/resource-requests/{id}/denyDeny a resource request
POST/api/v1/access/resource-requests/{id}/withdrawWithdraw a resource request
GET/api/v1/access/resources/{type}/{id}/effective-accessEffective access of a {type}
GET/api/v1/access/resources/{type}/{id}/requestsList the requests of a {type}
POST/api/v1/access/resources/{type}/{id}/requestsCreate a request for a {type}
GET/api/v1/access/resources/{type}/{id}/sharingSharing of a {type}
POST/api/v1/access/resources/{type}/{id}/sharingSharing a {type}
DELETE/api/v1/access/resources/{type}/{id}/sharing/{binding_id}Delete one sharing
POST/api/v1/access/resources/{type}/{id}/sharing/invitationsInvites a person who is not in the account and records a share applied when they accept.
DELETE/api/v1/access/resources/{type}/{id}/sharing/invitations/{pending_id}Removes a share waiting for an invitation.
GET/api/v1/access/review-schedulesList review schedules
POST/api/v1/access/review-schedulesCreate a review schedule
GET/api/v1/access/review-schedules/{id}Get one review schedule
PUT/api/v1/access/review-schedules/{id}Replace one review schedule
DELETE/api/v1/access/review-schedules/{id}Delete one review schedule
GET/api/v1/access/reviewsList reviews
POST/api/v1/access/reviewsCreate a review
GET/api/v1/access/reviews/{id}Get one review
POST/api/v1/access/reviews/{id}/closeClose a review
GET/api/v1/access/reviews/{id}/evidenceExports a campaign's evidence report as JSON (default) or CSV (format=csv).
GET/api/v1/access/reviews/{id}/itemsList the items of a review
POST/api/v1/access/reviews/{id}/items/{item_id}/decisionDecision an item
GET/api/v1/access/rolesList roles
POST/api/v1/access/rolesCreate a role
GET/api/v1/access/roles/{id}Get one role
PUT/api/v1/access/roles/{id}Replace one role
DELETE/api/v1/access/roles/{id}Delete one role
GET/api/v1/access/roles/{id}/versionsList the versions of a role
GET/api/v1/access/settingsList settings
PUT/api/v1/access/settingsSet settings
GET/api/v1/access/sod-rulesList sod rules
POST/api/v1/access/sod-rulesCreate a sod rule
GET/api/v1/access/sod-rules/{id}Get one sod rule
PUT/api/v1/access/sod-rules/{id}Replace one sod rule
DELETE/api/v1/access/sod-rules/{id}Delete one sod rule
POST/api/v1/enterprise/directory-syncCreate a directory sync
GET/api/v1/enterprise/directory-sync/statusList status
POST/api/v1/enterprise/jit-grantsCreate a jit grant
POST/api/v1/enterprise/jit-grants/{id}/approveApprove a jit grant
POST/api/v1/enterprise/jit-grants/{id}/revokeRevoke a jit grant
POST/api/v1/enterprise/jit-grants/expire(admin / cron)
POST/api/v1/enterprise/service-accountsCreate a service account
GET/api/v1/enterprise/service-accounts/{id}Get one service account
POST/api/v1/enterprise/service-accounts/{id}/rotateRotate a service account
POST/api/v1/enterprise/service-accounts/validate-tokenCreate a validate token
GET/api/v1/permissionsList permissions
POST/api/v1/svc/iam/AttachGroupPolicyAttach group policy
POST/api/v1/svc/iam/AttachUserPolicyAttach user policy
POST/api/v1/svc/iam/CreatePolicyCreate policy
POST/api/v1/svc/iam/CreatePolicyVersionCreate policy version
POST/api/v1/svc/iam/DeletePolicyDelete policy
POST/api/v1/svc/iam/DeletePolicyVersionDelete policy version
POST/api/v1/svc/iam/DeleteUserPermissionsBoundaryDelete user permissions boundary
POST/api/v1/svc/iam/DetachGroupPolicyDetach group policy
POST/api/v1/svc/iam/DetachUserPolicyDetach user policy
POST/api/v1/svc/iam/GetPolicyGet policy
POST/api/v1/svc/iam/GetPolicyVersionGet policy version
POST/api/v1/svc/iam/GetUserPermissionsBoundaryGet user permissions boundary
POST/api/v1/svc/iam/ListActionsList actions
POST/api/v1/svc/iam/ListAttachedGroupPoliciesList attached group policies
POST/api/v1/svc/iam/ListAttachedUserPoliciesList attached user policies
POST/api/v1/svc/iam/ListEntitiesForPolicyList entities for policy
POST/api/v1/svc/iam/ListPoliciesList policies
POST/api/v1/svc/iam/ListPolicyVersionsList policy versions
POST/api/v1/svc/iam/PutUserPermissionsBoundaryPut user permissions boundary
POST/api/v1/svc/iam/SetDefaultPolicyVersionSet default policy version
POST/api/v1/svc/iam/SimulateCustomPolicySimulate custom policy
POST/api/v1/svc/iam/SimulatePrincipalPolicySimulate principal policy
POST/api/v1/svc/iam/ValidatePolicyValidate policy

Endpoints

GET /api/v1/access/account-roles

List account roles

Permission
signed in
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/activations

List activations

Permission
iam.activations:read
Query parameters
kind, mine, page_size, page_token, review_state, state, user_id
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/activations

Create an activation

Permission
iam.activations:request
Request body
ActivationInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/activations/{id}

Get one activation

Permission
iam.activations:read
Path parameters
id
Response
200: ActivationView
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/activations/{id}/end

End an activation

Permission
iam.activations:approve
Path parameters
id
Request body
object
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

POST /api/v1/access/activations/{id}/review

Review an activation

Permission
iam.breakglass:review
Path parameters
id
Request body
ReviewInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

POST /api/v1/access/batch-check

Create a batch check

Permission
iam.access:analyze
Request body
object
Response
200: object of any
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/bindings

List bindings

Permission
iam.bindings:read
Query parameters
node, node_id, page_size, page_token, principal_id, principal_type, role_id, state
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/bindings

Create a binding

Permission
iam.bindings:create
Request body
BindingInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/bindings/{id}

Get one binding

Permission
iam.bindings:read
Path parameters
id
Response
200: BindingView
Errors
401: unauthorized; 403: permission_denied

PUT /api/v1/access/bindings/{id}

Replace one binding

Permission
iam.bindings:update
Path parameters
id
Request body
BindingUpdate
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

DELETE /api/v1/access/bindings/{id}

Delete one binding

Permission
iam.bindings:delete
Path parameters
id
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/ceilings

List ceilings

Permission
iam.ceilings:read
Query parameters
node_id, page_size, page_token
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/ceilings

Create a ceiling

Permission
iam.ceilings:manage
Request body
CeilingInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/ceilings/{id}

Get one ceiling

Permission
iam.ceilings:read
Path parameters
id
Response
200: CeilingView
Errors
401: unauthorized; 403: permission_denied

PUT /api/v1/access/ceilings/{id}

Replace one ceiling

Permission
iam.ceilings:manage
Path parameters
id
Request body
CeilingInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

DELETE /api/v1/access/ceilings/{id}

Delete one ceiling

Permission
iam.ceilings:manage
Path parameters
id
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/check

Create a check

Permission
iam.access:analyze
Request body
CheckInput
Response
200: Decision
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/classification/nodes/{node_id}

Get one node

Permission
iam.classification:read
Path parameters
node_id
Response
200: NodeClassification
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/classification/objects

List objects

Permission
iam.classification:read
Query parameters
page_size, page_token, resource_type
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/classification/objects/{type}/{id}

Get one {type}

Permission
iam.classification:read
Path parameters
type, id
Response
200: ObjectClassification
Errors
401: unauthorized; 403: permission_denied

PUT /api/v1/access/classification/objects/{type}/{id}

Replace one {type}

Permission
iam.classification:label
Path parameters
type, id
Request body
ObjectLabelInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

DELETE /api/v1/access/classification/objects/{type}/{id}

Delete one {type}

Permission
iam.classification:label
Path parameters
type, id
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/classification/scheme

List scheme

Permission
iam.classification:read
Response
200: SchemeView
Errors
401: unauthorized; 403: permission_denied

PUT /api/v1/access/classification/scheme

Set scheme

Permission
iam.classification:manage
Request body
SchemeInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/clearances

List clearances

Permission
iam.clearances:read
Query parameters
page_size, page_token, principal_id, principal_type
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/clearances

Create a clearance

Permission
iam.clearances:manage
Request body
ClearanceInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/clearances/{id}

Get one clearance

Permission
iam.clearances:read
Path parameters
id
Response
200: ClearanceView
Errors
401: unauthorized; 403: permission_denied

DELETE /api/v1/access/clearances/{id}

Delete one clearance

Permission
iam.clearances:manage
Path parameters
id
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/declassifications

List declassifications

Permission
iam.classification:read
Query parameters
node_id, page_size, page_token, status
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/declassifications

Create a declassification

Permission
iam.classification:declassify
Request body
DeclassifyInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/declassifications/{id}

Get one declassification

Permission
iam.classification:read
Path parameters
id
Response
200: Declassification
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/deny-policies

List deny policies

Permission
iam.denypolicies:read
Query parameters
node_id, page_size, page_token
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/deny-policies

Create a deny policy

Permission
iam.denypolicies:manage
Request body
DenyInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/deny-policies/{id}

Get one deny policy

Permission
iam.denypolicies:read
Path parameters
id
Response
200: DenyView
Errors
401: unauthorized; 403: permission_denied

PUT /api/v1/access/deny-policies/{id}

Replace one deny policy

Permission
iam.denypolicies:manage
Path parameters
id
Request body
DenyInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

DELETE /api/v1/access/deny-policies/{id}

Delete one deny policy

Permission
iam.denypolicies:manage
Path parameters
id
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/deny-policies/presets

Create a preset

Permission
iam.denypolicies:manage
Request body
PresetInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/disabled-users

List disabled users

Permission
iam.principals:read
Query parameters
page_size, page_token
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/disabled-users/{user_id}/enable

Enable a disabled user

Permission
iam.principals:manage
Path parameters
user_id
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/effective-permissions

List effective permissions

Permission
iam.access:analyze
Query parameters
node_id, principal_id, principal_type
Response
200: Effective
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/explain

Create an explain

Permission
iam.access:analyze
Request body
CheckInput
Response
200: Explanation
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/host-access/settings

List settings

Permission
iam.hostrules:read
Response
200: HostSettingsView
Errors
401: unauthorized; 403: permission_denied

PUT /api/v1/access/host-access/settings

Set settings

Permission
iam.hostrules:manage
Request body
object
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/host-rules

List host rules

Permission
iam.hostrules:read
Query parameters
node_id, page_size, page_token
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/host-rules

Create a host rule

Permission
iam.hostrules:manage
Request body
HostRuleInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/host-rules/{id}

Get one host rule

Permission
iam.hostrules:read
Path parameters
id
Response
200: HostRuleView
Errors
401: unauthorized; 403: permission_denied

PUT /api/v1/access/host-rules/{id}

Replace one host rule

Permission
iam.hostrules:manage
Path parameters
id
Request body
HostRuleInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

DELETE /api/v1/access/host-rules/{id}

Delete one host rule

Permission
iam.hostrules:manage
Path parameters
id
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/legacy-confirmations

List legacy confirmations

Permission
iam.bindings:read
Query parameters
page_size, page_token
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/me/eligibility

Lists the caller's eligible bindings with what activating each one takes.

Permission
signed in
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/me/explain

Create an explain

Permission
signed in
Request body
MineInput
Response
200: Explanation
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/me/resource-requests

List resource requests

Permission
signed in
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/me/shared-resources

List shared resources

Permission
signed in
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/network-zones

List network zones

Permission
iam.networkzones:read
Response
200: NetworkZonesView
Errors
401: unauthorized; 403: permission_denied

PUT /api/v1/access/network-zones

Set network zones

Permission
iam.networkzones:manage
Request body
object
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/nodes

List nodes

Permission
iam.access:analyze
Query parameters
page_size, page_token, permission, principal_id, principal_type
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/nodes/{node_id}/delegation

Delegation of a node

Permission
iam.delegation:read
Path parameters
node_id
Response
200: DelegationView
Errors
401: unauthorized; 403: permission_denied

PUT /api/v1/access/nodes/{node_id}/delegation

Set the delegation of a node

Permission
iam.delegation:manage
Path parameters
node_id
Request body
object
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

DELETE /api/v1/access/nodes/{node_id}/delegation

Delete the delegation of a node

Permission
iam.delegation:manage
Path parameters
node_id
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/principals

List principals

Permission
iam.access:analyze
Query parameters
node_id, page_size, page_token, permission
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/principals/{type}/{id}/permissions

The effective permissions on ?node_id= (the organization node by default).

Permission
iam.access:analyze
Path parameters
type, id
Query parameters
node_id
Response
200: Effective
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/principals/{type}/{id}/resources

The objects the principal holds access on (?type= repeats, ?level= the least level).

Permission
iam.access:analyze
Path parameters
type, id
Query parameters
level
Response
200: PrincipalResources
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/resource-requests/{id}/approve

Approve a resource request

Permission
signed in
Path parameters
id

POST /api/v1/access/resource-requests/{id}/deny

Deny a resource request

Permission
signed in
Path parameters
id

POST /api/v1/access/resource-requests/{id}/withdraw

Withdraw a resource request

Permission
signed in
Path parameters
id
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/resources/{type}/{id}/effective-access

Effective access of a {type}

Permission
signed in
Path parameters
type, id
Response
200: EffectiveAccess
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/resources/{type}/{id}/requests

List the requests of a {type}

Permission
signed in
Path parameters
type, id
Query parameters
status
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/resources/{type}/{id}/requests

Create a request for a {type}

Permission
signed in
Path parameters
type, id
Request body
RequestInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/resources/{type}/{id}/sharing

Sharing of a {type}

Permission
signed in
Path parameters
type, id
Response
200: Sharing
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/resources/{type}/{id}/sharing

Sharing a {type}

Permission
signed in
Path parameters
type, id
Request body
GrantInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

DELETE /api/v1/access/resources/{type}/{id}/sharing/{binding_id}

Delete one sharing

Permission
signed in
Path parameters
type, id, binding_id
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/resources/{type}/{id}/sharing/invitations

Invites a person who is not in the account and records a share applied when they accept.

Permission
signed in
Path parameters
type, id
Request body
InviteShareInput
Response
201: InviteShareResult
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

DELETE /api/v1/access/resources/{type}/{id}/sharing/invitations/{pending_id}

Removes a share waiting for an invitation.

Permission
signed in
Path parameters
type, id, pending_id
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/review-schedules

List review schedules

Permission
iam.reviews:read
Query parameters
page_size, page_token
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/review-schedules

Create a review schedule

Permission
iam.reviews:manage
Request body
ScheduleInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/review-schedules/{id}

Get one review schedule

Permission
iam.reviews:read
Path parameters
id
Response
200: ScheduleView
Errors
401: unauthorized; 403: permission_denied

PUT /api/v1/access/review-schedules/{id}

Replace one review schedule

Permission
iam.reviews:manage
Path parameters
id
Request body
ScheduleInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

DELETE /api/v1/access/review-schedules/{id}

Delete one review schedule

Permission
iam.reviews:manage
Path parameters
id
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/reviews

List reviews

Permission
iam.reviews:read
Query parameters
page_size, page_token, state
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/reviews

Create a review

Permission
iam.reviews:manage
Request body
CampaignInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/reviews/{id}

Get one review

Permission
iam.reviews:read
Path parameters
id
Response
200: CampaignView
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/reviews/{id}/close

Close a review

Permission
iam.reviews:manage
Path parameters
id
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/reviews/{id}/evidence

Exports a campaign's evidence report as JSON (default) or CSV (format=csv).

Permission
iam.reviews:export
Path parameters
id
Query parameters
format
Response
200: Evidence
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/reviews/{id}/items

List the items of a review

Permission
iam.reviews:read
Path parameters
id
Query parameters
outcome, page_size, page_token
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/reviews/{id}/items/{item_id}/decision

Decision an item

Permission
iam.reviews:decide
Path parameters
id, item_id
Request body
DecisionInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/roles

List roles

Permission
iam.roles:read
Query parameters
page_size, page_token, scope
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/roles

Create a role

Permission
iam.roles:create
Request body
RoleInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/roles/{id}

Get one role

Permission
iam.roles:read
Path parameters
id
Response
200: RoleView
Errors
401: unauthorized; 403: permission_denied

PUT /api/v1/access/roles/{id}

Replace one role

Permission
iam.roles:update
Path parameters
id
Request body
RoleInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

DELETE /api/v1/access/roles/{id}

Delete one role

Permission
iam.roles:delete
Path parameters
id
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/roles/{id}/versions

List the versions of a role

Permission
iam.roles:read
Path parameters
id
Response
200: object of any
Errors
401: unauthorized; 403: permission_denied

GET /api/v1/access/settings

List settings

Permission
iam.settings:read
Response
200: SettingsView
Errors
401: unauthorized; 403: permission_denied

PUT /api/v1/access/settings

Set settings

Permission
iam.settings:update
Request body
SettingsInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/sod-rules

List sod rules

Permission
iam.sod:read
Query parameters
page_size, page_token
Response
200: Page
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/access/sod-rules

Create a sod rule

Permission
iam.sod:manage
Request body
SoDInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

GET /api/v1/access/sod-rules/{id}

Get one sod rule

Permission
iam.sod:read
Path parameters
id
Response
200: SoDView
Errors
401: unauthorized; 403: permission_denied

PUT /api/v1/access/sod-rules/{id}

Replace one sod rule

Permission
iam.sod:manage
Path parameters
id
Request body
SoDInput
Errors
400: invalid_argument; 401: unauthorized; 403: permission_denied

DELETE /api/v1/access/sod-rules/{id}

Delete one sod rule

Permission
iam.sod:manage
Path parameters
id
Errors
401: unauthorized; 403: permission_denied

POST /api/v1/enterprise/directory-sync

Create a directory sync

Permission
directory.groups:sync
Request body
object
Response
201: object of string
Errors
401: unauthorized

GET /api/v1/enterprise/directory-sync/status

List status

Permission
api:access
Query parameters
org_id
Response
200: SyncStatus
Errors
401: unauthorized

POST /api/v1/enterprise/jit-grants

Create a jit grant

Permission
api:access
Request body
object
Response
201: PrivilegedAccessGrant
Errors
401: unauthorized

POST /api/v1/enterprise/jit-grants/{id}/approve

Approve a jit grant

Permission
access.jit:approve
Path parameters
id
Response
200: object of string
Errors
401: unauthorized

POST /api/v1/enterprise/jit-grants/{id}/revoke

Revoke a jit grant

Permission
access.jit:approve
Path parameters
id
Response
200: object of string
Errors
401: unauthorized

POST /api/v1/enterprise/jit-grants/expire

(admin / cron)

Permission
access.jit:approve
Response
200: object of integer

POST /api/v1/enterprise/service-accounts

Create a service account

Permission
directory.serviceaccounts:manage
Request body
ServiceAccount
Response
201: ServiceAccount
Errors
401: unauthorized

GET /api/v1/enterprise/service-accounts/{id}

Get one service account

Permission
directory.serviceaccounts:read
Path parameters
id
Response
200: ServiceAccount
Errors
401: unauthorized

POST /api/v1/enterprise/service-accounts/{id}/rotate

Rotate a service account

Permission
directory.serviceaccounts:manage
Path parameters
id
Response
200: object of any
Errors
401: unauthorized

POST /api/v1/enterprise/service-accounts/validate-token

Create a validate token

Permission
directory.serviceaccounts:manage
Request body
object
Response
200: object of string

GET /api/v1/permissions

List permissions

Permission
signed in
Query parameters
page_size, page_token, prefix, privileged, risk
Response
200: Page
Errors
400: invalid_argument

POST /api/v1/svc/iam/AttachGroupPolicy

Attach group policy

Permission
iam.grouppolicies:attachgrouppolicy

POST /api/v1/svc/iam/AttachUserPolicy

Attach user policy

Permission
iam.userpolicies:attachuserpolicy

POST /api/v1/svc/iam/CreatePolicy

Create policy

Permission
iam.roles:create
Request body
object

POST /api/v1/svc/iam/CreatePolicyVersion

Create policy version

Permission
iam.roles:update
Request body
object

POST /api/v1/svc/iam/DeletePolicy

Delete policy

Permission
iam.roles:delete
Request body
object

POST /api/v1/svc/iam/DeletePolicyVersion

Delete policy version

Permission
iam.policyversions:deletepolicyversion
Request body
object

POST /api/v1/svc/iam/DeleteUserPermissionsBoundary

Delete user permissions boundary

Permission
iam.boundaries:deleteuserpermissionsboundary
Request body
object

POST /api/v1/svc/iam/DetachGroupPolicy

Detach group policy

Permission
iam.grouppolicies:detachgrouppolicy

POST /api/v1/svc/iam/DetachUserPolicy

Detach user policy

Permission
iam.userpolicies:detachuserpolicy

POST /api/v1/svc/iam/GetPolicy

Get policy

Permission
iam.roles:read
Request body
object

POST /api/v1/svc/iam/GetPolicyVersion

Get policy version

Permission
iam.policyversions:getpolicyversion
Request body
object

POST /api/v1/svc/iam/GetUserPermissionsBoundary

Get user permissions boundary

Permission
iam.boundaries:getuserpermissionsboundary
Request body
object

POST /api/v1/svc/iam/ListActions

List actions

Permission
signed in
Request body
object

POST /api/v1/svc/iam/ListAttachedGroupPolicies

List attached group policies

Permission
iam.grouppolicies:listattachedgrouppolicies

POST /api/v1/svc/iam/ListAttachedUserPolicies

List attached user policies

Permission
iam.userpolicies:listattacheduserpolicies

POST /api/v1/svc/iam/ListEntitiesForPolicy

List entities for policy

Permission
iam.policies:listentitiesforpolicy
Request body
object

POST /api/v1/svc/iam/ListPolicies

List policies

Permission
iam.policies:listpolicies
Request body
object

POST /api/v1/svc/iam/ListPolicyVersions

List policy versions

Permission
iam.policyversions:listpolicyversions
Request body
object

POST /api/v1/svc/iam/PutUserPermissionsBoundary

Put user permissions boundary

Permission
iam.boundaries:putuserpermissionsboundary
Request body
object

POST /api/v1/svc/iam/SetDefaultPolicyVersion

Set default policy version

Permission
iam.policyversions:setdefaultpolicyversion
Request body
object

POST /api/v1/svc/iam/SimulateCustomPolicy

Simulate custom policy

Permission
iam.simulator:simulatecustompolicy
Request body
simulateBody

POST /api/v1/svc/iam/SimulatePrincipalPolicy

Simulate principal policy

Permission
iam.simulator:simulateprincipalpolicy
Request body
simulateBody

POST /api/v1/svc/iam/ValidatePolicy

Validate policy

Permission
iam.policyvalidation:validatepolicy
Request body
object

Objects

object

FieldTypeDescription
reasonstring

object

FieldTypeDescription
checksarray of CheckInput

object

FieldTypeDescription
org_idstring
providerstring
addedinteger
updatedinteger
removedinteger
error optionalstring

object

FieldTypeDescription
org_idstring
user_idstring
resourcestring
duration_minsinteger
justificationstring

object

FieldTypeDescription
tokenstring

object

FieldTypeDescription
PolicyNamestring
Pathstring
Descriptionstring
PolicyDocumentstring

object

FieldTypeDescription
PolicyArnstring
PolicyDocumentstring
SetAsDefaultboolean

object

FieldTypeDescription
PolicyArnstring

object

FieldTypeDescription
PolicyArnstring
VersionIdstring

object

FieldTypeDescription
UserNamestring

object

FieldTypeDescription
PolicyArnstring

object

FieldTypeDescription
PolicyArnstring
VersionIdstring

object

FieldTypeDescription
UserNamestring

object

FieldTypeDescription
Servicestring

object

FieldTypeDescription
PolicyArnstring

object

FieldTypeDescription
Scopestring
PathPrefixstring
Markerstring
OnlyAttachedboolean
MaxItemsinteger

object

FieldTypeDescription
PolicyArnstring

object

FieldTypeDescription
UserNamestring
PermissionsBoundarystring

object

FieldTypeDescription
PolicyArnstring
VersionIdstring

object

FieldTypeDescription
PolicyDocumentstring
PolicyTypestring

object

FieldTypeDescription
enforced optionalboolean
confirm_no_rulesboolean

object

FieldTypeDescription
zonesarray of ZoneInput

object

FieldTypeDescription
role_idsarray of string

ConditionStep

The evaluation of one condition of an IAM policy statement, with the request's value for its key.

FieldTypeDescription
operatorstring
keystring
valuesarray of string
context optionalarray of string
missing optionalboolean
resultstring
error optionalstring

Decision

The result of a check.

FieldTypeDescription
allowedboolean
decided_bystringDecidedBy names the step that decided.
revisionstringThe organization's access revision the decision was computed at.
step_up optionalStepUpRequirementSet when a deny policy asks for re-verification.

Explanation

A decision with the chain of objects that produced it.

FieldTypeDescription
allowedboolean
decided_bystringDecidedBy names the step that decided.
revisionstringThe organization's access revision the decision was computed at.
step_up optionalStepUpRequirementSet when a deny policy asks for re-verification.
permissionstring
nodeNodeRef
resource optionalResourceRefSet for a check on one object; Node is then its owner node.
principalPrincipalRef
stepsarray of Step
action optionalstringThe permission's IAM action; ResourceNRN the NRN the check's IAM policy statements were matched against ("*" for an action without resource types).
resource_nrn optionalstring
missing_context_keys optionalarray of stringThe condition keys an evaluated IAM policy statement read that the request did not have.
mac optionalMACOutcomeHow mandatory access control decided (step 4.5).

MACLabel

A classification label as an explanation and the API show it.

FieldTypeDescription
classificationstring
compartmentsarray of string

MACOutcome

How MAC decided a check. It is always set by the engine; the labels are filled in explanations only.

FieldTypeDescription
evaluatedbooleanSet when the MAC step ran.
rule optionalstringRule names the rule that applied (MACRule*).
relaxed optionalbooleanSet for a write allowed only by the organization's own-level rule.
bypass optionalstringSet when a super admin passed MAC on platform metadata, with the reason.
resource optionalMACLabelThe effective label of the checked node; Clearances the principal's.
clearances optionalarray of MACLabel

NodeRef

NodeRef identifies a node in explanations.

FieldTypeDescription
idstring
kindstring
pathstring

PrincipalRef

PrincipalRef identifies a principal in explanations and API payloads.

FieldTypeDescription
typestring
idstring

ResourceRef

ResourceRef identifies a shared object in explanations and API payloads.

FieldTypeDescription
typestring
idstring

Step

One entry in an explanation.

FieldTypeDescription
kindstring
id optionalstring
node_id optionalstring
inherited_from optionalstringSet when the step's object is on an ancestor of the checked node.
role optionalstring
via optionalPrincipalRef
resource optionalResourceRefSet on a step of a resource binding.
effectstring
reason optionalstring
policy_nrn optionalstringThe statement of an IAM policy step.
policy_type optionalstring
version_id optionalstring
sid optionalstring
statement optionalinteger
attached_to optionalPrincipalRef
conditions optionalarray of ConditionStep

StepUpRequirement

What a deny-with-step-up asks: a factor of at least Strength proved within MaxAgeSeconds.

FieldTypeDescription
strengthstring
max_age_secondsinteger

PrivilegedAccessGrant

PrivilegedAccessGrant represents a JIT escalation request.

FieldTypeDescription
idstring
org_idstring
user_idstring
resourcestring
duration_minsinteger
justificationstring
statusstringPending | approved | active | expired | revoked
granted_by optionalstring
expires_at optionaltimestamp
created_attimestamp

ServiceAccount

An M2M identity principal with rotating cryptographic tokens.

FieldTypeDescription
idstring
org_idstring
namestring
descriptionstring
token_ttl_secsinteger
rotate_everyintegerHours; 0 = manual
statusstringActive | suspended | revoked
created_attimestamp

SyncStatus

SyncStatus records the outcome of the most recent directory synchronisation.

FieldTypeDescription
org_idstring
providerstring
addedinteger
updatedinteger
removedinteger
sync_error optionalstring
synced_attimestamp

simulateBody

FieldTypeDescription
PolicySourceArn optionalstring
PolicyInputList optionalarray of string
PermissionsBoundaryPolicyInputList optionalarray of string
ActionNames optionalarray of string
ResourceArns optionalarray of string
ContextEntries optionalarray of ContextEntry
ResourceNodeId optionalstring
CallerArn optionalstring
ResourcePolicy optionalstring
ResourceOwner optionalstring
MaxItems optionalinteger
Marker optionalstring

Compartment

One compartment (a category or caveat).

FieldTypeDescription
keystring
namestring
descriptionstring
base_compartment optionalstringThe ID of the Base compartment this compartment maps to, carried to Base's Key Service with a person's clearances: a lease for it needs a clearance holding this compartment. It grants nothing in Base: a lease still needs Base's own compartment grant.

ContextLabel

The label a Context classification (public, internal, confidential, restricted) maps to.

FieldTypeDescription
classificationstring
compartmentsarray of string

Level

One classification level.

FieldTypeDescription
keystring
namestring
descriptionstring
base_compartment optionalstringThe ID of the Base compartment this level governs: a lease for it needs a clearance at this level or above, joined with the compartment that maps to the same Base compartment, if any. It grants nothing in Base.

ActivationInput

ActivationInput requests the activation of an eligible binding.

FieldTypeDescription
binding_idstring
justificationstring
minutesinteger
mfa_codestringA fresh TOTP code of the requester.

ActivationView

An activation with its etag. Reads (get and list) also name its role and node, so a reader need not look them up.

FieldTypeDescription
idstring
org_idstring
binding_id optionalstring
node_idstring
role_idstring
user_idstring
kindstring
statestring
justificationstring
requested_minutesinteger
mfa_verified_attimestamp
approval_request_id optionalstring
approved_by optionalstring
requested_attimestamp
decided_at optionaltimestamp
starts_at optionaltimestamp
expires_at optionaltimestamp
ended_at optionaltimestamp
ended_by optionalstring
end_reason optionalstring
review_statestring
reviewed_by optionalstring
reviewed_at optionaltimestamp
review_outcome optionalstring
review_notes optionalstring
etagstring
role_name optionalstring
node_path optionalstring

BindingInput

A binding as the API accepts it.

FieldTypeDescription
node_idstring
principal_typestring
principal_idstring
role_idstring
statestring
conditionstring
condition_titlestring
expires_at optionaltimestamp
requires_approvalboolean
max_activation_minutes optionalinteger
break_glassboolean
membership_boundboolean
descriptionstring

BindingUpdate

BindingUpdate holds the mutable fields of a binding.

FieldTypeDescription
statestring
conditionstring
condition_titlestring
expires_at optionaltimestamp
requires_approvalboolean
max_activation_minutes optionalinteger
break_glassboolean
membership_boundboolean
descriptionstring

BindingView

A binding with its etag.

FieldTypeDescription
idstring
org_idstring
node_idstring
principal_typestring
principal_idstring
role_idstring
statestring
condition optionalstring
condition_title optionalstring
expires_at optionaltimestamp
requires_approvalboolean
max_activation_minutes optionalinteger
break_glassboolean
membership_boundboolean
descriptionstring
sourcestring
resource_type optionalstringResourceType and ResourceID are set on a resource binding: a resource role on one object owned by NodeID.
resource_id optionalstring
managed_key optionalstringManagedKey names the system that manages a binding of source sso_mapping ("sso:<instance id>"); it is read by the managed binding queries only (Managed tells a managed binding by its source everywhere).
created_by optionalstring
created_attimestamp
updated_by optionalstring
updated_attimestamp
etagstring

CampaignInput

CampaignInput opens a campaign without a schedule.

FieldTypeDescription
namestring
node_idstring
role_idstring
include_subtree optionalboolean
duration_daysinteger
reviewersarray of PolicyPrincipal
auto_revokeboolean

CampaignView

A campaign with its progress.

FieldTypeDescription
idstring
org_idstring
schedule_id optionalstring
namestring
node_idstring
node_pathstring
role_id optionalstring
include_subtreeboolean
reviewersarray of PolicyPrincipal
auto_revokeboolean
statestring
starts_attimestamp
due_attimestamp
closed_at optionaltimestamp
closed_by optionalstring
created_by optionalstring
pending_itemsinteger

Capabilities

Capabilities says which verbs a principal holds on a target.

FieldTypeDescription
useboolean
readboolean
writeboolean
manageboolean

CeilingInput

A ceiling as the API accepts it.

FieldTypeDescription
node_idstring
namestring
descriptionstring
allowed_permissionsarray of string

CeilingView

A ceiling with its etag.

FieldTypeDescription
idstring
org_idstring
node_idstring
namestring
descriptionstring
allowed_permissionsarray of string
created_attimestamp
updated_attimestamp
etagstring

CheckInput

One access question.

FieldTypeDescription
principal optionalTarget
permissionstring
node_idstring

ClearanceInput

A clearance as the API accepts it.

FieldTypeDescription
principal_typestring
principal_idstring
classificationstring
compartmentsarray of string
reasonstring
expires_at optionaltimestamp

ClearanceView

A clearance with its etag.

FieldTypeDescription
idstring
org_idstring
principal_typestring
principal_idstring
classificationstring
compartmentsarray of string
reasonstring
expires_at optionaltimestamp
created_by optionalstring
created_attimestamp
updated_attimestamp
etagstring

ContextEntry

A condition key value of a simulation.

FieldTypeDescription
ContextKeyNamestring
ContextKeyValuesarray of string
ContextKeyTypestring

DecisionInput

A reviewer's decision on an item.

FieldTypeDescription
decisionstring
justificationstring

DeclassifyInput

A declassification request as the API accepts it: the node's own label after it is lowered (an empty classification and no compartments remove the node's own labels, so it inherits again).

FieldTypeDescription
node_idstring
resource_type optionalstringResourceType and ResourceID name a labelled object instead: its own label is lowered; NodeID is then the object's owner node and may be left empty.
resource_id optionalstring
classificationstring
compartmentsarray of string
reasonstring

DelegationView

A node's effective delegation allow-list.

FieldTypeDescription
node_idstring
setbooleanTrue when the list is set on this node, false when it is inherited or absent (every role may be bound).
inherited_from optionalstring
role_idsarray of string
all_rolesbooleanTrue when no list applies.
etag optionalstring

DenyInput

A deny policy as the API accepts it.

FieldTypeDescription
node_idstring
namestring
descriptionstring
denied_principalsarray of PolicyPrincipal
exception_principalsarray of PolicyPrincipal
denied_permissionsarray of string
exception_permissionsarray of string
conditionstring
condition_titlestring
step_up optionalStepUpStepUp makes the policy ask for re-verification instead of refusing: it applies (its condition true or in error) until the session proved a factor of the strength within the maximum age, and is answered 401 step_up_required.

DenyView

A deny policy with its etag.

FieldTypeDescription
idstring
org_idstring
node_idstring
namestring
descriptionstring
denied_principalsarray of PolicyPrincipal
exception_principalsarray of PolicyPrincipal
denied_permissionsarray of string
exception_permissionsarray of string
condition optionalstring
condition_title optionalstring
step_up optionalStepUpStepUp makes the policy ask for re-verification instead of refusing.
created_attimestamp
updated_attimestamp
etagstring

Effective

A principal's effective permissions on a node.

FieldTypeDescription
principalPrincipalRef
nodeNodeRef
revisionstring
permissionsarray of string
explanations optionalarray of ExplanationExplanations, when requested, cover every granted permission and every permission a binding would grant but a deny policy, ceiling, separation-of-duties rule or disabled state blocks.

EffectiveAccess

What the caller may do with a target, computed by access control: the console renders it and never derives rights itself.

FieldTypeDescription
resourceResourceView
levelstringThe highest level the caller holds: none, user, viewer, editor or manager; LevelLabel names it.
level_labelstring
canCapabilities
can_requestbooleanSet when the caller may ask for more access, and RequestableLevels lists what they may ask for.
requestable_levelsarray of LevelOption
pending_request optionalRequestViewThe caller's open request on the target.

Evidence

The exportable report of a campaign.

FieldTypeDescription
campaignCampaign
generated_attimestamp
generated_bystring
totalsobject of integer
itemsarray of ReviewItem

GrantInput

GrantInput grants a level on a target.

FieldTypeDescription
principal_typestring
principal_idstring
email optionalstringEmail names a user of the organization instead of PrincipalID (a Manager need not be able to list the organization's people).
levelstringUser, viewer, editor or manager.

GrantPath

A binding through which a group holds access.

FieldTypeDescription
binding_idstring
rolestring
node_idstring
resourcebooleanSet for a share on the object itself.

HostRuleInput

A host rule as the API accepts it.

FieldTypeDescription
node_idstring
namestring
descriptionstring
principalsarray of PolicyPrincipal
accessarray of string
host_kindsarray of string
host_idsarray of string
conditionstring

HostRuleView

A host rule with its etag.

FieldTypeDescription
idstring
org_idstring
node_idstring
namestring
descriptionstring
principalsarray of PolicyPrincipal
accessarray of string
host_kindsarray of string
host_idsarray of string
condition optionalstring
created_attimestamp
updated_attimestamp
etagstring

HostSettingsView

The host access settings with their etag and the number of host access rules the organization has (enforcing with none refuses every session).

FieldTypeDescription
enforcedboolean
updated_attimestamp
etagstring
rule_countinteger

InvitationView

The invitation a pending share waits for.

FieldTypeDescription
idstring
emailstring
expires_attimestamp
createdbooleanSet when this call made the invitation; otherwise the person already had a pending invitation and the share waits for it.

InviteShareInput

InviteShareInput invites a person into the account and shares a target with them.

FieldTypeDescription
emailstring
display_name optionalstringThe invitee's name on the invitation (optional).
levelstringUser, viewer, editor or manager.

InviteShareResult

FieldTypeDescription
pending_sharePendingShareView
invitationInvitationView
invitation_token optionalstringThe one-time token of a new invitation, for the inviter to pass on (as the People invitation returns it). It is absent when the invitation already existed.

LevelOption

A level a client may offer, with its label and meaning.

FieldTypeDescription
levelstring
labelstring
descriptionstring

MineInput

A question about the caller's own access (Brief H item 2): it names no principal, so it can only ever be about the caller. An empty NodeID is the caller's organization node.

FieldTypeDescription
permissionstring
node_idstring

NetworkZonesView

The organization's zones with the etag of the set (PUT replaces the set at that etag).

FieldTypeDescription
zonesarray of NetworkZone
etagstring

NodeClassification

A node's classification: its own labels, the label it inherits from its ancestors, and the effective one.

FieldTypeDescription
node_idstring
own optionalMACLabel
inheritedMACLabel
effectiveMACLabel
pending optionalDeclassificationThe node's open declassification request, if any.

ObjectClassification

An object's classification: its own label, the label its owner node gives it and the effective one.

FieldTypeDescription
resource_typestring
resource_idstring
node_idstring
own optionalMACLabel
inheritedMACLabel
effectiveMACLabel
source optionalstringSource and Reason are the own label's (person or dlp).
reason optionalstring
updated_at optionaltimestamp
etagstring
pending optionalDeclassificationThe object's open declassification request, if any.

ObjectLabelInput

An object's own label as the API accepts it.

FieldTypeDescription
classificationstring
compartmentsarray of string
reasonstring

Page

A page of a listing.

FieldTypeDescription
itemsarray of any
next_page_token optionalstring

PendingShareView

A pending share as the API returns it.

FieldTypeDescription
idstring
emailstring
invitation_idstring
levelstring
level_labelstring
statusstringAlways "invited": the share applies when the invitation is accepted.
invited_bystring
created_attimestamp
expires_attimestampWhen the invitation, and the share with it, lapses.
revocablebooleanSet when the caller may revoke it here (a Manager).

PresetInput

PresetInput asks for a preset deny policy on a node.

FieldTypeDescription
presetstring
node_idstring
classificationstringThe lowest level PresetCompliantDeviceForClassified covers (default SECRET).

PrincipalInfo

PrincipalInfo names the principal an answer is about.

FieldTypeDescription
typestring
idstring
display_namestring
email optionalstring

PrincipalResource

One object a principal holds access on.

FieldTypeDescription
typestring
idstring
namestring
node_idstring
levelstringThe highest resource role level held: user, viewer, editor or manager, and LevelLabel its label as the sharing panel shows it.
level_labelstring
via optionalarray of GrantPathVia lists, for a group, the bindings that give the level.

PrincipalResources

FieldTypeDescription
principalPrincipalInfo
basisstring"effective" for a user or service account (every grant path, deny policies and ceilings applied, exactly as checks decide), and "group_grants" for a group: what the group's own bindings give its members, before the deny policies that apply to each member.
resourcesarray of PrincipalResource

RequestInput

RequestInput asks for a level on a target.

FieldTypeDescription
levelstring
reasonstring

RequestView

An access request as the API returns it: the level asked for, its label, and whether the caller may decide it.

FieldTypeDescription
idstring
org_idstring
requester_idstring
resource_typestring
resource_idstring
node_idstring
requested_rolestring
reasonstring
statusstring
reviewed_by optionalstring
review_reason optionalstring
binding_id optionalstring
created_attimestamp
reviewed_at optionaltimestamp
levelstring
level_labelstring
can_decidebooleanSet when the caller may approve or deny the request: a Manager of the object who is not its requester.
can_withdrawbooleanSet on the caller's own open request.

ResourceView

ResourceView identifies a target in responses. NodeID is left out for a caller with no access, so the answer is the same whether or not the object exists.

FieldTypeDescription
typestring
idstring
node_id optionalstring

ReviewInput

The post-use review of a break-glass activation.

FieldTypeDescription
outcomestring
notesstring

RoleInput

A custom role definition.

FieldTypeDescription
namestring
descriptionstring
permissionsarray of string
compositesarray of string

RoleView

A role with its etag and whether it is privileged or grants roles.

FieldTypeDescription
idstring
org_id optionalstringEmpty for built-in roles.
builtin_key optionalstring
account_role optionalstringOwner, admin or member for the organization's account roles of those names, and empty otherwise.
namestring
descriptionstring
permissionsarray of string
compositesarray of string
versioninteger
created_attimestamp
updated_attimestamp
etagstring
privilegedboolean
grants_rolesboolean
scope optionalstringSet when the role was listed by scope (account or resource).
owner_reservedbooleanOwnerReserved reports whether the role holds the Owner-reserved actions: the account's Owner role only.
holders optionalarray of RoleHolderHolders are, for an account role listed by scope, the principals bound to it on the organization node, when the caller may read bindings there.
holders_shown optionalboolean

ScheduleInput

A schedule as the API accepts it.

FieldTypeDescription
namestring
node_idstring
role_idstring
include_subtree optionalboolean
frequency_daysinteger
duration_daysinteger
reviewersarray of PolicyPrincipal
auto_revokeboolean
enabled optionalboolean
first_run_at optionaltimestampWhen the first campaign opens; now when absent.

ScheduleView

A schedule with its etag.

FieldTypeDescription
idstring
org_idstring
namestring
node_idstring
role_id optionalstring
include_subtreeboolean
frequency_daysinteger
duration_daysinteger
reviewersarray of PolicyPrincipal
auto_revokeboolean
enabledboolean
next_run_attimestamp
created_attimestamp
updated_attimestamp
etagstring

SchemeInput

The writable part of the scheme.

FieldTypeDescription
levelsarray of Level
compartmentsarray of Compartment
write_rulestring
context_mapobject of ContextLabelContextMap maps Context classifications to labels.

SchemeView

The classification scheme with its etag.

FieldTypeDescription
org_idstring
levelsarray of Level
compartmentsarray of Compartment
write_rulestring
context_mapobject of ContextLabelContextMap maps Context classifications to labels.
labelled_at optionaltimestampWhen the first classification label or clearance was written; from then on the order of the levels is fixed.
defaultbooleanSet when the organization never set a scheme.
updated_attimestamp
etagstring

SettingsInput

The writable part of the settings.

FieldTypeDescription
inactivity_disable_days optionalinteger
jit_max_minutesinteger
break_glass_max_minutesinteger
approval_timeout_minutesinteger
delegation_defaultstring"closed" (the default when empty) or "open".
invitation_email_domains optionalarray of stringInvitationEmailDomains replaces the invitation email domains (lower-case domain names, at most 50; empty allows any domain). Left out, they are kept.

SettingsView

The organization's settings with their etag.

FieldTypeDescription
org_idstring
inactivity_disable_days optionalintegerInactivityDisableDays disables users with no session activity in the organization for this many days; nil turns it off.
jit_max_minutesinteger
break_glass_max_minutesinteger
approval_timeout_minutesinteger
delegation_defaultstringDelegationDefault applies where no delegation allow-list covers a node: DelegationClosed lets only organization-level granters bind roles there, DelegationOpen lets every granter.
invitation_email_domainsarray of stringThe email domains the organization invites people from; empty allows any.
updated_attimestamp
etagstring

ShareEntry

One principal's access to a target.

FieldTypeDescription
binding_id optionalstringSet for a binding; a project membership has none.
principalPrincipalName
role_id optionalstring
role_namestring
levelstring
level_labelstringLevelLabel names Level.
sourcestringShare, access_request, api, role_assignment, project_role, hierarchy_role or membership.
inherited_from optionalstringThe node the access comes from when it is not granted on the target itself.
expires_at optionaltimestamp
revocablebooleanSet when the caller may revoke the entry here.

Sharing

Who has access to a target.

FieldTypeDescription
resourceResourceView
can_managebooleanSet when the caller may grant and revoke.
entriesarray of ShareEntry
pending_requestsarray of RequestView
levelsarray of LevelOptionThe levels the caller may grant, with their labels.
pending_sharesarray of PendingShareViewShares waiting for an account invitation to be accepted, shown as "Invited".
can_invitebooleanSet when the caller may invite someone who is not in the account and share with them (a Manager who may also invite people, on an object that is not a project).

SoDInput

A rule as the API accepts it.

FieldTypeDescription
node_idstring
namestring
descriptionstring
role_idsarray of string

SoDView

A rule with its etag.

FieldTypeDescription
idstring
org_idstring
node_idstring
namestring
descriptionstring
role_idsarray of string
created_attimestamp
updated_attimestamp
etagstring

Target

Target names the principal a question is about; empty means the caller.

FieldTypeDescription
typestring
idstring

ZoneInput

A zone as the API accepts it.

FieldTypeDescription
namestring
descriptionstring
cidrsarray of string

Campaign

One access review.

FieldTypeDescription
idstring
org_idstring
schedule_id optionalstring
namestring
node_idstring
node_pathstring
role_id optionalstring
include_subtreeboolean
reviewersarray of PolicyPrincipal
auto_revokeboolean
statestring
starts_attimestamp
due_attimestamp
closed_at optionaltimestamp
closed_by optionalstring
created_by optionalstring

Declassification

A request to lower a node's own classification label.

FieldTypeDescription
idstring
org_idstring
node_idstring
resource_type optionalstringResourceType and ResourceID name the labelled object whose own label is lowered; both are empty for the node's own label.
resource_id optionalstring
from_classificationstring
from_compartmentsarray of string
to_classificationstring
to_compartmentsarray of string
reasonstring
requested_bystring
approval_request_id optionalstring
statusstring
decided_by optionalstring
decided_at optionaltimestamp
applied_by optionalstring
applied_at optionaltimestamp
expires_attimestamp
created_attimestamp

NetworkZone

A named set of CIDR prefixes of an organization: network.zone of a request is the zone that contains its address.

FieldTypeDescription
namestring
descriptionstring
cidrsarray of string
updated_attimestamp

PolicyPrincipal

A principal of a deny policy: a user, group or service account, or every principal (Type "all").

FieldTypeDescription
typestring
id optionalstring

PrincipalName

What is shown for a principal.

FieldTypeDescription
typestring
idstring
display_name optionalstring
email optionalstring

ReviewItem

One binding under review.

FieldTypeDescription
idstring
org_idstring
campaign_idstring
binding_idstring
node_idstring
node_pathstring
role_idstring
role_namestring
role_versioninteger
principal_typestring
principal_idstring
bindingJSON
decision optionalstring
justification optionalstring
decided_by optionalstring
decided_at optionaltimestamp
outcomestring
audit_record_id optionalinteger

RoleHolder

A principal bound to a role on a node, with the name the Access pages show for it.

FieldTypeDescription
binding_idstring
role_idstring
principal_typestring
principal_idstring
display_namestring
email optionalstring
statestring
conditionalboolean
expires_at optionaltimestamp

StepUp

The step-up requirement of a deny policy.

FieldTypeDescription
strengthstring
max_age_secondsinteger

This page is generated from the server's route table and the Go handlers that serve each route. Do not edit it by hand.