gcp.cloudidentity.getGroupLookup

Explore with Pulumi AI

Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi

Example Usage

data "google_cloud_identity_group_lookup" "group" {
  group_key {
    id = "my-group@example.com"
  }
}

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>

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]

func GetGroupLookup(ctx *Context, args *GetGroupLookupArgs, opts ...InvokeOption) (*GetGroupLookupResult, error)
func GetGroupLookupOutput(ctx *Context, args *GetGroupLookupOutputArgs, opts ...InvokeOption) GetGroupLookupResultOutput

> 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)
}

public static CompletableFuture<GetGroupLookupResult> getGroupLookup(GetGroupLookupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: gcp:cloudidentity/getGroupLookup:getGroupLookup
  arguments:
    # arguments dictionary

The following arguments are supported:

GroupKey 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 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 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 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 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 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 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 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 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 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 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 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 Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi

pulumi/pulumi-gcp

gcp.cloudidentity.getGroupLookup

On this page

On this page

Example Usage

Using getGroupLookup

getGroupLookup Result

Supporting Types

GetGroupLookupGroupKey

Package Details

On this page

On this page