Domains - Role Assignments Bulk Assign
Note
This API is in preview.
Assign the specified admins or contributors to the domain.
Permissions
The caller must have administrator rights such as Office 365 Global administrator or Fabric administrator.
Required Delegated Scopes
Tenant.ReadWrite.All.
Limitations
Maximum 25 requests per one minute per principal.
Microsoft Entra supported identities
This API supports the Microsoft identities listed in this section.
Identity | Support |
---|---|
User | Yes |
Service principal | No |
Managed identities | No |
Interface
POST https://api.fabric.microsoft.com/v1/admin/domains/{domainId}/roleAssignments/bulkAssign
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
domain
|
path | True |
string uuid |
The domain ID. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
type | True |
The update request type. |
|
principals |
Represents an identity or a Microsoft Entra group. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Request completed successfully. |
|
Other Status Codes |
Common error codes:
|
Examples
Assign domain admins example |
Assign domain contributors example |
Assign domain admins example
Sample request
POST https://api.fabric.microsoft.com/v1/admin/domains/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f/roleAssignments/bulkAssign
{
"type": "Admins",
"principals": [
{
"id": "796ce6ad-9163-4c16-9559-c68192a251de",
"type": "User"
}
]
}
Sample response
Assign domain contributors example
Sample request
POST https://api.fabric.microsoft.com/v1/admin/domains/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f/roleAssignments/bulkAssign
{
"type": "Contributors",
"principals": [
{
"id": "796ce6ad-9163-4c16-9559-c68192a251de",
"type": "User"
}
]
}
Sample response
Definitions
Name | Description |
---|---|
Domain |
Represents the domain members by the principal's request type. Additional request types may be added over time. |
Domain |
The request payload for assigning domain members for a domain by principal. |
Error |
The error related resource details object. |
Error |
The error response. |
Error |
The error response details. |
Group |
Group specific details. Applicable when the principal type is |
Group |
The type of the group. Additional group types may be added over time. |
Principal |
Represents an identity or a Microsoft Entra group. |
Principal |
The type of the principal. Additional principal types may be added over time. |
Service |
Service principal specific details. Applicable when the principal type is |
Service |
Service principal profile details. Applicable when the principal type is |
User |
User principal specific details. Applicable when the principal type is |
DomainRole
Represents the domain members by the principal's request type. Additional request types may be added over time.
Name | Type | Description |
---|---|---|
Admins |
string |
Domain admins request type. |
Contributors |
string |
Domain contributors request type. |
DomainRoleAssignmentRequest
The request payload for assigning domain members for a domain by principal.
Name | Type | Description |
---|---|---|
principals |
Represents an identity or a Microsoft Entra group. |
|
type |
The update request type. |
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 |
List of additional error details. |
|
relatedResource |
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 |
The error related resource details. |
GroupDetails
Group specific details. Applicable when the principal type is Group
.
Name | Type | Description |
---|---|---|
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
Represents an identity or a Microsoft Entra group.
Name | Type | Description |
---|---|---|
displayName |
string |
The principal's display name. |
groupDetails |
Group specific details. Applicable when the principal type is |
|
id |
string |
The principal's ID. |
servicePrincipalDetails |
Service principal specific details. Applicable when the principal type is |
|
servicePrincipalProfileDetails |
Service principal profile details. Applicable when the principal type is |
|
type |
The type of the principal. Additional principal types may be added over time. |
|
userDetails |
User principal specific details. Applicable when the principal type is |
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 |
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. |