Gateways - Add Gateway Role Assignment

Service:

Core

API Version:

v1

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

Service Principal Profiles are not supported for Gateway Role Assignments.

Permissions

• The caller must have ConnectionCreatorWithResharing or higher role on the gateway.

Required Delegated Scopes

Gateway.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/gateways/{gatewayId}/roleAssignments

URI Parameters

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

Request Body

Name	Required	Type	Description
principal	True	Principal	The principal.
role	True	GatewayRole	The gateway role of the principal.

Responses

Name	Type	Description
201 Created	GatewayRoleAssignment	Successfully created. Headers Location: string
Other Status Codes	ErrorResponse	Common error codes: BadRequest - Missing required parameter.

Examples

Add gateway role assignment example

Sample request

HTTP

POST https://api.fabric.microsoft.com/v1/gateways/d12d139f-4141-467c-9f53-80787b198843/roleAssignments

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

Sample response

Status code:

201

Location: https://api.fabric.microsoft.com/v1/gateways/d12d139f-4141-467c-9f53-80787b198843/roleAssignments/6a002b3d-e4ec-43df-8c08-e8eb7547d9dd

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

Definitions

Name	Description
AddGatewayRoleAssignmentRequest	The add gateway role assignment request for a principal.
ErrorRelatedResource	The error related resource details object.
ErrorResponse	The error response.
ErrorResponseDetails	The error response details.
GatewayRole	A Gateway role. Additional gateway roles may be added over time.
GatewayRoleAssignment	The gateway role assignment for a principal.
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.

AddGatewayRoleAssignmentRequest

Object

The add gateway role assignment request for a principal.

Name	Type	Description
principal	Principal	The principal.
role	GatewayRole	The gateway role of the principal.

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.

GatewayRole

Enumeration

A Gateway role. Additional gateway roles may be added over time.

Value	Description
Admin	Enables administrative access for the gateway.
ConnectionCreatorWithResharing	Enables connection creator with resharing access for the gateway.
ConnectionCreator	Enables connection creator access for the gateway.

GatewayRoleAssignment

Object

The gateway role assignment for a principal.

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

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

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.