Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. identitystore
  5. getGroupMemberships
AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-aws

aws.identitystore.getGroupMemberships

Explore with Pulumi AI

aws logo
AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-aws

    Use this data source to get a list of members in an Identity Store Group.

    Example Usage

    Basic Usage

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

const example = aws.ssoadmin.getInstances({});
const exampleGetGroup = example.then(example => aws.identitystore.getGroup({
    identityStoreId: example.identityStoreIds?.[0],
    alternateIdentifier: {
        uniqueAttribute: {
            attributePath: "DisplayName",
            attributeValue: "ExampleGroup",
        },
    },
}));
const exampleGetGroupMemberships = Promise.all([example, exampleGetGroup]).then(([example, exampleGetGroup]) => aws.identitystore.getGroupMemberships({
    identityStoreId: example.identityStoreIds?.[0],
    groupId: exampleGetGroup.groupId,
}));

    import pulumi
import pulumi_aws as aws

example = aws.ssoadmin.get_instances()
example_get_group = aws.identitystore.get_group(identity_store_id=example.identity_store_ids[0],
    alternate_identifier={
        "unique_attribute": {
            "attribute_path": "DisplayName",
            "attribute_value": "ExampleGroup",
        },
    })
example_get_group_memberships = aws.identitystore.get_group_memberships(identity_store_id=example.identity_store_ids[0],
    group_id=example_get_group.group_id)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/identitystore"
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ssoadmin"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := ssoadmin.GetInstances(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		exampleGetGroup, err := identitystore.LookupGroup(ctx, &identitystore.LookupGroupArgs{
			IdentityStoreId: example.IdentityStoreIds[0],
			AlternateIdentifier: identitystore.GetGroupAlternateIdentifier{
				UniqueAttribute: identitystore.GetGroupAlternateIdentifierUniqueAttribute{
					AttributePath:  "DisplayName",
					AttributeValue: "ExampleGroup",
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		_, err = identitystore.GetGroupMemberships(ctx, &identitystore.GetGroupMembershipsArgs{
			IdentityStoreId: example.IdentityStoreIds[0],
			GroupId:         exampleGetGroup.GroupId,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Aws.SsoAdmin.GetInstances.Invoke();

    var exampleGetGroup = Aws.IdentityStore.GetGroup.Invoke(new()
    {
        IdentityStoreId = example.Apply(getInstancesResult => getInstancesResult.IdentityStoreIds[0]),
        AlternateIdentifier = new Aws.IdentityStore.Inputs.GetGroupAlternateIdentifierInputArgs
        {
            UniqueAttribute = new Aws.IdentityStore.Inputs.GetGroupAlternateIdentifierUniqueAttributeInputArgs
            {
                AttributePath = "DisplayName",
                AttributeValue = "ExampleGroup",
            },
        },
    });

    var exampleGetGroupMemberships = Aws.IdentityStore.GetGroupMemberships.Invoke(new()
    {
        IdentityStoreId = example.Apply(getInstancesResult => getInstancesResult.IdentityStoreIds[0]),
        GroupId = exampleGetGroup.Apply(getGroupResult => getGroupResult.GroupId),
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ssoadmin.SsoadminFunctions;
import com.pulumi.aws.identitystore.IdentitystoreFunctions;
import com.pulumi.aws.identitystore.inputs.GetGroupArgs;
import com.pulumi.aws.identitystore.inputs.GetGroupAlternateIdentifierArgs;
import com.pulumi.aws.identitystore.inputs.GetGroupAlternateIdentifierUniqueAttributeArgs;
import com.pulumi.aws.identitystore.inputs.GetGroupMembershipsArgs;
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 example = SsoadminFunctions.getInstances();

        final var exampleGetGroup = IdentitystoreFunctions.getGroup(GetGroupArgs.builder()
            .identityStoreId(example.applyValue(getInstancesResult -> getInstancesResult.identityStoreIds()[0]))
            .alternateIdentifier(GetGroupAlternateIdentifierArgs.builder()
                .uniqueAttribute(GetGroupAlternateIdentifierUniqueAttributeArgs.builder()
                    .attributePath("DisplayName")
                    .attributeValue("ExampleGroup")
                    .build())
                .build())
            .build());

        final var exampleGetGroupMemberships = IdentitystoreFunctions.getGroupMemberships(GetGroupMembershipsArgs.builder()
            .identityStoreId(example.applyValue(getInstancesResult -> getInstancesResult.identityStoreIds()[0]))
            .groupId(exampleGetGroup.applyValue(getGroupResult -> getGroupResult.groupId()))
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: aws:ssoadmin:getInstances
      arguments: {}
  exampleGetGroup:
    fn::invoke:
      function: aws:identitystore:getGroup
      arguments:
        identityStoreId: ${example.identityStoreIds[0]}
        alternateIdentifier:
          uniqueAttribute:
            attributePath: DisplayName
            attributeValue: ExampleGroup
  exampleGetGroupMemberships:
    fn::invoke:
      function: aws:identitystore:getGroupMemberships
      arguments:
        identityStoreId: ${example.identityStoreIds[0]}
        groupId: ${exampleGetGroup.groupId}

    Using getGroupMemberships

    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 getGroupMemberships(args: GetGroupMembershipsArgs, opts?: InvokeOptions): Promise<GetGroupMembershipsResult>
function getGroupMembershipsOutput(args: GetGroupMembershipsOutputArgs, opts?: InvokeOptions): Output<GetGroupMembershipsResult>
    def get_group_memberships(group_id: Optional[str] = None,
                          identity_store_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetGroupMembershipsResult
def get_group_memberships_output(group_id: Optional[pulumi.Input[str]] = None,
                          identity_store_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetGroupMembershipsResult]
    func GetGroupMemberships(ctx *Context, args *GetGroupMembershipsArgs, opts ...InvokeOption) (*GetGroupMembershipsResult, error)
func GetGroupMembershipsOutput(ctx *Context, args *GetGroupMembershipsOutputArgs, opts ...InvokeOption) GetGroupMembershipsResultOutput

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

    public static class GetGroupMemberships 
{
    public static Task<GetGroupMembershipsResult> InvokeAsync(GetGroupMembershipsArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupMembershipsResult> Invoke(GetGroupMembershipsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGroupMembershipsResult> getGroupMemberships(GetGroupMembershipsArgs args, InvokeOptions options)
public static Output<GetGroupMembershipsResult> getGroupMemberships(GetGroupMembershipsArgs args, InvokeOptions options)

    fn::invoke:
  function: aws:identitystore/getGroupMemberships:getGroupMemberships
  arguments:
    # arguments dictionary

    The following arguments are supported:

    GroupId string
    The identifier for a group in the Identity Store.
    IdentityStoreId string
    Identity Store ID associated with the Single Sign-On Instance.
    GroupId string
    The identifier for a group in the Identity Store.
    IdentityStoreId string
    Identity Store ID associated with the Single Sign-On Instance.
    groupId String
    The identifier for a group in the Identity Store.
    identityStoreId String
    Identity Store ID associated with the Single Sign-On Instance.
    groupId string
    The identifier for a group in the Identity Store.
    identityStoreId string
    Identity Store ID associated with the Single Sign-On Instance.
    group_id str
    The identifier for a group in the Identity Store.
    identity_store_id str
    Identity Store ID associated with the Single Sign-On Instance.
    groupId String
    The identifier for a group in the Identity Store.
    identityStoreId String
    Identity Store ID associated with the Single Sign-On Instance.

    getGroupMemberships Result

    The following output properties are available:

    GroupId string
    Group identifier.
    GroupMemberships List<GetGroupMembershipsGroupMembership>
    A list of group membership objects. See group_memberships below.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityStoreId string
    Identity store identifier.
    GroupId string
    Group identifier.
    GroupMemberships []GetGroupMembershipsGroupMembership
    A list of group membership objects. See group_memberships below.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityStoreId string
    Identity store identifier.
    groupId String
    Group identifier.
    groupMemberships List<GetGroupMembershipsGroupMembership>
    A list of group membership objects. See group_memberships below.
    id String
    The provider-assigned unique ID for this managed resource.
    identityStoreId String
    Identity store identifier.
    groupId string
    Group identifier.
    groupMemberships GetGroupMembershipsGroupMembership[]
    A list of group membership objects. See group_memberships below.
    id string
    The provider-assigned unique ID for this managed resource.
    identityStoreId string
    Identity store identifier.
    group_id str
    Group identifier.
    group_memberships Sequence[GetGroupMembershipsGroupMembership]
    A list of group membership objects. See group_memberships below.
    id str
    The provider-assigned unique ID for this managed resource.
    identity_store_id str
    Identity store identifier.
    groupId String
    Group identifier.
    groupMemberships List<Property Map>
    A list of group membership objects. See group_memberships below.
    id String
    The provider-assigned unique ID for this managed resource.
    identityStoreId String
    Identity store identifier.

    Supporting Types

    GetGroupMembershipsGroupMembership

    GroupId string
    The identifier for a group in the Identity Store.
    IdentityStoreId string
    Identity Store ID associated with the Single Sign-On Instance.
    MemberId GetGroupMembershipsGroupMembershipMemberId
    An object containing the identifier of a group member. See member_id below.
    MembershipId string
    GroupId string
    The identifier for a group in the Identity Store.
    IdentityStoreId string
    Identity Store ID associated with the Single Sign-On Instance.
    MemberId GetGroupMembershipsGroupMembershipMemberId
    An object containing the identifier of a group member. See member_id below.
    MembershipId string
    groupId String
    The identifier for a group in the Identity Store.
    identityStoreId String
    Identity Store ID associated with the Single Sign-On Instance.
    memberId GetGroupMembershipsGroupMembershipMemberId
    An object containing the identifier of a group member. See member_id below.
    membershipId String
    groupId string
    The identifier for a group in the Identity Store.
    identityStoreId string
    Identity Store ID associated with the Single Sign-On Instance.
    memberId GetGroupMembershipsGroupMembershipMemberId
    An object containing the identifier of a group member. See member_id below.
    membershipId string
    group_id str
    The identifier for a group in the Identity Store.
    identity_store_id str
    Identity Store ID associated with the Single Sign-On Instance.
    member_id GetGroupMembershipsGroupMembershipMemberId
    An object containing the identifier of a group member. See member_id below.
    membership_id str
    groupId String
    The identifier for a group in the Identity Store.
    identityStoreId String
    Identity Store ID associated with the Single Sign-On Instance.
    memberId Property Map
    An object containing the identifier of a group member. See member_id below.
    membershipId String

    GetGroupMembershipsGroupMembershipMemberId

    UserId string
    User identifier of the group member.
    UserId string
    User identifier of the group member.
    userId String
    User identifier of the group member.
    userId string
    User identifier of the group member.
    user_id str
    User identifier of the group member.
    userId String
    User identifier of the group member.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi
    pulumi/pulumi-aws