Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

CreateUser

Request Syntax


{
   "Addresses": [ 
      { 
         "Country": "string",
         "Formatted": "string",
         "Locality": "string",
         "PostalCode": "string",
         "Primary": boolean,
         "Region": "string",
         "StreetAddress": "string",
         "Type": "string"
      }
   ],
   "DisplayName": "string",
   "Emails": [ 
      { 
         "Primary": boolean,
         "Type": "string",
         "Value": "string"
      }
   ],
   "IdentityStoreId": "string",
   "Locale": "string",
   "Name": { 
      "FamilyName": "string",
      "Formatted": "string",
      "GivenName": "string",
      "HonorificPrefix": "string",
      "HonorificSuffix": "string",
      "MiddleName": "string"
   },
   "NickName": "string",
   "PhoneNumbers": [ 
      { 
         "Primary": boolean,
         "Type": "string",
         "Value": "string"
      }
   ],
   "PreferredLanguage": "string",
   "ProfileUrl": "string",
   "Timezone": "string",
   "Title": "string",
   "UserName": "string",
   "UserType": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Addresses

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

Type: Array of Address objects

Array Members: Fixed number of 1 item.

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Required: No

Emails

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

Type: Array of Email objects

Array Members: Fixed number of 1 item.

Required: No

IdentityStoreId

The globally unique identifier for the identity store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Locale

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Required: No

Name

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

Type: Name object

Required: No

NickName

A string containing an alternate name for the user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Required: No

PhoneNumbers

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

Type: Array of PhoneNumber objects

Array Members: Fixed number of 1 item.

Required: No

PreferredLanguage

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Required: No

ProfileUrl

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Required: No

Timezone

A string containing the time zone of the user.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Required: No

Title

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Required: No

UserType

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r 　]+

Required: No

Response Syntax


{
   "IdentityStoreId": "string",
   "UserId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

IdentityStoreId

The globally unique identifier for the identity store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 36.

Pattern: d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

UserId

The identifier of the newly created user in the identity store.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 47.

Pattern: ([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

HTTP Status Code: 400

ConflictException

This request cannot be completed for one of the following reasons:

Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.

Reason

This request cannot be completed for one of the following reasons:

Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.
The requested resource was being concurrently modified by another request.

RequestId

The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

HTTP Status Code: 400

InternalServerException

The request processing has failed because of an unknown error, exception or failure with an internal server.

RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
RetryAfterSeconds: The number of seconds to wait before retrying the next request.

HTTP Status Code: 500

ResourceNotFoundException

Indicates that a requested resource is not found.

RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
ResourceId: The identifier for a resource in the identity store that can be used as UserId or GroupId. The format for ResourceId is either UUID or 1234567890-UUID, where UUID is a randomly generated value for each resource when it is created and 1234567890 represents the IdentityStoreId string value. In the case that the identity store is migrated from a legacy SSO identity store, the ResourceId for that identity store will be in the format of UUID. Otherwise, it will be in the 1234567890-UUID format.
ResourceType: An enum object indicating the type of resource in the identity store service. Valid values include USER, GROUP, and IDENTITY_STORE.

HTTP Status Code: 400

ServiceQuotaExceededException

The request would cause the number of users or groups in the identity store to exceed the maximum allowed.

RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

HTTP Status Code: 400

ThrottlingException

Indicates that the principal has crossed the throttling limits of the API operations.

RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.
RetryAfterSeconds: The number of seconds to wait before retrying the next request.

HTTP Status Code: 400

ValidationException

The request failed because it contains a syntax error.

RequestId: The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.

HTTP Status Code: 400

Examples

Example

This example creates a new user in the specified identity store.

Sample Request


{
    "IdentityStoreId": "d-1234567890",
    "UserName": "johndoe",
    "Name": {
        "Formatted": "John Steve Doe",
        "FamilyName": "Doe",
        "GivenName": "John",
        "MiddleName": "Steve",
        "HonorificPrefix": "Mr",
        "HonorificSuffix": "Jr"
    },
    "DisplayName": "John Doe",
    "NickName": "Johny",
    "ProfileUrl": "www.amazondomains.com",
    "Emails": [
        {
            "Value": "johndoe@example.com",
            "Type": "work",
            "Primary": true
        }
    ],
    "Addresses": [
        {
            "StreetAddress": "100 Universal City Plaza",
            "Locality": "Any Town",
            "Region": "WA",
            "PostalCode": "12345",
            "Country": "USA",
            "Formatted": "100 Universal City Plaza Any Town USA",
            "Type": "home",
            "Primary": true
        }
    ],
    "PhoneNumbers": [
        {
            "Value": "832-555-0100",
            "Type": "work",
            "Primary": true
        }
    ],
    "UserType": "temp",
    "Title": "Contractor",
    "PreferredLanguage": "en-us",
    "Locale": "NA",
    "Timezone": "pdt"
}

Sample Response



{
    "UserId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
    "IdentityStoreId": "d-1234567890"
}