Get All Users of a Setting
Request
GET <REST API URL>/settings/{setting 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 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: userGithubLogin — All users with the given login authName: value — All users with the given login authName: userGoogleName — All users with the given full name googleID: value — All users with the given openID identifier 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 authName: userOpenIDName — All users with the given full name openID: value — All 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 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 after: instant — Users created after specified date authEmail: email — Users with the given email in their credentials authJabber: jabber — Users with the given jabber in their credentials authLogin: userCoreLogin — Users with the given login in their credentials authMethod: authModule — Users with user details associated with the given auth provider authModule: authModule — Users with user details associated with the given auth provider before: instant — Users created before specified date 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 emails 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 hasLicense: service — Users who are licensed to use the given license hasLicense: value — Users who has the given license id: value — A user with the given id in: group — Users that are in the given group or any of its subgroup jabber: jabber — Users with the given jabber 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 login: userLogin — A user with the given login name: userName — A user with the given visible name nameStartsWith: value — Users whose name or login start 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 that has SSH public key with the given fingerprint vcsUserName: vcsUserName — Users with the given VCS user name |
orderBy | Order results. See Sorting Syntax for details. Roles can be ordered by the following fields: login, name, creationTime, lastAccessTime |
Response
Response body
page
{ "skip": int, "top": int, "total": int, "users": [user, ...] }