Sign in

v1

latestOpenAPI 3.0.02026-07-135965404.0 KB
Users

Get a list of users

Get a list of the users in your account. There are three main types of searches you can do with this method:

  1. Search for a user by username. If you provide the username parameter in your call, then only the user who exactly matches that username will be in the list of matches. Any other parameters are ignored.
  2. Search for a user by individual filter fields (nickname,email,role,status,homeDir). Users in the list will be ones who match all of the filters you choose to search by. For example, you could look for users with the "admin" role AND email addresses ending in "*@acme.com".
  3. Search for a user by search string. If you provide the search parameter, users whose nickname OR email OR role OR homeDir match value your provide.

Notes:

  • You must be an admin-level user to use this.
  • The homeDir is the full path to the user's home directory, not a resource ID or hash.
get/users

Query parameters

usernamestring

The username of the user you are looking for. Only entries with the same username as this will be in the list of results. Does not support wildcard searches.

homeResourcestring

Resource identifier for user's home directory. Does not support wildcard searches.

nicknamestring

Nickname to search for. Ignored if username is provided. Supports wildcard searches.

emailstring
Example:*@example.co

Email to search for. Ignored if username is provided. Supports wildcard searches

rolestring
Example:use

Types of users to include the list. Ignored if username is provided. Valid options are admin, master and user

statusinteger

Whether a user is locked. Ignored if username is provided. 0 means user is locked, 1 means user is not locked.

searchstring

Searches the nickname, email, role and homeDir fields for the provided value. Ignored if username is provided. Supports wildcard searches.

offsetinteger

Starting user record in the result set. Can be used for pagination.

sortstring
Example:homeDir,-modified

Sort order or matching users. You can sort by multiple columns by separating sort options with a comma; the sort will be applied in the order specified. The sort order for each sort field is ascending unless it is prefixed with a minus (“-“), in which case it will be descending.

Valid sort fields are: nickname, username, email, homeDir and modified

limitinteger

Number of users to return. Can be used for pagination.

includestring

Comma separated list of relationships to include in response. Valid options are homeResource and ownerAccount.

Headers

ev-api-keystring required

API key required to make the API call.

ev-access-tokenstring required

Access token required to make the API call.

Response

Successful Operation

responseStatusinteger

Http status code of the response.

totalResultsinteger

Total results found.

returnedResultsinteger

Number of results returned.