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
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
| Field | Type | Description |
|---|---|---|
reason | string |
object
| Field | Type | Description |
|---|---|---|
checks | array of CheckInput |
object
| Field | Type | Description |
|---|---|---|
org_id | string | |
provider | string | |
added | integer | |
updated | integer | |
removed | integer | |
error optional | string |
object
| Field | Type | Description |
|---|---|---|
org_id | string | |
user_id | string | |
resource | string | |
duration_mins | integer | |
justification | string |
object
| Field | Type | Description |
|---|---|---|
token | string |
object
| Field | Type | Description |
|---|---|---|
PolicyName | string | |
Path | string | |
Description | string | |
PolicyDocument | string |
object
| Field | Type | Description |
|---|---|---|
PolicyArn | string | |
PolicyDocument | string | |
SetAsDefault | boolean |
object
| Field | Type | Description |
|---|---|---|
PolicyArn | string |
object
| Field | Type | Description |
|---|---|---|
PolicyArn | string | |
VersionId | string |
object
| Field | Type | Description |
|---|---|---|
UserName | string |
object
| Field | Type | Description |
|---|---|---|
PolicyArn | string |
object
| Field | Type | Description |
|---|---|---|
PolicyArn | string | |
VersionId | string |
object
| Field | Type | Description |
|---|---|---|
UserName | string |
object
| Field | Type | Description |
|---|---|---|
Service | string |
object
| Field | Type | Description |
|---|---|---|
PolicyArn | string |
object
| Field | Type | Description |
|---|---|---|
Scope | string | |
PathPrefix | string | |
Marker | string | |
OnlyAttached | boolean | |
MaxItems | integer |
object
| Field | Type | Description |
|---|---|---|
PolicyArn | string |
object
| Field | Type | Description |
|---|---|---|
UserName | string | |
PermissionsBoundary | string |
object
| Field | Type | Description |
|---|---|---|
PolicyArn | string | |
VersionId | string |
object
| Field | Type | Description |
|---|---|---|
PolicyDocument | string | |
PolicyType | string |
object
| Field | Type | Description |
|---|---|---|
enforced optional | boolean | |
confirm_no_rules | boolean |
object
| Field | Type | Description |
|---|---|---|
zones | array of ZoneInput |
object
| Field | Type | Description |
|---|---|---|
role_ids | array of string |
ConditionStep
The evaluation of one condition of an IAM policy statement, with the request's value for its key.
| Field | Type | Description |
|---|---|---|
operator | string | |
key | string | |
values | array of string | |
context optional | array of string | |
missing optional | boolean | |
result | string | |
error optional | string |
Decision
The result of a check.
| Field | Type | Description |
|---|---|---|
allowed | boolean | |
decided_by | string | DecidedBy names the step that decided. |
revision | string | The organization's access revision the decision was computed at. |
step_up optional | StepUpRequirement | Set when a deny policy asks for re-verification. |
Explanation
A decision with the chain of objects that produced it.
| Field | Type | Description |
|---|---|---|
allowed | boolean | |
decided_by | string | DecidedBy names the step that decided. |
revision | string | The organization's access revision the decision was computed at. |
step_up optional | StepUpRequirement | Set when a deny policy asks for re-verification. |
permission | string | |
node | NodeRef | |
resource optional | ResourceRef | Set for a check on one object; Node is then its owner node. |
principal | PrincipalRef | |
steps | array of Step | |
action optional | string | The permission's IAM action; ResourceNRN the NRN the check's IAM policy statements were matched against ("*" for an action without resource types). |
resource_nrn optional | string | |
missing_context_keys optional | array of string | The condition keys an evaluated IAM policy statement read that the request did not have. |
mac optional | MACOutcome | How mandatory access control decided (step 4.5). |
MACLabel
A classification label as an explanation and the API show it.
| Field | Type | Description |
|---|---|---|
classification | string | |
compartments | array of string |
MACOutcome
How MAC decided a check. It is always set by the engine; the labels are filled in explanations only.
| Field | Type | Description |
|---|---|---|
evaluated | boolean | Set when the MAC step ran. |
rule optional | string | Rule names the rule that applied (MACRule*). |
relaxed optional | boolean | Set for a write allowed only by the organization's own-level rule. |
bypass optional | string | Set when a super admin passed MAC on platform metadata, with the reason. |
resource optional | MACLabel | The effective label of the checked node; Clearances the principal's. |
clearances optional | array of MACLabel |
NodeRef
NodeRef identifies a node in explanations.
| Field | Type | Description |
|---|---|---|
id | string | |
kind | string | |
path | string |
PrincipalRef
PrincipalRef identifies a principal in explanations and API payloads.
| Field | Type | Description |
|---|---|---|
type | string | |
id | string |
ResourceRef
ResourceRef identifies a shared object in explanations and API payloads.
| Field | Type | Description |
|---|---|---|
type | string | |
id | string |
Step
One entry in an explanation.
| Field | Type | Description |
|---|---|---|
kind | string | |
id optional | string | |
node_id optional | string | |
inherited_from optional | string | Set when the step's object is on an ancestor of the checked node. |
role optional | string | |
via optional | PrincipalRef | |
resource optional | ResourceRef | Set on a step of a resource binding. |
effect | string | |
reason optional | string | |
policy_nrn optional | string | The statement of an IAM policy step. |
policy_type optional | string | |
version_id optional | string | |
sid optional | string | |
statement optional | integer | |
attached_to optional | PrincipalRef | |
conditions optional | array of ConditionStep |
StepUpRequirement
What a deny-with-step-up asks: a factor of at least Strength proved within MaxAgeSeconds.
| Field | Type | Description |
|---|---|---|
strength | string | |
max_age_seconds | integer |
PrivilegedAccessGrant
PrivilegedAccessGrant represents a JIT escalation request.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
user_id | string | |
resource | string | |
duration_mins | integer | |
justification | string | |
status | string | Pending | approved | active | expired | revoked |
granted_by optional | string | |
expires_at optional | timestamp | |
created_at | timestamp |
ServiceAccount
An M2M identity principal with rotating cryptographic tokens.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
name | string | |
description | string | |
token_ttl_secs | integer | |
rotate_every | integer | Hours; 0 = manual |
status | string | Active | suspended | revoked |
created_at | timestamp |
SyncStatus
SyncStatus records the outcome of the most recent directory synchronisation.
| Field | Type | Description |
|---|---|---|
org_id | string | |
provider | string | |
added | integer | |
updated | integer | |
removed | integer | |
sync_error optional | string | |
synced_at | timestamp |
simulateBody
| Field | Type | Description |
|---|---|---|
PolicySourceArn optional | string | |
PolicyInputList optional | array of string | |
PermissionsBoundaryPolicyInputList optional | array of string | |
ActionNames optional | array of string | |
ResourceArns optional | array of string | |
ContextEntries optional | array of ContextEntry | |
ResourceNodeId optional | string | |
CallerArn optional | string | |
ResourcePolicy optional | string | |
ResourceOwner optional | string | |
MaxItems optional | integer | |
Marker optional | string |
Compartment
One compartment (a category or caveat).
| Field | Type | Description |
|---|---|---|
key | string | |
name | string | |
description | string | |
base_compartment optional | string | The 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.
| Field | Type | Description |
|---|---|---|
classification | string | |
compartments | array of string |
Level
One classification level.
| Field | Type | Description |
|---|---|---|
key | string | |
name | string | |
description | string | |
base_compartment optional | string | The 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.
| Field | Type | Description |
|---|---|---|
binding_id | string | |
justification | string | |
minutes | integer | |
mfa_code | string | A 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.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
binding_id optional | string | |
node_id | string | |
role_id | string | |
user_id | string | |
kind | string | |
state | string | |
justification | string | |
requested_minutes | integer | |
mfa_verified_at | timestamp | |
approval_request_id optional | string | |
approved_by optional | string | |
requested_at | timestamp | |
decided_at optional | timestamp | |
starts_at optional | timestamp | |
expires_at optional | timestamp | |
ended_at optional | timestamp | |
ended_by optional | string | |
end_reason optional | string | |
review_state | string | |
reviewed_by optional | string | |
reviewed_at optional | timestamp | |
review_outcome optional | string | |
review_notes optional | string | |
etag | string | |
role_name optional | string | |
node_path optional | string |
BindingInput
A binding as the API accepts it.
| Field | Type | Description |
|---|---|---|
node_id | string | |
principal_type | string | |
principal_id | string | |
role_id | string | |
state | string | |
condition | string | |
condition_title | string | |
expires_at optional | timestamp | |
requires_approval | boolean | |
max_activation_minutes optional | integer | |
break_glass | boolean | |
membership_bound | boolean | |
description | string |
BindingUpdate
BindingUpdate holds the mutable fields of a binding.
| Field | Type | Description |
|---|---|---|
state | string | |
condition | string | |
condition_title | string | |
expires_at optional | timestamp | |
requires_approval | boolean | |
max_activation_minutes optional | integer | |
break_glass | boolean | |
membership_bound | boolean | |
description | string |
BindingView
A binding with its etag.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
node_id | string | |
principal_type | string | |
principal_id | string | |
role_id | string | |
state | string | |
condition optional | string | |
condition_title optional | string | |
expires_at optional | timestamp | |
requires_approval | boolean | |
max_activation_minutes optional | integer | |
break_glass | boolean | |
membership_bound | boolean | |
description | string | |
source | string | |
resource_type optional | string | ResourceType and ResourceID are set on a resource binding: a resource role on one object owned by NodeID. |
resource_id optional | string | |
managed_key optional | string | ManagedKey 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 optional | string | |
created_at | timestamp | |
updated_by optional | string | |
updated_at | timestamp | |
etag | string |
CampaignInput
CampaignInput opens a campaign without a schedule.
| Field | Type | Description |
|---|---|---|
name | string | |
node_id | string | |
role_id | string | |
include_subtree optional | boolean | |
duration_days | integer | |
reviewers | array of PolicyPrincipal | |
auto_revoke | boolean |
CampaignView
A campaign with its progress.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
schedule_id optional | string | |
name | string | |
node_id | string | |
node_path | string | |
role_id optional | string | |
include_subtree | boolean | |
reviewers | array of PolicyPrincipal | |
auto_revoke | boolean | |
state | string | |
starts_at | timestamp | |
due_at | timestamp | |
closed_at optional | timestamp | |
closed_by optional | string | |
created_by optional | string | |
pending_items | integer |
Capabilities
Capabilities says which verbs a principal holds on a target.
| Field | Type | Description |
|---|---|---|
use | boolean | |
read | boolean | |
write | boolean | |
manage | boolean |
CeilingInput
A ceiling as the API accepts it.
| Field | Type | Description |
|---|---|---|
node_id | string | |
name | string | |
description | string | |
allowed_permissions | array of string |
CeilingView
A ceiling with its etag.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
node_id | string | |
name | string | |
description | string | |
allowed_permissions | array of string | |
created_at | timestamp | |
updated_at | timestamp | |
etag | string |
CheckInput
One access question.
| Field | Type | Description |
|---|---|---|
principal optional | Target | |
permission | string | |
node_id | string |
ClearanceInput
A clearance as the API accepts it.
| Field | Type | Description |
|---|---|---|
principal_type | string | |
principal_id | string | |
classification | string | |
compartments | array of string | |
reason | string | |
expires_at optional | timestamp |
ClearanceView
A clearance with its etag.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
principal_type | string | |
principal_id | string | |
classification | string | |
compartments | array of string | |
reason | string | |
expires_at optional | timestamp | |
created_by optional | string | |
created_at | timestamp | |
updated_at | timestamp | |
etag | string |
ContextEntry
A condition key value of a simulation.
| Field | Type | Description |
|---|---|---|
ContextKeyName | string | |
ContextKeyValues | array of string | |
ContextKeyType | string |
DecisionInput
A reviewer's decision on an item.
| Field | Type | Description |
|---|---|---|
decision | string | |
justification | string |
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).
| Field | Type | Description |
|---|---|---|
node_id | string | |
resource_type optional | string | ResourceType 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 optional | string | |
classification | string | |
compartments | array of string | |
reason | string |
DelegationView
A node's effective delegation allow-list.
| Field | Type | Description |
|---|---|---|
node_id | string | |
set | boolean | True when the list is set on this node, false when it is inherited or absent (every role may be bound). |
inherited_from optional | string | |
role_ids | array of string | |
all_roles | boolean | True when no list applies. |
etag optional | string |
DenyInput
A deny policy as the API accepts it.
| Field | Type | Description |
|---|---|---|
node_id | string | |
name | string | |
description | string | |
denied_principals | array of PolicyPrincipal | |
exception_principals | array of PolicyPrincipal | |
denied_permissions | array of string | |
exception_permissions | array of string | |
condition | string | |
condition_title | string | |
step_up optional | StepUp | StepUp 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.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
node_id | string | |
name | string | |
description | string | |
denied_principals | array of PolicyPrincipal | |
exception_principals | array of PolicyPrincipal | |
denied_permissions | array of string | |
exception_permissions | array of string | |
condition optional | string | |
condition_title optional | string | |
step_up optional | StepUp | StepUp makes the policy ask for re-verification instead of refusing. |
created_at | timestamp | |
updated_at | timestamp | |
etag | string |
Effective
A principal's effective permissions on a node.
| Field | Type | Description |
|---|---|---|
principal | PrincipalRef | |
node | NodeRef | |
revision | string | |
permissions | array of string | |
explanations optional | array of Explanation | Explanations, 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.
| Field | Type | Description |
|---|---|---|
resource | ResourceView | |
level | string | The highest level the caller holds: none, user, viewer, editor or manager; LevelLabel names it. |
level_label | string | |
can | Capabilities | |
can_request | boolean | Set when the caller may ask for more access, and RequestableLevels lists what they may ask for. |
requestable_levels | array of LevelOption | |
pending_request optional | RequestView | The caller's open request on the target. |
Evidence
The exportable report of a campaign.
| Field | Type | Description |
|---|---|---|
campaign | Campaign | |
generated_at | timestamp | |
generated_by | string | |
totals | object of integer | |
items | array of ReviewItem |
GrantInput
GrantInput grants a level on a target.
| Field | Type | Description |
|---|---|---|
principal_type | string | |
principal_id | string | |
email optional | string | Email names a user of the organization instead of PrincipalID (a Manager need not be able to list the organization's people). |
level | string | User, viewer, editor or manager. |
GrantPath
A binding through which a group holds access.
| Field | Type | Description |
|---|---|---|
binding_id | string | |
role | string | |
node_id | string | |
resource | boolean | Set for a share on the object itself. |
HostRuleInput
A host rule as the API accepts it.
| Field | Type | Description |
|---|---|---|
node_id | string | |
name | string | |
description | string | |
principals | array of PolicyPrincipal | |
access | array of string | |
host_kinds | array of string | |
host_ids | array of string | |
condition | string |
HostRuleView
A host rule with its etag.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
node_id | string | |
name | string | |
description | string | |
principals | array of PolicyPrincipal | |
access | array of string | |
host_kinds | array of string | |
host_ids | array of string | |
condition optional | string | |
created_at | timestamp | |
updated_at | timestamp | |
etag | string |
HostSettingsView
The host access settings with their etag and the number of host access rules the organization has (enforcing with none refuses every session).
| Field | Type | Description |
|---|---|---|
enforced | boolean | |
updated_at | timestamp | |
etag | string | |
rule_count | integer |
InvitationView
The invitation a pending share waits for.
| Field | Type | Description |
|---|---|---|
id | string | |
email | string | |
expires_at | timestamp | |
created | boolean | Set 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.
| Field | Type | Description |
|---|---|---|
email | string | |
display_name optional | string | The invitee's name on the invitation (optional). |
level | string | User, viewer, editor or manager. |
InviteShareResult
| Field | Type | Description |
|---|---|---|
pending_share | PendingShareView | |
invitation | InvitationView | |
invitation_token optional | string | The 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.
| Field | Type | Description |
|---|---|---|
level | string | |
label | string | |
description | string |
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.
| Field | Type | Description |
|---|---|---|
permission | string | |
node_id | string |
NetworkZonesView
The organization's zones with the etag of the set (PUT replaces the set at that etag).
| Field | Type | Description |
|---|---|---|
zones | array of NetworkZone | |
etag | string |
NodeClassification
A node's classification: its own labels, the label it inherits from its ancestors, and the effective one.
| Field | Type | Description |
|---|---|---|
node_id | string | |
own optional | MACLabel | |
inherited | MACLabel | |
effective | MACLabel | |
pending optional | Declassification | The 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.
| Field | Type | Description |
|---|---|---|
resource_type | string | |
resource_id | string | |
node_id | string | |
own optional | MACLabel | |
inherited | MACLabel | |
effective | MACLabel | |
source optional | string | Source and Reason are the own label's (person or dlp). |
reason optional | string | |
updated_at optional | timestamp | |
etag | string | |
pending optional | Declassification | The object's open declassification request, if any. |
ObjectLabelInput
An object's own label as the API accepts it.
| Field | Type | Description |
|---|---|---|
classification | string | |
compartments | array of string | |
reason | string |
Page
A page of a listing.
| Field | Type | Description |
|---|---|---|
items | array of any | |
next_page_token optional | string |
PendingShareView
A pending share as the API returns it.
| Field | Type | Description |
|---|---|---|
id | string | |
email | string | |
invitation_id | string | |
level | string | |
level_label | string | |
status | string | Always "invited": the share applies when the invitation is accepted. |
invited_by | string | |
created_at | timestamp | |
expires_at | timestamp | When the invitation, and the share with it, lapses. |
revocable | boolean | Set when the caller may revoke it here (a Manager). |
PresetInput
PresetInput asks for a preset deny policy on a node.
| Field | Type | Description |
|---|---|---|
preset | string | |
node_id | string | |
classification | string | The lowest level PresetCompliantDeviceForClassified covers (default SECRET). |
PrincipalInfo
PrincipalInfo names the principal an answer is about.
| Field | Type | Description |
|---|---|---|
type | string | |
id | string | |
display_name | string | |
email optional | string |
PrincipalResource
One object a principal holds access on.
| Field | Type | Description |
|---|---|---|
type | string | |
id | string | |
name | string | |
node_id | string | |
level | string | The highest resource role level held: user, viewer, editor or manager, and LevelLabel its label as the sharing panel shows it. |
level_label | string | |
via optional | array of GrantPath | Via lists, for a group, the bindings that give the level. |
PrincipalResources
| Field | Type | Description |
|---|---|---|
principal | PrincipalInfo | |
basis | string | "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. |
resources | array of PrincipalResource |
RequestInput
RequestInput asks for a level on a target.
| Field | Type | Description |
|---|---|---|
level | string | |
reason | string |
RequestView
An access request as the API returns it: the level asked for, its label, and whether the caller may decide it.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
requester_id | string | |
resource_type | string | |
resource_id | string | |
node_id | string | |
requested_role | string | |
reason | string | |
status | string | |
reviewed_by optional | string | |
review_reason optional | string | |
binding_id optional | string | |
created_at | timestamp | |
reviewed_at optional | timestamp | |
level | string | |
level_label | string | |
can_decide | boolean | Set when the caller may approve or deny the request: a Manager of the object who is not its requester. |
can_withdraw | boolean | Set 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.
| Field | Type | Description |
|---|---|---|
type | string | |
id | string | |
node_id optional | string |
ReviewInput
The post-use review of a break-glass activation.
| Field | Type | Description |
|---|---|---|
outcome | string | |
notes | string |
RoleInput
A custom role definition.
| Field | Type | Description |
|---|---|---|
name | string | |
description | string | |
permissions | array of string | |
composites | array of string |
RoleView
A role with its etag and whether it is privileged or grants roles.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id optional | string | Empty for built-in roles. |
builtin_key optional | string | |
account_role optional | string | Owner, admin or member for the organization's account roles of those names, and empty otherwise. |
name | string | |
description | string | |
permissions | array of string | |
composites | array of string | |
version | integer | |
created_at | timestamp | |
updated_at | timestamp | |
etag | string | |
privileged | boolean | |
grants_roles | boolean | |
scope optional | string | Set when the role was listed by scope (account or resource). |
owner_reserved | boolean | OwnerReserved reports whether the role holds the Owner-reserved actions: the account's Owner role only. |
holders optional | array of RoleHolder | Holders 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 optional | boolean |
ScheduleInput
A schedule as the API accepts it.
| Field | Type | Description |
|---|---|---|
name | string | |
node_id | string | |
role_id | string | |
include_subtree optional | boolean | |
frequency_days | integer | |
duration_days | integer | |
reviewers | array of PolicyPrincipal | |
auto_revoke | boolean | |
enabled optional | boolean | |
first_run_at optional | timestamp | When the first campaign opens; now when absent. |
ScheduleView
A schedule with its etag.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
name | string | |
node_id | string | |
role_id optional | string | |
include_subtree | boolean | |
frequency_days | integer | |
duration_days | integer | |
reviewers | array of PolicyPrincipal | |
auto_revoke | boolean | |
enabled | boolean | |
next_run_at | timestamp | |
created_at | timestamp | |
updated_at | timestamp | |
etag | string |
SchemeInput
The writable part of the scheme.
| Field | Type | Description |
|---|---|---|
levels | array of Level | |
compartments | array of Compartment | |
write_rule | string | |
context_map | object of ContextLabel | ContextMap maps Context classifications to labels. |
SchemeView
The classification scheme with its etag.
| Field | Type | Description |
|---|---|---|
org_id | string | |
levels | array of Level | |
compartments | array of Compartment | |
write_rule | string | |
context_map | object of ContextLabel | ContextMap maps Context classifications to labels. |
labelled_at optional | timestamp | When the first classification label or clearance was written; from then on the order of the levels is fixed. |
default | boolean | Set when the organization never set a scheme. |
updated_at | timestamp | |
etag | string |
SettingsInput
The writable part of the settings.
| Field | Type | Description |
|---|---|---|
inactivity_disable_days optional | integer | |
jit_max_minutes | integer | |
break_glass_max_minutes | integer | |
approval_timeout_minutes | integer | |
delegation_default | string | "closed" (the default when empty) or "open". |
invitation_email_domains optional | array of string | InvitationEmailDomains 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.
| Field | Type | Description |
|---|---|---|
org_id | string | |
inactivity_disable_days optional | integer | InactivityDisableDays disables users with no session activity in the organization for this many days; nil turns it off. |
jit_max_minutes | integer | |
break_glass_max_minutes | integer | |
approval_timeout_minutes | integer | |
delegation_default | string | DelegationDefault applies where no delegation allow-list covers a node: DelegationClosed lets only organization-level granters bind roles there, DelegationOpen lets every granter. |
invitation_email_domains | array of string | The email domains the organization invites people from; empty allows any. |
updated_at | timestamp | |
etag | string |
ShareEntry
One principal's access to a target.
| Field | Type | Description |
|---|---|---|
binding_id optional | string | Set for a binding; a project membership has none. |
principal | PrincipalName | |
role_id optional | string | |
role_name | string | |
level | string | |
level_label | string | LevelLabel names Level. |
source | string | Share, access_request, api, role_assignment, project_role, hierarchy_role or membership. |
inherited_from optional | string | The node the access comes from when it is not granted on the target itself. |
expires_at optional | timestamp | |
revocable | boolean | Set when the caller may revoke the entry here. |
Sharing
Who has access to a target.
| Field | Type | Description |
|---|---|---|
resource | ResourceView | |
can_manage | boolean | Set when the caller may grant and revoke. |
entries | array of ShareEntry | |
pending_requests | array of RequestView | |
levels | array of LevelOption | The levels the caller may grant, with their labels. |
pending_shares | array of PendingShareView | Shares waiting for an account invitation to be accepted, shown as "Invited". |
can_invite | boolean | Set 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.
| Field | Type | Description |
|---|---|---|
node_id | string | |
name | string | |
description | string | |
role_ids | array of string |
SoDView
A rule with its etag.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
node_id | string | |
name | string | |
description | string | |
role_ids | array of string | |
created_at | timestamp | |
updated_at | timestamp | |
etag | string |
Target
Target names the principal a question is about; empty means the caller.
| Field | Type | Description |
|---|---|---|
type | string | |
id | string |
ZoneInput
A zone as the API accepts it.
| Field | Type | Description |
|---|---|---|
name | string | |
description | string | |
cidrs | array of string |
Campaign
One access review.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
schedule_id optional | string | |
name | string | |
node_id | string | |
node_path | string | |
role_id optional | string | |
include_subtree | boolean | |
reviewers | array of PolicyPrincipal | |
auto_revoke | boolean | |
state | string | |
starts_at | timestamp | |
due_at | timestamp | |
closed_at optional | timestamp | |
closed_by optional | string | |
created_by optional | string |
Declassification
A request to lower a node's own classification label.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
node_id | string | |
resource_type optional | string | ResourceType and ResourceID name the labelled object whose own label is lowered; both are empty for the node's own label. |
resource_id optional | string | |
from_classification | string | |
from_compartments | array of string | |
to_classification | string | |
to_compartments | array of string | |
reason | string | |
requested_by | string | |
approval_request_id optional | string | |
status | string | |
decided_by optional | string | |
decided_at optional | timestamp | |
applied_by optional | string | |
applied_at optional | timestamp | |
expires_at | timestamp | |
created_at | timestamp |
NetworkZone
A named set of CIDR prefixes of an organization: network.zone of a request is the zone that contains its address.
| Field | Type | Description |
|---|---|---|
name | string | |
description | string | |
cidrs | array of string | |
updated_at | timestamp |
PolicyPrincipal
A principal of a deny policy: a user, group or service account, or every principal (Type "all").
| Field | Type | Description |
|---|---|---|
type | string | |
id optional | string |
PrincipalName
What is shown for a principal.
| Field | Type | Description |
|---|---|---|
type | string | |
id | string | |
display_name optional | string | |
email optional | string |
ReviewItem
One binding under review.
| Field | Type | Description |
|---|---|---|
id | string | |
org_id | string | |
campaign_id | string | |
binding_id | string | |
node_id | string | |
node_path | string | |
role_id | string | |
role_name | string | |
role_version | integer | |
principal_type | string | |
principal_id | string | |
binding | JSON | |
decision optional | string | |
justification optional | string | |
decided_by optional | string | |
decided_at optional | timestamp | |
outcome | string | |
audit_record_id optional | integer |
RoleHolder
A principal bound to a role on a node, with the name the Access pages show for it.
| Field | Type | Description |
|---|---|---|
binding_id | string | |
role_id | string | |
principal_type | string | |
principal_id | string | |
display_name | string | |
email optional | string | |
state | string | |
conditional | boolean | |
expires_at optional | timestamp |
StepUp
The step-up requirement of a deny policy.
| Field | Type | Description |
|---|---|---|
strength | string | |
max_age_seconds | integer |
This page is generated from the server's route table and the Go handlers that serve each route. Do not edit it by hand.