1. Packages
  2. AWS Classic
  3. API Docs
  4. identitystore
  5. getUser

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.27.0 published on Monday, Mar 18, 2024 by Pulumi

aws.identitystore.getUser

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.27.0 published on Monday, Mar 18, 2024 by Pulumi

    Use this data source to get an Identity Store User.

    Using getUser

    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 getUser(args: GetUserArgs, opts?: InvokeOptions): Promise<GetUserResult>
    function getUserOutput(args: GetUserOutputArgs, opts?: InvokeOptions): Output<GetUserResult>
    def get_user(alternate_identifier: Optional[GetUserAlternateIdentifier] = None,
                 filter: Optional[GetUserFilter] = None,
                 identity_store_id: Optional[str] = None,
                 user_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetUserResult
    def get_user_output(alternate_identifier: Optional[pulumi.Input[GetUserAlternateIdentifierArgs]] = None,
                 filter: Optional[pulumi.Input[GetUserFilterArgs]] = None,
                 identity_store_id: Optional[pulumi.Input[str]] = None,
                 user_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetUserResult]
    func LookupUser(ctx *Context, args *LookupUserArgs, opts ...InvokeOption) (*LookupUserResult, error)
    func LookupUserOutput(ctx *Context, args *LookupUserOutputArgs, opts ...InvokeOption) LookupUserResultOutput

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

    public static class GetUser 
    {
        public static Task<GetUserResult> InvokeAsync(GetUserArgs args, InvokeOptions? opts = null)
        public static Output<GetUserResult> Invoke(GetUserInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetUserResult> getUser(GetUserArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:identitystore/getUser:getUser
      arguments:
        # arguments dictionary

    The following arguments are supported:

    IdentityStoreId string

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

    The following arguments are optional:

    AlternateIdentifier GetUserAlternateIdentifier
    A unique identifier for a user or group that is not the primary identifier. Conflicts with user_id and filter. Detailed below.
    Filter GetUserFilter
    Configuration block for filtering by a unique attribute of the user. Detailed below.

    Deprecated:Use the alternate_identifier attribute instead.

    UserId string

    The identifier for a user in the Identity Store.

    Exactly one of the above arguments must be provided. Passing both filter and user_id is allowed for backwards compatibility.

    IdentityStoreId string

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

    The following arguments are optional:

    AlternateIdentifier GetUserAlternateIdentifier
    A unique identifier for a user or group that is not the primary identifier. Conflicts with user_id and filter. Detailed below.
    Filter GetUserFilter
    Configuration block for filtering by a unique attribute of the user. Detailed below.

    Deprecated:Use the alternate_identifier attribute instead.

    UserId string

    The identifier for a user in the Identity Store.

    Exactly one of the above arguments must be provided. Passing both filter and user_id is allowed for backwards compatibility.

    identityStoreId String

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

    The following arguments are optional:

    alternateIdentifier GetUserAlternateIdentifier
    A unique identifier for a user or group that is not the primary identifier. Conflicts with user_id and filter. Detailed below.
    filter GetUserFilter
    Configuration block for filtering by a unique attribute of the user. Detailed below.

    Deprecated:Use the alternate_identifier attribute instead.

    userId String

    The identifier for a user in the Identity Store.

    Exactly one of the above arguments must be provided. Passing both filter and user_id is allowed for backwards compatibility.

    identityStoreId string

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

    The following arguments are optional:

    alternateIdentifier GetUserAlternateIdentifier
    A unique identifier for a user or group that is not the primary identifier. Conflicts with user_id and filter. Detailed below.
    filter GetUserFilter
    Configuration block for filtering by a unique attribute of the user. Detailed below.

    Deprecated:Use the alternate_identifier attribute instead.

    userId string

    The identifier for a user in the Identity Store.

    Exactly one of the above arguments must be provided. Passing both filter and user_id is allowed for backwards compatibility.

    identity_store_id str

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

    The following arguments are optional:

    alternate_identifier GetUserAlternateIdentifier
    A unique identifier for a user or group that is not the primary identifier. Conflicts with user_id and filter. Detailed below.
    filter GetUserFilter
    Configuration block for filtering by a unique attribute of the user. Detailed below.

    Deprecated:Use the alternate_identifier attribute instead.

    user_id str

    The identifier for a user in the Identity Store.

    Exactly one of the above arguments must be provided. Passing both filter and user_id is allowed for backwards compatibility.

    identityStoreId String

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

    The following arguments are optional:

    alternateIdentifier Property Map
    A unique identifier for a user or group that is not the primary identifier. Conflicts with user_id and filter. Detailed below.
    filter Property Map
    Configuration block for filtering by a unique attribute of the user. Detailed below.

    Deprecated:Use the alternate_identifier attribute instead.

    userId String

    The identifier for a user in the Identity Store.

    Exactly one of the above arguments must be provided. Passing both filter and user_id is allowed for backwards compatibility.

    getUser Result

    The following output properties are available:

    Addresses List<GetUserAddress>
    List of details about the user's address.
    DisplayName string
    The name that is typically displayed when the user is referenced.
    Emails List<GetUserEmail>
    List of details about the user's email.
    ExternalIds List<GetUserExternalId>
    List of identifiers issued to this resource by an external identity provider.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityStoreId string
    Locale string
    The user's geographical region or location.
    Names List<GetUserName>
    Details about the user's full name.
    Nickname string
    An alternate name for the user.
    PhoneNumbers List<GetUserPhoneNumber>
    List of details about the user's phone number.
    PreferredLanguage string
    The preferred language of the user.
    ProfileUrl string
    An URL that may be associated with the user.
    Timezone string
    The user's time zone.
    Title string
    The user's title.
    UserId string
    UserName string
    User's user name value.
    UserType string
    The user type.
    AlternateIdentifier GetUserAlternateIdentifier
    Filter GetUserFilter

    Deprecated:Use the alternate_identifier attribute instead.

    Addresses []GetUserAddress
    List of details about the user's address.
    DisplayName string
    The name that is typically displayed when the user is referenced.
    Emails []GetUserEmail
    List of details about the user's email.
    ExternalIds []GetUserExternalId
    List of identifiers issued to this resource by an external identity provider.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityStoreId string
    Locale string
    The user's geographical region or location.
    Names []GetUserName
    Details about the user's full name.
    Nickname string
    An alternate name for the user.
    PhoneNumbers []GetUserPhoneNumber
    List of details about the user's phone number.
    PreferredLanguage string
    The preferred language of the user.
    ProfileUrl string
    An URL that may be associated with the user.
    Timezone string
    The user's time zone.
    Title string
    The user's title.
    UserId string
    UserName string
    User's user name value.
    UserType string
    The user type.
    AlternateIdentifier GetUserAlternateIdentifier
    Filter GetUserFilter

    Deprecated:Use the alternate_identifier attribute instead.

    addresses List<GetUserAddress>
    List of details about the user's address.
    displayName String
    The name that is typically displayed when the user is referenced.
    emails List<GetUserEmail>
    List of details about the user's email.
    externalIds List<GetUserExternalId>
    List of identifiers issued to this resource by an external identity provider.
    id String
    The provider-assigned unique ID for this managed resource.
    identityStoreId String
    locale String
    The user's geographical region or location.
    names List<GetUserName>
    Details about the user's full name.
    nickname String
    An alternate name for the user.
    phoneNumbers List<GetUserPhoneNumber>
    List of details about the user's phone number.
    preferredLanguage String
    The preferred language of the user.
    profileUrl String
    An URL that may be associated with the user.
    timezone String
    The user's time zone.
    title String
    The user's title.
    userId String
    userName String
    User's user name value.
    userType String
    The user type.
    alternateIdentifier GetUserAlternateIdentifier
    filter GetUserFilter

    Deprecated:Use the alternate_identifier attribute instead.

    addresses GetUserAddress[]
    List of details about the user's address.
    displayName string
    The name that is typically displayed when the user is referenced.
    emails GetUserEmail[]
    List of details about the user's email.
    externalIds GetUserExternalId[]
    List of identifiers issued to this resource by an external identity provider.
    id string
    The provider-assigned unique ID for this managed resource.
    identityStoreId string
    locale string
    The user's geographical region or location.
    names GetUserName[]
    Details about the user's full name.
    nickname string
    An alternate name for the user.
    phoneNumbers GetUserPhoneNumber[]
    List of details about the user's phone number.
    preferredLanguage string
    The preferred language of the user.
    profileUrl string
    An URL that may be associated with the user.
    timezone string
    The user's time zone.
    title string
    The user's title.
    userId string
    userName string
    User's user name value.
    userType string
    The user type.
    alternateIdentifier GetUserAlternateIdentifier
    filter GetUserFilter

    Deprecated:Use the alternate_identifier attribute instead.

    addresses Sequence[GetUserAddress]
    List of details about the user's address.
    display_name str
    The name that is typically displayed when the user is referenced.
    emails Sequence[GetUserEmail]
    List of details about the user's email.
    external_ids Sequence[GetUserExternalId]
    List of identifiers issued to this resource by an external identity provider.
    id str
    The provider-assigned unique ID for this managed resource.
    identity_store_id str
    locale str
    The user's geographical region or location.
    names Sequence[GetUserName]
    Details about the user's full name.
    nickname str
    An alternate name for the user.
    phone_numbers Sequence[GetUserPhoneNumber]
    List of details about the user's phone number.
    preferred_language str
    The preferred language of the user.
    profile_url str
    An URL that may be associated with the user.
    timezone str
    The user's time zone.
    title str
    The user's title.
    user_id str
    user_name str
    User's user name value.
    user_type str
    The user type.
    alternate_identifier GetUserAlternateIdentifier
    filter GetUserFilter

    Deprecated:Use the alternate_identifier attribute instead.

    addresses List<Property Map>
    List of details about the user's address.
    displayName String
    The 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.
    id String
    The provider-assigned unique ID for this managed resource.
    identityStoreId String
    locale String
    The 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
    The preferred language of the user.
    profileUrl String
    An URL that may be associated with the user.
    timezone String
    The user's time zone.
    title String
    The user's title.
    userId String
    userName String
    User's user name value.
    userType String
    The user type.
    alternateIdentifier Property Map
    filter Property Map

    Deprecated:Use the alternate_identifier attribute instead.

    Supporting Types

    GetUserAddress

    Country string
    The country that this address is in.
    Formatted string
    The name that is typically displayed when the name is shown for display.
    Locality string
    The address locality.
    PostalCode string
    The postal code of the address.
    Primary bool
    When true, this is the primary phone number associated with the user.
    Region string
    The region of the address.
    StreetAddress string
    The street of the address.
    Type string
    The type of phone number.
    Country string
    The country that this address is in.
    Formatted string
    The name that is typically displayed when the name is shown for display.
    Locality string
    The address locality.
    PostalCode string
    The postal code of the address.
    Primary bool
    When true, this is the primary phone number associated with the user.
    Region string
    The region of the address.
    StreetAddress string
    The street of the address.
    Type string
    The type of phone number.
    country String
    The country that this address is in.
    formatted String
    The name that is typically displayed when the name is shown for display.
    locality String
    The address locality.
    postalCode String
    The postal code of the address.
    primary Boolean
    When true, this is the primary phone number associated with the user.
    region String
    The region of the address.
    streetAddress String
    The street of the address.
    type String
    The type of phone number.
    country string
    The country that this address is in.
    formatted string
    The name that is typically displayed when the name is shown for display.
    locality string
    The address locality.
    postalCode string
    The postal code of the address.
    primary boolean
    When true, this is the primary phone number associated with the user.
    region string
    The region of the address.
    streetAddress string
    The street of the address.
    type string
    The type of phone number.
    country str
    The country that this address is in.
    formatted str
    The name that is typically displayed when the name is shown for display.
    locality str
    The address locality.
    postal_code str
    The postal code of the address.
    primary bool
    When true, this is the primary phone number associated with the user.
    region str
    The region of the address.
    street_address str
    The street of the address.
    type str
    The type of phone number.
    country String
    The country that this address is in.
    formatted String
    The name that is typically displayed when the name is shown for display.
    locality String
    The address locality.
    postalCode String
    The postal code of the address.
    primary Boolean
    When true, this is the primary phone number associated with the user.
    region String
    The region of the address.
    streetAddress String
    The street of the address.
    type String
    The type of phone number.

    GetUserAlternateIdentifier

    ExternalId GetUserAlternateIdentifierExternalId
    Configuration block for filtering by the identifier issued by an external identity provider. Detailed below.
    UniqueAttribute GetUserAlternateIdentifierUniqueAttribute

    An entity attribute that's unique to a specific entity. Detailed below.

    Exactly one of the above arguments must be provided.

    ExternalId GetUserAlternateIdentifierExternalId
    Configuration block for filtering by the identifier issued by an external identity provider. Detailed below.
    UniqueAttribute GetUserAlternateIdentifierUniqueAttribute

    An entity attribute that's unique to a specific entity. Detailed below.

    Exactly one of the above arguments must be provided.

    externalId GetUserAlternateIdentifierExternalId
    Configuration block for filtering by the identifier issued by an external identity provider. Detailed below.
    uniqueAttribute GetUserAlternateIdentifierUniqueAttribute

    An entity attribute that's unique to a specific entity. Detailed below.

    Exactly one of the above arguments must be provided.

    externalId GetUserAlternateIdentifierExternalId
    Configuration block for filtering by the identifier issued by an external identity provider. Detailed below.
    uniqueAttribute GetUserAlternateIdentifierUniqueAttribute

    An entity attribute that's unique to a specific entity. Detailed below.

    Exactly one of the above arguments must be provided.

    external_id GetUserAlternateIdentifierExternalId
    Configuration block for filtering by the identifier issued by an external identity provider. Detailed below.
    unique_attribute GetUserAlternateIdentifierUniqueAttribute

    An entity attribute that's unique to a specific entity. Detailed below.

    Exactly one of the above arguments must be provided.

    externalId Property Map
    Configuration block for filtering by the identifier issued by an external identity provider. Detailed below.
    uniqueAttribute Property Map

    An entity attribute that's unique to a specific entity. Detailed below.

    Exactly one of the above arguments must be provided.

    GetUserAlternateIdentifierExternalId

    Id string
    The identifier issued to this resource by an external identity provider.
    Issuer string
    The issuer for an external identifier.
    Id string
    The identifier issued to this resource by an external identity provider.
    Issuer string
    The issuer for an external identifier.
    id String
    The identifier issued to this resource by an external identity provider.
    issuer String
    The issuer for an external identifier.
    id string
    The identifier issued to this resource by an external identity provider.
    issuer string
    The issuer for an external identifier.
    id str
    The identifier issued to this resource by an external identity provider.
    issuer str
    The issuer for an external identifier.
    id String
    The identifier issued to this resource by an external identity provider.
    issuer String
    The issuer for an external identifier.

    GetUserAlternateIdentifierUniqueAttribute

    AttributePath string
    Attribute path that is used to specify which attribute name to search. For example: UserName. Refer to the User data type.
    AttributeValue string
    Value for an attribute.
    AttributePath string
    Attribute path that is used to specify which attribute name to search. For example: UserName. Refer to the User data type.
    AttributeValue string
    Value for an attribute.
    attributePath String
    Attribute path that is used to specify which attribute name to search. For example: UserName. Refer to the User data type.
    attributeValue String
    Value for an attribute.
    attributePath string
    Attribute path that is used to specify which attribute name to search. For example: UserName. Refer to the User data type.
    attributeValue string
    Value for an attribute.
    attribute_path str
    Attribute path that is used to specify which attribute name to search. For example: UserName. Refer to the User data type.
    attribute_value str
    Value for an attribute.
    attributePath String
    Attribute path that is used to specify which attribute name to search. For example: UserName. Refer to the User data type.
    attributeValue String
    Value for an attribute.

    GetUserEmail

    Primary bool
    When true, this is the primary phone number associated with the user.
    Type string
    The type of phone number.
    Value string
    The user's phone number.
    Primary bool
    When true, this is the primary phone number associated with the user.
    Type string
    The type of phone number.
    Value string
    The user's phone number.
    primary Boolean
    When true, this is the primary phone number associated with the user.
    type String
    The type of phone number.
    value String
    The user's phone number.
    primary boolean
    When true, this is the primary phone number associated with the user.
    type string
    The type of phone number.
    value string
    The user's phone number.
    primary bool
    When true, this is the primary phone number associated with the user.
    type str
    The type of phone number.
    value str
    The user's phone number.
    primary Boolean
    When true, this is the primary phone number associated with the user.
    type String
    The type of phone number.
    value String
    The user's phone number.

    GetUserExternalId

    Id string
    The identifier issued to this resource by an external identity provider.
    Issuer string
    The issuer for an external identifier.
    Id string
    The identifier issued to this resource by an external identity provider.
    Issuer string
    The issuer for an external identifier.
    id String
    The identifier issued to this resource by an external identity provider.
    issuer String
    The issuer for an external identifier.
    id string
    The identifier issued to this resource by an external identity provider.
    issuer string
    The issuer for an external identifier.
    id str
    The identifier issued to this resource by an external identity provider.
    issuer str
    The issuer for an external identifier.
    id String
    The identifier issued to this resource by an external identity provider.
    issuer String
    The issuer for an external identifier.

    GetUserFilter

    AttributePath string
    Attribute path that is used to specify which attribute name to search. Currently, UserName is the only valid attribute path.
    AttributeValue string
    Value for an attribute.
    AttributePath string
    Attribute path that is used to specify which attribute name to search. Currently, UserName is the only valid attribute path.
    AttributeValue string
    Value for an attribute.
    attributePath String
    Attribute path that is used to specify which attribute name to search. Currently, UserName is the only valid attribute path.
    attributeValue String
    Value for an attribute.
    attributePath string
    Attribute path that is used to specify which attribute name to search. Currently, UserName is the only valid attribute path.
    attributeValue string
    Value for an attribute.
    attribute_path str
    Attribute path that is used to specify which attribute name to search. Currently, UserName is the only valid attribute path.
    attribute_value str
    Value for an attribute.
    attributePath String
    Attribute path that is used to specify which attribute name to search. Currently, UserName is the only valid attribute path.
    attributeValue String
    Value for an attribute.

    GetUserName

    FamilyName string
    The family name of the user.
    Formatted string
    The name that is typically displayed when the name is shown for display.
    GivenName string
    The given name of the user.
    HonorificPrefix string
    The honorific prefix of the user.
    HonorificSuffix string
    The honorific suffix of the user.
    MiddleName string
    The middle name of the user.
    FamilyName string
    The family name of the user.
    Formatted string
    The name that is typically displayed when the name is shown for display.
    GivenName string
    The given name of the user.
    HonorificPrefix string
    The honorific prefix of the user.
    HonorificSuffix string
    The honorific suffix of the user.
    MiddleName string
    The middle name of the user.
    familyName String
    The family name of the user.
    formatted String
    The name that is typically displayed when the name is shown for display.
    givenName String
    The given name of the user.
    honorificPrefix String
    The honorific prefix of the user.
    honorificSuffix String
    The honorific suffix of the user.
    middleName String
    The middle name of the user.
    familyName string
    The family name of the user.
    formatted string
    The name that is typically displayed when the name is shown for display.
    givenName string
    The given name of the user.
    honorificPrefix string
    The honorific prefix of the user.
    honorificSuffix string
    The honorific suffix of the user.
    middleName string
    The middle name of the user.
    family_name str
    The family name of the user.
    formatted str
    The name that is typically displayed when the name is shown for display.
    given_name str
    The given name of the user.
    honorific_prefix str
    The honorific prefix of the user.
    honorific_suffix str
    The honorific suffix of the user.
    middle_name str
    The middle name of the user.
    familyName String
    The family name of the user.
    formatted String
    The name that is typically displayed when the name is shown for display.
    givenName String
    The given name of the user.
    honorificPrefix String
    The honorific prefix of the user.
    honorificSuffix String
    The honorific suffix of the user.
    middleName String
    The middle name of the user.

    GetUserPhoneNumber

    Primary bool
    When true, this is the primary phone number associated with the user.
    Type string
    The type of phone number.
    Value string
    The user's phone number.
    Primary bool
    When true, this is the primary phone number associated with the user.
    Type string
    The type of phone number.
    Value string
    The user's phone number.
    primary Boolean
    When true, this is the primary phone number associated with the user.
    type String
    The type of phone number.
    value String
    The user's phone number.
    primary boolean
    When true, this is the primary phone number associated with the user.
    type string
    The type of phone number.
    value string
    The user's phone number.
    primary bool
    When true, this is the primary phone number associated with the user.
    type str
    The type of phone number.
    value str
    The user's phone number.
    primary Boolean
    When true, this is the primary phone number associated with the user.
    type String
    The type of phone number.
    value String
    The 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 logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.27.0 published on Monday, Mar 18, 2024 by Pulumi