Skip to main content

user_blocks

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

Overview​

Nameuser_blocks
TypeResource
Idokta.users.user_blocks

Fields​

The following fields are returned by SELECT queries:

Describes how the account is blocked from access. If appliesTo is ANY_DEVICES, then the account is blocked for all devices. If appliesTo is UNKNOWN_DEVICES, then the account is only blocked for unknown devices.

NameDatatypeDescription
appliesTostringThe devices that the block applies to (ANY_DEVICES, UNKNOWN_DEVICES)
typestringType of access block (DEVICE_BASED)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
list_user_blocksselectid, subdomainLists information about how the user is blocked from accessing their 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.

NameDatatypeDescription
idstringAn ID, login, or login shortname (as long as the shortname is unambiguous) of an existing Okta user
subdomainstring(default: my-org)

SELECT examples​

Lists information about how the user is blocked from accessing their account

SELECT
appliesTo,
type
FROM okta.users.user_blocks
WHERE id = '{{ id }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;