Method: orgUnits.memberships.move

Move an OrgMembership to a new OrgUnit.

NOTE: This is an atomic copy-and-delete. The resource will have a new copy under the destination OrgUnit and be deleted from the source OrgUnit. The resource can only be searched under the destination OrgUnit afterwards.

HTTP request

POST https://cloudidentity.googleapis.com/v1beta1/{name=orgUnits/*/memberships/*}:move

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Immutable. The resource name of the OrgMembership.

Format: orgUnits/{$orgUnitId}/memberships/{$membership}

The $orgUnitId is the orgUnitId from the Admin SDK OrgUnit resource. To manage a Membership without specifying source orgUnitId, this API also supports the wildcard character '-' for $orgUnitId per https://google.aip.dev/159.

The $membership shall be of the form {$entityType};{$memberId}, where $entityType is the enum value of OrgMembership.EntityType, and memberId is the id from Drive API (V3) Drive resource for OrgMembership.EntityType.SHARED_DRIVE.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "customer": string,
  "destinationOrgUnit": string
}
Fields
customer

string

Required. Immutable. Customer on whose membership change is made.

All authorization will happen on the role assignments of this customer.

Format: customers/{$customerId}

where $customerId is the id from the Admin SDK Customer resource.

You may also use customers/my_customer to specify your own organization.
destinationOrgUnit

string

Required. Immutable. OrgUnit where the membership will be moved to.

Format: orgUnits/{$orgUnitId}

where $orgUnitId is the orgUnitId from the Admin SDK OrgUnit resource.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-identity.orgunits

For more information, see the Authorization guide.