View Source GoogleApi.CloudIdentity.V1.Model.Group (google_api_cloud_identity v0.33.0)

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.

Attributes

  • additionalGroupKeys (type: list(GoogleApi.CloudIdentity.V1.Model.EntityKey.t), default: nil) - Output only. Additional group keys associated with the Group.
  • createTime (type: DateTime.t, default: nil) - Output only. The time when the Group was created.
  • description (type: String.t, default: nil) - An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
  • displayName (type: String.t, default: nil) - The display name of the Group.
  • dynamicGroupMetadata (type: GoogleApi.CloudIdentity.V1.Model.DynamicGroupMetadata.t, default: nil) - Optional. Dynamic group metadata like queries and status.
  • groupKey (type: GoogleApi.CloudIdentity.V1.Model.EntityKey.t, default: nil) - Required. The EntityKey of the Group.
  • labels (type: map(), default: nil) - Required. One or more label entries that apply to the Group. Currently supported 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.
  • name (type: String.t, default: nil) - Output only. The resource name of the Group. Shall be of the form groups/{group}.
  • parent (type: String.t, default: nil) - 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)
  • updateTime (type: DateTime.t, default: nil) - Output only. The time when the Group was last updated.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.CloudIdentity.V1.Model.Group{
  additionalGroupKeys: [GoogleApi.CloudIdentity.V1.Model.EntityKey.t()] | nil,
  createTime: DateTime.t() | nil,
  description: String.t() | nil,
  displayName: String.t() | nil,
  dynamicGroupMetadata:
    GoogleApi.CloudIdentity.V1.Model.DynamicGroupMetadata.t() | nil,
  groupKey: GoogleApi.CloudIdentity.V1.Model.EntityKey.t() | nil,
  labels: map() | nil,
  name: String.t() | nil,
  parent: String.t() | nil,
  updateTime: DateTime.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.