Partager via

Workspaces - Add Workspace Role Assignment

Service:
Core
Version d'API:
v1

Ajoute une attribution de rôle d’espace de travail.
Pour obtenir l’ID d’objet utilisateur principal requis pour le corps de la demande, consultez Rechercher l’ID d’objet utilisateur.

Autorisations

  • L’appelant doit avoir un rôle de membre ou d’espace de travail supérieur.
  • Les membres peuvent ajouter des membres ou d’autres personnes disposant d’autorisations inférieures. Pour plus d’informations, consultez : rôles d’espace de travail.

Étendues déléguées requises

Workspace.ReadWrite.All

Limites

  • Chaque espace de travail est limité à un maximum de 1 000 utilisateurs ou groupes dans les rôles d’espace de travail (Administrateur, Membre, Contributeur, Visionneuse). Le nombre d’utilisateurs au sein d’un groupe n’est pas limité. La limitation couvre également les invités externes.

Identités prises en charge par Microsoft Entra

Cette API prend en charge les identités Microsoft répertoriées dans cette section.

Identité Soutien
Utilisateur Oui
Service principal et identités gérées Oui

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/roleAssignments

Paramètres URI

Nom Dans Obligatoire Type Description
workspaceId
 path True

string (uuid)

Identifiant de l’espace de travail.

Corps de la demande

Nom Obligatoire Type Description
principal True

Principal

Principal.
role True

WorkspaceRole

Rôle d’espace de travail du principal.

Réponses

Nom Type Description
201 Created

WorkspaceRoleAssignment

Création réussie.

En-têtes

Location: string
Other Status Codes

ErrorResponse

Codes d’erreur courants :

  • UnknownError : une erreur s’est produite.

Exemples

Add workspace role assignment example

Exemple de requête

POST https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff512/roleAssignments

{
  "principal": {
    "id": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
    "type": "User"
  },
  "role": "Member"
}

Exemple de réponse

Code d’état:
201 
Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb27ff512/roleAssignments/8eedb1b0-3af8-4b17-8e7e-663e61e12211
{
  "id": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
  "principal": {
    "id": "8eedb1b0-3af8-4b17-8e7e-663e61e12211",
    "type": "User"
  },
  "role": "Member"
}

Définitions

Nom Description
AddWorkspaceRoleAssignmentRequest

Ajoutez la charge utile de demande d’attribution de rôle d’espace de travail.
ErrorRelatedResource

Objet de détails de ressource associé à l’erreur.
ErrorResponse

Réponse d’erreur.
ErrorResponseDetails

Détails de la réponse d’erreur.
GroupDetails

Détails spécifiques du groupe. Applicable lorsque le type principal est Group.
GroupType

Type du groupe. Des types de groupes supplémentaires peuvent être ajoutés au fil du temps.
Principal

Représente une identité ou un groupe Microsoft Entra.
PrincipalType

Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.
ServicePrincipalDetails

Détails spécifiques au principal de service. Applicable lorsque le type principal est ServicePrincipal.
ServicePrincipalProfileDetails

Détails du profil du principal de service. Applicable lorsque le type principal est ServicePrincipalProfile.
UserDetails

Détails spécifiques au principal de l’utilisateur. Applicable lorsque le type principal est User.
WorkspaceRole

Rôle Espace de travail. Des rôles d’espace de travail supplémentaires peuvent être ajoutés au fil du temps.
WorkspaceRoleAssignment

Objet d’attribution de rôle d’espace de travail.

AddWorkspaceRoleAssignmentRequest

Object

Ajoutez la charge utile de demande d’attribution de rôle d’espace de travail.

Nom Type Description
principal

Principal

Principal.
role

WorkspaceRole

Rôle d’espace de travail du principal.

ErrorRelatedResource

Object

Objet de détails de ressource associé à l’erreur.

Nom Type Description
resourceId

string

ID de ressource impliqué dans l’erreur.
resourceType

string

Type de la ressource impliquée dans l’erreur.

ErrorResponse

Object

Réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
moreDetails

ErrorResponseDetails[]

Liste des détails d’erreur supplémentaires.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.
requestId

string

ID de la demande associée à l’erreur.

ErrorResponseDetails

Object

Détails de la réponse d’erreur.

Nom Type Description
errorCode

string

Identificateur spécifique qui fournit des informations sur une condition d’erreur, ce qui permet une communication standardisée entre notre service et ses utilisateurs.
message

string

Représentation lisible humaine de l’erreur.
relatedResource

ErrorRelatedResource

Détails de la ressource associée à l’erreur.

GroupDetails

Object

Détails spécifiques du groupe. Applicable lorsque le type principal est Group.

Nom Type Description
groupType

GroupType

Type du groupe. Des types de groupes supplémentaires peuvent être ajoutés au fil du temps.

GroupType

Énumération

Type du groupe. Des types de groupes supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
Unknown

Le type de groupe principal est inconnu.
SecurityGroup

Principal est un groupe de sécurité.
DistributionList

Principal est une liste de distribution.

Principal

Object

Représente une identité ou un groupe Microsoft Entra.

Nom Type Description
displayName

string

Nom complet du principal.
groupDetails

GroupDetails

Détails spécifiques du groupe. Applicable lorsque le type principal est Group.
id

string (uuid)

ID du principal.
servicePrincipalDetails

ServicePrincipalDetails

Détails spécifiques au principal de service. Applicable lorsque le type principal est ServicePrincipal.
servicePrincipalProfileDetails

ServicePrincipalProfileDetails

Détails du profil du principal de service. Applicable lorsque le type principal est ServicePrincipalProfile.
type

PrincipalType

Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.
userDetails

UserDetails

Détails spécifiques au principal de l’utilisateur. Applicable lorsque le type principal est User.

PrincipalType

Énumération

Type du principal. Des types principaux supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
User

Principal est un principal d’utilisateur Microsoft Entra.
ServicePrincipal

Principal est un principal de service Microsoft Entra.
Group

Principal est un groupe de sécurité.
ServicePrincipalProfile

Le principal est un profil de principal de service.

ServicePrincipalDetails

Object

Détails spécifiques au principal de service. Applicable lorsque le type principal est ServicePrincipal.

Nom Type Description
aadAppId

string (uuid)

Microsoft EntraId du principal de service.

ServicePrincipalProfileDetails

Object

Détails du profil du principal de service. Applicable lorsque le type principal est ServicePrincipalProfile.

Nom Type Description
parentPrincipal

Principal

Principal parent du profil de principal de service.

UserDetails

Object

Détails spécifiques au principal de l’utilisateur. Applicable lorsque le type principal est User.

Nom Type Description
userPrincipalName

string

Nom d’utilisateur principal.

WorkspaceRole

Énumération

Rôle Espace de travail. Des rôles d’espace de travail supplémentaires peuvent être ajoutés au fil du temps.

Valeur Description
Admin

Active l’accès administratif à l’espace de travail.
Member

Active l’accès à l’appartenance à l’espace de travail.
Contributor

Active la contribution à l’espace de travail.
Viewer

Active l’affichage de l’espace de travail.

WorkspaceRoleAssignment

Object

Objet d’attribution de rôle d’espace de travail.

Nom Type Description
id

string (uuid)

ID d’attribution de rôle d’espace de travail.
principal

Principal

Principal.
role

WorkspaceRole

Rôle d’espace de travail du principal.