Create User

identitystore_create_user

R Documentation

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)

Arguments¶

IdentityStoreId: [required] The globally unique identifier for the identity store.
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.
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."
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.

Value¶

A list with the following syntax:

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