Hub 2.0 Help

Get All Users of a User Group

Request

GET /usergroups/{user group id}/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 the subset.
$skip Optional query parameter. Number of users to skip before returning the first entry in the page.
$top Optional query parameter. Maximum number of users 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: userGithubLogin — All users with the given login

authName: value — All users with the given login

googleID: value — All users with the given openID identifier

authName: userGoogleName — All users with the given full name

authLogin: userJBALogin — All users with the given login

authLogin: userJiraLogin — All users with the given login

authName: userJiraName — All users with the given full name

authLogin: userLdapLogin — All users with the given login

authName: value — All users with the given login

openID: value — All users with the given openID identifier

authName: userOpenIDName — All users with the given full name

id: value — A user with the given id

name: userName — A user with the given visible name

login: userLogin — A user with the given login

after: instant — Users created after specified date

before: instant — Users created before specified date

lastAccess(after: instant) — Users with ranged last access

lastAccess(before: instant) — Users with ranged last access

lastAccess(after: instant, before: instant) — Users with ranged last access

has: lastAccess — Users that have logged in

vcsUserName: vcsUserName — Users with the given VCS user name

ownRole: role — Users who owns the given role in some project

has: ownRole — Users with own roles

in: group — Users that are in the given group or any of its subgroup

group: group — Users that are in the given group

has: group — Users that are added to some group explicitly

is: guest — The guest user

is: banned — Banned users

authMethod: authModule — Users with user details associated with the given auth provider

authModule: authModule — Users with user details associated with the given auth provider

has: authMethod — Users with some user details

email: email — Users with the given email

has: email — Users with defined email

jabber: jabber — Users with the given jabber

has: jabber — Users with defined jabber

originService: service — Users with user details that were imported from the given service

has: originService — Users with user details that were imported from some service

authLogin: userCoreLogin — Users with the given login

has: login — Users that have login

sshPublicKey: value — User that has SSH public key with the given fingerprint

has: sshPublicKey — Users that have SSH public key

nameStartsWith: value — Users whose name start with the given prefix

loginStartsWith: value — Users whose login start with the given prefix

has: license — Users who have any license

hasLicense: service — Users who are licensed to use the given license

hasLicense: value — Users who has the given license

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 the any role in the given project

access(with: role) — Users who have the given role in some project

access(with: permission) — Users who have the given permission in some project

has: refresh token — User who has emitted refresh tokens

has: approved resource — Users with approved resources

orderBy Order results. See Sorting Syntax for details. Users can be ordered by the following fields: login, name, creationTime, lastAccessTime

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.

Response body

page

{ "skip": int, /* Requested number of users to skip before returning the first entry in the page */ "top": int, /* Requested maximum number of users to return in the page */ "total": int, /* Total number of users. Returned only if the total field is included as a value of the fields parameter in the query */ "users": [user, ...] }
Last modified: 19 September 2016