Skip to content

Creates a user within the specified identity store

Description

Creates a user within the specified identity store.

Usage

identitystore_create_user(IdentityStoreId, UserName, Name, DisplayName,
  NickName, ProfileUrl, Emails, Addresses, PhoneNumbers, UserType, Title,
  PreferredLanguage, Locale, Timezone, Photos, Website, Birthdate, Roles,
  Extensions)

Arguments

  • IdentityStoreId

    [required] The globally unique identifier for the identity store.

    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.

  • UserName

    A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store. Administrator and AWSAdministrators are reserved names and can't be used for users or groups.

  • Name

    An object containing the name of the user. When used in IAM Identity Center, this parameter is required.

  • DisplayName

    A string containing the name of the user. This value is typically formatted for display when the user is referenced. For example, "John Doe." When used in IAM Identity Center, this parameter is required.

  • NickName

    A string containing an alternate name for the user.

  • ProfileUrl

    A string containing a URL that might be associated with the user.

  • Emails

    A list of Email objects containing email addresses associated with the user.

  • Addresses

    A list of Address objects containing addresses associated with the user.

  • PhoneNumbers

    A list of PhoneNumber objects containing phone numbers associated with the user.

  • UserType

    A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.

  • Title

    A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.

  • PreferredLanguage

    A string containing the preferred language of the user. For example, "American English" or "en-us."

  • Locale

    A string containing the geographical region or location of the user.

  • Timezone

    A string containing the time zone of the user.

  • Photos

    A list of photos associated with the user. You can add up to 3 photos per user. Each photo can include a value, type, display name, and primary designation.

  • Website

    The user's personal website or blog URL. This field allows users to provide a link to their personal or professional website.

  • Birthdate

    The user's birthdate in YYYY-MM-DD format. This field supports standard date format for storing personal information.

  • Roles

    A list of Role objects containing roles associated with the user.

  • Extensions

    A map with additional attribute extensions for the user. Each map key corresponds to an extension name, while map values represent extension data in Document type (not supported by Java V1, Go V1 and older versions of the CLI). 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"
)

Request syntax

svc$create_user(
  IdentityStoreId = "string",
  UserName = "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",
  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
    )
  ),
  Extensions = list(
    list()
  )
)