Search Users

Tenovos Search. The Search endpoint is used to search the system for users based on matching user profile information.

SecurityOAuth2
Request
path Parameters
searchTerm
required
string [ 2 .. 256 ] characters

The term to search against. When searching for users, can include values such as "disabled", "enabled", "local", a last name, email address, etc.

Example: John Continental
query Parameters
before
string or null [ 12 .. 36 ] characters

The cursor value returned by Tenovos to retrieve the previous page of results. If the before parameter is used, the after parameter cannot be used.

Example: before=196100ac-4ee
after
string or null [ 12 .. 36 ] characters

The cursor value returned by Tenovos to retrieve the next page of results. If the after parameter is used, the before parameter cannot be used.

Example: after=16969100ac-4ef
header Parameters
content-type
string
Example: application/json
Authorization
string
Example: Bearer <token>
Responses
200

Successful Request. Search Results Returned.

400

One or more required parameters are missing or invalid.

401

Authentication failed (unauthorized).

403

Forbidden. You do not have permissions to perform this action, or your connection information is not correct.

503

The server is too busy to handle the request.

get/search/users/{searchTerm}
Request samples
Response samples
application/json
{
  • "users": [
    ],
  • "pagination": {
    }
}