Workspaces - Update Workspace Role Assignment

Service:

Core

API Version:

v1

Note

This API is in preview.

Updates a principal's role assignment over a workspace.

The role assignment of the last admin can't be changed.

Permissions

The caller must have admin role on the workspace.

Required Delegated Scopes

Workspace.ReadWrite.All

Interface

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

URI Parameters

Name	In	Required	Type	Description
principalId	path	True	string uuid	The principal ID.
workspaceId	path	True	string uuid	The workspace ID.

Request Body

Name	Type	Description
role	WorkspaceRole	The workspace role of the principal.

Responses

Name	Type	Description
200 OK	WorkspaceRoleAssignment	Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: UnknownError - An error occurred.

Examples

Update workspace role assignment example

Sample Request

HTTP

PATCH https://api.fabric.microsoft.com/v1/workspaces/0ac682f5-aee3-4968-9d21-692eb3fd4056/roleAssignments/0218b8c4-f5a2-4a1e-bbbd-a986dd8aeb81

{
  "role": "Contributor"
}

Sample Response

Status code:

200

{
  "principal": {
    "displayName": "user1",
    "id": "0218b8c4-f5a2-4a1e-bbbd-a986dd8aeb81",
    "type": "User",
    "userDetails": {
      "userPrincipalName": "user1@microsoft.com"
    }
  },
  "role": "Contributor"
}

Definitions

Name	Description
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
GroupDetails	Group specific details. Applicable when the principal type is Group.
GroupType	The type of the group. Additional group types may be added over time.
Principal
PrincipalType	The type of the principal. Additional principal types may be added over time.
ServicePrincipalDetails	Service principal specific details. Applicable when the principal type is ServicePrincipal.
ServicePrincipalProfileDetails	Service principal profile details. Applicable when the principal type is ServicePrincipalProfile.
UpdateWorkspaceRoleAssignmentRequest	Update workspace role assignment request payload.
UserDetails	User principal specific details. Applicable when the principal type is User.
WorkspaceRole	A Workspace role. Additional WorkspaceRole types may be added over time.
WorkspaceRoleAssignment	A workspace role assignment (principal and workspace role).

ErrorRelatedResource

The error related resource details object.

Name	Type	Description
resourceId	string	The resource ID that's involved in the error.
resourceType	string	The type of the resource that's involved in the error.

ErrorResponse

The error response.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
moreDetails	ErrorResponseDetails[]	List of additional error details.
relatedResource	ErrorRelatedResource	The error related resource details.
requestId	string	ID of the request associated with the error.

ErrorResponseDetails

The error response details.

Name	Type	Description
errorCode	string	A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users.
message	string	A human readable representation of the error.
relatedResource	ErrorRelatedResource	The error related resource details.

GroupDetails

Group specific details. Applicable when the principal type is Group.

Name	Type	Description
groupType	GroupType	The type of the group. Additional group types may be added over time.

GroupType

The type of the group. Additional group types may be added over time.

Name	Type	Description
DistributionList	string	Principal is a distribution list.
SecurityGroup	string	Principal is a security group.
Unknown	string	Principal group type is unknown.

Principal

Name	Type	Description
displayName	string	The principal's display name.
groupDetails	GroupDetails	Group specific details. Applicable when the principal type is Group.
id	string	The principal's ID.
servicePrincipalDetails	ServicePrincipalDetails	Service principal specific details. Applicable when the principal type is ServicePrincipal.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Service principal profile details. Applicable when the principal type is ServicePrincipalProfile.
type	PrincipalType	The type of the principal. Additional principal types may be added over time.
userDetails	UserDetails	User principal specific details. Applicable when the principal type is User.

PrincipalType

The type of the principal. Additional principal types may be added over time.

Name	Type	Description
Group	string	Principal is a security group.
ServicePrincipal	string	Principal is a Microsoft Entra service principal.
ServicePrincipalProfile	string	Principal is a service principal profile.
User	string	Principal is a Microsoft Entra user principal.

ServicePrincipalDetails

Service principal specific details. Applicable when the principal type is ServicePrincipal.

Name	Type	Description
aadAppId	string	The service principal's Microsoft Entra AppId.

ServicePrincipalProfileDetails

Service principal profile details. Applicable when the principal type is ServicePrincipalProfile.

Name	Type	Description
parentPrincipal	Principal	The service principal profile's parent principal.

UpdateWorkspaceRoleAssignmentRequest

Update workspace role assignment request payload.

Name	Type	Description
role	WorkspaceRole	The workspace role of the principal.

UserDetails

User principal specific details. Applicable when the principal type is User.

Name	Type	Description
userPrincipalName	string	The user principal name.

WorkspaceRole

A Workspace role. Additional WorkspaceRole types may be added over time.

Name	Type	Description
Admin	string	Enables administrative access to the workspace.
Contributor	string	Enables contribution to the workspace.
Member	string	Enables membership access to the workspace.
Viewer	string	Enables viewing of the workspace.

WorkspaceRoleAssignment

A workspace role assignment (principal and workspace role).

Name	Type	Description
principal	Principal	The principal.
role	WorkspaceRole	The workspace role of the principal.