Users
Users in an organization.
Table Specific Information
Required Scopes
To query this view, Scope must include okta.users.read. To edit this table, it must include okta.users.manage.
Select
The driver uses the Okta API to process WHERE clause conditions built with the following columns and operators.- Id supports the '>', '>=', '=', '<=', '<', and 'LIKE' operators
- Activated supports the '>', '>=', '=', '<=', and '<' operators
- Created supports the '>', '>=', '=', '<=', and '<' operators
- LastUpdated supports the '>', '>=', '=', '<=', and '<' operators
- ProfileEmail supports the '>', '>=', '=', '<=', '<', and 'LIKE' operators
- ProfileFirstName supports the '>', '>=', '=', '<=', '<', and 'LIKE' operators
- ProfileLastName supports the '>', '>=', '=', '<=', '<', and 'LIKE' operators
- ProfileLogin supports the '>', '>=', '=', '<=', '<', and 'LIKE' operators
- ProfileMobilePhone supports the '>', '>=', '=', '<=', '<', and 'LIKE' operators
- ProfileSecondEmail supports the '>', '>=', '=', '<=', '<', and 'LIKE' operators
- Status supports the '>', '>=', '=', '<=', '<', and 'LIKE' operators
- StatusChanged supports the '>', '>=', '=', '<=', and '<' operators
- TypeId supports the '>', '>=', '=', '<=', '<', and 'LIKE' operators
All other filters are processed client-side within the driver.
For example, the following query is processed server-side:
SELECT * FROM Users WHERE Id = '00uip08mzta1JvWRu5d7'
Insert
At minimum the ProfileFirstName, ProfileLastName, ProfileLogin, and ProfileEmail are required to insert into this table. Note that custom fields can also be inserted.Sample Inserts are given below. For reference, profile_nickname is a custom field.
INSERT INTO Users (ProfileFirstName, ProfileLastName, ProfileLogin, ProfileEmail) VALUES ('Roger', 'Green', '[email protected]', '[email protected]') INSERT INTO Users (ProfileFirstName, ProfileLastName, ProfileLogin, ProfileEmail, profile_nickname) VALUES ('Elizabeth', 'Smith', '[email protected]', '[email protected]', 'Liz')
Update
Only the Profile properties can be updated. Note that custom fields can also be updated.A sample Update is given below. For reference, profile_displayName and profile_city are custom fields.
UPDATE Users SET ProfileLastName = 'Johnson', profile_displayName = null, profile_city = 'Glendale' WHERE Id = '00ukviuouiwlCDXyu5d7'
Delete
If a user has not been deactivated (having a Status of DEPROVISIONED), executing a Delete on that user will set the user's Status to DEPROVISIONED but not delete the user. If a user has a status of DEPROVISIONED, executing a Delete on that user will fully delete the user. Therefore, to fully delete an active user, the Delete must be executed on it twice.A sample Delete is given below.
DELETE FROM Users WHERE Id = '00ukviuouiwlCDXyu5d7'
Columns
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
Id of the user |
Activated | Datetime | True |
When the user was activated |
Created | Datetime | True |
When the user was created |
LastLogin | Datetime | True |
When the user was last logged in |
LastUpdated | Datetime | True |
When the user was last updated |
PasswordChanged | Datetime | True |
When the user last changed their password |
ProfileEmail | String | False |
Email of the profile |
ProfileFirstName | String | False |
First name of the profile |
ProfileLastName | String | False |
Last name of the profile |
ProfileLogin | String | False |
Unique identifier for the user |
ProfileMobilePhone | String | False |
Mobile phone of the profile |
ProfileSecondEmail | String | False |
Secondary email of the profile |
Status | String | True |
Status of the user |
StatusChanged | Datetime | True |
When the user's status was changed |
TypeId | String | False |
Type id |