Connections - List Connection Role Assignments

Service:: Core

API Version:: v1

Returns a list of connection role assignments.
This API supports pagination.

Permissions

The caller must have User or higher role on the connection or be an Admin on the gateway that's bound to the connection.

Required Delegated Scopes

Connection.Read.All or Connection.ReadWrite.All

Microsoft Entra supported identities

This API supports the Microsoft identities listed in this section.

Identity	Support
User	Yes
Service principal and Managed identities	Yes

Interface

GET https://api.fabric.microsoft.com/v1/connections/{connectionId}/roleAssignments

With optional parameters:

GET https://api.fabric.microsoft.com/v1/connections/{connectionId}/roleAssignments?continuationToken={continuationToken}

URI Parameters

Name	In	Required	Type	Description
connectionId	path	True	string (uuid)	The ID of the connection.
continuationToken	query		string	A token for retrieving the next page of results.

Responses

Name	Type	Description
200 OK	ConnectionRoleAssignments	OK. The operation was successful.
Other Status Codes	ErrorResponse	Common error codes: UnknownError - An error occurred.

Name

Type

Description

200 OK

ConnectionRoleAssignments

OK. The operation was successful.

Other Status Codes

ErrorResponse

Common error codes:

UnknownError - An error occurred.

Examples

List connection role assignment example

List connection role assignment with continuation example

List connection role assignment example

Sample request

HTTP

GET https://api.fabric.microsoft.com/v1/connections/9558d649-84f1-4b7e-850a-59b5d0ae95eb/roleAssignments

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "1c15c348-dd88-4065-8f25-57581c216bcf",
      "principal": {
        "id": "1c15c348-dd88-4065-8f25-57581c216bcf",
        "type": "User"
      },
      "role": "Owner"
    },
    {
      "id": "d3a7dbf7-6641-48f2-851e-d71bbf9d90c4",
      "principal": {
        "id": "d3a7dbf7-6641-48f2-851e-d71bbf9d90c4",
        "type": "Group"
      },
      "role": "Owner"
    },
    {
      "id": "48ba22da-4431-4da4-8b70-3401685bf9e5",
      "principal": {
        "id": "48ba22da-4431-4da4-8b70-3401685bf9e5",
        "type": "Group"
      },
      "role": "User"
    },
    {
      "id": "1dfa1747-ce76-4caf-99c8-360b95f9f17a",
      "principal": {
        "id": "1dfa1747-ce76-4caf-99c8-360b95f9f17a",
        "type": "User"
      },
      "role": "UserWithReshare"
    }
  ]
}

List connection role assignment with continuation example

Sample request

HTTP

GET https://api.fabric.microsoft.com/v1/connections/9558d649-84f1-4b7e-850a-59b5d0ae95eb/roleAssignments

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "1c15c348-dd88-4065-8f25-57581c216bcf",
      "principal": {
        "id": "1c15c348-dd88-4065-8f25-57581c216bcf",
        "type": "User"
      },
      "role": "Owner"
    },
    {
      "id": "d3a7dbf7-6641-48f2-851e-d71bbf9d90c4",
      "principal": {
        "id": "d3a7dbf7-6641-48f2-851e-d71bbf9d90c4",
        "type": "Group"
      },
      "role": "Owner"
    },
    {
      "id": "48ba22da-4431-4da4-8b70-3401685bf9e5",
      "principal": {
        "id": "48ba22da-4431-4da4-8b70-3401685bf9e5",
        "type": "Group"
      },
      "role": "User"
    },
    {
      "id": "1dfa1747-ce76-4caf-99c8-360b95f9f17a",
      "principal": {
        "id": "1dfa1747-ce76-4caf-99c8-360b95f9f17a",
        "type": "User"
      },
      "role": "UserWithReshare"
    }
  ],
  "continuationToken": "LDEsMTAwMDAwLDA%3D",
  "continuationUri": "https://api.fabric.microsoft.com/v1/connections/9558d649-84f1-4b7e-850a-59b5d0ae95eb/roleAssignments?continuationToken=LDEsMTAwMDAwLDA%3D"
}

Definitions

Name	Description
ConnectionRole	A Connection role. Additional connection roles may be added over time.
ConnectionRoleAssignment	The connection role assignment for a principal.
ConnectionRoleAssignments
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	Represents an identity or a Microsoft Entra group.
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`.

ConnectionRole

Enumeration

A Connection role. Additional connection roles may be added over time.

Value	Description
User	Enables user access for the connection.
UserWithReshare	Enables user with resharing access for the connection.
Owner	Enables ownership access for the connection.

ConnectionRoleAssignment

Object

The connection role assignment for a principal.

Name	Type	Description
id	string (uuid)	The object ID of the connection role assignment.
principal	Principal	The principal.
role	ConnectionRole	The connection role of the principal.

ConnectionRoleAssignments

Object

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	ConnectionRoleAssignment[]	A list of connection role assignments.

ErrorRelatedResource

Object

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

Object

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

Object

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

Object

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

Enumeration

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

Value	Description
Unknown	Principal group type is unknown.
SecurityGroup	Principal is a security group.
DistributionList	Principal is a distribution list.

Principal

Object

Represents an identity or a Microsoft Entra group.

Name	Type	Description
displayName	string	The principal's display name.
groupDetails	GroupDetails	Group specific details. Applicable when the principal type is `Group`.
id	string (uuid)	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

Enumeration

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

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

ServicePrincipalDetails

Object

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

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

ServicePrincipalProfileDetails

Object

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

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

UserDetails

Object

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

Name	Type	Description
userPrincipalName	string	The user principal name.

Share via

Connections - List Connection Role Assignments

Permissions

Required Delegated Scopes

Microsoft Entra supported identities

Interface

URI Parameters

Responses

Examples

List connection role assignment example

Sample request

Sample response

List connection role assignment with continuation example

Sample request

Sample response

Definitions

ConnectionRole

ConnectionRoleAssignment

ConnectionRoleAssignments

ErrorRelatedResource

ErrorResponse

ErrorResponseDetails

GroupDetails

GroupType

Principal

PrincipalType

ServicePrincipalDetails

ServicePrincipalProfileDetails

UserDetails