Hub 2018.3 Help

Get All Users

Request

GET <REST API URL>/users?fields=string&$skip=int&$top=int&query=string&orderBy=string

Parameter

Description

fields

Optional. Returns only the specified subset of the fields for each User. Use Fields Syntax to define the subset.

$skip

Optional. Lets you set a number of Users to skip before returning the first one.

$top

Optional. Lets you set the maximum number of Users to return.

query

Optional. Lets you specify a search query to filter the returned results. See Query Syntax for the definition of supported logical operations syntax. For the Users, the following fields and tuples are supported:

authName: userSamlName — Users with the given name provided by SAML

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) — Returns a list of users with the specified role assigned in the specified project

access(project: project, with: permission) — Returns a list of users with the specified permission granted in the specified project

access(project: project) — Returns a list of users with any role assigned in the specified project

access(with: role) — Returns a list of users with the specified role assigned in any project

access(with: permission) — Returns a list of users with the specified permission granted in any project

after: instant — Returns a list of users that were created after the specified moment

authEmail: email — Returns a list of users with the specified email in their user details

authJabber: jabber — Returns a list of users with the specified jabber address in their user details

authLogin: userCoreLogin — Returns a list of users with the specified login in their user details

authMethod: authModule — Returns a set of users with user details associated with the specified auth module

authModule: authModule — Users with user details associated with the specified auth module

before: instant — Returns a list of users that were created before the specified moment

email: email — Users with the specified email

group: group — Returns members of the specified group

has: lastAccess — Returns a list of users that logged in at least once

has: ownRole — Returns a list of users with any role that was granted directly

has: group — Returns a list of users that are added to any group explicitly

has: authMethod — Users with some user details

has: email — Users with defined email

has: verifiedEmail — Returns a list of users with verified emails

has: jabber — Returns a list of users that provided a jabber account

has: verifiedJabber — Returns a list of users with verified jabber accounts

has: originService — Returns a list of users with user details that were imported from any service

has: login — Returns a list of users that have login

has: sshPublicKey — Returns a list of users with an SSH public key

has: license — Returns a list of users with any license

has: approved resource — Returns a list of users with approved resources

has: refresh token — Returns a list of users with refresh tokens

has: permanent token — Returns a list of users with created permanent tokens

has: accepted end-user agreement — Returns a list of users that accepted current version of the end-user agreement

hasLicense: service — Returns a list of users with the specified license

hasLicense: value — Returns a list of users with the specified license

id: value — User with the given ID

in: group — Returns a list of users that are members of the specified group or any of its subgroups

in: team — Returns a list of users that are members of the specified project team

is: guest — Returns the guest user

is: banned — Returns a list of banned users

jabber: jabber — Returns a list of users with the specified jabber address

lastAccess(after: instant) — Returns a list of users that logged into Hub after the specified moment

lastAccess(before: instant) — Returns a list of users that logged into Hub before the specified moment

lastAccess(after: instant, before: instant) — Returns a list of users that logged into Hub during the specified period of time

login: userLogin — Returns a list of users with the specified login

name: userName — Returns a list of users with the specified full name

nameStartsWith: value — Returns a list of users with names or logins that start with the specified prefix

originService: service — Returns a list of users with user details that were imported from the specified service

ownRole: role — Returns a list of users with the specified role that was granted directly in any project

sshPublicKey: value — Returns a user with the specified SSH public key

team: team — Returns a list of members of the specified team

vcsUserName: vcsUserName — Returns a list of users with the specified username in a VCS

orderBy

Optional. Returns the list of Users sorted by a specified field. See Sorting Syntax for details. Users support ordering by the following fields: creationTime, lastAccessTime, login, name

Response

Response Code

Meaning

200 OK

Successful request.

400 Bad Request

At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response.

403 Forbidden

The requester has no access to the requested resource.

404 Not Found

The requested resource was not found.

500 Internal Server Error

Failed to process request because of the server error. For details, check the error message in the response.

Response body

{ "skip": int, "top": int, "total": int, "users": [user, ...] }
Last modified: 30 November 2018