Edit

Share via

Domains - Sync Role Assignments To Subdomains

Service:
Admin
API Version:
v1

Sync the role assignments from the specified domain to its subdomains.

Permissions

The caller must be a Fabric administrator.

Required Delegated Scopes

Tenant.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/admin/domains/{domainId}/roleAssignments/syncToSubdomains

URI Parameters

Name In Required Type Description
domainId
 path True

string (uuid)

The domain ID.

Request Body

Name Required Type Description
role True

DomainRole

Specifies the role of members to be synchronized with subdomains.

Responses

Name Type Description
200 OK

Request completed successfully.
Other Status Codes

ErrorResponse

Common error codes:

  • SyncingAdminsToSubdomainsIsNotSupported - Syncing admins to subdomains is not supported

  • DomainNotFound - The provided domain was not found

  • UnknownError - An error occurred.

Examples

Assign domain contributors to subdomains example

Sample request

POST https://api.fabric.microsoft.com/v1/admin/domains/d27d5b23-4a7e-4185-b81e-ac2b20cdd9a8/roleAssignments/syncToSubdomains

{
  "role": "Contributor"
}

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

The error related resource details object.
ErrorResponse

The error response.
ErrorResponseDetails

The error response details.
SyncRoleAssignmentsToSubdomainsRequest

The request payload for syncing domain members to subdomains.

DomainRole

Enumeration

Represents the domain members by the principal's request type. Additional request types may be added over time.

Value Description
Admin

Domain admin.
Contributor

Domain contributor.

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.

SyncRoleAssignmentsToSubdomainsRequest

Object

The request payload for syncing domain members to subdomains.

Name Type Description
role

DomainRole

Specifies the role of members to be synchronized with subdomains.