YouTrack Standalone 2017.3 Help

GET Users

GET /admin/user

Get a list of all available registered users.

GET /rest/admin/user?{q}&{group}&{role}&{project}&{permission}&{onlineOnly}&{start}

Parameters:

Name

Type

Description

q

string

search query (part of user login, name or email)

group

string

filter by group (groupID)

role

string

filter by role

project

string

filter by project (projectID)

permission

string

filter by permission

onlineOnly

boolean

get only users which are currently online

start

Integer

paginator mode (takes 10 records)

Sample

Request:

HTTP GET: /admin/user

Response:

<userRefs> <user login="guest" url="https://example.com/youtrack/rest/admin/user/guest"/> <user login="newroot" url="https://example.com/youtrack/rest/admin/user/newroot"/> <user login="root" url="https://example.com/youtrack/rest/admin/user/root"/> </userRefs>

Query Sample

Request:

HTTP GET: /admin/user/?q=alex*%20Che

Response:

<userRefs> <user login="chebaturkin" url="https://example.com/youtrack/rest/admin/user/chebaturkin"/> <!-- The user account found by the full name: Alexander Chebaturkin --> <user login="alexey.chebotarev" url="https://example.com/youtrack/rest/admin/user/alexey.chebotarev"/> <!-- User's login matches the query in the request --> </userRefs>
Last modified: 7 March 2019