Skip to content

Retrieves the user metadata and attributes from the UserId in an identity store

Description

Retrieves the user metadata and attributes from the UserId in an identity store.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Usage

identitystore_describe_user(IdentityStoreId, UserId, Extensions)

Arguments

  • IdentityStoreId

    [required] The globally unique identifier for the identity store, such as d-1234567890. In this example, d- is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

    You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.

  • UserId

    [required] The identifier for a user in the identity store.

    You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 or user ARN arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

  • Extensions

    A collection of extension names indicating what extensions the service should retrieve alongside other user attributes. aws:identitystore:enterprise is the only supported extension name.

Value

A list with the following syntax:

list(
  IdentityStoreId = "string",
  UserId = "string",
  UserArn = "string",
  Revision = "string",
  UserName = "string",
  ExternalIds = list(
    list(
      Issuer = "string",
      Id = "string"
    )
  ),
  Name = list(
    Formatted = "string",
    FamilyName = "string",
    GivenName = "string",
    MiddleName = "string",
    HonorificPrefix = "string",
    HonorificSuffix = "string"
  ),
  DisplayName = "string",
  NickName = "string",
  ProfileUrl = "string",
  Emails = list(
    list(
      Value = "string",
      Type = "string",
      Primary = TRUE|FALSE
    )
  ),
  Addresses = list(
    list(
      StreetAddress = "string",
      Locality = "string",
      Region = "string",
      PostalCode = "string",
      Country = "string",
      Formatted = "string",
      Type = "string",
      Primary = TRUE|FALSE
    )
  ),
  PhoneNumbers = list(
    list(
      Value = "string",
      Type = "string",
      Primary = TRUE|FALSE
    )
  ),
  UserType = "string",
  Title = "string",
  PreferredLanguage = "string",
  Locale = "string",
  Timezone = "string",
  UserStatus = "ENABLED"|"DISABLED",
  Photos = list(
    list(
      Value = "string",
      Type = "string",
      Display = "string",
      Primary = TRUE|FALSE
    )
  ),
  Website = "string",
  Birthdate = "string",
  Roles = list(
    list(
      Value = "string",
      Type = "string",
      Primary = TRUE|FALSE
    )
  ),
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  CreatedBy = "string",
  UpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  UpdatedBy = "string",
  Extensions = list(
    list()
  )
)

Request syntax

svc$describe_user(
  IdentityStoreId = "string",
  UserId = "string",
  Extensions = list(
    "string"
  )
)