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: 100 · default: 10optional

Limits the number of results to return

pageTokenstringoptional

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

reverseboolean · default: falseoptional

Order in which to retrieve the results

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/organizations/{organizationId}/iam-policies' \
  --header 'Authorization: Bearer jwt'

200

401

404

200

{
  "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-03-28T19:11:46.612Z",
      "updatedAt": "2025-03-28T19:11:46.612Z",
      "metadata": {
        "clouds": [
          "platform"
        ],
        "apps": [
          "inbox"
        ],
        "groups": [
          "text"
        ]
      }
    }
  ],
  "nextPageToken": "text"
}

OK

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.

definitionsobject[] · min: 1 · max: 240required

List of IAM Policy definitions.

metadataobjectoptional

Metadata for the IAM Role.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/organizations/{organizationId}/iam-policies' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
      ]
    }
  }'

201

404

422

201

{
  "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-03-28T19:11:46.612Z",
  "updatedAt": "2025-03-28T19:11:46.612Z",
  "metadata": {
    "clouds": [
      "platform"
    ],
    "apps": [
      "inbox"
    ],
    "groups": [
      "text"
    ]
  }
}

Created

Get policy

get

Retrieve a single IAM policy.

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

policyIdstringrequired

ID for an IAM policy

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/organizations/{organizationId}/iam-policies/{policyId}' \
  --header 'Authorization: Bearer jwt'

200

404

200

{
  "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-03-28T19:11:46.612Z",
  "updatedAt": "2025-03-28T19:11:46.612Z",
  "metadata": {
    "clouds": [
      "platform"
    ],
    "apps": [
      "inbox"
    ],
    "groups": [
      "text"
    ]
  }
}

OK

Delete policy

delete

Remove an IAM policy from the organization.

Authorizations

Path parameters

organizationIdstringrequired

The organization ID

policyIdstringrequired

ID for an IAM policy

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/organizations/{organizationId}/iam-policies/{policyId}' \
  --header 'Authorization: Bearer jwt'

204

400

404

410

204

No body

OK

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.

definitionsobject[] · min: 1 · max: 240optional

List of IAM Policy definitions.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/organizations/{organizationId}/iam-policies/{policyId}' \
  --header 'Authorization: Bearer jwt' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "description": "text",
    "definitions": [
      {
        "effect": "allow",
        "resources": [
          "text"
        ],
        "actions": [
          "any"
        ],
        "conditionsAll": [
          {
            "any": {
              "ANY_ADDITIONAL_PROPERTY": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              }
            }
          }
        ]
      }
    ]
  }'

200

404

422

200

{
  "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-03-28T19:11:46.612Z",
  "updatedAt": "2025-03-28T19:11:46.612Z",
  "metadata": {
    "clouds": [
      "platform"
    ],
    "apps": [
      "inbox"
    ],
    "groups": [
      "text"
    ]
  }
}

OK