YouTrack Standalone 2017.2 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:

NameTypeDescription
qstringsearch query (part of user login, name or email)
groupstringfilter by group (groupID)
rolestringfilter by role
projectstringfilter by project (projectID)
permissionstringfilter by permission
onlineOnlybooleanget only users which are currently online
startIntegerpaginator mode (takes 10 records)

Sample

Request:

HTTP GET: /admin/user

Response:

<userRefs> <user login="guest" url="http://localhost:8080/charisma/rest/admin/user/guest"/> <user login="newroot" url="http://localhost:8080/charisma/rest/admin/user/newroot"/> <user login="root" url="http://localhost:8080/charisma/rest/admin/user/root"/> </userRefs>

Query Sample

Request:

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

Response:

<userRefs> <user login="chebaturkin" url="http://localhost:8080/charisma/rest/admin/user/chebaturkin"/> <!-- The user account found by the full name: Alexander Chebaturkin --> <user login="alexey.chebotarev" url="http://localhost:8080/charisma/rest/admin/user/alexey.chebotarev"/> <!-- User's login matches the query in the request --> </userRefs>
Last modified: 9 August 2017