Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. cloudidentity
  5. cloudidentity/v1beta1
  6. getGroup

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.cloudidentity/v1beta1.getGroup

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Retrieves a Group.

Using getGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>
Copy
def get_group(group_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(group_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]
Copy
func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput
Copy

> Note: This function is named LookupGroup in the Go SDK.

public static class GetGroup 
{
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
public static Output<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:cloudidentity/v1beta1:getGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GroupId This property is required. string
GroupId This property is required. string
groupId This property is required. String
groupId This property is required. string
group_id This property is required. str
groupId This property is required. String

getGroup Result

The following output properties are available:

AdditionalGroupKeys List<Pulumi.GoogleNative.CloudIdentity.V1Beta1.Outputs.EntityKeyResponse>
Additional group keys associated with the Group.
CreateTime string
The time when the Group was created.
Description string
An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
DisplayName string
The display name of the Group.
DynamicGroupMetadata Pulumi.GoogleNative.CloudIdentity.V1Beta1.Outputs.DynamicGroupMetadataResponse
Optional. Dynamic group metadata like queries and status.
GroupKey Pulumi.GoogleNative.CloudIdentity.V1Beta1.Outputs.EntityKeyResponse
The EntityKey of the Group.
Labels Dictionary<string, string>
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.
Name string
The resource name of the Group. Shall be of the form groups/{group_id}.
Parent 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} 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)
PosixGroups List<Pulumi.GoogleNative.CloudIdentity.V1Beta1.Outputs.PosixGroupResponse>
Optional. The POSIX groups associated with the Group.
UpdateTime string
The time when the Group was last updated.
AdditionalGroupKeys []EntityKeyResponse
Additional group keys associated with the Group.
CreateTime string
The time when the Group was created.
Description string
An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
DisplayName string
The display name of the Group.
DynamicGroupMetadata DynamicGroupMetadataResponse
Optional. Dynamic group metadata like queries and status.
GroupKey EntityKeyResponse
The EntityKey of the Group.
Labels map[string]string
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.
Name string
The resource name of the Group. Shall be of the form groups/{group_id}.
Parent 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} 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)
PosixGroups []PosixGroupResponse
Optional. The POSIX groups associated with the Group.
UpdateTime string
The time when the Group was last updated.
additionalGroupKeys List<EntityKeyResponse>
Additional group keys associated with the Group.
createTime String
The time when the Group was created.
description String
An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
displayName String
The display name of the Group.
dynamicGroupMetadata DynamicGroupMetadataResponse
Optional. Dynamic group metadata like queries and status.
groupKey EntityKeyResponse
The EntityKey of the Group.
labels Map<String,String>
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.
name String
The resource name of the Group. Shall be of the form groups/{group_id}.
parent 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} 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)
posixGroups List<PosixGroupResponse>
Optional. The POSIX groups associated with the Group.
updateTime String
The time when the Group was last updated.
additionalGroupKeys EntityKeyResponse[]
Additional group keys associated with the Group.
createTime string
The time when the Group was created.
description string
An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
displayName string
The display name of the Group.
dynamicGroupMetadata DynamicGroupMetadataResponse
Optional. Dynamic group metadata like queries and status.
groupKey EntityKeyResponse
The EntityKey of the Group.
labels {[key: string]: string}
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.
name string
The resource name of the Group. Shall be of the form groups/{group_id}.
parent 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} 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)
posixGroups PosixGroupResponse[]
Optional. The POSIX groups associated with the Group.
updateTime string
The time when the Group was last updated.
additional_group_keys Sequence[EntityKeyResponse]
Additional group keys associated with the Group.
create_time str
The time when the Group was created.
description str
An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
display_name str
The display name of the Group.
dynamic_group_metadata DynamicGroupMetadataResponse
Optional. Dynamic group metadata like queries and status.
group_key EntityKeyResponse
The EntityKey of the Group.
labels Mapping[str, str]
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.
name str
The resource name of the Group. Shall be of the form groups/{group_id}.
parent str
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)
posix_groups Sequence[PosixGroupResponse]
Optional. The POSIX groups associated with the Group.
update_time str
The time when the Group was last updated.
additionalGroupKeys List<Property Map>
Additional group keys associated with the Group.
createTime String
The time when the Group was created.
description String
An extended description to help users determine the purpose of a Group. Must not be longer than 4,096 characters.
displayName String
The display name of the Group.
dynamicGroupMetadata Property Map
Optional. Dynamic group metadata like queries and status.
groupKey Property Map
The EntityKey of the Group.
labels Map<String>
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.
name String
The resource name of the Group. Shall be of the form groups/{group_id}.
parent 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} 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)
posixGroups List<Property Map>
Optional. The POSIX groups associated with the Group.
updateTime String
The time when the Group was last updated.

Supporting Types

DynamicGroupMetadataResponse

Queries This property is required. List<Pulumi.GoogleNative.CloudIdentity.V1Beta1.Inputs.DynamicGroupQueryResponse>
Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups.
Status This property is required. Pulumi.GoogleNative.CloudIdentity.V1Beta1.Inputs.DynamicGroupStatusResponse
Status of the dynamic group.
Queries This property is required. []DynamicGroupQueryResponse
Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups.
Status This property is required. DynamicGroupStatusResponse
Status of the dynamic group.
queries This property is required. List<DynamicGroupQueryResponse>
Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups.
status This property is required. DynamicGroupStatusResponse
Status of the dynamic group.
queries This property is required. DynamicGroupQueryResponse[]
Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups.
status This property is required. DynamicGroupStatusResponse
Status of the dynamic group.
queries This property is required. Sequence[DynamicGroupQueryResponse]
Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups.
status This property is required. DynamicGroupStatusResponse
Status of the dynamic group.
queries This property is required. List<Property Map>
Memberships will be the union of all queries. Only one entry with USER resource is currently supported. Customers can create up to 100 dynamic groups.
status This property is required. Property Map
Status of the dynamic group.

DynamicGroupQueryResponse

Query This property is required. string
Query that determines the memberships of the dynamic group. Examples: All users with at least one organizations.department of engineering. user.organizations.exists(org, org.department=='engineering') All users with at least one location that has area of foo and building_id of bar. user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar') All users with any variation of the name John Doe (case-insensitive queries add equalsIgnoreCase() to the value being queried). user.name.value.equalsIgnoreCase('jOhn DoE')
ResourceType This property is required. string
Query This property is required. string
Query that determines the memberships of the dynamic group. Examples: All users with at least one organizations.department of engineering. user.organizations.exists(org, org.department=='engineering') All users with at least one location that has area of foo and building_id of bar. user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar') All users with any variation of the name John Doe (case-insensitive queries add equalsIgnoreCase() to the value being queried). user.name.value.equalsIgnoreCase('jOhn DoE')
ResourceType This property is required. string
query This property is required. String
Query that determines the memberships of the dynamic group. Examples: All users with at least one organizations.department of engineering. user.organizations.exists(org, org.department=='engineering') All users with at least one location that has area of foo and building_id of bar. user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar') All users with any variation of the name John Doe (case-insensitive queries add equalsIgnoreCase() to the value being queried). user.name.value.equalsIgnoreCase('jOhn DoE')
resourceType This property is required. String
query This property is required. string
Query that determines the memberships of the dynamic group. Examples: All users with at least one organizations.department of engineering. user.organizations.exists(org, org.department=='engineering') All users with at least one location that has area of foo and building_id of bar. user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar') All users with any variation of the name John Doe (case-insensitive queries add equalsIgnoreCase() to the value being queried). user.name.value.equalsIgnoreCase('jOhn DoE')
resourceType This property is required. string
query This property is required. str
Query that determines the memberships of the dynamic group. Examples: All users with at least one organizations.department of engineering. user.organizations.exists(org, org.department=='engineering') All users with at least one location that has area of foo and building_id of bar. user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar') All users with any variation of the name John Doe (case-insensitive queries add equalsIgnoreCase() to the value being queried). user.name.value.equalsIgnoreCase('jOhn DoE')
resource_type This property is required. str
query This property is required. String
Query that determines the memberships of the dynamic group. Examples: All users with at least one organizations.department of engineering. user.organizations.exists(org, org.department=='engineering') All users with at least one location that has area of foo and building_id of bar. user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar') All users with any variation of the name John Doe (case-insensitive queries add equalsIgnoreCase() to the value being queried). user.name.value.equalsIgnoreCase('jOhn DoE')
resourceType This property is required. String

