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


Profiles - Get

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

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

Параметры URI

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

string

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

api-version
query True

string

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

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

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token 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

Scopes

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

Примеры

Sample Request

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

Sample Response

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

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

CoreProfileAttribute

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

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

AttributeDescriptor

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

revision

integer

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

timeStamp

string

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

value

string

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

Profile

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

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

AttributesContainer

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

coreAttributes

<string,  CoreProfileAttribute>

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

coreRevision

integer

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

id

string

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

profileState

ProfileState

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

revision

integer

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

timeStamp

string

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

ProfileAttribute

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

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

AttributeDescriptor

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

revision

integer

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

timeStamp

string

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

value

string

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

ProfileState

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

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

string

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

customReadOnly

string

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

readOnly

string

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