Organization policies

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

List policies

List the IAM policies that are defined for this organization.

GET/organizations/{organizationId}/iam-policies

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

Query parameters

Response

200401404

OK

Body

application/json

results*array of Policy

List of IAM policies.

nextPageTokenstring

The token to fetch the next page of results. If empty, there are no more results to fetch.

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/iam-policies', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200401404

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "definitions": [
        {
          "effect": "allow",
          "resources": [
            "text"
          ],
          "actions": [
            "any"
          ],
          "conditionsAll": [
            {}
          ]
        }
      ],
      "rolesDependencyCount": 0,
      "usersDependencyCount": 0,
      "scope": "organization",
      "type": "managed",
      "createdAt": "2024-12-21T12:12:30.729Z",
      "updatedAt": "2024-12-21T12:12:30.729Z",
      "metadata": {
        "clouds": [
          "platform"
        ],
        "apps": [
          "inbox"
        ],
        "groups": [
          "text"
        ]
      }
    }
  ],
  "nextPageToken": "text"
}

Create policy

Create a new IAM policy for this organization.

POST/organizations/{organizationId}/iam-policies

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

Body

application/json

name*iam_policy_properties-name (string)

IAM Policy name.

descriptionproperties-description (string)

IAM Policy description.

definitions*PolicyDefinitions

List of IAM Policy definitions.

metadataobject

Metadata for the IAM Role.

Response

201404422

Created

Body

application/json

id*string (uuid)

ID of the IAM Policy.

name*string

IAM Policy name.

descriptionstring

IAM Policy description.

definitions*PolicyDefinitions

List of IAM Policy definitions.

rolesDependencyCountinteger

The number of IAM Roles that depend on this IAM policy.

usersDependencyCountinteger

The number of users that depend on this IAM policy.

scope*enum

The scope to which this policy applies.

organizationroot

typeenum

The type of policy, managed indicates it's controlled by the platform.

managedorganization

createdAt*string (date-time)

When the IAM Policy was created.

updatedAt*string (date-time)

When the IAM Policy was last updated.

metadatanullable object

Metadata for the IAM Policy.

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/iam-policies', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "definitions": [
        {
          "effect": "allow",
          "resources": [
            "text"
          ],
          "actions": [
            "any"
          ]
        }
      ]
    }),
});
const data = await response.json();

Response

201404422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "definitions": [
    {
      "effect": "allow",
      "resources": [
        "text"
      ],
      "actions": [
        "any"
      ],
      "conditionsAll": [
        {}
      ]
    }
  ],
  "rolesDependencyCount": 0,
  "usersDependencyCount": 0,
  "scope": "organization",
  "type": "managed",
  "createdAt": "2024-12-21T12:12:30.729Z",
  "updatedAt": "2024-12-21T12:12:30.729Z",
  "metadata": {
    "clouds": [
      "platform"
    ],
    "apps": [
      "inbox"
    ],
    "groups": [
      "text"
    ]
  }
}

Get policy

Retrieve a single IAM policy.

GET/organizations/{organizationId}/iam-policies/{policyId}

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

policyId*string

ID for an IAM policy

Response

200404

OK

Body

application/json

id*string (uuid)

ID of the IAM Policy.

name*string

IAM Policy name.

descriptionstring

IAM Policy description.

definitions*PolicyDefinitions

List of IAM Policy definitions.

rolesDependencyCountinteger

The number of IAM Roles that depend on this IAM policy.

usersDependencyCountinteger

The number of users that depend on this IAM policy.

scope*enum

The scope to which this policy applies.

organizationroot

typeenum

The type of policy, managed indicates it's controlled by the platform.

managedorganization

createdAt*string (date-time)

When the IAM Policy was created.

updatedAt*string (date-time)

When the IAM Policy was last updated.

metadatanullable object

Metadata for the IAM Policy.

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/iam-policies/{policyId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

200404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "definitions": [
    {
      "effect": "allow",
      "resources": [
        "text"
      ],
      "actions": [
        "any"
      ],
      "conditionsAll": [
        {}
      ]
    }
  ],
  "rolesDependencyCount": 0,
  "usersDependencyCount": 0,
  "scope": "organization",
  "type": "managed",
  "createdAt": "2024-12-21T12:12:30.729Z",
  "updatedAt": "2024-12-21T12:12:30.729Z",
  "metadata": {
    "clouds": [
      "platform"
    ],
    "apps": [
      "inbox"
    ],
    "groups": [
      "text"
    ]
  }
}

Delete policy

Remove an IAM policy from the organization.

DELETE/organizations/{organizationId}/iam-policies/{policyId}

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

policyId*string

ID for an IAM policy

Response

204400404410

OK

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/iam-policies/{policyId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

400404410

{
  "code": "text",
  "message": "text"
}

Update policy

Update an IAM policy's properties.

PATCH/organizations/{organizationId}/iam-policies/{policyId}

Authorization

useraccessKey

Path parameters

organizationId*string

The organization ID

policyId*string

ID for an IAM policy

Body

application/json

nameiam_policy_properties-name (string)

IAM Policy name.

descriptionproperties-description (string)

IAM Policy description.

definitionsPolicyDefinitions

List of IAM Policy definitions.

Response

200404422

OK

Body

application/json

id*string (uuid)

ID of the IAM Policy.

name*string

IAM Policy name.

descriptionstring

IAM Policy description.

definitions*PolicyDefinitions

List of IAM Policy definitions.

rolesDependencyCountinteger

The number of IAM Roles that depend on this IAM policy.

usersDependencyCountinteger

The number of users that depend on this IAM policy.

scope*enum

The scope to which this policy applies.

organizationroot

typeenum

The type of policy, managed indicates it's controlled by the platform.

managedorganization

createdAt*string (date-time)

When the IAM Policy was created.

updatedAt*string (date-time)

When the IAM Policy was last updated.

metadatanullable object

Metadata for the IAM Policy.

Request

JavaScriptCurlPython

const response = await fetch('/organizations/{organizationId}/iam-policies/{policyId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer jwt",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200404422

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "definitions": [
    {
      "effect": "allow",
      "resources": [
        "text"
      ],
      "actions": [
        "any"
      ],
      "conditionsAll": [
        {}
      ]
    }
  ],
  "rolesDependencyCount": 0,
  "usersDependencyCount": 0,
  "scope": "organization",
  "type": "managed",
  "createdAt": "2024-12-21T12:12:30.729Z",
  "updatedAt": "2024-12-21T12:12:30.729Z",
  "metadata": {
    "clouds": [
      "platform"
    ],
    "apps": [
      "inbox"
    ],
    "groups": [
      "text"
    ]
  }
}