Rediger

Del via

Workspaces - List Workspace Role Assignments

  • Reference
Service:
Core
API Version:
v1

Note

This API is in preview.

Returns a list of workspace role assignments.

This API supports pagination.

Permissions

The caller must have member or higher role on the workspace.

Required Delegated Scopes

Workspace.Read.All or Workspace.ReadWrite.All

Interface

GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/roleAssignments
With optional parameters: 
GET https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/roleAssignments?continuationToken={continuationToken}

URI Parameters

Name In Required Type Description
workspaceId
 path True

string

uuid

The workspace ID.
continuationToken
 query

string

A token for retrieving the next page of results.

Responses

Name Type Description
200 OK

WorkspaceRoleAssignments

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • UnknownError - An error occurred.

Examples

Get workspace role assignments example
Get workspace role assignments with continuation example

Get workspace role assignments example

Sample Request

GET https://api.fabric.microsoft.com/v1/workspaces/e4ae4765-02a0-4cd8-bbef-65be17dd5a22/roleAssignments

Sample Response

Status code:
200 
{
  "value": [
    {
      "principal": {
        "displayName": "Eric Solomon",
        "id": "81fac5e1-2a81-421b-a168-110b1c72fa11",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "eric@microsoft.com"
        }
      },
      "role": "Admin"
    },
    {
      "principal": {
        "displayName": "ServicePrincipal",
        "id": "dbc4f130-681f-46b9-b19a-ca19ea5daa31",
        "type": "ServicePrincipal",
        "servicePrincipalDetails": {
          "aadAppId": "7ac9c70b-69f1-48c5-bf5b-69ac50578a55"
        }
      },
      "role": "Member"
    }
  ]
}

Get workspace role assignments with continuation example

Sample Request

GET https://api.fabric.microsoft.com/v1/workspaces/e4ae4765-02a0-4cd8-bbef-65be17dd5a22/roleAssignments

Sample Response

Status code:
200 
{
  "value": [
    {
      "principal": {
        "displayName": "Eric Solomon",
        "id": "81fac5e1-2a81-421b-a168-110b1c72fa11",
        "type": "User",
        "userDetails": {
          "userPrincipalName": "eric@microsoft.com"
        }
      },
      "role": "Admin"
    },
    {
      "principal": {
        "displayName": "ServicePrincipal",
        "id": "dbc4f130-681f-46b9-b19a-ca19ea5daa31",
        "type": "ServicePrincipal",
        "servicePrincipalDetails": {
          "aadAppId": "7ac9c70b-69f1-48c5-bf5b-69ac50578a55"
        }
      },
      "role": "Member"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/workspaces/e4ae4765-02a0-4cd8-bbef-65be17dd5a22/roleAssignments?continuationToken=LDEsMTAwMDAwLDA%3D"
}

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.
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).
WorkspaceRoleAssignments

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.

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.

WorkspaceRoleAssignments

Name Type Description
continuationToken

string

The token for the next result set batch. If there are no more records, it's removed from the response.
continuationUri

string

The URI of the next result set batch. If there are no more records, it's removed from the response.
value

WorkspaceRoleAssignment[]

A list of workspace role assignments.