Skip to content
Cloudflare API
Start here
API Reference
Accounts
Roles

List Roles

accounts.roles.list(RoleListParams**kwargs) -> SyncV4PagePaginationArray[Role]
GET/accounts/{account_id}/roles

Get all available roles for an account.

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
SCIM ProvisioningAccount Settings WriteAccount Settings Read
ParametersExpand Collapse
account_id: str

Account identifier tag.

maxLength32
minLength32
page: Optional[float]

Page number of paginated results.

minimum1
per_page: Optional[float]

Number of roles per page.

maximum50
minimum5
ReturnsExpand Collapse
class Role: …
id: str

Role identifier tag.

maxLength32
description: str

Description of role's permissions.

name: str

Role name.

maxLength120
permissions: Permissions
analytics: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
billing: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
cache_purge: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
dns: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
dns_records: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
lb: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
logs: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
organization: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
ssl: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
waf: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
zone_settings: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]
zones: Optional[PermissionGrant]
read: Optional[bool]
write: Optional[bool]

List Roles

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
page = client.accounts.roles.list(
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
page = page.result[0]
print(page.id)
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "3536bcfad5faccb999b47003c79917fb",
      "description": "Administrative access to the entire Account",
      "name": "Account Administrator",
      "permissions": {
        "analytics": {
          "read": true,
          "write": false
        },
        "billing": {
          "read": true,
          "write": false
        },
        "cache_purge": {
          "read": true,
          "write": false
        },
        "dns": {
          "read": true,
          "write": false
        },
        "dns_records": {
          "read": true,
          "write": false
        },
        "lb": {
          "read": true,
          "write": false
        },
        "logs": {
          "read": true,
          "write": false
        },
        "organization": {
          "read": true,
          "write": false
        },
        "ssl": {
          "read": true,
          "write": false
        },
        "waf": {
          "read": true,
          "write": false
        },
        "zone_settings": {
          "read": true,
          "write": false
        },
        "zones": {
          "read": true,
          "write": true
        }
      }
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}
Returns Examples
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "3536bcfad5faccb999b47003c79917fb",
      "description": "Administrative access to the entire Account",
      "name": "Account Administrator",
      "permissions": {
        "analytics": {
          "read": true,
          "write": false
        },
        "billing": {
          "read": true,
          "write": false
        },
        "cache_purge": {
          "read": true,
          "write": false
        },
        "dns": {
          "read": true,
          "write": false
        },
        "dns_records": {
          "read": true,
          "write": false
        },
        "lb": {
          "read": true,
          "write": false
        },
        "logs": {
          "read": true,
          "write": false
        },
        "organization": {
          "read": true,
          "write": false
        },
        "ssl": {
          "read": true,
          "write": false
        },
        "waf": {
          "read": true,
          "write": false
        },
        "zone_settings": {
          "read": true,
          "write": false
        },
        "zones": {
          "read": true,
          "write": true
        }
      }
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}