Roleassignments - Set Role Assignments

Référence

Service:: Security Roles

API Version:: 7.1-preview.1

Définir des attributions de rôles sur une 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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
resourceId	path	True	string	ID de la ressource sur laquelle le rôle doit être attribué
scopeId	path	True	string	ID de l’étendue affectée
organization	path		string	Nom de l’organisation Azure DevOps.
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.1 » pour utiliser cette version de l’API.
limitToCallerIdentityDomain	query		boolean

Corps de la demande

Nom	Type	Description
body	UserRoleAssignmentRef[]	Rôles à attribuer

Réponses

Nom	Type	Description
200 OK	RoleAssignment[]	opération réussie

Sécurité

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

Nom	Description
vso.security_manage	Octroie la possibilité de lire, d’écrire et de gérer des autorisations de sécurité.

Exemples

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

Définitions

Nom	Description
IdentityRef
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
RoleAccess	Désigne le rôle comme explicitement attribué ou hérité.
RoleAssignment
SecurityRole
UserRoleAssignmentRef

IdentityRef

Nom	Type	Description
_links	ReferenceLinks	Ce champ contient zéro ou plus de liens intéressants sur le sujet du graphe. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique.
descriptor	string	Le descripteur est le principal moyen de référencer l’objet du graphe pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphe pour les comptes et les organisations.
directoryAlias	string	Déconseillé : peut être récupéré en interrogeant l’utilisateur Graph référencé dans l’entrée « auto » du dictionnaire IdentityRef « _links »
displayName	string	Il s’agit du nom d’affichage non unique du sujet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source.
id	string
imageUrl	string	Déconseillé : disponible dans l’entrée « avatar » du dictionnaire IdentityRef « _links »
inactive	boolean	Déconseillé : peut être récupéré en interrogeant l’état d’appartenance Graph référencé dans l’entrée « membershipState » du dictionnaire GraphUser « _links »
isAadIdentity	boolean	Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Déconseillé : non utilisé dans la plupart des implémentations préexistantes de ToIdentityRef
uniqueName	string	Déconseillé : utilisez Domain+PrincipalName à la place
url	string	Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique.

ReferenceLinks

Classe pour représenter une collection de liens de référence REST.

Nom	Type	Description
links	object	Vue en lecture seule des liens. Étant donné que les liens de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

RoleAccess

Désigne le rôle comme explicitement attribué ou hérité.

Nom	Type	Description
assigned	string	L’accès a été défini explicitement.
inherited	string	L’accès a été hérité d’une étendue plus élevée.

RoleAssignment

Nom	Type	Description
access	RoleAccess	Désigne le rôle comme explicitement attribué ou hérité.
accessDisplayName	string	Description conviviale de l’attribution d’accès.
identity	IdentityRef	Utilisateur auquel le rôle est attribué.
role	SecurityRole	Rôle attribué à l’utilisateur.

SecurityRole

Nom	Type	Description
allowPermissions	integer	Autorisations pour le rôle autorisé.
denyPermissions	integer	Autorisations pour le rôle refusé.
description	string	Description de l’accès utilisateur défini par le rôle
displayName	string	Nom convivial du rôle.
identifier	string	Identificateur global unique pour le rôle.
name	string	Nom unique du rôle dans l’étendue.
scope	string	Retourne l’ID du ParentScope.

UserRoleAssignmentRef

Nom	Type	Description
roleName	string	Nom du rôle attribué.
uniqueName	string	Identificateur de l’utilisateur en fonction de l’attribution de rôle.
userId	string	ID unique de l’utilisateur en fonction de l’attribution de rôle.

Partager via