Service Principals - List

Ссылка

Service:: Graph

API Version:: 7.1-preview.1

Получение списка всех субъектов-служб в заданной области.

Так как список субъектов-служб может быть большим, результаты возвращаются на страницах субъектов-служб. Если результатов больше, чем может быть возвращено на одной странице, результирующий набор будет содержать маркер продолжения для получения следующего набора результатов. Единственный надежный способ узнать, не осталось ли субъектов-служб больше, — отсутствие маркера продолжения.

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

With optional parameters:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Название организации Azure DevOps.
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.1.
continuationToken	query		string	Непрозрачный большой двоичный объект данных, позволяющий возобновить работу следующей страницы данных сразу после окончания предыдущей страницы. Единственный надежный способ узнать, осталось ли больше данных, — наличие маркера продолжения.
scopeDescriptor	query		string	Укажите нестандартную область (коллекцию, проект) для поиска субъектов-служб.

Ответы

Имя	Тип	Описание
200 OK	GraphServicePrincipal[]	успешная операция Headers X-MS-ContinuationToken: string

Имя

Тип

Описание

200 OK

GraphServicePrincipal[]

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

Headers

X-MS-ContinuationToken: string

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

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

HTTP

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

Sample Response

Status code:: 200

{
  "count": 2,
  "value": [
    {
      "subjectKind": "servicePrincipal",
      "applicationId": "57227acc-068c-4bd0-b122-76af4ca8156d",
      "directoryAlias": "db2b37a2-4d17-4de2-b935-59d43396a001",
      "domain": "62e2ee3f-dbd4-48d8-9b85-4a3776783e13",
      "principalName": "db2b37a2-4d17-4de2-b935-59d43396a001",
      "mailAddress": null,
      "origin": "aad",
      "originId": "db2b37a2-4d17-4de2-b935-59d43396a001",
      "displayName": "ServicePrincipalDisplayName",
      "_links": {
        "self": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx"
        },
        "memberships": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx"
        },
        "membershipState": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx"
        },
        "storageKey": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx"
        },
        "avatar": {
          "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx"
        }
      },
      "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx",
      "descriptor": "aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx"
    },
    {
      "subjectKind": "servicePrincipal",
      "applicationId": "4461fafd-3c00-43b1-9e9a-5c554405a9d3",
      "directoryAlias": "eb8f407c-9b55-4e8a-acab-7416774c5479",
      "domain": "62e2ee3f-dbd4-48d8-9b85-4a3776783e13",
      "principalName": "eb8f407c-9b55-4e8a-acab-7416774c5479",
      "mailAddress": null,
      "origin": "aad",
      "originId": "eb8f407c-9b55-4e8a-acab-7416774c5479",
      "displayName": "ServicePrincipalDispalyName2",
      "_links": {
        "self": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5"
        },
        "memberships": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5"
        },
        "membershipState": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5"
        },
        "storageKey": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5"
        },
        "avatar": {
          "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5"
        }
      },
      "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5",
      "descriptor": "aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5"
    }
  ]
}

Определения

Имя	Описание
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-адрес является полным маршрутом к исходному ресурсу этого субъекта графа.

ReferenceLinks

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

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

Share via