active_sessions

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

Overview

Name	active_sessions
Type	Resource
Id	cloudflare.zero_trust.active_sessions

Fields

The following fields are returned by SELECT queries:

get

Get active session response

Name	Datatype	Description
account_id	string	(example: 1234567890)
device_id	string	(example: )
service_token_id	string	(example: )
common_name	string	(example: )
auth_status	string	(example: NONE)
devicePosture	object
device_sessions	object
email	string	(example: test@cloudflare.com)
geo	object
iat	number
idp	object
ip	string	(example: 127.0.0.0)
isActive	boolean
is_gateway	boolean
is_warp	boolean
mtls_auth	object
service_token_status	boolean
user_uuid	string	(example: 57cf8cf2-f55a-4588-9ac9-f5e41e9f09b4)
version	number

list

Get active sessions response

Name	Datatype	Description
name	string
expiration	integer
metadata	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	user_id, account_id, nonce		Get an active session for a single user.
list	select	user_id, account_id		Get active sessions for a single user.

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.
nonce	string
user_id	string	The user ID.

SELECT examples

get

Get an active session for a single user.

SELECT
account_id,
device_id,
service_token_id,
common_name,
auth_status,
devicePosture,
device_sessions,
email,
geo,
iat,
idp,
ip,
isActive,
is_gateway,
is_warp,
mtls_auth,
service_token_status,
user_uuid,
version
FROM cloudflare.zero_trust.active_sessions
WHERE user_id = '{{ user_id }}' -- required
AND account_id = '{{ account_id }}' -- required
AND nonce = '{{ nonce }}' -- required
;

list

Get active sessions for a single user.

SELECT
name,
expiration,
metadata
FROM cloudflare.zero_trust.active_sessions
WHERE user_id = '{{ user_id }}' -- required
AND account_id = '{{ account_id }}' -- required
;