Method: domains.checkMigrationPermission

Full name: projects.locations.global.domains.checkMigrationPermission

domains.checkMigrationPermission API gets the current state of DomainMigration

HTTP request

POST https://managedidentities.googleapis.com/v1beta1/{domain=projects/*/locations/global/domains/*}:checkMigrationPermission

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
domain

string

Required. The domain resource name using the form: projects/{projectId}/locations/global/domains/{domainName}

Authorization requires the following IAM permission on the specified resource domain:

  • managedidentities.domains.checkMigrationPermission

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

CheckMigrationPermissionResponse is the response message for domains.checkMigrationPermission method.

JSON representation 
{
  "state": enum (State),
  "onpremDomains": [
    {
      object (OnPremDomainSIDDetails)
    }
  ]
}
Fields
state

enum (State)

The state of DomainMigration.
onpremDomains[]

object (OnPremDomainSIDDetails)

The state of SID filtering of all the domains which has trust established.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

State

State of DomainMigration Permissions.

Enums
STATE_UNSPECIFIED DomainMigration is in unspecified state.
DISABLED Domain Migration is Disabled.
ENABLED Domain Migration is Enabled.
NEEDS_MAINTENANCE Domain Migration is not in valid state.

OnPremDomainSIDDetails

OnPremDomainDetails is the message which contains details of on-prem domain which is trusted and needs to be migrated.

JSON representation 
{
  "name": string,
  "sidFilteringState": enum (SIDFilteringState)
}
Fields
name

string

FQDN of the on-prem domain being migrated.
sidFilteringState

enum (SIDFilteringState)

Current SID filtering state.

SIDFilteringState

State of SIDFiltering Permissions.

Enums
SID_FILTERING_STATE_UNSPECIFIED SID Filtering is in unspecified state.
ENABLED SID Filtering is Enabled.
DISABLED SID Filtering is Disabled.