google-native.cloudidentity/v1.getGroup
Explore with Pulumi AI
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>
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]
func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput
> 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)
}
public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: google-native:cloudidentity/v1:getGroup
arguments:
# arguments dictionary
The following arguments are supported:
- Group
Id string
- Group
Id string
- group
Id String
- group
Id string
- group_
id str
- group
Id String
getGroup Result
The following output properties are available:
- Additional
Group List<Pulumi.Keys Google Native. Cloud Identity. V1. Outputs. Entity Key Response> Additional group keys associated with the Group.
- Create
Time 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.- Display
Name string The display name of the
Group
.- Dynamic
Group Pulumi.Metadata Google Native. Cloud Identity. V1. Outputs. Dynamic Group Metadata Response Optional. Dynamic group metadata like queries and status.
- Group
Key Pulumi.Google Native. Cloud Identity. V1. Outputs. Entity Key Response The
EntityKey
of theGroup
.- 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 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 string
The resource name of the
Group
. Shall be of the formgroups/{group}
.- Parent string
Immutable. The resource name of the entity under which this
Group
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)- Update
Time string The time when the
Group
was last updated.
- Additional
Group []EntityKeys Key Response Additional group keys associated with the Group.
- Create
Time 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.- Display
Name string The display name of the
Group
.- Dynamic
Group DynamicMetadata Group Metadata Response Optional. Dynamic group metadata like queries and status.
- Group
Key EntityKey Response The
EntityKey
of theGroup
.- 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 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 string
The resource name of the
Group
. Shall be of the formgroups/{group}
.- Parent string
Immutable. The resource name of the entity under which this
Group
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)- Update
Time string The time when the
Group
was last updated.
- additional
Group List<EntityKeys Key Response> Additional group keys associated with the Group.
- create
Time 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.- display
Name String The display name of the
Group
.- dynamic
Group DynamicMetadata Group Metadata Response Optional. Dynamic group metadata like queries and status.
- group
Key EntityKey Response The
EntityKey
of theGroup
.- 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 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 String
The resource name of the
Group
. Shall be of the formgroups/{group}
.- parent String
Immutable. The resource name of the entity under which this
Group
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)- update
Time String The time when the
Group
was last updated.
- additional
Group EntityKeys Key Response[] Additional group keys associated with the Group.
- create
Time 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.- display
Name string The display name of the
Group
.- dynamic
Group DynamicMetadata Group Metadata Response Optional. Dynamic group metadata like queries and status.
- group
Key EntityKey Response The
EntityKey
of theGroup
.- 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 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 string
The resource name of the
Group
. Shall be of the formgroups/{group}
.- parent string
Immutable. The resource name of the entity under which this
Group
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)- update
Time string The time when the
Group
was last updated.
- additional_
group_ Sequence[Entitykeys Key Response] 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_ Dynamicmetadata Group Metadata Response Optional. Dynamic group metadata like queries and status.
- group_
key EntityKey Response The
EntityKey
of theGroup
.- 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 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 str
The resource name of the
Group
. Shall be of the formgroups/{group}
.- parent str
Immutable. The resource name of the entity under which this
Group
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)- update_
time str The time when the
Group
was last updated.
- additional
Group List<Property Map>Keys Additional group keys associated with the Group.
- create
Time 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.- display
Name String The display name of the
Group
.- dynamic
Group Property MapMetadata Optional. Dynamic group metadata like queries and status.
- group
Key Property Map The
EntityKey
of theGroup
.- 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 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 String
The resource name of the
Group
. Shall be of the formgroups/{group}
.- parent String
Immutable. The resource name of the entity under which this
Group
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)- update
Time String The time when the
Group
was last updated.
Supporting Types
DynamicGroupMetadataResponse
- Queries
List<Pulumi.
Google Native. Cloud Identity. V1. Inputs. Dynamic Group Query Response> 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
Pulumi.
Google Native. Cloud Identity. V1. Inputs. Dynamic Group Status Response Status of the dynamic group.
- Queries
[]Dynamic
Group Query Response 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
Dynamic
Group Status Response Status of the dynamic group.
- queries
List<Dynamic
Group Query Response> 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
Dynamic
Group Status Response Status of the dynamic group.
- queries
Dynamic
Group Query Response[] 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
Dynamic
Group Status Response Status of the dynamic group.
- queries
Sequence[Dynamic
Group Query Response] 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
Dynamic
Group Status Response Status of the dynamic group.
- queries 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 Property Map
Status of the dynamic group.
DynamicGroupQueryResponse
- Query 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 hasarea
offoo
andbuilding_id
ofbar
.user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')
All users with any variation of the name John Doe (case-insensitive queries addequalsIgnoreCase()
to the value being queried).user.name.value.equalsIgnoreCase('jOhn DoE')
- Resource
Type string Resource type for the Dynamic Group Query
- Query 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 hasarea
offoo
andbuilding_id
ofbar
.user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')
All users with any variation of the name John Doe (case-insensitive queries addequalsIgnoreCase()
to the value being queried).user.name.value.equalsIgnoreCase('jOhn DoE')
- Resource
Type string Resource type for the Dynamic Group Query
- query 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 hasarea
offoo
andbuilding_id
ofbar
.user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')
All users with any variation of the name John Doe (case-insensitive queries addequalsIgnoreCase()
to the value being queried).user.name.value.equalsIgnoreCase('jOhn DoE')
- resource
Type String Resource type for the Dynamic Group Query
- query 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 hasarea
offoo
andbuilding_id
ofbar
.user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')
All users with any variation of the name John Doe (case-insensitive queries addequalsIgnoreCase()
to the value being queried).user.name.value.equalsIgnoreCase('jOhn DoE')
- resource
Type string Resource type for the Dynamic Group Query
- query 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 hasarea
offoo
andbuilding_id
ofbar
.user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')
All users with any variation of the name John Doe (case-insensitive queries addequalsIgnoreCase()
to the value being queried).user.name.value.equalsIgnoreCase('jOhn DoE')
- resource_
type str Resource type for the Dynamic Group Query
- query 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 hasarea
offoo
andbuilding_id
ofbar
.user.locations.exists(loc, loc.area=='foo' && loc.building_id=='bar')
All users with any variation of the name John Doe (case-insensitive queries addequalsIgnoreCase()
to the value being queried).user.name.value.equalsIgnoreCase('jOhn DoE')
- resource
Type String Resource type for the Dynamic Group Query
DynamicGroupStatusResponse
- Status string
Status of the dynamic group.
- Status
Time 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 isUPDATING_MEMBERSHIPS
, the time at which dynamic group was created.
- Status string
Status of the dynamic group.
- Status
Time 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 isUPDATING_MEMBERSHIPS
, the time at which dynamic group was created.
- status String
Status of the dynamic group.
- status
Time 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 isUPDATING_MEMBERSHIPS
, the time at which dynamic group was created.
- status string
Status of the dynamic group.
- status
Time 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 isUPDATING_MEMBERSHIPS
, the time at which dynamic group was created.
- status str
Status of the dynamic group.
- status_
time 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 isUPDATING_MEMBERSHIPS
, the time at which dynamic group was created.
- status String
Status of the dynamic group.
- status
Time 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 isUPDATING_MEMBERSHIPS
, the time at which dynamic group was created.
EntityKeyResponse
- Namespace 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, theEntityKey
represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form ofidentitysources/{identity_source}
.
- Namespace 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, theEntityKey
represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form ofidentitysources/{identity_source}
.
- namespace 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, theEntityKey
represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form ofidentitysources/{identity_source}
.
- namespace 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, theEntityKey
represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form ofidentitysources/{identity_source}
.
- namespace 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, theEntityKey
represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form ofidentitysources/{identity_source}
.
- namespace 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, theEntityKey
represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form ofidentitysources/{identity_source}
.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0