LogoCloudflare API

IAM

iam

IAM

Permission Groups

iam.permission_groups

Methods

Permission Group Details -> { id, meta, name }
get/accounts/{account_id}/iam/permission_groups/{permission_group_id}

Get information about a specific permission group in an account.

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Trust and Safety Write Trust and Safety Read DNS View Write DNS View Read SCIM Provisioning Load Balancers Account Write Load Balancers Account Read Zero Trust: PII Read DDoS Botnet Feed Write DDoS Botnet Feed Read Workers R2 Storage Write Workers R2 Storage Read DDoS Protection Write DDoS Protection Read Workers Tail Read Workers KV Storage Write Workers KV Storage Read Workers Scripts Write Workers Scripts Read Load Balancing: Monitors and Pools Write Load Balancing: Monitors and Pools Read Account Firewall Access Rules Write Account Firewall Access Rules Read DNS Firewall Write DNS Firewall Read Billing Write Billing Read Account Settings Write Account Settings Read

Parameters
account_id: string
(maxLength: 32)

Account identifier tag.

permission_group_id: string
(maxLength: 32)

Permission Group identifier tag.

Response fields
id: string

Identifier of the group.

meta: { key, value }
Optional

Attributes associated to the permission group.

name: string
Optional

Name of the group.

Request example
200Example
List Account Permission Groups -> V4PagePaginationArray<{ id, meta, name }>
get/accounts/{account_id}/iam/permission_groups

List all the permissions groups for an account.

IAM

Resource Groups

iam.resource_groups

Methods

Create Resource Group -> { id, meta, scope }
post/accounts/{account_id}/iam/resource_groups

Create a new Resource Group under the specified account.

Remove Resource Group -> Envelope<{ id }>
delete/accounts/{account_id}/iam/resource_groups/{resource_group_id}

Remove a resource group from an account.

Resource Group Details -> { id, scope, meta, 1 more... }
get/accounts/{account_id}/iam/resource_groups/{resource_group_id}

Get information about a specific resource group in an account.

List Resource Groups -> V4PagePaginationArray<{ id, scope, meta, 1 more... }>
get/accounts/{account_id}/iam/resource_groups

List all the resource groups for an account.

Update Resource Group -> { id, scope, meta, 1 more... }
put/accounts/{account_id}/iam/resource_groups/{resource_group_id}

Modify an existing resource group.