List Permission Groups

Find all available permission groups.

application/json

Body

result

required

Any of

allOf {2}

array [object]

allOf {2}

One of

array [object]

object

Example:

[{"id":"7cf72faf220841aabcfdfab81c43c4f6","name":"Billing Read","scopes":["com.cloudflare.api.account"]},{"id":"9d24387c6e8544e2bc4024a03991339f","name":"Load Balancing: Monitors and Pools Read","scopes":["com.cloudflare.api.account"]},{"id":"d2a1802cc9a34e30852f8b33869b2f3c","name":"Load Balancing: Monitors and Pools Write","scopes":["com.cloudflare.api.account"]},{"id":"8b47d2786a534c08a1f94ee8f9f599ef","name":"Workers KV Storage Read","scopes":["com.cloudflare.api.account"]},{"id":"f7f0eda5697f475c90846e879bab8666","name":"Workers KV Storage Write","scopes":["com.cloudflare.api.account"]},{"id":"1a71c399035b4950a1bd1466bbe4f420","name":"Workers Scripts Read","scopes":["com.cloudflare.api.account"]},{"id":"e086da7e2179491d91ee5f35b3ca210a","name":"Workers Scripts Write","scopes":["com.cloudflare.api.account"]}]

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "id": "7cf72faf220841aabcfdfab81c43c4f6",
            "name": "Billing Read",
            "scopes": [
                "com.cloudflare.api.account"
            ]
        },
        {
            "id": "9d24387c6e8544e2bc4024a03991339f",
            "name": "Load Balancing: Monitors and Pools Read",
            "scopes": [
                "com.cloudflare.api.account"
            ]
        },
        {
            "id": "d2a1802cc9a34e30852f8b33869b2f3c",
            "name": "Load Balancing: Monitors and Pools Write",
            "scopes": [
                "com.cloudflare.api.account"
            ]
        },
        {
            "id": "8b47d2786a534c08a1f94ee8f9f599ef",
            "name": "Workers KV Storage Read",
            "scopes": [
                "com.cloudflare.api.account"
            ]
        },
        {
            "id": "f7f0eda5697f475c90846e879bab8666",
            "name": "Workers KV Storage Write",
            "scopes": [
                "com.cloudflare.api.account"
            ]
        },
        {
            "id": "1a71c399035b4950a1bd1466bbe4f420",
            "name": "Workers Scripts Read",
            "scopes": [
                "com.cloudflare.api.account"
            ]
        },
        {
            "id": "e086da7e2179491d91ee5f35b3ca210a",
            "name": "Workers Scripts Write",
            "scopes": [
                "com.cloudflare.api.account"
            ]
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

List Permission Groups

Request

Request samples

Responses