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


Users - Get

Получение пользователя по его дескриптору.

GET https://vssps.dev.azure.com/{organization}/_apis/graph/users/{userDescriptor}?api-version=7.1-preview.1

Параметры URI

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

string

Название организации Azure DevOps.

userDescriptor
path True

string

Дескриптор нужного пользователя.

api-version
query True

string

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

Ответы

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

GraphUser

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

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

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.graph Предоставляет возможность чтения сведений о пользователях, группах, область и членстве в группах.

Примеры

Sample Request

GET https://vssps.dev.azure.com/{organization}/_apis/graph/users/{userDescriptor}?api-version=7.1-preview.1

Sample Response

{
  "subjectKind": "user",
  "domain": "45aa3d2d-7442-473d-b4d3-3c670da9dd96",
  "principalName": "jtseng@vscsi.us",
  "mailAddress": "jtseng@vscsi.us",
  "origin": "aad",
  "originId": "55c8c7b6-7ace-43bc-918f-304dfa2b6317",
  "displayName": "Jia-hao Tseng",
  "_links": {
    "self": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4"
    },
    "memberships": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4"
    },
    "membershipState": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4"
    },
    "storageKey": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4"
    },
    "avatar": {
      "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4"
    }
  },
  "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4",
  "descriptor": "aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4"
}

Определения

Имя Описание
GraphUser
ReferenceLinks

Класс, представляющий коллекцию ссылок REST.

GraphUser

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

ReferenceLinks

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

descriptor

string

Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях.

directoryAlias

string

Короткое, обычно уникальное имя пользователя в резервном каталоге. Для пользователей AAD это соответствует почтовому псевдониму, который часто, но не обязательно похож на часть почтового адреса пользователя перед знаком @. Для пользователей GitHub это соответствует дескриптору пользователя GitHub.

displayName

string

Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника.

domain

string

Представляет имя контейнера источника для элемента графа. (Для MSA это "Идентификатор Windows Live ID", для AD — имя домена, для AAD — идентификатор клиента каталога, для групп VSTS — ScopeId и т. д.)

isDeletedInOrigin

boolean

Если значение равно true, группа была удалена в поставщике удостоверений.

legacyDescriptor

string

[Только для внутреннего использования] Устаревший дескриптор доступен на случай, если вам потребуется получить доступ к старой версии IMS с помощью дескриптора удостоверения.

mailAddress

string

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

metaType

string

Тип метаданных пользователя в источнике, например "member", "guest" и т. д. Набор возможных значений см. в разделе UserMetaType.

origin

string

Тип поставщика источника для идентификатора источника (например, AD, AAD, MSA).

originId

string

Уникальный идентификатор из системы источника. Обычно это идентификатор sid, идентификатор объекта или guid. Операции связывания и отмены связи могут привести к изменению этого значения для пользователя, так как пользователь не поддерживается другим поставщиком и имеет другой уникальный идентификатор в новом поставщике.

principalName

string

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

subjectKind

string

Это поле определяет тип субъекта графа (например, "Группа", "Область", "Пользователь").

url

string

Этот URL-адрес является полным маршрутом к исходному ресурсу этого субъекта графа.

Класс, представляющий коллекцию ссылок REST.

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

object

Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения.