REST Resource: groups.memberships

Resource: Membership

A membership within the Cloud Identity Groups API.

A Membership defines a relationship between a Group and an entity belonging to that Group, referred to as a "member".

JSON representation
{
  "name": string,
  "preferredMemberKey": {
    object (EntityKey)
  },
  "createTime": string,
  "updateTime": string,
  "roles": [
    {
      object (MembershipRole)
    }
  ],
  "type": enum (Type),
  "deliverySetting": enum (DeliverySetting)
}
Fields
name

string

Output only. The resource name of the Membership.

Shall be of the form groups/{group}/memberships/{membership}.

preferredMemberKey

object (EntityKey)

Required. Immutable. The EntityKey of the member.

createTime

string (Timestamp format)

Output only. The time when the Membership was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. The time when the Membership was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

roles[]

object (MembershipRole)

The MembershipRoles that apply to the Membership.

If unspecified, defaults to a single MembershipRole with name MEMBER.

Must not contain duplicate MembershipRoles with the same name.

type

enum (Type)

Output only. The type of the membership.

deliverySetting

enum (DeliverySetting)

Output only. Delivery setting associated with the membership.

MembershipRole

A membership role within the Cloud Identity Groups API.

A MembershipRole defines the privileges granted to a Membership.

JSON representation
{
  "name": string,
  "expiryDetail": {
    object (ExpiryDetail)
  },
  "restrictionEvaluations": {
    object (RestrictionEvaluations)
  }
}
Fields
name

string

The name of the MembershipRole.

Must be one of OWNER, MANAGER, MEMBER.

expiryDetail

object (ExpiryDetail)

The expiry details of the MembershipRole.

Expiry details are only supported for MEMBER MembershipRoles.

May be set if name is MEMBER. Must not be set if name is any other value.

restrictionEvaluations

object (RestrictionEvaluations)

Evaluations of restrictions applied to parent group on this membership.

ExpiryDetail

The MembershipRole expiry details.

JSON representation
{
  "expireTime": string
}
Fields
expireTime

string (Timestamp format)

The time at which the MembershipRole will expire.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

RestrictionEvaluations

Evaluations of restrictions applied to parent group on this membership.

JSON representation
{
  "memberRestrictionEvaluation": {
    object (RestrictionEvaluation)
  }
}
Fields
memberRestrictionEvaluation

object (RestrictionEvaluation)

Evaluation of the member restriction applied to this membership.

Empty if the user lacks permission to view the restriction evaluation.

RestrictionEvaluation

The evaluated state of this restriction.

JSON representation
{
  "state": enum (State)
}
Fields
state

enum (State)

Output only. The current state of the restriction

State

All possible states of a restriction.

Enums
STATE_UNSPECIFIEDDefault. Should not be used.
COMPLIANTThe member adheres to the parent group's restriction.
FORWARD_COMPLIANTThe group-group membership might be currently violating some parent group's restriction but in future, it will never allow any new member in the child group which can violate parent group's restriction.
NON_COMPLIANTThe member violates the parent group's restriction.
EVALUATINGThe state of the membership is under evaluation.

Type

Enums
TYPE_UNSPECIFIEDDefault. Should not be used.
USERRepresents user type.
SERVICE_ACCOUNTRepresents service account type.
GROUPRepresents group type.
SHARED_DRIVERepresents Shared drive.
CBCM_BROWSERRepresents a CBCM-managed Chrome Browser type.
OTHERRepresents other type.

DeliverySetting

Delivery setting associated with the membership.

Enums
DELIVERY_SETTING_UNSPECIFIEDDefault. Should not be used.
ALL_MAILRepresents each mail should be delivered
DIGESTRepresents 1 email for every 25 messages.
DAILYRepresents daily summary of messages.
NONERepresents no delivery.
DISABLEDRepresents disabled state.

Methods

checkTransitiveMembership

Check a potential member for membership in a group.

create

Creates a Membership.

delete

Deletes a Membership.

get

Retrieves a Membership.

getMembershipGraph

Get a membership graph of just a member or both a member and a group.

list

Lists the Memberships within a Group.

lookup

Looks up the resource name of a Membership by its EntityKey.

modifyMembershipRoles

Modifies the MembershipRoles of a Membership.

searchDirectGroups

Searches direct groups of a member.

searchTransitiveGroups

Search transitive groups of a member.

searchTransitiveMemberships

Search transitive memberships of a group.