CloudIdentityGroup

Property Value
Google Cloud Service Name Cloud Identity
Google Cloud Service Documentation /identity/docs/
Google Cloud REST Resource Name v1.groups
Google Cloud REST Resource Documentation /identity/docs/reference/rest/v1/groups
Config Connector Resource Short Names gcpcloudidentitygroup
gcpcloudidentitygroups
cloudidentitygroup
Config Connector Service Name cloudidentity.googleapis.com
Config Connector Resource Fully Qualified Name cloudidentitygroups.cloudidentity.cnrm.cloud.google.com
Can Be Referenced by IAMPolicy/IAMPolicyMember No

Custom Resource Definition Properties

Spec

Schema

  description: string
  displayName: string
  groupKey:
    id: string
    namespace: string
  initialGroupConfig: string
  labels:
    string: string
  parent: string
  resourceID: string
Fields

description

Optional

string

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

displayName

Optional

string

The display name of the Group.

groupKey

Required

object

Immutable. EntityKey of the Group.

groupKey.id

Required

string

Immutable. The ID of the entity. For Google-managed entities, the id must be the email address of an existing group or user. For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements. Must be unique within a namespace.

groupKey.namespace

Optional

string

Immutable. The namespace in which the entity exists. If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of 'identitysources/{identity_source_id}'.

initialGroupConfig

Optional

string

Immutable. The initial configuration options for creating a Group. See the [API reference](https://cloud.google.com/identity/docs/reference/rest/v1beta1/groups/create#initialgroupconfig) for possible values. Default value: "EMPTY" Possible values: ["INITIAL_GROUP_CONFIG_UNSPECIFIED", "WITH_INITIAL_OWNER", "EMPTY"]

labels

Required

map (key: string, value: string)

Immutable. The labels that apply to the Group. Must not contain more than one entry. Must contain the entry 'cloudidentity.googleapis.com/groups.discussion_forum': '' if the Group is a Google Group or 'system/groups/external': '' if the Group is an external-identity-mapped group.

parent

Required

string

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.

resourceID

Optional

string

Immutable. Optional. The service-generated name of the resource. Used for acquisition only. Leave unset to create a new resource.

Status

Schema

  conditions:
  - lastTransitionTime: string
    message: string
    reason: string
    status: string
    type: string
  createTime: string
  name: string
  observedGeneration: integer
  updateTime: string
Fields
conditions

list (object)

Conditions represent the latest available observation of the resource's current state.

conditions.[]

object

conditions.[].lastTransitionTime

string

Last time the condition transitioned from one status to another.

conditions.[].message

string

Human-readable message indicating details about last transition.

conditions.[].reason

string

Unique, one-word, CamelCase reason for the condition's last transition.

conditions.[].status

string

Status is the status of the condition. Can be True, False, Unknown.

conditions.[].type

string

Type is the type of the condition.

createTime

string

The time when the Group was created.

name

string

Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.

observedGeneration

integer

ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource.

updateTime

string

The time when the Group was last updated.

Sample YAML(s)

Typical Use Case

  # Copyright 2021 Google LLC
  #
  # Licensed under the Apache License, Version 2.0 (the "License");
  # you may not use this file except in compliance with the License.
  # You may obtain a copy of the License at
  #
  #     http://www.apache.org/licenses/LICENSE-2.0
  #
  # Unless required by applicable law or agreed to in writing, software
  # distributed under the License is distributed on an "AS IS" BASIS,
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  # See the License for the specific language governing permissions and
  # limitations under the License.
  
  apiVersion: cloudidentity.cnrm.cloud.google.com/v1beta1
  kind: CloudIdentityGroup
  metadata:
    name: cloudidentitygroup-sample
  spec:
    displayName: Cloud Identity Group Name
    description: This is a test CloudIdentityGroup. It should be modified before use as a sample.
    groupKey:
      id: example.com
    parent: customers/C00qzcxfe
    labels:
      cloudidentity.googleapis.com/groups.discussion_forum: ""