Cloudflare API | IAM › Permission Groups › List Account Permission Groups

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.

id: string

Optional

(maxLength: 32, minLength: 32)

ID of the permission group to be fetched.

label: string

Optional

Label of the permission group to be fetched.

name: string

Optional

Name of the permission group to be fetched.

page: number

Optional

(minimum: 1)

Page number of paginated results.

per_page: number

Optional

(maximum: 50, minimum: 5)

Maximum number of results per page.

Response fields

errors: Array<

ResponseInfo

messages: Array<

ResponseInfo

success: true

Whether the API call was successful

result: Array<{ id, meta, name }>

Optional

A set of permission groups that are specified to the policy.

result_info: { count, page, per_page, 1 more... }

Optional

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/iam/permission_groups \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "success": true,
  "result": [
    {
      "id": "c8fed203ed3043cba015a93ad1616f1f",
      "meta": {
        "key": "key",
        "value": "value"
      }
    },
    {
      "id": "82e64a83756745bbbb1c9c2701bf816b",
      "meta": {
        "key": "key",
        "value": "value"
      }
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

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.