class Google::Apis::CloudidentityV1beta1::Group

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

additional_group_keys[RW]

Additional entity key aliases for a Group. Corresponds to the JSON property `additionalGroupKeys` @return [Array<Google::Apis::CloudidentityV1beta1::EntityKey>]

create_time[RW]

Output only. The time when the `Group` was created. Corresponds to the JSON property `createTime` @return [String]

description[RW]

An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters. Corresponds to the JSON property `description` @return [String]

display_name[RW]

The display name of the `Group`. Corresponds to the JSON property `displayName` @return [String]

dynamic_group_metadata[RW]

Dynamic group metadata like queries and status. Corresponds to the JSON property `dynamicGroupMetadata` @return [Google::Apis::CloudidentityV1beta1::DynamicGroupMetadata]

group_key[RW]

A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a ` namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. Corresponds to the JSON property `groupKey` @return [Google::Apis::CloudidentityV1beta1::EntityKey]

labels[RW]

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. Corresponds to the JSON property `labels` @return [Hash<String,String>]

name[RW]

Output only. The [resource name](cloud.google.com/apis/design/ resource_names) of the `Group`. Shall be of the form `groups/`group_id“. Corresponds to the JSON property `name` @return [String]

parent[RW]

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_id“ for external- identity-mapped groups or ` customers/`customer_id“ for Google Groups. The `customer_id` must begin with “ C” (for example, 'C046psxkn'). Corresponds to the JSON property `parent` @return [String]

posix_groups[RW]

Optional. The POSIX groups associated with the `Group`. Corresponds to the JSON property `posixGroups` @return [Array<Google::Apis::CloudidentityV1beta1::PosixGroup>]

update_time[RW]

Output only. The time when the `Group` was last updated. Corresponds to the JSON property `updateTime` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/cloudidentity_v1beta1/classes.rb, line 1637
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/cloudidentity_v1beta1/classes.rb, line 1642
def update!(**args)
  @additional_group_keys = args[:additional_group_keys] if args.key?(:additional_group_keys)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @dynamic_group_metadata = args[:dynamic_group_metadata] if args.key?(:dynamic_group_metadata)
  @group_key = args[:group_key] if args.key?(:group_key)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @parent = args[:parent] if args.key?(:parent)
  @posix_groups = args[:posix_groups] if args.key?(:posix_groups)
  @update_time = args[:update_time] if args.key?(:update_time)
end