Getting information about users
This request enables you to get information about the accounts of users registered in the organization. The request result is paginated.
GET
https://api.tracker.yandex.net/v3/users
Query format
Before making a request, get permission to access the API.
To get information about users in the organization, use an HTTP GET
request:
GET /v3/users
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
Headers
-
Host
: Address of the node that provides the API. -
Authorization
: Authorization token about these formats:-
OAuth <OAuth_token>
: For authorization using the OAuth 2.0 protocol. Learn more -
Bearer <IAM_token>
: For authorization using an IAM token, if a Yandex Cloud Organization organization is linked to Tracker. Learn more
-
-
X-Org-ID
orX-Cloud-Org-ID
: Organization ID.-
Use the
X-Org-ID
header if a Tracker organization is linked to Yandex 360 for Business. -
Use the
X-Cloud-Org-ID
header if a Tracker organization is linked to Yandex Cloud Organization.
To get the organization ID, go to Administration → Organizations and copy the value from the ID field.
-
Response format
If the request is successful, the API returns a response with code 200 OK
.
The response body contains a JSON array with the user parameters.
[
{
"self": "https://api.tracker.yandex.net/v3/users/12********",
"uid": 12********,
"login": "<user_login>",
"trackerUid": 12********,
"passportUid": 12********,
"cloudUid": "bfbdrb1aa248********",
"firstName": "<first_name>",
"lastName": "<last_name>",
"display": "<displayed_name>",
"email": "<email>",
"external": false,
"hasLicense": true,
"dismissed": false,
"useNewFilters": true,
"disableNotifications": false,
"firstLoginDate": "2019-08-22T14:56:57.981+0000",
"lastLoginDate": "2022-06-22T17:44:32.981+0000",
"welcomeMailSent": true
},
...
]
Response parameters
Starting October 1, 2023, the default user ID type changed from passportUid
to uid
. We recommend that you clearly specify the user ID type when performing integration.
Parameter | Description | Data type |
---|---|---|
self | Address of the API resource with information about the user account. | String |
uid | Unique ID of the user Tracker account. | Number |
login | User's login. | String |
trackerUid | Unique ID of the user Tracker account. | Number |
passportUid | Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID | Number |
cloudUid | Unique user ID in Yandex Cloud Organization | String |
firstName | Username | String |
lastName | User's last name. | String |
display | Displayed user name | String |
User email address. | String | |
external | Service parameter | Boolean |
hasLicense | Flag indicating whether the user has full access to Tracker:
|
Boolean |
dismissed | User status in the organization:
|
Boolean |
useNewFilters | Service parameter | Boolean |
disableNotifications | Flag indicating whether user notifications are forced disabled:
|
Boolean |
firstLoginDate | Date and time of the user's first authentication, in the YYYY-MM-DDThh:mm:ss.sss±hhmm format. |
String |
lastLoginDate | Date and time of the user's last authentication, in the YYYY-MM-DDThh:mm:ss.sss±hhmm format. |
String |
welcomeMailSent | Method of adding a user:
|
Logical |
- 401
- The user is not authorized. Make sure that actions described in the API access section are performed.
- 403
- You are not authorized to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.