roles

Creates, updates, deletes, gets or lists a roles resource.

Overview

Name	roles
Type	Resource
Id	cloudflare.accounts.roles

Fields

The following fields are returned by SELECT queries:

get

Role Details response

Name	Datatype	Description
id	string	Role identifier tag. (example: 3536bcfad5faccb999b47003c79917fb)
name	string	Role name. (example: Account Administrator)
description	string	Description of role's permissions. (example: Administrative access to the entire Account)
permissions	object

list

List Roles response

Name	Datatype	Description
id	string	Role identifier tag. (example: 3536bcfad5faccb999b47003c79917fb)
name	string	Role name. (example: Account Administrator)
description	string	Description of role's permissions. (example: Administrative access to the entire Account)
permissions	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	role_id, account_id		Get information about a specific role for an account.
list	select	account_id	page, per_page	Get all available roles for an account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
role_id	string	The role ID.
page	number
per_page	number

SELECT examples

get

Get information about a specific role for an account.

SELECT
id,
name,
description,
permissions
FROM cloudflare.accounts.roles
WHERE role_id = '{{ role_id }}' -- required
AND account_id = '{{ account_id }}' -- required
;

list

Get all available roles for an account.

SELECT
id,
name,
description,
permissions
FROM cloudflare.accounts.roles
WHERE account_id = '{{ account_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;