AWS v6.74.0, Mar 26 25

AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi

aws.identitystore.getUsers

Explore with Pulumi AI

AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi

pulumi/pulumi-aws

Example Usage

Basic Usage

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

const example = aws.ssoadmin.getInstances({});
const exampleGetUsers = example.then(example => aws.identitystore.getUsers({
    identityStoreId: example.identityStoreIds?.[0],
}));

import pulumi
import pulumi_aws as aws

example = aws.ssoadmin.get_instances()
example_get_users = aws.identitystore.get_users(identity_store_id=example.identity_store_ids[0])

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
		}
		_, err = identitystore.GetUsers(ctx, &identitystore.GetUsersArgs{
			IdentityStoreId: example.IdentityStoreIds[0],
		}, 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 exampleGetUsers = Aws.IdentityStore.GetUsers.Invoke(new()
    {
        IdentityStoreId = example.Apply(getInstancesResult => getInstancesResult.IdentityStoreIds[0]),
    });

});

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.GetUsersArgs;
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 exampleGetUsers = IdentitystoreFunctions.getUsers(GetUsersArgs.builder()
            .identityStoreId(example.applyValue(getInstancesResult -> getInstancesResult.identityStoreIds()[0]))
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: aws:ssoadmin:getInstances
      arguments: {}
  exampleGetUsers:
    fn::invoke:
      function: aws:identitystore:getUsers
      arguments:
        identityStoreId: ${example.identityStoreIds[0]}

Using getUsers

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 getUsers(args: GetUsersArgs, opts?: InvokeOptions): Promise<GetUsersResult>
function getUsersOutput(args: GetUsersOutputArgs, opts?: InvokeOptions): Output<GetUsersResult>

def get_users(identity_store_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetUsersResult
def get_users_output(identity_store_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetUsersResult]

func GetUsers(ctx *Context, args *GetUsersArgs, opts ...InvokeOption) (*GetUsersResult, error)
func GetUsersOutput(ctx *Context, args *GetUsersOutputArgs, opts ...InvokeOption) GetUsersResultOutput

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

public static class GetUsers 
{
    public static Task<GetUsersResult> InvokeAsync(GetUsersArgs args, InvokeOptions? opts = null)
    public static Output<GetUsersResult> Invoke(GetUsersInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)
public static Output<GetUsersResult> getUsers(GetUsersArgs args, InvokeOptions options)

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

The following arguments are supported:

IdentityStoreId string: Identity Store ID associated with the Single Sign-On Instance.

IdentityStoreId string: Identity Store ID associated with the Single Sign-On Instance.

identityStoreId String: Identity Store ID associated with the Single Sign-On Instance.

identityStoreId string: Identity Store ID associated with the Single Sign-On Instance.

identity_store_id str: Identity Store ID associated with the Single Sign-On Instance.

identityStoreId String: Identity Store ID associated with the Single Sign-On Instance.

getUsers Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
IdentityStoreId string
Users List<GetUsersUser>: List of Identity Store Users

Id string: The provider-assigned unique ID for this managed resource.
IdentityStoreId string
Users []GetUsersUser: List of Identity Store Users

id String: The provider-assigned unique ID for this managed resource.
identityStoreId String
users List<GetUsersUser>: List of Identity Store Users

id string: The provider-assigned unique ID for this managed resource.
identityStoreId string
users GetUsersUser[]: List of Identity Store Users

id str: The provider-assigned unique ID for this managed resource.
identity_store_id str
users Sequence[GetUsersUser]: List of Identity Store Users

id String: The provider-assigned unique ID for this managed resource.
identityStoreId String
users List<Property Map>: List of Identity Store Users

Supporting Types

GetUsersUser

Addresses List<GetUsersUserAddress>: List of details about the user's address.
DisplayName string: Name that is typically displayed when the user is referenced.
Emails List<GetUsersUserEmail>: List of details about the user's email.
ExternalIds List<GetUsersUserExternalId>: List of identifiers issued to this resource by an external identity provider.
IdentityStoreId string: Identity Store ID associated with the Single Sign-On Instance.
Locale string: User's geographical region or location.
Names List<GetUsersUserName>: Details about the user's full name.
Nickname string: An alternate name for the user.
PhoneNumbers List<GetUsersUserPhoneNumber>: List of details about the user's phone number.
PreferredLanguage string: Preferred language of the user.
ProfileUrl string: An URL that may be associated with the user.
Timezone string: User's time zone.
Title string: User's title.
UserId string: Identifier of the user in the Identity Store.
UserName string: User's user name value.
UserType string: User type.

Addresses []GetUsersUserAddress: List of details about the user's address.
DisplayName string: Name that is typically displayed when the user is referenced.
Emails []GetUsersUserEmail: List of details about the user's email.
ExternalIds []GetUsersUserExternalId: List of identifiers issued to this resource by an external identity provider.
IdentityStoreId string: Identity Store ID associated with the Single Sign-On Instance.
Locale string: User's geographical region or location.
Names []GetUsersUserName: Details about the user's full name.
Nickname string: An alternate name for the user.
PhoneNumbers []GetUsersUserPhoneNumber: List of details about the user's phone number.
PreferredLanguage string: Preferred language of the user.
ProfileUrl string: An URL that may be associated with the user.
Timezone string: User's time zone.
Title string: User's title.
UserId string: Identifier of the user in the Identity Store.
UserName string: User's user name value.
UserType string: User type.

addresses List<GetUsersUserAddress>: List of details about the user's address.
displayName String: Name that is typically displayed when the user is referenced.
emails List<GetUsersUserEmail>: List of details about the user's email.
externalIds List<GetUsersUserExternalId>: List of identifiers issued to this resource by an external identity provider.
identityStoreId String: Identity Store ID associated with the Single Sign-On Instance.
locale String: User's geographical region or location.
names List<GetUsersUserName>: Details about the user's full name.
nickname String: An alternate name for the user.
phoneNumbers List<GetUsersUserPhoneNumber>: List of details about the user's phone number.
preferredLanguage String: Preferred language of the user.
profileUrl String: An URL that may be associated with the user.
timezone String: User's time zone.
title String: User's title.
userId String: Identifier of the user in the Identity Store.
userName String: User's user name value.
userType String: User type.

addresses GetUsersUserAddress[]: List of details about the user's address.
displayName string: Name that is typically displayed when the user is referenced.
emails GetUsersUserEmail[]: List of details about the user's email.
externalIds GetUsersUserExternalId[]: List of identifiers issued to this resource by an external identity provider.
identityStoreId string: Identity Store ID associated with the Single Sign-On Instance.
locale string: User's geographical region or location.
names GetUsersUserName[]: Details about the user's full name.
nickname string: An alternate name for the user.
phoneNumbers GetUsersUserPhoneNumber[]: List of details about the user's phone number.
preferredLanguage string: Preferred language of the user.
profileUrl string: An URL that may be associated with the user.
timezone string: User's time zone.
title string: User's title.
userId string: Identifier of the user in the Identity Store.
userName string: User's user name value.
userType string: User type.

addresses Sequence[GetUsersUserAddress]: List of details about the user's address.
display_name str: Name that is typically displayed when the user is referenced.
emails Sequence[GetUsersUserEmail]: List of details about the user's email.
external_ids Sequence[GetUsersUserExternalId]: List of identifiers issued to this resource by an external identity provider.
identity_store_id str: Identity Store ID associated with the Single Sign-On Instance.
locale str: User's geographical region or location.
names Sequence[GetUsersUserName]: Details about the user's full name.
nickname str: An alternate name for the user.
phone_numbers Sequence[GetUsersUserPhoneNumber]: List of details about the user's phone number.
preferred_language str: Preferred language of the user.
profile_url str: An URL that may be associated with the user.
timezone str: User's time zone.
title str: User's title.
user_id str: Identifier of the user in the Identity Store.
user_name str: User's user name value.
user_type str: User type.

addresses List<Property Map>: List of details about the user's address.
displayName String: Name that is typically displayed when the user is referenced.
emails List<Property Map>: List of details about the user's email.
externalIds List<Property Map>: List of identifiers issued to this resource by an external identity provider.
identityStoreId String: Identity Store ID associated with the Single Sign-On Instance.
locale String: User's geographical region or location.
names List<Property Map>: Details about the user's full name.
nickname String: An alternate name for the user.
phoneNumbers List<Property Map>: List of details about the user's phone number.
preferredLanguage String: Preferred language of the user.
profileUrl String: An URL that may be associated with the user.
timezone String: User's time zone.
title String: User's title.
userId String: Identifier of the user in the Identity Store.
userName String: User's user name value.
userType String: User type.

GetUsersUserAddress

Country string: Country that this address is in.
Formatted string: Name that is typically displayed when the name is shown for display.
Locality string: Address locality.
PostalCode string: Postal code of the address.
Primary bool: When true, this is the primary phone number associated with the user.
Region string: Region of the address.
StreetAddress string: Street of the address.
Type string: Type of phone number.

Country string: Country that this address is in.
Formatted string: Name that is typically displayed when the name is shown for display.
Locality string: Address locality.
PostalCode string: Postal code of the address.
Primary bool: When true, this is the primary phone number associated with the user.
Region string: Region of the address.
StreetAddress string: Street of the address.
Type string: Type of phone number.

country String: Country that this address is in.
formatted String: Name that is typically displayed when the name is shown for display.
locality String: Address locality.
postalCode String: Postal code of the address.
primary Boolean: When true, this is the primary phone number associated with the user.
region String: Region of the address.
streetAddress String: Street of the address.
type String: Type of phone number.

country string: Country that this address is in.
formatted string: Name that is typically displayed when the name is shown for display.
locality string: Address locality.
postalCode string: Postal code of the address.
primary boolean: When true, this is the primary phone number associated with the user.
region string: Region of the address.
streetAddress string: Street of the address.
type string: Type of phone number.

country str: Country that this address is in.
formatted str: Name that is typically displayed when the name is shown for display.
locality str: Address locality.
postal_code str: Postal code of the address.
primary bool: When true, this is the primary phone number associated with the user.
region str: Region of the address.
street_address str: Street of the address.
type str: Type of phone number.

country String: Country that this address is in.
formatted String: Name that is typically displayed when the name is shown for display.
locality String: Address locality.
postalCode String: Postal code of the address.
primary Boolean: When true, this is the primary phone number associated with the user.
region String: Region of the address.
streetAddress String: Street of the address.
type String: Type of phone number.

GetUsersUserEmail

Primary bool: When true, this is the primary phone number associated with the user.
Type string: Type of phone number.
Value string: User's phone number.

Primary bool: When true, this is the primary phone number associated with the user.
Type string: Type of phone number.
Value string: User's phone number.

primary Boolean: When true, this is the primary phone number associated with the user.
type String: Type of phone number.
value String: User's phone number.

primary boolean: When true, this is the primary phone number associated with the user.
type string: Type of phone number.
value string: User's phone number.

primary bool: When true, this is the primary phone number associated with the user.
type str: Type of phone number.
value str: User's phone number.

primary Boolean: When true, this is the primary phone number associated with the user.
type String: Type of phone number.
value String: User's phone number.

GetUsersUserExternalId

Id string: Identifier issued to this resource by an external identity provider.
Issuer string: Issuer for an external identifier.

Id string: Identifier issued to this resource by an external identity provider.
Issuer string: Issuer for an external identifier.

id String: Identifier issued to this resource by an external identity provider.
issuer String: Issuer for an external identifier.

id string: Identifier issued to this resource by an external identity provider.
issuer string: Issuer for an external identifier.

id str: Identifier issued to this resource by an external identity provider.
issuer str: Issuer for an external identifier.

id String: Identifier issued to this resource by an external identity provider.
issuer String: Issuer for an external identifier.

GetUsersUserName

FamilyName string: Family name of the user.
Formatted string: Name that is typically displayed when the name is shown for display.
GivenName string: Given name of the user.
HonorificPrefix string: Honorific prefix of the user.
HonorificSuffix string: Honorific suffix of the user.
MiddleName string: Middle name of the user.

FamilyName string: Family name of the user.
Formatted string: Name that is typically displayed when the name is shown for display.
GivenName string: Given name of the user.
HonorificPrefix string: Honorific prefix of the user.
HonorificSuffix string: Honorific suffix of the user.
MiddleName string: Middle name of the user.

familyName String: Family name of the user.
formatted String: Name that is typically displayed when the name is shown for display.
givenName String: Given name of the user.
honorificPrefix String: Honorific prefix of the user.
honorificSuffix String: Honorific suffix of the user.
middleName String: Middle name of the user.

familyName string: Family name of the user.
formatted string: Name that is typically displayed when the name is shown for display.
givenName string: Given name of the user.
honorificPrefix string: Honorific prefix of the user.
honorificSuffix string: Honorific suffix of the user.
middleName string: Middle name of the user.

family_name str: Family name of the user.
formatted str: Name that is typically displayed when the name is shown for display.
given_name str: Given name of the user.
honorific_prefix str: Honorific prefix of the user.
honorific_suffix str: Honorific suffix of the user.
middle_name str: Middle name of the user.

familyName String: Family name of the user.
formatted String: Name that is typically displayed when the name is shown for display.
givenName String: Given name of the user.
honorificPrefix String: Honorific prefix of the user.
honorificSuffix String: Honorific suffix of the user.
middleName String: Middle name of the user.

GetUsersUserPhoneNumber

Primary bool: When true, this is the primary phone number associated with the user.
Type string: Type of phone number.
Value string: User's phone number.

Primary bool: When true, this is the primary phone number associated with the user.
Type string: Type of phone number.
Value string: User's phone number.

primary Boolean: When true, this is the primary phone number associated with the user.
type String: Type of phone number.
value String: User's phone number.

primary boolean: When true, this is the primary phone number associated with the user.
type string: Type of phone number.
value string: User's phone number.

primary bool: When true, this is the primary phone number associated with the user.
type str: Type of phone number.
value str: User's phone number.

primary Boolean: When true, this is the primary phone number associated with the user.
type String: Type of phone number.
value String: User's phone number.

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

AWS v6.74.0 published on Wednesday, Mar 26, 2025 by Pulumi

pulumi/pulumi-aws

aws.identitystore.getUsers

On this page

On this page

Example Usage

Basic Usage

Using getUsers

getUsers Result

Supporting Types

GetUsersUser

GetUsersUserAddress

GetUsersUserEmail

GetUsersUserExternalId

GetUsersUserName

GetUsersUserPhoneNumber

Package Details

On this page

On this page