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

gcp.cloudidentity.getGroupTransitiveMemberships

Explore with Pulumi AI

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

    Use this data source to get list of the Cloud Identity Group Memberships within a given Group. Whereas gcp.cloudidentity.getGroupMemberships returns details of only direct members of the group, gcp.cloudidentity.getGroupTransitiveMemberships will return details about both direct and indirect members. For example, a user is an indirect member of Group A if the user is a direct member of Group B and Group B is a direct member of Group A.

    To get more information about TransitiveGroupMembership, see:

    Example Usage

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

const members = gcp.cloudidentity.getGroupTransitiveMemberships({
    group: "groups/123eab45c6defghi",
});

    import pulumi
import pulumi_gcp as gcp

members = gcp.cloudidentity.get_group_transitive_memberships(group="groups/123eab45c6defghi")

    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.GetGroupTransitiveMemberships(ctx, &cloudidentity.GetGroupTransitiveMembershipsArgs{
			Group: "groups/123eab45c6defghi",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var members = Gcp.CloudIdentity.GetGroupTransitiveMemberships.Invoke(new()
    {
        Group = "groups/123eab45c6defghi",
    });

});

    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.GetGroupTransitiveMembershipsArgs;
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 members = CloudidentityFunctions.getGroupTransitiveMemberships(GetGroupTransitiveMembershipsArgs.builder()
            .group("groups/123eab45c6defghi")
            .build());

    }
}

    variables:
  members:
    fn::invoke:
      function: gcp:cloudidentity:getGroupTransitiveMemberships
      arguments:
        group: groups/123eab45c6defghi

    Using getGroupTransitiveMemberships

    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 getGroupTransitiveMemberships(args: GetGroupTransitiveMembershipsArgs, opts?: InvokeOptions): Promise<GetGroupTransitiveMembershipsResult>
