Get All Users
Request
GET <REST API URL>
/users?fields=string
&$skip=int
&$top=int
&query=string
&orderBy=string
Parameter | Description |
---|---|
fields | Optional query parameter. Specifies a subset of the fields to be returned. Use Fields Syntax to define subset. |
$skip | Optional query parameter. Number of roles to skip before returning first entry of the page. |
$top | Optional query parameter. Max number of roles to return in the page. |
query | Filter query. See Query Syntax for the definition of supported logical operations syntax. Following fields and tuples are supported for Users: authLogin: userJBALogin — Users with the given JetBrains account login authName: userGoogleName — Users with the given name provided by Google googleID: value — Users with the given Google identifier authLogin: userGithubLogin — Users with the given GitHub login authName: value — Users with the given name provided by GitHub authLogin: userJiraLogin — Users with the given Jira login authName: userJiraName — Users with the given name provided by JetBrains account authLogin: userLdapLogin — Users with the given LDAP user ID authName: value — Users with the given name provided by LDAP authName: userOpenIDName — Users with the given name provided by OpenID openID: value — Users with the given OpenID identifier access(project: project, with: role) — Users who have the given role in the given project access(project: project, with: permission) — Users who have the given permission in the given project access(project: project) — Users who have some role in the given project access(with: role) — Users who have the given role in some projects access(with: permission) — Users who have the given permission in some projects after: instant — Users registered after the given moment authEmail: email — Users with the given email in their user details authJabber: jabber — Users with the given jabber address in their user details authLogin: userCoreLogin — Users with the given login in their user details authMethod: authModule — Users with user details associated with the given auth module authModule: authModule — Users with user details associated with the given auth module before: instant — Users registered before the given moment email: email — Users with the given email group: group — Users that are in the given group has: lastAccess — Users that have logged in has: ownRole — Users with own roles has: group — Users that are added to some group explicitly has: authMethod — Users with some user details has: email — Users with defined email has: verifiedEmail — Users with verified emails has: jabber — Users with defined jabber has: verifiedJabber — Users with verified jabbers has: originService — Users with user details that were imported from some service has: login — Users that have login has: sshPublicKey — Users that have SSH public key has: license — Users who have any license has: approved resource — Users with approved resources has: refresh token — User who has emitted refresh tokens has: permanent token — User who has emitted permanent tokens hasLicense: service — Users who have a license for the given service hasLicense: value — Users who are licensed to use the given license id: value — User with the given ID in: group — Users that are in the given group or any of its subgroup in: team — Users that are members of the given project team jabber: jabber — Users with the given jabber address lastAccess(after: instant) — Users who logged into Hub after the given moment lastAccess(before: instant) — Users who logged into Hub before the given moment lastAccess(after: instant, before: instant) — Users who logged into Hub during the given period of time login: userLogin — Users with the given login name: userName — Users with the given full name nameStartsWith: value — Users whose names or logins are starting with the given prefix originService: service — Users with user details that were imported from the given service ownRole: role — Users who owns the given role in some project sshPublicKey: value — User with the given SSH public key team: team — Users who are members of the given team vcsUserName: vcsUserName — Users with the given username in VCS |
orderBy | Order results. See Sorting Syntax for details. Roles can be ordered by the following fields: creationTime, lastAccessTime, login, name |
Response
Response Code | Meaning |
---|---|
200 OK | Successful request. |
400 Bad Request | Some of the parameters of the request are invalid (for example, required fields in the passed JSON object are missing). The response contains message describing the error. |
403 Forbidden | Requester has no access to the request. |
404 Not Found | Requested resource wasn't found. |
500 Internal Server Error | Failed to process request because of the server error. The response contains message describing the error. |