DokumentationEngagement Platform API
Sign inGet started
Guides
API

Organization policies

GET
/organizations/{organizationId}/iam-policies
List the IAM policies that are defined for this organization.
Abfrageparameter
limit
integer
Limits the number of results to return.
pageToken
string
The cursor that keeps track of the current position in the results.
reverse
boolean
Reverses the order in which the results are returned.
Antwort-Payload
results
array of object
erforderlich
List of IAM policies.
Untergeordnete Attribute anzeigen
results.createdAt
string
erforderlich
When the IAM Policy was created.
results.definitions
array of object
erforderlich
List of IAM Policy definitions.
Untergeordnete Attribute anzeigen
results.definitions.actions
array of string
erforderlich
A list of actions
results.definitions.conditionsAll
array of object
Untergeordnete Attribute anzeigen
results.definitions.conditionsAll.any
object
results.definitions.effect
string
erforderlich
The outcome of the definition if a combination of the resources and actions match.
Possible values: allow, deny
results.definitions.resources
array of string
erforderlich
A list of resources
results.description
string
IAM Policy description.
results.id
string
erforderlich
ID of the IAM Policy.
results.metadata
object
Metadata for the IAM Policy.
Untergeordnete Attribute anzeigen
results.metadata.apps
array of string
results.metadata.clouds
array of string
results.metadata.groups
array of string
results.name
string
erforderlich
IAM Policy name.
results.rolesDependencyCount
integer
The number of IAM Roles that depend on this IAM policy.
results.scope
string
erforderlich
The scope to which this policy applies.
Possible values: organization, root
results.type
string
The type of policy, managed indicates it's controlled by the platform.
Possible values: managed, organization
results.updatedAt
string
erforderlich
When the IAM Policy was last updated.
results.usersDependencyCount
integer
The number of users that depend on this IAM policy.
nextPageToken
string
The token to fetch the next page of results. If empty, there are no more results to fetch.
Codebeispiel
curl -X GET 'https://api.bird.com/organizations/{organizationId}/iam-policies' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
POST
/organizations/{organizationId}/iam-policies
Create a new IAM policy for this organization.
Anfrage-Payload
name
string
erforderlich
IAM Policy name.
description
string
IAM Policy description.
definitions
array of object
erforderlich
List of IAM Policy definitions.
Untergeordnete Parameter anzeigen
definitions.actions
array of string
erforderlich
A list of actions
definitions.conditionsAll
array of object
Untergeordnete Parameter anzeigen
definitions.conditionsAll.any
object
definitions.effect
string
erforderlich
The outcome of the definition if a combination of the resources and actions match.
Possible values: allow, deny
definitions.resources
array of string
erforderlich
A list of resources
metadata
object
Metadata for the IAM Role.
Untergeordnete Parameter anzeigen
metadata.clouds
array of string
metadata.apps
array of string
metadata.groups
array of string
Antwort-Payload
createdAt
string
erforderlich
When the IAM Policy was created.
definitions
array of object
erforderlich
List of IAM Policy definitions.
Untergeordnete Attribute anzeigen
definitions.actions
array of string
erforderlich
A list of actions
definitions.conditionsAll
array of object
Untergeordnete Attribute anzeigen
definitions.conditionsAll.any
object
definitions.effect
string
erforderlich
The outcome of the definition if a combination of the resources and actions match.
Possible values: allow, deny
definitions.resources
array of string
erforderlich
A list of resources
description
string
IAM Policy description.
id
string
erforderlich
ID of the IAM Policy.
metadata
object
Metadata for the IAM Policy.
Untergeordnete Attribute anzeigen
metadata.apps
array of string
metadata.clouds
array of string
metadata.groups
array of string
name
string
erforderlich
IAM Policy name.
rolesDependencyCount
integer
The number of IAM Roles that depend on this IAM policy.
scope
string
erforderlich
The scope to which this policy applies.
Possible values: organization, root
type
string
The type of policy, managed indicates it's controlled by the platform.
Possible values: managed, organization
updatedAt
string
erforderlich
When the IAM Policy was last updated.
usersDependencyCount
integer
The number of users that depend on this IAM policy.
Codebeispiel
curl -X POST 'https://api.bird.com/organizations/{organizationId}/iam-policies' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
GET
/organizations/{organizationId}/iam-policies/{policyId}
Retrieve a single IAM policy.
Antwort-Payload
createdAt
string
erforderlich
When the IAM Policy was created.
definitions
array of object
erforderlich
List of IAM Policy definitions.
Untergeordnete Attribute anzeigen
definitions.actions
array of string
erforderlich
A list of actions
definitions.conditionsAll
array of object
Untergeordnete Attribute anzeigen
definitions.conditionsAll.any
object
definitions.effect
string
erforderlich
The outcome of the definition if a combination of the resources and actions match.
Possible values: allow, deny
definitions.resources
array of string
erforderlich
A list of resources
description
string
IAM Policy description.
id
string
erforderlich
ID of the IAM Policy.
metadata
object
Metadata for the IAM Policy.
Untergeordnete Attribute anzeigen
metadata.apps
array of string
metadata.clouds
array of string
metadata.groups
array of string
name
string
erforderlich
IAM Policy name.
rolesDependencyCount
integer
The number of IAM Roles that depend on this IAM policy.
scope
string
erforderlich
The scope to which this policy applies.
Possible values: organization, root
type
string
The type of policy, managed indicates it's controlled by the platform.
Possible values: managed, organization
updatedAt
string
erforderlich
When the IAM Policy was last updated.
usersDependencyCount
integer
The number of users that depend on this IAM policy.
Codebeispiel
curl -X GET 'https://api.bird.com/organizations/{organizationId}/iam-policies/{policyId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
DELETE
/organizations/{organizationId}/iam-policies/{policyId}
Remove an IAM policy from the organization.
Codebeispiel
curl -X DELETE 'https://api.bird.com/organizations/{organizationId}/iam-policies/{policyId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'
PATCH
/organizations/{organizationId}/iam-policies/{policyId}
Update an IAM policy's properties.
Anfrage-Payload
name
string
IAM Policy name.
description
string
IAM Policy description.
definitions
array of object
List of IAM Policy definitions.
Untergeordnete Parameter anzeigen
definitions.actions
array of string
erforderlich
A list of actions
definitions.conditionsAll
array of object
Untergeordnete Parameter anzeigen
definitions.conditionsAll.any
object
definitions.effect
string
erforderlich
The outcome of the definition if a combination of the resources and actions match.
Possible values: allow, deny
definitions.resources
array of string
erforderlich
A list of resources
Antwort-Payload
createdAt
string
erforderlich
When the IAM Policy was created.
definitions
array of object
erforderlich
List of IAM Policy definitions.
Untergeordnete Attribute anzeigen
definitions.actions
array of string
erforderlich
A list of actions
definitions.conditionsAll
array of object
Untergeordnete Attribute anzeigen
definitions.conditionsAll.any
object
definitions.effect
string
erforderlich
The outcome of the definition if a combination of the resources and actions match.
Possible values: allow, deny
definitions.resources
array of string
erforderlich
A list of resources
description
string
IAM Policy description.
id
string
erforderlich
ID of the IAM Policy.
metadata
object
Metadata for the IAM Policy.
Untergeordnete Attribute anzeigen
metadata.apps
array of string
metadata.clouds
array of string
metadata.groups
array of string
name
string
erforderlich
IAM Policy name.
rolesDependencyCount
integer
The number of IAM Roles that depend on this IAM policy.
scope
string
erforderlich
The scope to which this policy applies.
Possible values: organization, root
type
string
The type of policy, managed indicates it's controlled by the platform.
Possible values: managed, organization
updatedAt
string
erforderlich
When the IAM Policy was last updated.
usersDependencyCount
integer
The number of users that depend on this IAM policy.
Codebeispiel
curl -X PATCH 'https://api.bird.com/organizations/{organizationId}/iam-policies/{policyId}' \
  -H 'Authorization: AccessKey YOUR_ACCESS_KEY'