Connections - Add Connection Role Assignment

Service:

Core

API Version:

v1

Adds a connection role assignment.
To get the principal user ID required for request body, see Find the user ID.

Permissions

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

Required Delegated Scopes

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

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

URI Parameters

Name	In	Required	Type	Description
connectionId	path	True	string (uuid)	The ID of the connection.

Request Body

Name	Required	Type	Description
principal	True	Principal: UserPrincipal ServicePrincipalPrincipal GroupPrincipal ServicePrincipalProfilePrincipal EntireTenantPrincipal	The principal.
role	True	ConnectionRole	The connection role of the principal.

Responses

Name	Type	Description
201 Created	ConnectionRoleAssignment	Successfully created. Headers Location: string
429 Too Many Requests	ErrorResponse	The service rate limit was exceeded. The server returns a Retry-After header indicating, in seconds, how long the client must wait before sending additional requests. Headers Retry-After: integer
Other Status Codes	ErrorResponse	Common error codes: BadRequest - Missing required parameter.

Examples

Add connection role assignment example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/connections/f3a2e6af-d048-4f85-94d9-b3d16140df05/roleAssignments

{
  "principal": {
    "id": "6a002b3d-e4ec-43df-8c08-e8eb7547d9dd",
    "type": "User"
  },
  "role": "Owner"
}

Sample response

Status code:

201

Location: https://api.fabric.microsoft.com/v1/connections/f3a2e6af-d048-4f85-94d9-b3d16140df05/roleAssignments/6a002b3d-e4ec-43df-8c08-e8eb7547d9dd

{
  "id": "6a002b3d-e4ec-43df-8c08-e8eb7547d9dd",
  "principal": {
    "id": "6a002b3d-e4ec-43df-8c08-e8eb7547d9dd",
    "type": "User"
  },
  "role": "Owner"
}

Definitions

Name	Description
AddConnectionRoleAssignmentRequest	The add connection role assignment request for a principal.
ConnectionRole	A Connection role. Additional connection roles may be added over time.
ConnectionRoleAssignment	The connection role assignment for a principal.
EntireTenantPrincipal	Represents a tenant principal
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.
GroupPrincipal	Represents a security group.
GroupType	The type of the group. Additional group types may be added over time.
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.
ServicePrincipalPrincipal	Represents a Microsoft Entra service principal.
ServicePrincipalProfileDetails	Service principal profile details. Applicable when the principal type is ServicePrincipalProfile.
ServicePrincipalProfilePrincipal	Represents a service principal profile.
UserDetails	User principal specific details. Applicable when the principal type is User.
UserPrincipal	Represents a Microsoft Entra user principal.

AddConnectionRoleAssignmentRequest

Object

The add connection role assignment request for a principal.

Name	Type	Description
principal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	The principal.
role	ConnectionRole	The connection role of the principal.

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: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	The principal.
role	ConnectionRole	The connection role of the principal.

EntireTenantPrincipal

Object

Represents a tenant principal

Name	Type	Description
displayName	string	The principal's display name.
id	string (uuid)	The principal's ID.
type	string: EntireTenant	The type of the principal. Additional principal types may be added over time.

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 (uuid)	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.

GroupPrincipal

Object

Represents a security 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.
type	string: Group	The type of the principal. Additional principal 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.

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.
EntireTenant	Principal represents all tenant users.

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.

ServicePrincipalPrincipal

Object

Represents a Microsoft Entra service principal.

Name	Type	Description
displayName	string	The principal's display name.
id	string (uuid)	The principal's ID.
servicePrincipalDetails	ServicePrincipalDetails	Service principal specific details. Applicable when the principal type is ServicePrincipal.
type	string: ServicePrincipal	The type of the principal. Additional principal types may be added over time.

ServicePrincipalProfileDetails

Object

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

Name	Type	Description
parentPrincipal	Principal: EntireTenantPrincipal GroupPrincipal ServicePrincipalPrincipal ServicePrincipalProfilePrincipal UserPrincipal	The service principal profile's parent principal.

ServicePrincipalProfilePrincipal

Object

Represents a service principal profile.

Name	Type	Description
displayName	string	The principal's display name.
id	string (uuid)	The principal's ID.
servicePrincipalProfileDetails	ServicePrincipalProfileDetails	Service principal profile details. Applicable when the principal type is ServicePrincipalProfile.
type	string: ServicePrincipalProfile	The type of the principal. Additional principal types may be added over time.

UserDetails

Object

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

Name	Type	Description
userPrincipalName	string	The user principal name.

UserPrincipal

Object

Represents a Microsoft Entra user principal.

Name	Type	Description
displayName	string	The principal's display name.
id	string (uuid)	The principal's ID.
type	string: User	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.