Skip to content

Fine-grained access control policies for users, teams, and service accounts.

GET/org/policies

List organization policies

Returns all access policies defined at the organization level, showing which principals have been granted specific permissions.

Parameters

limitinteger
limit

The maximum number of items to list.

Type
integer
Format
"int32"
Minimum
0
Maximum
100
Default
100
markerstring
marker

The pagination token returned from the previous list operation.

Type
string
Responses

Responses

A list of resource policies is returned.

application/json
JSON
{
  
"items": [
  
  
{
  
  
  
"principal": {
  
  
  
  
"type": "string",
  
  
  
  
"id": "A1B2C3D4E5"
  
  
  
},
  
  
  
"permissions": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"createdAt": "string",
  
  
  
"updatedAt": "string"
  
  
}
  
],
  
"marker": "string"
}
GET/org/policies/{principal}

Describe organization policy

Returns the organization-level access policy for a specific principal, including all permissions that have been explicitly granted.

Responses

Responses

The information about the resource policy is returned.

application/json
JSON
{
  
"principal": {
  
  
"type": "string",
  
  
"id": "A1B2C3D4E5"
  
},
  
"permissions": [
  
  
"string"
  
],
  
"createdAt": "string",
  
"updatedAt": "string"
}
PUT/org/policies/{principal}

Set organization policy

Sets the organization-level access policy for a principal, replacing any existing policy. Use this to grant or modify permissions for users or teams at the organization scope.

Request Body

application/json
JSON
{
  
"permissions": [
  
  
"string"
  
]
}
Responses

Responses

The existing resource policy was modified successfully.

application/json
JSON
{
  
"principal": {
  
  
"type": "string",
  
  
"id": "A1B2C3D4E5"
  
},
  
"permissions": [
  
  
"string"
  
],
  
"createdAt": "string",
  
"updatedAt": "string"
}
DELETE/org/policies/{principal}

Delete organization policy

This revokes all permissions that have been granted to the principal organization-wide,
but the principal may still have permissions at the resource level.

Responses

Responses

The requested operation was done successfully.