Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. cloudidentity
  5. getGroupLookup
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.cloudidentity.getGroupLookup

Explore with Pulumi AI

Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp

Use this data source to look up the resource name of a Cloud Identity Group by its EntityKey, i.e. the group’s email.

https://cloud.google.com/identity/docs/concepts/overview#groups

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const group = gcp.cloudidentity.getGroupLookup({
    groupKey: {
        id: "my-group@example.com",
    },
});
Copy
import pulumi
import pulumi_gcp as gcp

group = gcp.cloudidentity.get_group_lookup(group_key={
    "id": "my-group@example.com",
})
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/cloudidentity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudidentity.GetGroupLookup(ctx, &cloudidentity.GetGroupLookupArgs{
			GroupKey: cloudidentity.GetGroupLookupGroupKey{
				Id: "my-group@example.com",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var @group = Gcp.CloudIdentity.GetGroupLookup.Invoke(new()
    {
        GroupKey = new Gcp.CloudIdentity.Inputs.GetGroupLookupGroupKeyInputArgs
        {
            Id = "my-group@example.com",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.cloudidentity.CloudidentityFunctions;
import com.pulumi.gcp.cloudidentity.inputs.GetGroupLookupArgs;
import com.pulumi.gcp.cloudidentity.inputs.GetGroupLookupGroupKeyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var group = CloudidentityFunctions.getGroupLookup(GetGroupLookupArgs.builder()
            .groupKey(GetGroupLookupGroupKeyArgs.builder()
                .id("my-group@example.com")
                .build())
            .build());

    }
}
Copy
variables:
  group:
    fn::invoke:
      function: gcp:cloudidentity:getGroupLookup
      arguments:
        groupKey:
          id: my-group@example.com
Copy

Using getGroupLookup

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 getGroupLookup(args: GetGroupLookupArgs, opts?: InvokeOptions): Promise<GetGroupLookupResult>
function getGroupLookupOutput(args: GetGroupLookupOutputArgs, opts?: InvokeOptions): Output<GetGroupLookupResult>
Copy
def get_group_lookup(group_key: Optional[GetGroupLookupGroupKey] = None,
                     opts: Optional[InvokeOptions] = None) -> GetGroupLookupResult
def get_group_lookup_output(group_key: Optional[pulumi.Input[GetGroupLookupGroupKeyArgs]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetGroupLookupResult]
Copy
func GetGroupLookup(ctx *Context, args *GetGroupLookupArgs, opts ...InvokeOption) (*GetGroupLookupResult, error)
func GetGroupLookupOutput(ctx *Context, args *GetGroupLookupOutputArgs, opts ...InvokeOption) GetGroupLookupResultOutput
Copy

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

public static class GetGroupLookup 
{
    public static Task<GetGroupLookupResult> InvokeAsync(GetGroupLookupArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupLookupResult> Invoke(GetGroupLookupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGroupLookupResult> getGroupLookup(GetGroupLookupArgs args, InvokeOptions options)
public static Output<GetGroupLookupResult> getGroupLookup(GetGroupLookupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: gcp:cloudidentity/getGroupLookup:getGroupLookup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

GroupKey This property is required. GetGroupLookupGroupKey
The EntityKey of the Group to lookup. 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. Structure is documented below.
GroupKey This property is required. GetGroupLookupGroupKey
The EntityKey of the Group to lookup. 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. Structure is documented below.
groupKey This property is required. GetGroupLookupGroupKey
The EntityKey of the Group to lookup. 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. Structure is documented below.
groupKey This property is required. GetGroupLookupGroupKey
The EntityKey of the Group to lookup. 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. Structure is documented below.
group_key This property is required. GetGroupLookupGroupKey
The EntityKey of the Group to lookup. 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. Structure is documented below.
groupKey This property is required. Property Map
The EntityKey of the Group to lookup. 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. Structure is documented below.

getGroupLookup Result

The following output properties are available:

GroupKey GetGroupLookupGroupKey
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
GroupKey GetGroupLookupGroupKey
Id string
The provider-assigned unique ID for this managed resource.
Name string
Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
groupKey GetGroupLookupGroupKey
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
groupKey GetGroupLookupGroupKey
id string
The provider-assigned unique ID for this managed resource.
name string
Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
group_key GetGroupLookupGroupKey
id str
The provider-assigned unique ID for this managed resource.
name str
Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.
groupKey Property Map
id String
The provider-assigned unique ID for this managed resource.
name String
Resource name of the Group in the format: groups/{group_id}, where group_id is the unique ID assigned to the Group.

Supporting Types

GetGroupLookupGroupKey

Id This property is required. string
(Required) The ID of the entity. For Google-managed entities, the id is the email address of an existing group or user. For external-identity-mapped entities, the id is a string conforming to the Identity Source's requirements.
Namespace string
(Optional) The namespace in which the entity exists. If not populated, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If populated, 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}.
Id This property is required. string
(Required) The ID of the entity. For Google-managed entities, the id is the email address of an existing group or user. For external-identity-mapped entities, the id is a string conforming to the Identity Source's requirements.
Namespace string
(Optional) The namespace in which the entity exists. If not populated, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If populated, 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}.
id This property is required. String
(Required) The ID of the entity. For Google-managed entities, the id is the email address of an existing group or user. For external-identity-mapped entities, the id is a string conforming to the Identity Source's requirements.
namespace String
(Optional) The namespace in which the entity exists. If not populated, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If populated, 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}.
id This property is required. string
(Required) The ID of the entity. For Google-managed entities, the id is the email address of an existing group or user. For external-identity-mapped entities, the id is a string conforming to the Identity Source's requirements.
namespace string
(Optional) The namespace in which the entity exists. If not populated, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If populated, 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}.
id This property is required. str
(Required) The ID of the entity. For Google-managed entities, the id is the email address of an existing group or user. For external-identity-mapped entities, the id is a string conforming to the Identity Source's requirements.
namespace str
(Optional) The namespace in which the entity exists. If not populated, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If populated, 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}.
id This property is required. String
(Required) The ID of the entity. For Google-managed entities, the id is the email address of an existing group or user. For external-identity-mapped entities, the id is a string conforming to the Identity Source's requirements.
namespace String
(Optional) The namespace in which the entity exists. If not populated, the EntityKey represents a Google-managed entity such as a Google user or a Google Group. If populated, 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}.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.
Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
pulumi/pulumi-gcp