Organization policies

Allows you to define fine-grained access policies on your organization

List policies

get

List the IAM policies that are defined for this organization.

Authorizations

Path parameters

organizationIdstringRequired

The organization ID

Query parameters

limitinteger · min: 1 · max: 100Optional

Limits the number of results to return

Default: 10

pageTokenstringOptional

Pagination token that keeps of track of the current position in the list

reversebooleanOptional

Order in which to retrieve the results

Default: false

Responses

200

OK

application/json

Responseall of

and

401

unauthorized request

application/json

404

Resource not found

application/json

get

HTTPcURLJavaScriptPython

GET /organizations/{organizationId}/iam-policies HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "definitions": [
        {
          "effect": "allow",
          "resources": [
            "text"
          ],
          "actions": [
            "any"
          ],
          "conditionsAll": [
            {
              "any": {
                "ANY_ADDITIONAL_PROPERTY": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                }
              }
            }
          ]
        }
      ],
      "rolesDependencyCount": 1,
      "usersDependencyCount": 1,
      "scope": "organization",
      "type": "managed",
      "createdAt": "2025-05-09T05:27:32.570Z",
      "updatedAt": "2025-05-09T05:27:32.570Z",
      "metadata": {
        "clouds": [
          "platform"
        ],
        "apps": [
          "inbox"
        ],
        "groups": [
          "text"
        ]
      }
    }
  ],
  "nextPageToken": "text"
}

Create policy

post

Create a new IAM policy for this organization.

Authorizations

Path parameters

organizationIdstringRequired

The organization ID

Body

namestringRequired

IAM Policy name.

descriptionstringOptional

IAM Policy description.

Responses

201

Created

application/json

404

Resource not found

application/json

422

Request validation failed

application/json

post

HTTPcURLJavaScriptPython

POST /organizations/{organizationId}/iam-policies HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 269

{
  "name": "text",
  "description": "text",
  "definitions": [
    {
      "effect": "allow",
      "resources": [
        "text"
      ],
      "actions": [
        "any"
      ],
      "conditionsAll": [
        {
          "any": {
            "ANY_ADDITIONAL_PROPERTY": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        }
      ]
    }
  ],
  "metadata": {
    "clouds": [
      "platform"
    ],
    "apps": [
      "inbox"
    ],
    "groups": [
      "text"
    ]
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "definitions": [
    {
      "effect": "allow",
      "resources": [
        "text"
      ],
      "actions": [
        "any"
      ],
      "conditionsAll": [
        {
          "any": {
            "ANY_ADDITIONAL_PROPERTY": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        }
      ]
    }
  ],
  "rolesDependencyCount": 1,
  "usersDependencyCount": 1,
  "scope": "organization",
  "type": "managed",
  "createdAt": "2025-05-09T05:27:32.570Z",
  "updatedAt": "2025-05-09T05:27:32.570Z",
  "metadata": {
    "clouds": [
      "platform"
    ],
    "apps": [
      "inbox"
    ],
    "groups": [
      "text"
    ]
  }
}

Get policy

get

Retrieve a single IAM policy.

Authorizations

Path parameters

organizationIdstringRequired

The organization ID

policyIdstringRequired

ID for an IAM policy

Responses

200

OK

application/json

404

Resource not found

application/json

get

HTTPcURLJavaScriptPython

GET /organizations/{organizationId}/iam-policies/{policyId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "definitions": [
    {
      "effect": "allow",
      "resources": [
        "text"
      ],
      "actions": [
        "any"
      ],
      "conditionsAll": [
        {
          "any": {
            "ANY_ADDITIONAL_PROPERTY": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        }
      ]
    }
  ],
  "rolesDependencyCount": 1,
  "usersDependencyCount": 1,
  "scope": "organization",
  "type": "managed",
  "createdAt": "2025-05-09T05:27:32.570Z",
  "updatedAt": "2025-05-09T05:27:32.570Z",
  "metadata": {
    "clouds": [
      "platform"
    ],
    "apps": [
      "inbox"
    ],
    "groups": [
      "text"
    ]
  }
}

Delete policy

delete

Remove an IAM policy from the organization.

Authorizations

Path parameters

organizationIdstringRequired

The organization ID

policyIdstringRequired

ID for an IAM policy

Responses

204

OK

400

Cannot remove policy because it's still in use

application/json

404

Resource not found

application/json

410

Resource not found

application/json

delete

HTTPcURLJavaScriptPython

DELETE /organizations/{organizationId}/iam-policies/{policyId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Accept: */*

No content

Update policy

patch

Update an IAM policy's properties.

Authorizations

Path parameters

organizationIdstringRequired

The organization ID

policyIdstringRequired

ID for an IAM policy

Body

namestringOptional

IAM Policy name.

descriptionstringOptional

IAM Policy description.

Responses

200

OK

application/json

404

Resource not found

application/json

422

Request validation failed

application/json

patch

HTTPcURLJavaScriptPython

PATCH /organizations/{organizationId}/iam-policies/{policyId} HTTP/1.1
Host: 
Authorization: Bearer jwt
Content-Type: application/json
Accept: */*
Content-Length: 199

{
  "name": "text",
  "description": "text",
  "definitions": [
    {
      "effect": "allow",
      "resources": [
        "text"
      ],
      "actions": [
        "any"
      ],
      "conditionsAll": [
        {
          "any": {
            "ANY_ADDITIONAL_PROPERTY": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        }
      ]
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "definitions": [
    {
      "effect": "allow",
      "resources": [
        "text"
      ],
      "actions": [
        "any"
      ],
      "conditionsAll": [
        {
          "any": {
            "ANY_ADDITIONAL_PROPERTY": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        }
      ]
    }
  ],
  "rolesDependencyCount": 1,
  "usersDependencyCount": 1,
  "scope": "organization",
  "type": "managed",
  "createdAt": "2025-05-09T05:27:32.570Z",
  "updatedAt": "2025-05-09T05:27:32.570Z",
  "metadata": {
    "clouds": [
      "platform"
    ],
    "apps": [
      "inbox"
    ],
    "groups": [
      "text"
    ]
  }
}