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


Service Principals - Get

Получение субъекта-службы по его дескриптору.

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

Параметры URI

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

string

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

servicePrincipalDescriptor
path True

string

Дескриптор нужного субъекта-службы.

api-version
query True

string

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

Ответы

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

GraphServicePrincipal

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

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

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/serviceprincipals/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz?api-version=7.1-preview.1

Sample Response

{
  "subjectKind": "servicePrincipal",
  "applicationId": "4096aded-4444-4444-9ad0-b25b6b2a2bbe",
  "directoryAlias": "f632cdfd-4444-4444-99ce-6fe0fd007d9d",
  "domain": "62e2ee3f-4444-4444-9b85-4a3776783e13",
  "principalName": "f632cdfd-4444-4444-99ce-6fe0fd007d9d",
  "mailAddress": null,
  "origin": "aad",
  "originId": "f632cdfd-4444-4444-99ce-6fe0fd007d9d",
  "displayName": "ServicePrincipalDisplayName",
  "_links": {
    "self": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz"
    },
    "memberships": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz"
    },
    "membershipState": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz"
    },
    "storageKey": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz"
    },
    "avatar": {
      "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz"
    }
  },
  "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz",
  "descriptor": "aadsp.OTE2ZTY1NmItYTBiNS03ZjNmLTg0YWEtNGViMTVhZjc4ZTYz"
}

Определения

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

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

GraphServicePrincipal

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

ReferenceLinks

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

applicationId

string

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

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