List Roles

Get all available roles for an organization.

application/json

Body

result

required

Any of

allOf {2}

array[object (schemas-role) {4}]

allOf {2}

One of

array[object (schemas-role) {4}]

object

description

string

description

read-onlyrequired

Description of role's permissions.

Example:

Administrative access to the entire Organization

string

role_components-schemas-identifier

read-onlyrequired

Role identifier tag.

<= 32 characters

Example:

3536bcfad5faccb999b47003c79917fb

name

string

Cloudflare Client API_components-schemas-name

read-onlyrequired

Role Name.

<= 120 characters

Example:

Organization Admin

permissions

array[string]

schemas-permissions

read-onlyrequired

Access permissions for this User.

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": [
        {
            "description": "Administrative access to the entire Organization",
            "id": "3536bcfad5faccb999b47003c79917fb",
            "name": "Organization Admin",
            "permissions": [
                "#zones:read"
            ]
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses