Resource: 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.
JSON representation |
---|
{ "name": string, "groupKey": { object ( |
Fields | |
---|---|
name |
Output only. The resource name of the Shall be of the form |
groupKey |
Required. The |
additionalGroupKeys[] |
Output only. Additional group keys associated with the Group. |
parent |
Required. Immutable. The resource name of the entity under which this Must be of the form |
displayName |
The display name of the |
description |
An extended description to help users determine the purpose of a Must not be longer than 4,096 characters. |
createTime |
Output only. The time when the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. The time when the A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
labels |
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 Existing Google Groups can have an additional label with a key of Dynamic groups have a label with a key of Identity-mapped groups for Cloud Search have a label with a key of An object containing a list of |
dynamicGroupMetadata |
Optional. Dynamic group metadata like queries and status. |
DynamicGroupMetadata
Dynamic group metadata like queries and status.
JSON representation |
---|
{ "queries": [ { object ( |
Fields | |
---|---|
queries[] |
Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 500 dynamic groups. |
status |
Output only. Status of the dynamic group. |
DynamicGroupQuery
Defines a query on a resource.
JSON representation |
---|
{
"resourceType": enum ( |
Fields | |
---|---|
resourceType |
Resource type for the Dynamic Group Query |
query |
Query that determines the memberships of the dynamic group. Examples: All users with at least one
All users with at least one location that has
All users with any variation of the name John Doe (case-insensitive queries add
|
ResourceType
Resources supported for dynamic groups.
Enums | |
---|---|
RESOURCE_TYPE_UNSPECIFIED |
Default value (not valid) |
USER |
For queries on User |
DynamicGroupStatus
The current status of a dynamic group along with timestamp.
JSON representation |
---|
{
"status": enum ( |
Fields | |
---|---|
status |
Status of the dynamic group. |
statusTime |
The latest time at which the dynamic group is guaranteed to be in the given status. If status is A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
Status
All possible statuses of a dynamic group.
Enums | |
---|---|
STATUS_UNSPECIFIED |
Default. |
UP_TO_DATE |
The dynamic group is up-to-date. |
UPDATING_MEMBERSHIPS |
The dynamic group has just been created and memberships are being updated. |
INVALID_QUERY |
Group is in an unrecoverable state and its memberships can't be updated. |
Methods |
|
---|---|
|
Creates a Group. |
|
Deletes a Group . |
|
Retrieves a Group . |
|
Get Security Settings |
|
Lists the Group resources under a customer or namespace. |
|
Looks up the resource name of a Group by its EntityKey . |
|
Updates a Group . |
|
Searches for Group resources matching a specified query. |
|
Update Security Settings |