--- title: Role Details --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api) [Accounts](https://developers.cloudflare.com/api/resources/accounts) [Roles](https://developers.cloudflare.com/api/resources/accounts/subresources/roles) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Role Details Deprecated: Use /accounts/{account\_id}/iam/permission\_groups/{permission\_group\_id} instead. GET/accounts/{account\_id}/roles/{role\_id} Get information about a specific role 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` ##### P ath ParametersExpand Collapse account\_id: string Account identifier tag. maxLength32 minLength32 [Link to this property](<#(resource)%20accounts.roles%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>) role\_id: string Role identifier tag. maxLength32 [Link to this property](<#(resource)%20accounts.roles%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20role_id%20%3E%20(schema)>) ##### ReturnsExpand Collapse
errors: array of object {code, message, documentation\_url, source } code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property
source: optional object {pointer } pointer: optional string Link to this property
Link to this property
[Link to this property](<#(resource)%20accounts.roles%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of object {code, message, documentation\_url, source } code: number minimum1000 Link to this property message: string Link to this property documentation\_url: optional string Link to this property
source: optional object {pointer } pointer: optional string Link to this property
Link to this property
[Link to this property](<#(resource)%20accounts.roles%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20messages>) success: true Whether the API call was successful. [Link to this property](<#(resource)%20accounts.roles%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result: optional Role { id, description, name, permissions } id: string Role identifier tag. maxLength32 Link to this property description: string Description of role’s permissions. Link to this property name: string Role name. maxLength120 Link to this property
permissions: object {analytics, billing, cache\_purge, 9 more }
analytics: optional PermissionGrant { read, write } read: optional boolean Link to this property write: optional boolean Link to this property
Link to this property
billing: optional PermissionGrant { read, write } read: optional boolean Link to this property write: optional boolean Link to this property
Link to this property
cache\_purge: optional PermissionGrant { read, write } read: optional boolean Link to this property write: optional boolean Link to this property
Link to this property
dns: optional PermissionGrant { read, write } read: optional boolean Link to this property write: optional boolean Link to this property
Link to this property
dns\_records: optional PermissionGrant { read, write } read: optional boolean Link to this property write: optional boolean Link to this property
Link to this property
lb: optional PermissionGrant { read, write } read: optional boolean Link to this property write: optional boolean Link to this property
Link to this property
logs: optional PermissionGrant { read, write } read: optional boolean Link to this property write: optional boolean Link to this property
Link to this property
organization: optional PermissionGrant { read, write } read: optional boolean Link to this property write: optional boolean Link to this property
Link to this property
ssl: optional PermissionGrant { read, write } read: optional boolean Link to this property write: optional boolean Link to this property
Link to this property
waf: optional PermissionGrant { read, write } read: optional boolean Link to this property write: optional boolean Link to this property
Link to this property
zone\_settings: optional PermissionGrant { read, write } read: optional boolean Link to this property write: optional boolean Link to this property
Link to this property
zones: optional PermissionGrant { read, write } read: optional boolean Link to this property write: optional boolean Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20accounts.roles%20%3E%20(method)%20get%20%3E%20(network%20schema)%20%3E%20(property)%20result>) ### Role Details HTTP HTTPTypeScriptPythonGoTerraform ``` curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/roles/$ROLE_ID \ -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \ -H "X-Auth-Key: $CLOUDFLARE_API_KEY" ``` 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 } } } } ``` ##### 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 } } } } ```