Roleassignments - Set Role Assignments
Definir atribuições de função em um recurso
PUT https://dev.azure.com/{organization}/_apis/securityroles/scopes/{scopeId}/roleassignments/resources/{resourceId}?api-version=7.1-preview.1
PUT https://dev.azure.com/{organization}/_apis/securityroles/scopes/{scopeId}/roleassignments/resources/{resourceId}?limitToCallerIdentityDomain={limitToCallerIdentityDomain}&api-version=7.1-preview.1
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
ID do recurso no qual a função deve ser atribuída |
scope
|
path | True |
string |
ID do escopo atribuído |
organization
|
path |
string |
O nome da organização do Azure DevOps. |
|
api-version
|
query | True |
string |
Versão da API a ser usada. Isso deve ser definido como '7.1-preview.1' para usar essa versão da API. |
limit
|
query |
boolean |
Corpo da solicitação
Nome | Tipo | Description |
---|---|---|
body |
Funções a serem atribuídas |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
operação bem-sucedida |
Segurança
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
Nome | Description |
---|---|
vso.security_manage | Concede a capacidade de ler, gravar e gerenciar permissões de segurança. |
Exemplos
Set Role assignments
Sample Request
PUT https://dev.azure.com/_apis/securityroles/scopes/{scopeId}/roleassignments/resources/{resourceId}?api-version=7.1-preview.1
[
{
"roleName": "Administrator",
"userId": "4189bd2b-de9c-45de-a886-4e3d9c03f1f9"
}
]
Sample Response
{
"count": 1,
"value": [
{
"identity": {
"displayName": "Your Identity Name",
"id": "cbb1d8ac-cee5-47c1-878a-e75c0e94ac89",
"uniqueName": "Your Identity Unique Name"
},
"role": {
"displayName": "Administrator",
"name": "Administrator",
"allowPermissions": 3,
"denyPermissions": 0,
"identifier": "distributedtask.serviceendpointrole.Administrator",
"description": "Administrator can use and manage the service connection.",
"scope": "distributedtask.serviceendpointrole"
},
"access": "assigned",
"accessDisplayName": "Assigned"
}
]
}
Definições
Nome | Description |
---|---|
Identity |
|
Reference |
A classe para representar uma coleção de links de referência REST. |
Role |
Designa a função como explicitamente atribuída ou herdada. |
Role |
|
Security |
|
User |
IdentityRef
Nome | Tipo | Description |
---|---|---|
_links |
Esse campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo. |
|
descriptor |
string |
O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto do grafo entre contas e organizações. |
directoryAlias |
string |
Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário "_links" identityRef |
displayName |
string |
Este é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem. |
id |
string |
|
imageUrl |
string |
Preterido - Disponível na entrada "avatar" do dicionário "_links" IdentityRef |
inactive |
boolean |
Preterido – pode ser recuperado consultando o estado de associação do Graph referenciado na entrada "membershipState" do dicionário "_links" do GraphUser |
isAadIdentity |
boolean |
Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
Preterido – não em uso na maioria das implementações preexistidas de ToIdentityRef |
uniqueName |
string |
Preterido – use Domain+PrincipalName |
url |
string |
Essa URL é a rota completa para o recurso de origem desta entidade de grafo. |
ReferenceLinks
A classe para representar uma coleção de links de referência REST.
Nome | Tipo | Description |
---|---|---|
links |
object |
A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura. |
RoleAccess
Designa a função como explicitamente atribuída ou herdada.
Nome | Tipo | Description |
---|---|---|
assigned |
string |
O acesso foi definido explicitamente. |
inherited |
string |
O acesso foi herdado de um escopo mais alto. |
RoleAssignment
Nome | Tipo | Description |
---|---|---|
access |
Designa a função como explicitamente atribuída ou herdada. |
|
accessDisplayName |
string |
Descrição amigável da atribuição de acesso. |
identity |
O usuário ao qual a função é atribuída. |
|
role |
A função atribuída ao usuário. |
SecurityRole
Nome | Tipo | Description |
---|---|---|
allowPermissions |
integer |
Permissões que a função é permitida. |
denyPermissions |
integer |
Permissões que a função foi negada. |
description |
string |
Descrição do acesso do usuário definido pela função |
displayName |
string |
Nome amigável da função. |
identifier |
string |
Identificador global exclusivo para a função. |
name |
string |
Nome exclusivo da função no escopo. |
scope |
string |
Retorna a ID do ParentScope. |
UserRoleAssignmentRef
Nome | Tipo | Description |
---|---|---|
roleName |
string |
O nome da função atribuída. |
uniqueName |
string |
Identificador do usuário que recebeu a atribuição de função. |
userId |
string |
ID exclusiva do usuário dada a atribuição de função. |