Group

import type { Group } from "https://googleapis.deno.dev/v1/cloudidentity:v1.ts";

A group within the Cloud Identity Groups API. A Group is a collection of entities, where each entity is either a user, another group, or a service account.

interface Group {

readonly additionalGroupKeys?: EntityKey[];

readonly createTime?: Date;

description?: string;

displayName?: string;

dynamicGroupMetadata?: DynamicGroupMetadata;

groupKey?: EntityKey;

labels?: {

[key: string]: string;

};

readonly name?: string;

parent?: string;

readonly updateTime?: Date;

}

§Properties

readonly additionalGroupKeys?: EntityKey[]

[src]

Output only. Additional group keys associated with the Group.

readonly createTime?: Date

[src]

Output only. The time when the Group was created.

description?: string

[src]

An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.

displayName?: string

[src]

The display name of the Group.

dynamicGroupMetadata?: DynamicGroupMetadata

[src]

Optional. Dynamic group metadata like queries and status.

groupKey?: EntityKey

[src]

Required. The EntityKey of the Group.

labels?: {

[key: string]: string;

}

[src]

Required. One or more label entries that apply to the Group. Labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of cloudidentity.googleapis.com/groups.discussion_forum and an empty value. Existing Google Groups can have an additional label with a key of cloudidentity.googleapis.com/groups.security and an empty value added to them. This is an immutable change and the security label cannot be removed once added. Dynamic groups have a label with a key of cloudidentity.googleapis.com/groups.dynamic. Identity-mapped groups for Cloud Search have a label with a key of system/groups/external and an empty value. Google Groups can be locked. To lock a group, add a label with a key of cloudidentity.googleapis.com/groups.locked and an empty value. Doing so locks the group. To unlock the group, remove this label.

readonly name?: string

[src]

Output only. The resource name of the Group. Shall be of the form groups/{group}.

parent?: string

[src]

Required. Immutable. The resource name of the entity under which this Group resides in the Cloud Identity resource hierarchy. Must be of the form identitysources/{identity_source} for external identity-mapped groups or customers/{customer_id} for Google Groups. The customer_id must begin with "C" (for example, 'C046psxkn'). [Find your customer ID.] (https://support.google.com/cloudidentity/answer/10070793)

readonly updateTime?: Date

[src]

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