access_users

Creates, updates, deletes, gets or lists an access_users resource.

Overview

Name	access_users
Type	Resource
Id	cloudflare.zero_trust.access_users

Fields

The following fields are returned by SELECT queries:

list_by_account

Get users response

Name	Datatype	Description
id	string	UUID. (example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415)
name	string	The name of the user. (example: Jane Doe)
access_seat	boolean	True if the user has authenticated with Cloudflare Access.
active_device_count	number	The number of active devices registered to the user.
created_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
email	string (email)	The email of the user. (example: jdoe@example.com)
gateway_seat	boolean	True if the user has logged into the WARP client.
last_successful_login	string (date-time)	The time at which the user last successfully logged in. (example: 2020-07-01T05:20:00Z)
seat_uid	string	The unique API identifier for the Zero Trust seat.
uid	string	The unique API identifier for the user.
updated_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_account	select	account_id	name, email, search, page, per_page	Gets a list of users 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.
email	string
name	string
page	integer
per_page	integer
search	string

SELECT examples

list_by_account

Gets a list of users for an account.

SELECT
id,
name,
access_seat,
active_device_count,
created_at,
email,
gateway_seat,
last_successful_login,
seat_uid,
uid,
updated_at
FROM cloudflare.zero_trust.access_users
WHERE account_id = '{{ account_id }}' -- required
AND name = '{{ name }}'
AND email = '{{ email }}'
AND search = '{{ search }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;