Поделиться через


Profiles - Get

Возвращает профиль пользователя.

GET https://app.vssps.visualstudio.com/_apis/profile/profiles/{id}?api-version=7.1
GET https://app.vssps.visualstudio.com/_apis/profile/profiles/{id}?details={details}&withAttributes={withAttributes}&partition={partition}&coreAttributes={coreAttributes}&forceRefresh={forceRefresh}&api-version=7.1

Параметры URI

Имя В Обязательно Тип Описание
id
path True

string

Идентификатор целевого профиля пользователя в той же организации или "меня", чтобы получить профиль текущего пользователя, прошедшего проверку подлинности.

api-version
query True

string

Используемая версия API. Для использования этой версии API необходимо задать значение "7.1".

coreAttributes
query

string

Список возвращаемых атрибутов профиля с разделителями-запятыми. Допустимые значения: Email, Аватар, DisplayName и ContactWithOffers.

details
query

boolean

Возвращает сведения о общедоступном профиле, такие как отображаемое имя, адрес электронной почты, страна и т. д. Если значение false, параметр withAttributes игнорируется.

forceRefresh
query

boolean

Не используется в этой версии API.

partition
query

string

Раздел (именованной группы) возвращаемых атрибутов.

withAttributes
query

boolean

Если значение true, возвращает атрибуты (пары "ключ-значение" произвольных данных), связанные с профилем. Параметр секции также должен иметь значение.

Ответы

Имя Тип Описание
200 OK

Profile

успешная операция

Безопасность

oauth2

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL-адрес токена: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Области

Имя Описание
vso.profile Предоставляет возможность читать профиль, учетные записи, коллекции, проекты, команды и другие артефакты организации верхнего уровня.

Примеры

Образец запроса

GET https://app.vssps.visualstudio.com/_apis/profile/profiles/{id}?api-version=7.1

Пример ответа

{
  "displayName": "Normal Paulk",
  "publicAlias": "d6245f20-2af8-44f4-9451-8107cb2767db",
  "emailAddress": "fabrikamfiber16@hotmail.com",
  "coreRevision": 1647,
  "timeStamp": "2014-05-12T22:23:07.727+00:00",
  "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
  "revision": 1647
}

Определения

Имя Описание
AttributeDescriptor

Определяет атрибут с именем и контейнером.

AttributesContainer

Хранит набор именованных атрибутов профиля.

CoreProfileAttribute

Атрибут профиля, который всегда имеет значение для каждого профиля.

Profile

Профиль пользователя.

ProfileAttribute

Именованный объект, связанный с профилем.

ProfileState

Текущее состояние профиля.

AttributeDescriptor

Определяет атрибут с именем и контейнером.

Имя Тип Описание
attributeName

string

Имя атрибута.

containerName

string

Контейнер, в котором находится атрибут.

AttributesContainer

Хранит набор именованных атрибутов профиля.

Имя Тип Описание
attributes

<string,  ProfileAttribute>

Атрибуты, хранящиеся контейнером.

containerName

string

Имя контейнера.

revision

integer (int32)

Максимальное число редакций любого атрибута в контейнере.

CoreProfileAttribute

Атрибут профиля, который всегда имеет значение для каждого профиля.

Имя Тип Описание
descriptor

AttributeDescriptor

Дескриптор атрибута.

revision

integer (int32)

Номер редакции атрибута.

timeStamp

string (date-time)

Время последнего изменения атрибута.

value

string (T)

Значение атрибута.

Profile

Профиль пользователя.

Имя Тип Описание
applicationContainer

AttributesContainer

Атрибуты этого профиля.

coreAttributes

<string,  CoreProfileAttribute>

Основные атрибуты этого профиля.

coreRevision

integer (int32)

Максимальное число редакций любого атрибута.

id

string (uuid)

Уникальный идентификатор профиля.

profileState

ProfileState

Текущее состояние профиля.

revision

integer (int32)

Максимальное число редакций любого атрибута.

timeStamp

string (date-time)

Время последнего изменения этого профиля.

ProfileAttribute

Именованный объект, связанный с профилем.

Имя Тип Описание
descriptor

AttributeDescriptor

Дескриптор атрибута.

revision

integer (int32)

Номер редакции атрибута.

timeStamp

string (date-time)

Время последнего изменения атрибута.

value

string (T)

Значение атрибута.

ProfileState

Текущее состояние профиля.

Значение Описание
custom

Профиль используется.

customReadOnly

Профиль используется, но может быть прочитан только.

readOnly

Профиль может быть прочитан только.