Domains - Role Assignments Bulk Unassign

Service:

Admin

API Version:

v1

Note

This API is in preview.

Unassign the specified admins or contributors from 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.

Interface

POST https://api.fabric.microsoft.com/v1/admin/domains/{domainId}/roleAssignments/bulkUnassign

URI Parameters

Name	In	Required	Type	Description
domainId	path	True	string uuid	The domain ID.

Request Body

Name	Required	Type	Description
type	True	DomainRole	The update request type.
principals		Principal[]

Responses

Name	Type	Description
200 OK		Request completed successfully.
Other Status Codes	ErrorResponse	Common error codes: DomainSpecificUsersScopeCannotBeEmptyError - Unassigning domain members failed because when the contributors scope is set to 'Specific Users And Groups', the users or groups list can't be empty.

Examples

Unassign domain admins example

Unassign domain contributors example

Unassign domain admins example

Sample Request

HTTP

POST https://api.fabric.microsoft.com/v1/admin/domains/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f/roleAssignments/bulkUnassign

{
  "type": "Admins",
  "principals": [
    {
      "id": "796ce6ad-9163-4c16-9559-c68192a251de",
      "type": "User"
    }
  ]
}

Sample Response

Status code:

200

Unassign domain contributors example

Sample Request

HTTP

POST https://api.fabric.microsoft.com/v1/admin/domains/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f/roleAssignments/bulkUnassign

{
  "type": "Contributors",
  "principals": [
    {
      "id": "796ce6ad-9163-4c16-9559-c68192a251de",
      "type": "User"
    }
  ]
}

Sample Response

Status code:

200

Definitions

Name	Description
DomainRole	Represents the domain members by the principal's request type. Additional request types may be added over time.
DomainRoleUnassignmentRequest	The request payload for unassigning domain members by 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.
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.

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.

DomainRoleUnassignmentRequest

The request payload for unassigning domain members by principal.

Name	Type	Description
principals	Principal[]
type	DomainRole	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	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.