IdentityStore / Client / create_user

create_user¶

IdentityStore.Client.create_user(**kwargs)¶

Creates a user within the specified identity store.

Request Syntax

response = client.create_user(
    IdentityStoreId='string',
    UserName='string',
    Name={
        'Formatted': 'string',
        'FamilyName': 'string',
        'GivenName': 'string',
        'MiddleName': 'string',
        'HonorificPrefix': 'string',
        'HonorificSuffix': 'string'
    },
    DisplayName='string',
    NickName='string',
    ProfileUrl='string',
    Emails=[
        {
            'Value': 'string',
            'Type': 'string',
            'Primary': True|False
        },
    ],
    Addresses=[
        {
            'StreetAddress': 'string',
            'Locality': 'string',
            'Region': 'string',
            'PostalCode': 'string',
            'Country': 'string',
            'Formatted': 'string',
            'Type': 'string',
            'Primary': True|False
        },
    ],
    PhoneNumbers=[
        {
            'Value': 'string',
            'Type': 'string',
            'Primary': True|False
        },
    ],
    UserType='string',
    Title='string',
    PreferredLanguage='string',
    Locale='string',
    Timezone='string',
    Photos=[
        {
            'Value': 'string',
            'Type': 'string',
            'Display': 'string',
            'Primary': True|False
        },
    ],
    Website='string',
    Birthdate='string'
)

Parameters:

IdentityStoreId (string) –
[REQUIRED]

The globally unique identifier for the identity store.
UserName (string) – 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 (dict) –
An object containing the name of the user. When used in IAM Identity Center, this parameter is required.
- Formatted (string) –
  
  A string containing a formatted version of the name for display.
- FamilyName (string) –
  
  The family name of the user.
- GivenName (string) –
  
  The given name of the user.
- MiddleName (string) –
  
  The middle name of the user.
- HonorificPrefix (string) –
  
  The honorific prefix of the user. For example, “Dr.”
- HonorificSuffix (string) –
  
  The honorific suffix of the user. For example, “M.D.”
DisplayName (string) – 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 (string) – A string containing an alternate name for the user.
ProfileUrl (string) – A string containing a URL that might be associated with the user.
Emails (list) –
A list of Email objects containing email addresses associated with the user.
- (dict) –
  
  The email address associated with the user.
  - Value (string) –
    
    A string containing an email address. For example, “johndoe@amazon.com.”
  - Type (string) –
    
    A string representing the type of address. For example, “Work.”
  - Primary (boolean) –
    
    A Boolean value representing whether this is the primary email address for the associated resource.
Addresses (list) –
A list of Address objects containing addresses associated with the user.
- (dict) –
  
  The address associated with the specified user.
  - StreetAddress (string) –
    
    The street of the address.
  - Locality (string) –
    
    A string of the address locality.
  - Region (string) –
    
    The region of the address.
  - PostalCode (string) –
    
    The postal code of the address.
  - Country (string) –
    
    The country of the address.
  - Formatted (string) –
    
    A string containing a formatted version of the address for display.
  - Type (string) –
    
    A string representing the type of address. For example, “Home.”
  - Primary (boolean) –
    
    A Boolean value representing whether this is the primary address for the associated resource.
PhoneNumbers (list) –
A list of PhoneNumber objects containing phone numbers associated with the user.
- (dict) –
  
  The phone number associated with the user.
  - Value (string) –
    
    A string containing a phone number. For example, “8675309” or “+1 (800) 123-4567”.
  - Type (string) –
    
    A string representing the type of a phone number. For example, “Mobile.”
  - Primary (boolean) –
    
    A Boolean value representing whether this is the primary phone number for the associated resource.
UserType (string) – A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.
Title (string) – A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.
PreferredLanguage (string) – A string containing the preferred language of the user. For example, “American English” or “en-us.”
Locale (string) – A string containing the geographical region or location of the user.
Timezone (string) – A string containing the time zone of the user.
Photos (list) –
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.
- (dict) –
  
  Contains information about a user’s photo. Users can have up to 3 photos, with one designated as primary. Supports common image formats, including jpg, jpeg, png, and gif.
  - Value (string) – [REQUIRED]
    
    The photo data or URL. Supported formats include jpg, jpeg, png, and gif. This field is required for all photo entries.
  - Type (string) –
    
    The type of photo. This field is optional and can be used to categorize different types of photos.
  - Display (string) –
    
    A human-readable description of the photo for display purposes. This optional field provides context about the photo.
  - Primary (boolean) –
    
    Specifies whether this is the user’s primary photo. Default value is false. Only one photo can be designated as primary per user.
Website (string) – The user’s personal website or blog URL. This field allows users to provide a link to their personal or professional website.
Birthdate (string) – The user’s birthdate in YYYY-MM-DD format. This field supports standard date format for storing personal information.

Return type:

dict

Returns:

Response Syntax

{
    'IdentityStoreId': 'string',
    'UserId': 'string'
}

Response Structure

(dict) –
- IdentityStoreId (string) –
  
  The globally unique identifier for the identity store.
- UserId (string) –
  
  The identifier of the newly created user in the identity store.

Exceptions

IdentityStore.Client.exceptions.ResourceNotFoundException
IdentityStore.Client.exceptions.ThrottlingException
IdentityStore.Client.exceptions.AccessDeniedException
IdentityStore.Client.exceptions.ConflictException
IdentityStore.Client.exceptions.InternalServerException
IdentityStore.Client.exceptions.ValidationException
IdentityStore.Client.exceptions.ServiceQuotaExceededException