user_blocks
Creates, updates, deletes, gets or lists a user_blocks resource.
Overview​
| Name | user_blocks |
| Type | Resource |
| Id | okta.users.user_blocks |
Fields​
The following fields are returned by SELECT queries:
- list_user_blocks
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.
| Name | Datatype | Description |
|---|---|---|
appliesTo | string | The devices that the block applies to (ANY_DEVICES, UNKNOWN_DEVICES) |
type | string | Type of access block (DEVICE_BASED) |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list_user_blocks | select | id, subdomain | Lists 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.
| Name | Datatype | Description |
|---|---|---|
id | string | An ID, login, or login shortname (as long as the shortname is unambiguous) of an existing Okta user |
subdomain | string | (default: my-org) |
SELECT examples​
- list_user_blocks
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
;