Service Principal Entitlements - Update Service Principal Entitlements
Измените права (лицензии, расширения, проекты, Teams и т. д.) для одного или нескольких субъектов-служб.
PATCH https://vsaex.dev.azure.com/{organization}/_apis/serviceprincipalentitlements?api-version=7.1-preview.1
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
organization
|
path | True |
string |
Название организации Azure DevOps. |
api-version
|
query | True |
string |
Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.1. |
Текст запроса
Media Types: "application/json-patch+json"
Имя | Тип | Описание |
---|---|---|
from |
string |
Путь для копирования для операции перемещения или копирования. |
op |
Операция исправления |
|
path |
string |
Путь к операции. В случае массива можно использовать отсчитываемый от нуля индекс для указания позиции в массиве (например, /biscuits/0/name). Символ "-" можно использовать вместо индекса для вставки в конец массива (например, /biscuits/-). |
value |
object |
Значение для операции. Это либо примитив, либо JToken. |
Ответы
Имя | Тип | Описание |
---|---|---|
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_write | Предоставляет возможность управлять пользователями, их лицензиями, а также проектами и расширениями, к которым они могут получить доступ. |
Примеры
Sample Request
PATCH https://vsaex.dev.azure.com/{organization}/_apis/serviceprincipalentitlements?api-version=7.1-preview.1
[
{
"from": "",
"op": "replace",
"path": "/ed82811a-0890-6f7f-813e-69dd9ebd5ba3/accessLevel",
"value": {
"accountLicenseType": "express",
"licensingSource": "account"
}
},
{
"from": "",
"op": "remove",
"path": "/ed82811a-0890-6f7f-813e-69dd9ebd5ba3/projectEntitlements/fca61097-56a1-464f-85ba-1b126cf02cd1",
"value": ""
},
{
"from": "",
"op": "add",
"path": "/ed82811a-0890-6f7f-813e-69dd9ebd5ba3/projectEntitlements/6fa35aad-6755-4dd7-8c69-e13f702af0f9",
"value": {
"group": {
"groupType": "projectAdministrator"
},
"projectRef": {
"id": "6fa35aad-6755-4dd7-8c69-e13f702af0f9"
}
}
},
{
"from": "",
"op": "add",
"path": "",
"value": {
"accessLevel": {
"accountLicenseType": "stakeholder"
},
"projectEntitlements": [
{
"group": {
"groupType": "projectAdministrator"
},
"projectRef": {
"id": "fca61097-56a1-464f-85ba-1b126cf02cd1"
}
}
],
"servicePrincipal": {
"origin": "aad",
"originId": "00ed1ce5-4257-4bbd-946e-1b57718e203e",
"subjectKind": "servicePrincipal"
}
}
}
]
Sample Response
{
"id": "cba1141f-6471-437e-8c6c-79a08813f247",
"status": "succeeded",
"haveResultsSucceeded": true,
"completed": true,
"results": [
{
"servicePrincipalId": "ed82811a-0890-6f7f-813e-69dd9ebd5ba3",
"isSuccess": true,
"errors": [],
"result": {
"servicePrincipal": {
"subjectKind": "servicePrincipal",
"applicationId": "d1a24244-f6cc-488b-bca7-42eb10f13c5b",
"metaType": "application",
"directoryAlias": "00ed1ce5-4257-4bbd-946e-1b57718e203e",
"domain": "faab4a73-0db3-4a5e-8e8a-02188f1d3f4b",
"principalName": "00ed1ce5-4257-4bbd-946e-1b57718e203e",
"mailAddress": null,
"origin": "aad",
"originId": "00ed1ce5-4257-4bbd-946e-1b57718e203e",
"displayName": "Service principal",
"_links": {
"self": {
"href": "https://vssps.dev.azure.com/fabrikam/_apis/Graph/ServicePrincipals/aadsp.ZWQ4MjgxMWEtMDg5MC03ZjdmLTgxM2UtNjlkZDllYmQ1YmEz"
},
"memberships": {
"href": "https://vssps.dev.azure.com/fabrikam/_apis/Graph/Memberships/aadsp.ZWQ4MjgxMWEtMDg5MC03ZjdmLTgxM2UtNjlkZDllYmQ1YmEz"
},
"membershipState": {
"href": "https://vssps.dev.azure.com/fabrikam/_apis/Graph/MembershipStates/aadsp.ZWQ4MjgxMWEtMDg5MC03ZjdmLTgxM2UtNjlkZDllYmQ1YmEz"
},
"storageKey": {
"href": "https://vssps.dev.azure.com/fabrikam/_apis/Graph/StorageKeys/aadsp.ZWQ4MjgxMWEtMDg5MC03ZjdmLTgxM2UtNjlkZDllYmQ1YmEz"
},
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aadsp.ZWQ4MjgxMWEtMDg5MC03ZjdmLTgxM2UtNjlkZDllYmQ1YmEz"
}
},
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Graph/ServicePrincipals/aadsp.ZWQ4MjgxMWEtMDg5MC03ZjdmLTgxM2UtNjlkZDllYmQ1YmEz",
"descriptor": "aadsp.ZWQ4MjgxMWEtMDg5MC03ZjdmLTgxM2UtNjlkZDllYmQ1YmEz"
},
"id": "ed82811a-0890-6f7f-813e-69dd9ebd5ba3",
"accessLevel": {
"licensingSource": "account",
"accountLicenseType": "earlyAdopter",
"msdnLicenseType": "none",
"licenseDisplayName": "Early Adopter",
"status": "pending",
"statusMessage": "",
"assignmentSource": "unknown"
},
"lastAccessedDate": "0001-01-01T00:00:00",
"dateCreated": "0001-01-01T00:00:00",
"projectEntitlements": null,
"groupAssignments": null
}
},
{
"servicePrincipalId": "ed82811a-0890-6f7f-813e-69dd9ebd5ba3",
"isSuccess": true,
"errors": [],
"result": null
},
{
"servicePrincipalId": "ed82811a-0890-6f7f-813e-69dd9ebd5ba3",
"isSuccess": true,
"errors": [],
"result": null
},
{
"servicePrincipalId": "ed82811a-0890-6f7f-813e-69dd9ebd5ba3",
"isSuccess": true,
"errors": [],
"result": {
"servicePrincipal": {
"subjectKind": "servicePrincipal",
"applicationId": "d1a24244-f6cc-488b-bca7-42eb10f13c5b",
"metaType": "application",
"directoryAlias": "00ed1ce5-4257-4bbd-946e-1b57718e203e",
"domain": "faab4a73-0db3-4a5e-8e8a-02188f1d3f4b",
"principalName": "d1a24244-f6cc-488b-bca7-42eb10f13c5b",
"mailAddress": null,
"origin": "aad",
"originId": "00ed1ce5-4257-4bbd-946e-1b57718e203e",
"displayName": "Service principal",
"_links": {
"self": {
"href": "https://vssps.dev.azure.com/fabrikam/_apis/Graph/ServicePrincipals/aadsp.ZWQ4MjgxMWEtMDg5MC03ZjdmLTgxM2UtNjlkZDllYmQ1YmEz"
},
"memberships": {
"href": "https://vssps.dev.azure.com/fabrikam/_apis/Graph/Memberships/aadsp.ZWQ4MjgxMWEtMDg5MC03ZjdmLTgxM2UtNjlkZDllYmQ1YmEz"
},
"membershipState": {
"href": "https://vssps.dev.azure.com/fabrikam/_apis/Graph/MembershipStates/aadsp.ZWQ4MjgxMWEtMDg5MC03ZjdmLTgxM2UtNjlkZDllYmQ1YmEz"
},
"storageKey": {
"href": "https://vssps.dev.azure.com/fabrikam/_apis/Graph/StorageKeys/aadsp.ZWQ4MjgxMWEtMDg5MC03ZjdmLTgxM2UtNjlkZDllYmQ1YmEz"
},
"avatar": {
"href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/aadsp.ZWQ4MjgxMWEtMDg5MC03ZjdmLTgxM2UtNjlkZDllYmQ1YmEz"
}
},
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Graph/ServicePrincipals/aadsp.ZWQ4MjgxMWEtMDg5MC03ZjdmLTgxM2UtNjlkZDllYmQ1YmEz",
"descriptor": "aadsp.ZWQ4MjgxMWEtMDg5MC03ZjdmLTgxM2UtNjlkZDllYmQ1YmEz"
},
"id": "ed82811a-0890-6f7f-813e-69dd9ebd5ba3",
"accessLevel": {
"licensingSource": "account",
"accountLicenseType": "earlyAdopter",
"msdnLicenseType": "none",
"licenseDisplayName": "Early Adopter",
"status": "pending",
"statusMessage": "",
"assignmentSource": "unknown"
},
"lastAccessedDate": "0001-01-01T00:00:00Z",
"dateCreated": "2023-02-08T12:30:21.5692042Z",
"projectEntitlements": [],
"groupAssignments": []
}
}
]
}
Определения
Имя | Описание |
---|---|
Json |
Модель JSON для операций исправления JSON |
Operation |
Операция исправления |
Operation |
Текущее состояние операции. |
Service |
|
Service |
JsonPatchDocument
Модель JSON для операций исправления JSON
Имя | Тип | Описание |
---|---|---|
from |
string |
Путь для копирования для операции перемещения или копирования. |
op |
Операция исправления |
|
path |
string |
Путь к операции. В случае массива можно использовать отсчитываемый от нуля индекс для указания позиции в массиве (например, /biscuits/0/name). Символ "-" можно использовать вместо индекса для вставки в конец массива (например, /biscuits/-). |
value |
object |
Значение для операции. Это либо примитив, либо JToken. |
Operation
Операция исправления
Имя | Тип | Описание |
---|---|---|
add |
string |
|
copy |
string |
|
move |
string |
|
remove |
string |
|
replace |
string |
|
test |
string |
OperationStatus
Текущее состояние операции.
Имя | Тип | Описание |
---|---|---|
cancelled |
string |
Операция была отменена пользователем. |
failed |
string |
Операция завершилась ошибкой. |
inProgress |
string |
Операция выполняется. |
notSet |
string |
Для операции не задано состояние. |
queued |
string |
Операция поставлена в очередь. |
succeeded |
string |
Операция выполнена успешно. |
ServicePrincipalEntitlementOperationReference
Имя | Тип | Описание |
---|---|---|
completed |
boolean |
Операция завершена успешно или неудачно. |
haveResultsSucceeded |
boolean |
Значение true, если все операции были успешными. |
id |
string |
Уникальный идентификатор операции. |
pluginId |
string |
Уникальный идентификатор подключаемого модуля. |
results |
Список результатов для каждой операции. |
|
status |
Текущее состояние операции. |
|
url |
string |
URL-адрес для получения полного объекта операции. |
ServicePrincipalEntitlementOperationResult
Имя | Тип | Описание |
---|---|---|
errors |
object[] |
Список кодов ошибок, сопряженных с соответствующими сообщениями об ошибках. |
isSuccess |
boolean |
Состояние успешного выполнения операции. |
result |
string |
Результирующее свойство прав. Конкретные реализации см. также в разделе: |
servicePrincipalId |
string |
Идентификатор объекта ServicePrincipal, с которой выполняется действие. |
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по