Describe User

identitystore_describe_user

R Documentation

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 administrator access to a member account, you can use this API from the member account. Read about member accounts in the Organizations User Guide.

Usage¶

identitystore_describe_user(IdentityStoreId, UserId)

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.

UserId

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

Value¶

A list with the following syntax:

list(
  UserName = "string",
  UserId = "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",
  IdentityStoreId = "string"
)

Request syntax¶

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