REST Resource: orgUnits.memberships

Stay organized with collections Save and categorize content based on your preferences.

Resource: OrgMembership

A membership in an OrgUnit.

An OrgMembership defines a relationship between an OrgUnit and an entity belonging to that OrgUnit, referred to as a "member".

JSON representation
{
  "name": string,
  "type": enum (EntityType),
  "member": string,
  "memberUri": string
}
Fields
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.

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.

type

enum (EntityType)

Immutable. Entity type for the org member.

member

string

Immutable. Org member id as full resource name.

Format for shared drive resource: //drive.googleapis.com/drives/{$memberId}

where $memberId is the id from Drive API (V3) Drive resource.

memberUri

string

Uri with which you can read the member.

This follows https://aip.dev/122

Format for shared drive resource: https://drive.googleapis.com/drive/v3/drives/{$memberId}

where $memberId is the id from Drive API (V3) Drive resource.

EntityType

Entity type for an org member.

Enums
ENTITY_TYPE_UNSPECIFIED Equivalent to no resource type mentioned
SHARED_DRIVE Shared drive as resource type

Methods

list

List OrgMembership resources in an OrgUnit treated as 'parent'.

move

Move an OrgMembership to a new OrgUnit.