Method: orgUnits.memberships.list

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

Parent format: orgUnits/{$orgUnitId}

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

HTTP request

GET https://cloudidentity.googleapis.com/v1beta1/{parent=orgUnits/*}/memberships

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Immutable. OrgUnit which is queried for a list of memberships.

Format: orgUnits/{$orgUnitId}

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

Query parameters

Parameters
customer

string

Required. Immutable. Customer that this OrgMembership belongs to.

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

string

The search query.

Must be specified in Common Expression Language. May only contain equality operators on the type (e.g., type == 'shared_drive').
pageSize

integer

The maximum number of results to return.

The service may return fewer than this value.

If omitted (or defaulted to zero) the server will default to 50.

The maximum allowed value is 100, though requests with pageSize greater than that will be silently interpreted as 100.
pageToken

string

A page token, received from a previous OrgMembershipsService.ListOrgMemberships call.

Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListOrgMembershipsRequest must match the call that provided the page token.

Request body

The request body must be empty.

Response body

The response message for OrgMembershipsService.ListOrgMemberships.

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

JSON representation 
{
  "orgMemberships": [
    {
      object (OrgMembership)
    }
  ],
  "nextPageToken": string
}
Fields
orgMemberships[]

object (OrgMembership)

The non-vacuous membership in an orgUnit.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page.

If this field is empty, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authorization guide.