DynamicGroupStatusResponse

Status This property is required. string
Status of the dynamic group.
StatusTime This property is required. string
The latest time at which the dynamic group is guaranteed to be in the given status. If status is UP_TO_DATE, the latest time at which the dynamic group was confirmed to be up-to-date. If status is UPDATING_MEMBERSHIPS, the time at which dynamic group was created.
Status This property is required. string
Status of the dynamic group.
StatusTime This property is required. string
The latest time at which the dynamic group is guaranteed to be in the given status. If status is UP_TO_DATE, the latest time at which the dynamic group was confirmed to be up-to-date. If status is UPDATING_MEMBERSHIPS, the time at which dynamic group was created.
status This property is required. String
Status of the dynamic group.
statusTime This property is required. String
The latest time at which the dynamic group is guaranteed to be in the given status. If status is UP_TO_DATE, the latest time at which the dynamic group was confirmed to be up-to-date. If status is UPDATING_MEMBERSHIPS, the time at which dynamic group was created.
status This property is required. string
Status of the dynamic group.
statusTime This property is required. string
The latest time at which the dynamic group is guaranteed to be in the given status. If status is UP_TO_DATE, the latest time at which the dynamic group was confirmed to be up-to-date. If status is UPDATING_MEMBERSHIPS, the time at which dynamic group was created.
status This property is required. str
Status of the dynamic group.
status_time This property is required. str
The latest time at which the dynamic group is guaranteed to be in the given status. If status is UP_TO_DATE, the latest time at which the dynamic group was confirmed to be up-to-date. If status is UPDATING_MEMBERSHIPS, the time at which dynamic group was created.
status This property is required. String
Status of the dynamic group.
statusTime This property is required. String
The latest time at which the dynamic group is guaranteed to be in the given status. If status is UP_TO_DATE, the latest time at which the dynamic group was confirmed to be up-to-date. If status is UPDATING_MEMBERSHIPS, the time at which dynamic group was created.

EntityKeyResponse

Namespace This property is required. string
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}.
Namespace This property is required. string
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}.
namespace This property is required. String
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}.
namespace This property is required. string
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}.
namespace This property is required. str
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}.
namespace This property is required. String
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}.

PosixGroupResponse

Gid This property is required. string
GID of the POSIX group.
Name This property is required. string
Name of the POSIX group.
SystemId This property is required. string
System identifier for which group name and gid apply to. If not specified it will default to empty value.
Gid This property is required. string
GID of the POSIX group.
Name This property is required. string
Name of the POSIX group.
SystemId This property is required. string
System identifier for which group name and gid apply to. If not specified it will default to empty value.
gid This property is required. String
GID of the POSIX group.
name This property is required. String
Name of the POSIX group.
systemId This property is required. String
System identifier for which group name and gid apply to. If not specified it will default to empty value.
gid This property is required. string
GID of the POSIX group.
name This property is required. string
Name of the POSIX group.
systemId This property is required. string
System identifier for which group name and gid apply to. If not specified it will default to empty value.
gid This property is required. str
GID of the POSIX group.
name This property is required. str
Name of the POSIX group.
system_id This property is required. str
System identifier for which group name and gid apply to. If not specified it will default to empty value.
gid This property is required. String
GID of the POSIX group.
name This property is required. String
Name of the POSIX group.
systemId This property is required. String
System identifier for which group name and gid apply to. If not specified it will default to empty value.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native