groups

Creates, updates, deletes, gets or lists a groups resource.

Overview

Name	groups
Type	Resource
Id	google.cloudidentity.groups

Fields

Name	Datatype	Description
name	string	Output only. The resource name of the Group. Shall be of the form groups/{group}.
description	string	An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
additionalGroupKeys	array	Output only. Additional group keys associated with the Group.
createTime	string	Output only. The time when the Group was created.
displayName	string	The display name of the Group.
dynamicGroupMetadata	object	Dynamic group metadata like queries and status.
groupKey	object	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 namespaces.
labels	object	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.
parent	string	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	string	Output only. The time when the Group was last updated.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	groupsId	Retrieves a Group.
list	SELECT		Lists the Group resources under a customer or namespace.
create	INSERT		Creates a Group.
delete	DELETE	groupsId	Deletes a Group.
patch	UPDATE	groupsId	Updates a Group.
lookup	EXEC		Looks up the resource name of a Group by its EntityKey.
search	EXEC		Searches for Group resources matching a specified query.

SELECT examples

Lists the Group resources under a customer or namespace.

SELECT
name,
description,
additionalGroupKeys,
createTime,
displayName,
dynamicGroupMetadata,
groupKey,
labels,
parent,
updateTime
FROM google.cloudidentity.groups
;

INSERT example

Use the following StackQL query and manifest file to create a new groups resource.

All Properties

/*+ create */
INSERT INTO google.cloudidentity.groups (
groupKey,
parent,
displayName,
description,
labels,
dynamicGroupMetadata
)
SELECT 
'{{ groupKey }}',
'{{ parent }}',
'{{ displayName }}',
'{{ description }}',
'{{ labels }}',
'{{ dynamicGroupMetadata }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: groupKey
      value:
        - name: id
          value: string
        - name: namespace
          value: string
    - name: additionalGroupKeys
      value:
        - - name: id
            value: string
          - name: namespace
            value: string
    - name: parent
      value: string
    - name: displayName
      value: string
    - name: description
      value: string
    - name: createTime
      value: string
    - name: updateTime
      value: string
    - name: labels
      value: object
    - name: dynamicGroupMetadata
      value:
        - name: queries
          value:
            - - name: resourceType
                value: string
              - name: query
                value: string
        - name: status
          value:
            - name: status
              value: string
            - name: statusTime
              value: string

UPDATE example

Updates a groups resource.

/*+ update */
UPDATE google.cloudidentity.groups
SET 
groupKey = '{{ groupKey }}',
parent = '{{ parent }}',
displayName = '{{ displayName }}',
description = '{{ description }}',
labels = '{{ labels }}',
dynamicGroupMetadata = '{{ dynamicGroupMetadata }}'
WHERE 
groupsId = '{{ groupsId }}';

DELETE example

Deletes the specified groups resource.

/*+ delete */
DELETE FROM google.cloudidentity.groups
WHERE groupsId = '{{ groupsId }}';