Read an Okta Users API export
Paste the JSON the Okta Users API returns for its list of users, or drop the file on the paste box. Every user becomes one line: the login, the status, the last login, when the password last changed, the user type and the manager.
What to export
The list of users from the Users API, GET /api/v1/users, with an API token created in the Admin Console and sent as Authorization: SSWS followed by the token. The list leaves out users whose status is DEPROVISIONED; a request with a filter or search returns them, so run the second request below too. The list is paged (limit sets the page size, 200 by default) and the next page is in the response's Link header (rel="next"); paste each page one after another, or a JSON Lines file, or the array inside an object. The same user id on two pages is read once.
curl -s -H "Accept: application/json" -H "Authorization: SSWS $OKTA_API_TOKEN" \
"https://{yourOktaDomain}/api/v1/users?limit=200"
curl -s -H "Accept: application/json" -H "Authorization: SSWS $OKTA_API_TOKEN" \
"https://{yourOktaDomain}/api/v1/users?filter=status%20eq%20%22DEPROVISIONED%22&limit=200"The fields read
| Field in the export | Read as |
|---|---|
profile.login | the account (profile.email when login is missing) |
profile.displayName, profile.firstName, profile.lastName | the display name |
profile.userType | the type: Employee, Contractor, a service account or an AI agent, as your org fills it |
status | enabled: ACTIVE, PASSWORD_EXPIRED, LOCKED_OUT and RECOVERY read as enabled; SUSPENDED and DEPROVISIONED as disabled and set aside; STAGED and PROVISIONED (not yet activated) as status not recorded, so their findings are questions; any other value is said on the line and read as not recorded |
lastLogin | last used, an interactive sign-in field: null reads as never signed in; on a service, agent or automation account the dormancy finding is a question |
passwordChanged | last changed |
created | created |
profile.manager, profile.managerId | the manager, which owns a service, agent or automation account |
statusChanged, activated, lastUpdated, transitioningToStatus | notes |
profile.employeeNumber, profile.department | notes |
id | joins pages of the same user; not shown |
What the Users API export does not carry
- No groups or admin roles. The user list does not include group membership or administrator role assignments, so the privileged finding cannot fire from it; add a
PrivilegedorMember ofcolumn to a CSV if you need it read. - Deprovisioned users only on request. See the second request above.
- The type id, not the type name.
typecarries only the user type's id, so the checker readsprofile.userTypeinstead and names a type from the login when that is blank. - No last review or approval. Those columns are read when a CSV carries them.
The checker reads the JSON in your browser: nothing is uploaded and no connection is made to the system it came from. The JSON is flattened into the same lines a pasted table becomes, so every finding, clause and export works the same. The format name is used to describe the file; the checker is not affiliated with its publisher. Never paste passwords, keys or tokens; the list needs names and dates only.