External DocumentationTo learn more, visit the Okta documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Query | Finds a user that matches firstName, lastName, and email properties. |
| Return All Pages | Automatically fetch all resources, page by page. |
| Search | Searches for users with a supported filtering expression for most properties based on the SCIM protocol specification. Refer to https://developer.okta.com/docs/reference/core-okta-api/#filter for more information. For example: status eq "ACTIVE", lastUpdated gt "yyyy-MM-dd'T'HH:mm:ss.SSSZ". |
Advanced Parameters
| Parameter | Description |
|---|---|
| After | The numerical cursor to use for pagination. Represents the index of the first item on the next page of results. |
| Filter | Filters users with a supported expression for a subset of properties. Refer to https://developer.okta.com/docs/reference/core-okta-api/#filter for more information. Okta recommends using the search parameter instead. |
| Limit | Specifies the number of results returned (maximum 200 per page). |
| Sort By | Only relevant along with the ‘Search’ parameter. Can be any single property, for example sortBy=profile.lastName. |
| Sort Order | Only relevant along with both the ‘Search’ and the ‘Sort By’ parameter. |
Example Output
[
{
"id": "<string>",
"status": "<string>",
"created": "2001-03-25T23:44:01.441Z",
"activated": "2003-05-11T19:07:15.860Z",
"statusChanged": "2021-02-22T20:15:10.278Z",
"lastLogin": "2020-07-27T06:21:38.869Z",
"lastUpdated": "2023-10-09T00:43:35.331Z",
"passwordChanged": null,
"type": {
"id": "<string>"
},
"profile": {
"zipCode": "<string>",
"managersAMAccountName": "<string>",
"sxmHrpronouns": "<string>",
"workerStatus": "<string>",
"managerName": "<string>",
"employeeNumber": "<string>",
"managerPandoraSalesforceID": "<string>",
"Location_ID": "<string>",
"immutableID": "<string>",
"adUPN": "<string>",
"PreHire_Status": false,
"state": "<string>",
"adLastLogonTimeStamp": "<string>",
"workdayUniversalID": "<string>",
"ad_dn": "<string>",
"physicalDeliveryOfficeName": "<string>",
"costCenter": "<string>",
"managerOfManagerName": "<string>",
"is_manager": "<string>",
"firstName": "<string>",
"primaryPhone": "<string>",
"managerEmployeeID": "<string>",
"Worker_Type": "<string>",
"mobilePhone": null,
"departmentNumber": "<string>",
"unixHomeDirectory": "<string>",
"active_directory_company": "<string>",
"gidNumber": "<string>",
"EmployeeID": "<string>",
"workdayLoginId": "<string>",
"pwdLastSet": "<string>",
"lastName": "<string>",
"userLDAPDN": "<string>",
"jobFamilyGroup": "<string>",
"city": "<string>",
"displayName": "<string>",
"executiveLeader": "<string>",
"managerOfManagerEmail": "<string>",
"provisioningReady": true,
"title": "<string>",
"login": "<string>",
"adUserLogonName": "<string>",
"managerSMTP": "<string>",
"UidNumber": "<string>",
"company": "<string>",
"GL_Entity": "<string>",
"department": "<string>",
"userPrincipalName": "<string>",
"email": "<string>",
"sxmJobLevel": "<string>",
"sxmssoid": "<string>",
"sxmaccounttype": "<string>",
"loginShell": "<string>",
"employeetype": "<string>",
"hireDate": "2014-04-22",
"adCN": "<string>",
"manager": "<string>",
"secondEmail": "<string>",
"managerId": "<string>",
"samaccountname": "<string>",
"streetAddress": "<string>",
"job_family": "<string>",
"managerLDAPDN": "<string>",
"Location": "<string>"
},
"credentials": {
"provider": {
"type": "<string>",
"name": "<string>"
}
},
"_links": {
"self": {
"href": "<string>"
}
}
}
]