--- title: List Roles --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Accounts](https://developers.cloudflare.com/api/python/resources/accounts) [Roles](https://developers.cloudflare.com/api/python/resources/accounts/subresources/roles) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # List Roles Deprecated: Use /accounts/{account\_id}/iam/permission\_groups instead. 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 Provisioning``Account Settings Write``Account Settings Read` ##### ParametersExpand Collapse account\_id: str Account identifier tag. maxLength32 minLength32 [Link to this property](<#(resource)%20accounts.roles%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) page: Optional\[float] Page number of paginated results. minimum1 [Link to this property](<#(resource)%20accounts.roles%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20page%20%3E%20(schema)>) per\_page: Optional\[float] Number of roles per page. maximum50 minimum5 [Link to this property](<#(resource)%20accounts.roles%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20per_page%20%3E%20(schema)>) ##### ReturnsExpand Collapse
class Role: … id: str Role identifier tag. maxLength32 Link to this property description: str Description of role’s permissions. Link to this property name: str Role name. maxLength120 Link to this property
permissions: Permissions
analytics: Optional\[PermissionGrant] read: Optional\[bool] Link to this property write: Optional\[bool] Link to this property
Link to this property
billing: Optional\[PermissionGrant] read: Optional\[bool] Link to this property write: Optional\[bool] Link to this property
Link to this property
cache\_purge: Optional\[PermissionGrant] read: Optional\[bool] Link to this property write: Optional\[bool] Link to this property
Link to this property
dns: Optional\[PermissionGrant] read: Optional\[bool] Link to this property write: Optional\[bool] Link to this property
Link to this property
dns\_records: Optional\[PermissionGrant] read: Optional\[bool] Link to this property write: Optional\[bool] Link to this property
Link to this property
lb: Optional\[PermissionGrant] read: Optional\[bool] Link to this property write: Optional\[bool] Link to this property
Link to this property
logs: Optional\[PermissionGrant] read: Optional\[bool] Link to this property write: Optional\[bool] Link to this property
Link to this property
organization: Optional\[PermissionGrant] read: Optional\[bool] Link to this property write: Optional\[bool] Link to this property
Link to this property
ssl: Optional\[PermissionGrant] read: Optional\[bool] Link to this property write: Optional\[bool] Link to this property
Link to this property
waf: Optional\[PermissionGrant] read: Optional\[bool] Link to this property write: Optional\[bool] Link to this property
Link to this property
zone\_settings: Optional\[PermissionGrant] read: Optional\[bool] Link to this property write: Optional\[bool] Link to this property
Link to this property
zones: Optional\[PermissionGrant] read: Optional\[bool] Link to this property write: Optional\[bool] Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20%24shared%20%3E%20(model)%20role%20%3E%20(schema)>) ### List Roles Python HTTPTypeScriptPythonGoTerraform ``` 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) ``` 200 example ``` { "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 200 example ``` { "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 } } ```