function getGroupTransitiveMembershipsOutput(args: GetGroupTransitiveMembershipsOutputArgs, opts?: InvokeOptions): Output<GetGroupTransitiveMembershipsResult>
    def get_group_transitive_memberships(group: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetGroupTransitiveMembershipsResult
def get_group_transitive_memberships_output(group: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetGroupTransitiveMembershipsResult]
    func GetGroupTransitiveMemberships(ctx *Context, args *GetGroupTransitiveMembershipsArgs, opts ...InvokeOption) (*GetGroupTransitiveMembershipsResult, error)
func GetGroupTransitiveMembershipsOutput(ctx *Context, args *GetGroupTransitiveMembershipsOutputArgs, opts ...InvokeOption) GetGroupTransitiveMembershipsResultOutput

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

    public static class GetGroupTransitiveMemberships 
{
    public static Task<GetGroupTransitiveMembershipsResult> InvokeAsync(GetGroupTransitiveMembershipsArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupTransitiveMembershipsResult> Invoke(GetGroupTransitiveMembershipsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGroupTransitiveMembershipsResult> getGroupTransitiveMemberships(GetGroupTransitiveMembershipsArgs args, InvokeOptions options)
public static Output<GetGroupTransitiveMembershipsResult> getGroupTransitiveMemberships(GetGroupTransitiveMembershipsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Group string
    The parent Group resource to search transitive memberships in. Must be of the form groups/{group_id}.
    Group string
    The parent Group resource to search transitive memberships in. Must be of the form groups/{group_id}.
    group String
    The parent Group resource to search transitive memberships in. Must be of the form groups/{group_id}.
    group string
    The parent Group resource to search transitive memberships in. Must be of the form groups/{group_id}.
    group str
    The parent Group resource to search transitive memberships in. Must be of the form groups/{group_id}.
    group String
    The parent Group resource to search transitive memberships in. Must be of the form groups/{group_id}.

    getGroupTransitiveMemberships Result

    The following output properties are available:

    Group string
    Id string
    The provider-assigned unique ID for this managed resource.
    Memberships List<GetGroupTransitiveMembershipsMembership>
    The list of memberships under the given group. Structure is documented below.
    Group string
    Id string
    The provider-assigned unique ID for this managed resource.
    Memberships []GetGroupTransitiveMembershipsMembership
    The list of memberships under the given group. Structure is documented below.
    group String
    id String
    The provider-assigned unique ID for this managed resource.
    memberships List<GetGroupTransitiveMembershipsMembership>
    The list of memberships under the given group. Structure is documented below.
    group string
    id string
    The provider-assigned unique ID for this managed resource.
    memberships GetGroupTransitiveMembershipsMembership[]
    The list of memberships under the given group. Structure is documented below.
    group str
    id str
    The provider-assigned unique ID for this managed resource.
    memberships Sequence[GetGroupTransitiveMembershipsMembership]
    The list of memberships under the given group. Structure is documented below.
    group String
    id String
    The provider-assigned unique ID for this managed resource.
    memberships List<Property Map>
    The list of memberships under the given group. Structure is documented below.

    Supporting Types

    GetGroupTransitiveMembershipsMembership

    Member string
    EntityKey of the member. This value will be either a userKey in the format users/000000000000000000000 with a numerical id or a groupKey in the format groups/000ab0000ab0000 with a hexadecimal id.
    PreferredMemberKeys List<GetGroupTransitiveMembershipsMembershipPreferredMemberKey>
    EntityKey of the member. Structure is documented below.
    RelationType string
    The relation between the group and the transitive member. The value can be DIRECT, INDIRECT, or DIRECT_AND_INDIRECT.
    Roles List<GetGroupTransitiveMembershipsMembershipRole>
    The TransitiveMembershipRoles that apply to the Membership. Structure is documented below.
    Member string
    EntityKey of the member. This value will be either a userKey in the format users/000000000000000000000 with a numerical id or a groupKey in the format groups/000ab0000ab0000 with a hexadecimal id.
    PreferredMemberKeys []GetGroupTransitiveMembershipsMembershipPreferredMemberKey
    EntityKey of the member. Structure is documented below.
    RelationType string
    The relation between the group and the transitive member. The value can be DIRECT, INDIRECT, or DIRECT_AND_INDIRECT.
    Roles []GetGroupTransitiveMembershipsMembershipRole
    The TransitiveMembershipRoles that apply to the Membership. Structure is documented below.
    member String
    EntityKey of the member. This value will be either a userKey in the format users/000000000000000000000 with a numerical id or a groupKey in the format groups/000ab0000ab0000 with a hexadecimal id.
    preferredMemberKeys List<GetGroupTransitiveMembershipsMembershipPreferredMemberKey>
    EntityKey of the member. Structure is documented below.
    relationType String
    The relation between the group and the transitive member. The value can be DIRECT, INDIRECT, or DIRECT_AND_INDIRECT.
    roles List<GetGroupTransitiveMembershipsMembershipRole>
    The TransitiveMembershipRoles that apply to the Membership. Structure is documented below.
    member string
    EntityKey of the member. This value will be either a userKey in the format users/000000000000000000000 with a numerical id or a groupKey in the format groups/000ab0000ab0000 with a hexadecimal id.
    preferredMemberKeys GetGroupTransitiveMembershipsMembershipPreferredMemberKey[]
    EntityKey of the member. Structure is documented below.
    relationType string
    The relation between the group and the transitive member. The value can be DIRECT, INDIRECT, or DIRECT_AND_INDIRECT.
    roles GetGroupTransitiveMembershipsMembershipRole[]
    The TransitiveMembershipRoles that apply to the Membership. Structure is documented below.
    member str
    EntityKey of the member. This value will be either a userKey in the format users/000000000000000000000 with a numerical id or a groupKey in the format groups/000ab0000ab0000 with a hexadecimal id.
    preferred_member_keys Sequence[GetGroupTransitiveMembershipsMembershipPreferredMemberKey]
    EntityKey of the member. Structure is documented below.
    relation_type str
    The relation between the group and the transitive member. The value can be DIRECT, INDIRECT, or DIRECT_AND_INDIRECT.
    roles Sequence[GetGroupTransitiveMembershipsMembershipRole]
    The TransitiveMembershipRoles that apply to the Membership. Structure is documented below.
    member String
    EntityKey of the member. This value will be either a userKey in the format users/000000000000000000000 with a numerical id or a groupKey in the format groups/000ab0000ab0000 with a hexadecimal id.
    preferredMemberKeys List<Property Map>
    EntityKey of the member. Structure is documented below.
    relationType String
    The relation between the group and the transitive member. The value can be DIRECT, INDIRECT, or DIRECT_AND_INDIRECT.
    roles List<Property Map>
    The TransitiveMembershipRoles that apply to the Membership. Structure is documented below.

    GetGroupTransitiveMembershipsMembershipPreferredMemberKey

    Id string
    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
    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.
    Id string
    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
    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.
    id String
    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
    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.
    id string
    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
    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.
    id str
    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
    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.
    id String
    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
    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.

    GetGroupTransitiveMembershipsMembershipRole

    Role string
    The name of the TransitiveMembershipRole. One of OWNER, MANAGER, MEMBER.
    Role string
    The name of the TransitiveMembershipRole. One of OWNER, MANAGER, MEMBER.
    role String
    The name of the TransitiveMembershipRole. One of OWNER, MANAGER, MEMBER.
    role string
    The name of the TransitiveMembershipRole. One of OWNER, MANAGER, MEMBER.
    role str
    The name of the TransitiveMembershipRole. One of OWNER, MANAGER, MEMBER.
    role String
    The name of the TransitiveMembershipRole. One of OWNER, MANAGER, MEMBER.

    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.
    gcp logo
    Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi
    pulumi/pulumi-gcp