Service Principal Entitlements - Get
Получение права субъекта-службы для субъекта-службы.
GET https://vsaex.dev.azure.com/{organization}/_apis/serviceprincipalentitlements/{servicePrincipalId}?api-version=7.1-preview.1
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
organization
|
path | True |
string |
Название организации Azure DevOps. |
service
|
path | True |
string uuid |
Идентификатор субъекта-службы. |
api-version
|
query | True |
string |
Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.1. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
успешная операция |
Безопасность
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.memberentitlementmanagement | Предоставляет возможность чтения пользователей, их лицензий, а также проектов и расширений, к которые они могут получить доступ. |
Примеры
Sample Request
GET https://vsaex.dev.azure.com/fabrikam/_apis/serviceprincipalentitlements/593F6716-627C-6CCB-833E-77A7F9CA422F?api-version=7.1-preview.1
Sample Response
{
"servicePrincipal": {
"subjectKind": "servicePrincipal",
"applicationId": "d1a24244-f6cc-488b-bca7-42eb10f13c5b",
"metaType": "application",
"directoryAlias": "16ba55b6-4d49-4712-9da8-1de280da5c0a",
"domain": "14c5367e-ee12-4c94-98b8-b52c1fe3cfb1",
"principalName": "16ba55b6-4d49-4712-9da8-1de280da5c0a",
"mailAddress": null,
"origin": "aad",
"originId": "16ba55b6-4d49-4712-9da8-1de280da5c0a",
"displayName": "Service principal",
"_links": {
"self": {
"href": "https://vsaex.dev.azure.com/fabrikam/_apis/Graph/Serviceprincipals/aadsp.ZTM1NTU0YzUtMjg2MC03MWFkLWIzYjAtNzkzNWViMDg1Njg3"
},
"memberships": {
"href": "https://vsaex.dev.azure.com/fabrikam/_apis/Graph/Memberships/aadsp.ZTM1NTU0YzUtMjg2MC03MWFkLWIzYjAtNzkzNWViMDg1Njg3"
},
"membershipState": {
"href": "https://vsaex.dev.azure.com/fabrikam/_apis/Graph/MembershipStates/aadsp.ZTM1NTU0YzUtMjg2MC03MWFkLWIzYjAtNzkzNWViMDg1Njg3"
},
"storageKey": {
"href": "https://vsaex.dev.azure.com/fabrikam/_apis/Graph/StorageKeys/aadsp.ZTM1NTU0YzUtMjg2MC03MWFkLWIzYjAtNzkzNWViMDg1Njg3"
},
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aadsp.ZTM1NTU0YzUtMjg2MC03MWFkLWIzYjAtNzkzNWViMDg1Njg3"
}
},
"url": "https://vsaex.dev.azure.com/fabrikam/_apis/Graph/Serviceprincipals/aadsp.ZTM1NTU0YzUtMjg2MC03MWFkLWIzYjAtNzkzNWViMDg1Njg3",
"descriptor": "aadsp.ZTM1NTU0YzUtMjg2MC03MWFkLWIzYjAtNzkzNWViMDg1Njg3"
},
"id": "593F6716-627C-6CCB-833E-77A7F9CA422F",
"accessLevel": {
"licensingSource": "account",
"accountLicenseType": "stakeholder",
"msdnLicenseType": "none",
"licenseDisplayName": "Stakeholder",
"status": "pending",
"statusMessage": "",
"assignmentSource": "unknown"
},
"lastAccessedDate": "0001-01-01T08:00:00Z",
"dateCreated": "0001-01-01T08:00:00Z",
"projectEntitlements": [
{
"projectRef": {
"id": "c944c983-e90b-4499-938a-5897ea954ace",
"name": "TestProject"
},
"group": {
"groupType": "projectAdministrator",
"displayName": "Project Administrators"
},
"projectPermissionInherited": "notInherited",
"teamRefs": [],
"assignmentSource": "unknown"
}
],
"extensions": [],
"groupAssignments": []
}
Определения
Имя | Описание |
---|---|
Access |
Лицензия, назначенная пользователю |
Account |
Тип лицензии учетной записи (например, Express, заинтересованные лица и т. д.). Чтобы использовать AccountLicenseType, LicensingSource должен быть определен как account в тексте запроса. |
Account |
Состояние пользователя в учетной записи |
Assignment |
Источник назначения лицензии (например, Group, Unknown и т. д. |
Graph |
Сущность группы Graph |
Graph |
|
Graph |
|
Group |
Группа проекта (например, участник, читатель и т. д.) |
Group |
Сущность группы с дополнительными свойствами, включая лицензию, расширения и членство в проекте. |
Group |
Состояние правила группы. |
Group |
Тип группы |
Licensing |
Источник лицензирования (например, учетная запись. MSDN и т. д.) |
Msdn |
Тип лицензии MSDN (например, Visual Studio Professional, Visual Studio Enterprise и т. д.). Чтобы использовать msdnLicenseType, LicensingSource должен быть определен как msdn в тексте запроса. |
Project |
Связь между проектом и действующими разрешениями пользователя в этом проекте. |
Project |
Наследует ли пользователь разрешения для проекта через членство в группе Azure DevOps или AAD. |
Project |
Ссылка на проект |
Reference |
Класс, представляющий коллекцию ссылок REST. |
Service |
|
Team |
Ссылка на команду |
User |
Сущность пользователя с дополнительными свойствами, включая лицензию, расширения и членство в проекте. |
AccessLevel
Лицензия, назначенная пользователю
Имя | Тип | Описание |
---|---|---|
accountLicenseType |
Тип лицензии учетной записи (например, Express, заинтересованные лица и т. д.). Чтобы использовать AccountLicenseType, LicensingSource должен быть определен как account в тексте запроса. |
|
assignmentSource |
Источник назначения лицензии (например, Group, Unknown и т. д. |
|
licenseDisplayName |
string |
Отображаемое имя лицензии |
licensingSource |
Источник лицензирования (например, учетная запись. MSDN и т. д.) |
|
msdnLicenseType |
Тип лицензии MSDN (например, Visual Studio Professional, Visual Studio Enterprise и т. д.). Чтобы использовать msdnLicenseType, LicensingSource должен быть определен как msdn в тексте запроса. |
|
status |
Состояние пользователя в учетной записи |
|
statusMessage |
string |
Сообщение о состоянии. |
AccountLicenseType
Тип лицензии учетной записи (например, Express, заинтересованные лица и т. д.). Чтобы использовать AccountLicenseType, LicensingSource должен быть определен как account в тексте запроса.
Имя | Тип | Описание |
---|---|---|
advanced |
string |
|
earlyAdopter |
string |
|
express |
string |
|
none |
string |
|
professional |
string |
|
stakeholder |
string |
AccountUserStatus
Состояние пользователя в учетной записи
Имя | Тип | Описание |
---|---|---|
active |
string |
Пользователь выполнил хотя бы один вход в учетную запись VSTS. |
deleted |
string |
Пользователь удаляется из учетной записи VSTS администратором учетной записи VSTS |
disabled |
string |
Пользователь не может войти в систему; в основном используется администратором для временного удаления пользователя из-за отсутствия или перераспределения лицензий |
expired |
string |
Пользователь может выполнять вход; в основном используется, когда срок действия лицензии истек, и мы предоставляем льготный период |
none |
string |
|
pending |
string |
Пользователь может присоединиться к учетной записи VSTS администратором учетной записи VSTS, но еще не зарегистрировался или не выполнил вход. |
pendingDisabled |
string |
Пользователь отключен; если они повторно вошли, они по-прежнему будут находиться в состоянии Ожидание |
AssignmentSource
Источник назначения лицензии (например, Group, Unknown и т. д.
Имя | Тип | Описание |
---|---|---|
groupRule |
string |
|
none |
string |
|
unknown |
string |
GraphGroup
Сущность группы Graph
Имя | Тип | Описание |
---|---|---|
_links |
Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа. |
|
description |
string |
Короткая фраза, чтобы помочь читателям-людьми неоднозначно определить группы с похожими именами |
descriptor |
string |
Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях. |
displayName |
string |
Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника. |
domain |
string |
Представляет имя контейнера источника для элемента графа. (Для MSA это "Идентификатор Windows Live ID", для AD — имя домена, для AAD — идентификатор клиента каталога, для групп VSTS — ScopeId и т. д.) |
legacyDescriptor |
string |
[Только для внутреннего использования] Устаревший дескриптор доступен на случай, если вам потребуется получить доступ к IMS старой версии с помощью дескриптора удостоверений. |
mailAddress |
string |
Адрес электронной почты записи для данного элемента графа. Это может отличаться от имени субъекта. |
origin |
string |
Тип поставщика источника для идентификатора источника (например, AD, AAD, MSA). |
originId |
string |
Уникальный идентификатор из системы источника. Обычно это идентификатор sid, идентификатор объекта или guid. Операции связывания и отмены связи могут привести к изменению этого значения для пользователя, так как пользователь не поддерживается другим поставщиком и имеет другой уникальный идентификатор в новом поставщике. |
principalName |
string |
Это principalName этого элемента графа от поставщика источника. Поставщик источника может изменить это поле с течением времени, и VSTS не гарантирует, что оно будет неизменяемым в течение срока существования члена графа. |
subjectKind |
string |
Это поле определяет тип субъекта графа (например, "Группа", "Область", "Пользователь"). |
url |
string |
Этот URL-адрес представляет собой полный маршрут к исходному ресурсу этого субъекта графа. |
GraphServicePrincipal
Имя | Тип | Описание |
---|---|---|
_links |
Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа. |
|
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-адрес представляет собой полный маршрут к исходному ресурсу этого субъекта графа. |
GraphUser
Имя | Тип | Описание |
---|---|---|
_links |
Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа. |
|
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-адрес является полным маршрутом к исходному ресурсу этого субъекта графа. |
Group
Группа проекта (например, участник, читатель и т. д.)
Имя | Тип | Описание |
---|---|---|
displayName |
string |
Отображаемое имя группы |
groupType |
Тип группы |
GroupEntitlement
Сущность группы с дополнительными свойствами, включая лицензию, расширения и членство в проекте.
Имя | Тип | Описание |
---|---|---|
group |
Ссылка на член. |
|
id |
string |
Уникальный идентификатор, соответствующий идентификатору GraphMember. |
lastExecuted |
string |
[Только для чтения] Время последнего выполнения правила лицензирования группы (независимо от того, были ли внесены какие-либо изменения). |
licenseRule |
Правило лицензии. |
|
members |
Участники группы. Используется только при создании новой группы. |
|
projectEntitlements |
Связь между проектом и действующими разрешениями участника в этом проекте. |
|
status |
Состояние правила группы. |
GroupLicensingRuleStatus
Состояние правила группы.
Имя | Тип | Описание |
---|---|---|
applied |
string |
Применяется правило |
applyPending |
string |
Правило создано или обновлено, но применение ожидается |
incompatible |
string |
Правило группы было несовместимо |
unableToApply |
string |
Правило не удалось применить неожиданно, и его следует повторить |
GroupType
Тип группы
Имя | Тип | Описание |
---|---|---|
custom |
string |
|
projectAdministrator |
string |
|
projectContributor |
string |
|
projectReader |
string |
|
projectStakeholder |
string |
LicensingSource
Источник лицензирования (например, учетная запись. MSDN и т. д.)
Имя | Тип | Описание |
---|---|---|
account |
string |
|
auto |
string |
|
msdn |
string |
|
none |
string |
|
profile |
string |
|
trial |
string |
MsdnLicenseType
Тип лицензии MSDN (например, Visual Studio Professional, Visual Studio Enterprise и т. д.). Чтобы использовать msdnLicenseType, LicensingSource должен быть определен как msdn в тексте запроса.
Имя | Тип | Описание |
---|---|---|
eligible |
string |
|
enterprise |
string |
|
none |
string |
|
platforms |
string |
|
premium |
string |
|
professional |
string |
|
testProfessional |
string |
|
ultimate |
string |
ProjectEntitlement
Связь между проектом и действующими разрешениями пользователя в этом проекте.
Имя | Тип | Описание |
---|---|---|
assignmentSource |
Источник назначения (например, групповая или неизвестная). |
|
group |
Группа проектов (например, участник, читатель и т. д.) |
|
projectPermissionInherited |
Наследует ли пользователь разрешения для проекта через членство в группе Azure DevOps или AAD. |
|
projectRef |
Ссылка на project |
|
teamRefs |
Team |
Ссылка на команду |
ProjectPermissionInherited
Наследует ли пользователь разрешения для проекта через членство в группе Azure DevOps или AAD.
Имя | Тип | Описание |
---|---|---|
inherited |
string |
|
notInherited |
string |
|
notSet |
string |
ProjectRef
Ссылка на проект
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор проекта. |
name |
string |
Имя проекта. |
ReferenceLinks
Класс, представляющий коллекцию ссылок REST.
Имя | Тип | Описание |
---|---|---|
links |
object |
Представление ссылок только для чтения. Так как ссылочные ссылки доступны только для чтения, мы хотим предоставить их только для чтения. |
ServicePrincipalEntitlement
Имя | Тип | Описание |
---|---|---|
accessLevel |
Уровень доступа участника, обозначаемый лицензией. |
|
dateCreated |
string |
[Только для чтения] Дата добавления члена в коллекцию. |
groupAssignments |
[Только для чтения] GroupEntitlements, к которому принадлежит этот элемент. |
|
id |
string |
Уникальный идентификатор, соответствующий идентификатору идентификатора, связанного с GraphMember. |
lastAccessedDate |
string |
[Только для чтения] Дата последнего доступа участника к коллекции. |
projectEntitlements |
Связь между проектом и действующими разрешениями участника в этом проекте. |
|
servicePrincipal |
Справочник по ServicePrincipal. |
TeamRef
Ссылка на команду
Имя | Тип | Описание |
---|---|---|
id |
string |
Идентификатор команды |
name |
string |
Имя команды |
UserEntitlement
Сущность пользователя с дополнительными свойствами, включая лицензию, расширения и членство в проекте.
Имя | Тип | Описание |
---|---|---|
accessLevel |
Уровень доступа участника, обозначаемый лицензией. |
|
dateCreated |
string |
[Только для чтения] Дата добавления члена в коллекцию. |
groupAssignments |
[Только для чтения] GroupEntitlements, к которому принадлежит этот элемент. |
|
id |
string |
Уникальный идентификатор, соответствующий идентификатору идентификатора, связанного с GraphMember. |
lastAccessedDate |
string |
[Только для чтения] Дата последнего доступа члена к коллекции. |
projectEntitlements |
Связь между проектом и действующими разрешениями участника в этом проекте. |
|
user |
Справочник пользователя. |
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по