View Source GoogleApi.CloudIdentity.V1.Model.Group (google_api_cloud_identity v0.31.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 theGroup
was created. -
description
(type:String.t
, default:nil
) - An extended description to help users determine the purpose of aGroup
. Must not be longer than 4,096 characters. -
displayName
(type:String.t
, default:nil
) - The display name of theGroup
. -
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. TheEntityKey
of theGroup
. -
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 ofcloudidentity.googleapis.com/groups.discussion_forum
and an empty value. Existing Google Groups can have an additional label with a key ofcloudidentity.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 ofcloudidentity.googleapis.com/groups.dynamic
. Identity-mapped groups for Cloud Search have a label with a key ofsystem/groups/external
and an empty value. -
name
(type:String.t
, default:nil
) - Output only. The resource name of theGroup
. Shall be of the formgroups/{group}
. -
parent
(type:String.t
, default:nil
) - Required. Immutable. The resource name of the entity under which thisGroup
resides in the Cloud Identity resource hierarchy. Must be of the formidentitysources/{identity_source}
for external identity-mapped groups orcustomers/{customer_id}
for Google Groups. Thecustomer_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 theGroup
was last updated.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@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
Unwrap a decoded JSON object into its complex fields.