User Details of a Specific User

This resource provides access to user details of a user.

Resource	<Hub Service URL>/api/rest/users/{userID}/userdetails For details and examples of Hub Service URLs, see Hub REST API URL.
Returned entity	Details. For the description of the entity attributes, see Details Attributes.
Supported methods	`GET`: Read All Details of a User.

Details Attributes

Represents user details of a user.

Attributes

This table describes attributes of the Details entity.

To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.
To update an attribute, provide it in the body of a POST request.

Field	Type	Description
id	String	The unique identifier of the set of credentials associated with the user. `Read-only`.
authModule	authModule	The details about the auth module that this user logs in with.
authModuleName	String	The name of the auth module that this user logs in with.
email	email	The details about the user email and its status.
lastAccessAddress	String	The IP address that this user was accessing YouTrack from.
lastAccessTime	Long	The timestamp when the user account last logged in to the system.
lastAccessUserAgent	String	The user agent that this user was accessing YouTrack with.
user	user	The details about the user.

Read All Details of a User

Get all user details of a specific user.

Request Syntax

                GET <Hub Service URL>/api/rest/users/{userID}/userdetails?{fields}&{$top}&{$skip}&{query}&{orderBy}
            

Request Parameters

Parameter	Type	Description
fields	String	Optional. Returns only the specified subset of the fields for each user. Use Fields Syntax to define the subset.
$skip	Int	Optional. Lets you set a number of returned entities to skip before returning the first one.
$top	Int	Optional. Lets you specify the maximum number of Users that are returned in the response.
query	String	Optional. Lets you specify a search query to filter the returned results. See Query Syntax for the definition of supported logical operations syntax. For the UserDetails fields and tuples, see Hub REST API Reference.

Sample

Request

                    https://example.youtrack.cloud/hub/api/rest/users/7a0673d6-a39e-4724-80e7-081acb8d2c99/userdetails?fields=id,email(verified,email),authModule(name),authModuleName,user(id,login)
                

Response Body

                    {
                          "type": "UserdetailsPage",
                          "skip": 0,
                          "top": 100,
                          "total": 1,
                          "userdetails": [
                              {
                                  "type": "EmailuserdetailsJSON",
                                  "id": "c3236def-af46-4cfb-8e2f-91a453f77bcd",
                                  "email": {
                                      "type": "EmailJSON",
                                      "verified": true,
                                      "email": "william.johnson@example.com"
                                  },
                                  "authModule": {
                                      "type": "CoreauthmoduleJSON",
                                      "name": "Hub"
                                  },
                                  "authModuleName": "Hub",
                                  "user": {
                                      "type": "user",
                                      "id": "7a0673d6-a39e-4724-80e7-081acb8d2c99",
                                      "login": "william.johnson"
                                  }
                              }
                          ]
                      }
                

Last modified: 7 November 2024