Get Users

description retrieves a list of users from okta identity management, providing an overview of user accounts endpoint url /api/v1/users method get inputs parameters (object) q (string) finds users who match the specified query this doesn't support pagination this might not deliver optimal performance for large orgs, and is deprecated for such use cases to ensure optimal performance, use a search parameter instead use the q parameter for a simple lookup of users by name, for example when creating a people picker the value of q is matched against firstname, lastname, or email this performs a startswith match, but this is an implementation detail and can change without notice you don't need to specify firstname, lastname, or email filter (string) filters users with a supported expression for a subset of properties this requires url encoding for example, filter=lastupdated gt "2013 06 01t00 00 00 000z" is encoded as filter=lastupdated%20gt%20%222013 06 01t00 00 00 000z%22 filtering is case sensitive for attribute names and query values, while attribute operators are case insensitive filtering supports the following limited number of properties status, lastupdated, id, profile login, profile email, profile firstname, and profile lastname additionally, filtering supports only the equal eq operator from the standard okta api filtering semantics, except in the case of the lastupdated property this property can also use the inequality operators (gt, ge, lt, and le) for logical operators, only the logical operators and and or are supported the not operator isn't supported see filtering and operators for more information after (string) specifies the pagination cursor for the next page of groups the after cursor should be treated as an opaque value and obtained through the next link relation limit (number) specifies the number of results returned defaults to 10 if q is provided expand (string) an optional parameter to include metadata in the embedded attribute valid value classification search (string) searches for users with a supported filtering expression for most properties okta recommends using this parameter for search for best performance this operation supports pagination use an id lookup for records that you update to ensure your results contain the latest data property names in the search parameter are case sensitive, whereas operators (eq, sw, and so on) and string values are case insensitive unlike with user logins, diacritical marks are significant in search string values a search for isaac brock finds isaac brock, but doesn't find a property whose value is isáàc bröck this operation requires url encoding for example, search=profile department eq "engineering" is encoded as search=profile department%20eq%20%22engineering%22 sortby (string) specifies field to sort by (for search queries only) this can be any single property, for example sortby=profile lastname users with the same value for the sortby property will be ordered by id sortorder (string) specifies sort order asc or desc (for search queries only) sorting is done in ascii sort order (that is, by ascii character value), but isn't case sensitive sortorder is ignored if sortby is not present headers (object) content type (string) specifies the media type of the resource optional okta response value can be included for performance optimization complex delauth configurations may degrade performance when fetching specific parts of the response, and passing this parameter can omit these parts, bypassing the bottleneck enum values for okta response omitcredentials omits the credentials subobject from the response omitcredentialslinks omits the following hal links from the response change password, change recovery question, forgot password, reset password, reset factors, unlock omittransitioningtostatus omits the transitioningtostatus field from the response output example \[ { "status code" 200, "response headers" { "content length" "140", "content type" "application/json", "date" "wed, 8 jan 2025 20 37 23 gmt" }, "reason" "ok", "json" { "id" "00u118oqyt4tbguay0g4", "status" "active", "created" "2022 04 04t15 56 05 000z", "activated" null, "statuschanged" null, "lastlogin" "2022 05 04t19 50 52 000z", "lastupdated" "2022 05 05t18 15 44 000z", "passwordchanged" "2022 04 04t16 00 22 000z", "type" { "id" "oty1162qar8hjjtaq0g4" }, "profile" { "firstname" "alice", "lastname" "smith", "mobilephone" null, "secondemail" null, "login" "alice smith\@example com", "email" "alice smith\@example com" }, "realmid" "guo1afintsnzyilxo0g4", "credentials" { "password" {}, "provider" { "type" "okta", "name" "okta" } }, " links" { "self" { "href" "http //your subdomain okta com/api/v1/users/00u118oqyt4tbguay0g4" } } } } ] output parameters status code (number) reason (string) json (object) id (string) status (string) created (string) activated (object) statuschanged (object) lastlogin (string) lastupdated (string) passwordchanged (string) type (object) id (string) profile (object) firstname (string) lastname (string) mobilephone (object) secondemail (object) login (string) email (string) realmid (string) credentials (object) password (object) provider (object) type (string) name (string) links (object) self (object) href (string) response headers header type content length string content type string date string