Developer Portal for YouTrack and Hub Help

Operations with a Specific Set of User Details of a User

This resource lets you work with a specific set of user details.

Resource

<Hub Service URL>/api/rest/users/{userID}/userdetails/{userdetailsID}

Returned entity

Details. For the description of the entity attributes, see Details Attributes.

Supported methods

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 Specific Details of a User

Get a specific set of user details of a user.

Request Syntax

GET <Hub Service URL>/api/rest/users/{userID}/userdetails/{userdetailsID}?{fields}

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.

Sample

Request

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

Response Body

{ "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" } }

Delete Specific Details of a User

Delete a specific set of user details from a user.

Request Syntax

POST <Hub Service URL>/api/rest/users/{userID}/userdetails/{userdetailsID}?fields=string

Request Parameters

Parameter

Type

Description

fields

String

A list of UserDetails attributes that should be returned in the response. If no field is specified, only the entityID is returned.

Sample

Request

https://example.youtrack.cloud/hub/api/rest/users/7a0573d6-a39e-4724-80e7-081acb8d2c99/userdetails/c3236def-af56-4cfb-8e2f-91a453f77bcd
Last modified: 8 February 2024