Organization policies
GET
/organizations/{organizationId}/iam-policies
List the IAM policies that are defined for this organization.
查询参数
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.
响应载荷
results
array of object
必填
List of IAM policies.
显示子属性
results.createdAt
string
必填
When the IAM Policy was created.
results.definitions
array of object
必填
List of IAM Policy definitions.
显示子属性
results.definitions.actions
array of string
必填
A list of actions
results.definitions.conditionsAll
array of object
显示子属性
results.definitions.conditionsAll.any
object
results.definitions.effect
string
必填
The outcome of the definition if a combination of the resources and actions match.
Possible values: allow, deny
results.definitions.resources
array of string
必填
A list of resources
results.description
string
IAM Policy description.
results.id
string
必填
ID of the IAM Policy.
results.metadata
object
Metadata for the IAM Policy.
显示子属性
results.metadata.apps
array of string
results.metadata.clouds
array of string
results.metadata.groups
array of string
results.name
string
必填
IAM Policy name.
results.rolesDependencyCount
integer
The number of IAM Roles that depend on this IAM policy.
results.scope
string
必填
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
必填
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.
代码示例
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.
请求载荷
name
string
必填
IAM Policy name.
description
string
IAM Policy description.
definitions
array of object
必填
List of IAM Policy definitions.
显示子参数
definitions.actions
array of string
必填
A list of actions
definitions.conditionsAll
array of object
显示子参数
definitions.conditionsAll.any
object
definitions.effect
string
必填
The outcome of the definition if a combination of the resources and actions match.
Possible values: allow, deny
definitions.resources
array of string
必填
A list of resources
metadata
object
Metadata for the IAM Role.
显示子参数
metadata.clouds
array of string
metadata.apps
array of string
metadata.groups
array of string
响应载荷
createdAt
string
必填
When the IAM Policy was created.
definitions
array of object
必填
List of IAM Policy definitions.
显示子属性
definitions.actions
array of string
必填
A list of actions
definitions.conditionsAll
array of object
显示子属性
definitions.conditionsAll.any
object
definitions.effect
string
必填
The outcome of the definition if a combination of the resources and actions match.
Possible values: allow, deny
definitions.resources
array of string
必填
A list of resources
description
string
IAM Policy description.
id
string
必填
ID of the IAM Policy.
metadata
object
Metadata for the IAM Policy.
显示子属性
metadata.apps
array of string
metadata.clouds
array of string
metadata.groups
array of string
name
string
必填
IAM Policy name.
rolesDependencyCount
integer
The number of IAM Roles that depend on this IAM policy.
scope
string
必填
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
必填
When the IAM Policy was last updated.
usersDependencyCount
integer
The number of users that depend on this IAM policy.
代码示例
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.
响应载荷
createdAt
string
必填
When the IAM Policy was created.
definitions
array of object
必填
List of IAM Policy definitions.
显示子属性
definitions.actions
array of string
必填
A list of actions
definitions.conditionsAll
array of object
显示子属性
definitions.conditionsAll.any
object
definitions.effect
string
必填
The outcome of the definition if a combination of the resources and actions match.
Possible values: allow, deny
definitions.resources
array of string
必填
A list of resources
description
string
IAM Policy description.
id
string
必填
ID of the IAM Policy.
metadata
object
Metadata for the IAM Policy.
显示子属性
metadata.apps
array of string
metadata.clouds
array of string
metadata.groups
array of string
name
string
必填
IAM Policy name.
rolesDependencyCount
integer
The number of IAM Roles that depend on this IAM policy.
scope
string
必填
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
必填
When the IAM Policy was last updated.
usersDependencyCount
integer
The number of users that depend on this IAM policy.
代码示例
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.
代码示例
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.
请求载荷
name
string
IAM Policy name.
description
string
IAM Policy description.
definitions
array of object
List of IAM Policy definitions.
显示子参数
definitions.actions
array of string
必填
A list of actions
definitions.conditionsAll
array of object
显示子参数
definitions.conditionsAll.any
object
definitions.effect
string
必填
The outcome of the definition if a combination of the resources and actions match.
Possible values: allow, deny
definitions.resources
array of string
必填
A list of resources
响应载荷
createdAt
string
必填
When the IAM Policy was created.
definitions
array of object
必填
List of IAM Policy definitions.
显示子属性
definitions.actions
array of string
必填
A list of actions
definitions.conditionsAll
array of object
显示子属性
definitions.conditionsAll.any
object
definitions.effect
string
必填
The outcome of the definition if a combination of the resources and actions match.
Possible values: allow, deny
definitions.resources
array of string
必填
A list of resources
description
string
IAM Policy description.
id
string
必填
ID of the IAM Policy.
metadata
object
Metadata for the IAM Policy.
显示子属性
metadata.apps
array of string
metadata.clouds
array of string
metadata.groups
array of string
name
string
必填
IAM Policy name.
rolesDependencyCount
integer
The number of IAM Roles that depend on this IAM policy.
scope
string
必填
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
必填
When the IAM Policy was last updated.
usersDependencyCount
integer
The number of users that depend on this IAM policy.
代码示例
curl -X PATCH 'https://api.bird.com/organizations/{organizationId}/iam-policies/{policyId}' \
-H 'Authorization: AccessKey YOUR_ACCESS_KEY'