Roleassignments - Set Role Assignments

Referenz

Service:: Security Roles

API Version:: 7.1-preview.1

Festlegen von Rollenzuweisungen für eine Ressource

PUT https://dev.azure.com/{organization}/_apis/securityroles/scopes/{scopeId}/roleassignments/resources/{resourceId}?api-version=7.1-preview.1

With optional parameters:

PUT https://dev.azure.com/{organization}/_apis/securityroles/scopes/{scopeId}/roleassignments/resources/{resourceId}?limitToCallerIdentityDomain={limitToCallerIdentityDomain}&api-version=7.1-preview.1

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceId	path	True	string	ID der Ressource, der die Rolle zugewiesen werden soll
scopeId	path	True	string	ID des zugewiesenen Bereichs
organization	path		string	Der Name der Azure DevOps-Organisation.
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1-preview.1" festgelegt werden, um diese Version der API zu verwenden.
limitToCallerIdentityDomain	query		boolean

Anforderungstext

Name	Typ	Beschreibung
body	UserRoleAssignmentRef[]	Zuzuweisende Rollen

Antworten

Name	Typ	Beschreibung
200 OK	RoleAssignment[]	Erfolgreicher Vorgang

Sicherheit

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

Name	Beschreibung
vso.security_manage	Gewährt die Möglichkeit zum Lesen, Schreiben und Verwalten von Sicherheitsberechtigungen.

Beispiele

Set Role assignments

Sample Request

HTTP

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

Status code:: 200

{
  "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"
    }
  ]
}

Definitionen

Name	Beschreibung
IdentityRef
ReferenceLinks	Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.
RoleAccess	Legt die Rolle als explizit zugewiesen oder geerbt fest.
RoleAssignment
SecurityRole
UserRoleAssignmentRef

IdentityRef

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Graphthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graphthema zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Methode, um auf den Graph-Betreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird derselbe Graph-Betreff sowohl für Konten als auch für Organisationen eindeutig identifiziert.
directoryAlias	string	Veraltet: Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im Eintrag "self" des IdentityRef-Wörterbuchs "_links" verwiesen wird.
displayName	string	Dies ist der nicht eindeutige Anzeigename des Graph-Betreffs. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.
id	string
imageUrl	string	Veraltet: Im Eintrag "avatar" des IdentityRef-Wörterbuchs "_links" verfügbar
inactive	boolean	Veraltet: Kann abgerufen werden, indem der Graph-Mitgliedschaftsstatus abgefragt wird, auf den im Eintrag "membershipState" des GraphUser-Wörterbuchs "_links" verwiesen wird.
isAadIdentity	boolean	Veraltet: Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Veraltet: Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Veraltet– wird in den meisten vorhandenen Implementierungen von ToIdentityRef nicht verwendet.
uniqueName	string	Veraltet: Verwenden Sie stattdessen Domain+PrincipalName.
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

ReferenceLinks

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützter Sind, möchten wir sie nur als schreibgeschützter Link verfügbar machen.

RoleAccess

Legt die Rolle als explizit zugewiesen oder geerbt fest.

Name	Typ	Beschreibung
assigned	string	Der Zugriff wurde explizit festgelegt.
inherited	string	Der Zugriff wurde von einem höheren Bereich geerbt.

RoleAssignment

Name	Typ	Beschreibung
access	RoleAccess	Legt die Rolle als explizit zugewiesen oder geerbt fest.
accessDisplayName	string	Benutzerfreundliche Beschreibung der Zugriffszuweisung.
identity	IdentityRef	Der Benutzer, dem die Rolle zugewiesen ist.
role	SecurityRole	Die dem Benutzer zugewiesene Rolle.

SecurityRole

Name	Typ	Beschreibung
allowPermissions	integer	Berechtigungen, die für die Rolle zulässig sind.
denyPermissions	integer	Berechtigungen, die der Rolle verweigert werden.
description	string	Beschreibung des durch die Rolle definierten Benutzerzugriffs
displayName	string	Benutzerfreundlichkeitsname der Rolle.
identifier	string	Global eindeutiger Bezeichner für die Rolle.
name	string	Eindeutiger Name der Rolle im Bereich.
scope	string	Gibt die ID des ParentScope zurück.

UserRoleAssignmentRef

Name	Typ	Beschreibung
roleName	string	Der Name der zugewiesenen Rolle.
uniqueName	string	Bezeichner des Benutzers, dem die Rollenzuweisung zugewiesen wurde.
userId	string	Eindeutige ID des Benutzers, dem die Rollenzuweisung zugewiesen wurde.

Freigeben über