Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.

The permission resource is arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> .

The condition resource is the Amazon Resource Name (ARN) for the IAM user or role, and the session name.

The condition keys are quicksight:IamArn and quicksight:SessionName.

CLI Sample:

aws quicksight register-user -\-aws-account-id=111122223333 -\-namespace=default -\ -\-identity-type=IAM -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat

Request Syntax

POST /accounts/AwsAccountId/namespaces/Namespace/users HTTP/1.1 Content-type: application/json { "Email": "string", "IamArn": "string", "IdentityType": "string", "SessionName": "string", "UserName": "string", "UserRole": "string" }

URI Request Parameters

The request requires the following URI parameters.


The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$


The namespace. Currently, you should set this to default.

Pattern: default

Request Body

The request accepts the following data in JSON format.


The email address of the user that you want to register.

Type: String

Required: Yes


Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

  • IAM: A user whose identity maps to an existing IAM user or role.

  • QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

Type: String

Valid Values: IAM | QUICKSIGHT

Required: Yes


The Amazon QuickSight role of the user. The user role can be one of the following:

  • READER: A user who has read-only access to dashboards.

  • AUTHOR: A user who can create data sources, data sets, analyses, and dashboards.

  • ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.

Type: String


Required: Yes


The ARN of the IAM user or role that you are registering with Amazon QuickSight.

Type: String

Required: No


You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the AWS CLI Reference.

Type: String

Length Constraints: Minimum length of 2. Maximum length of 64.

Pattern: [\w+=.@-]*

Required: No


The Amazon QuickSight user name that you want to create for the user you are registering.

Type: String

Length Constraints: Minimum length of 1.

Pattern: [\u0020-\u00FF]+

Required: No

Response Syntax

HTTP/1.1 Status Content-type: application/json { "RequestId": "string", "User": { "Active": boolean, "Arn": "string", "Email": "string", "IdentityType": "string", "PrincipalId": "string", "Role": "string", "UserName": "string" }, "UserInvitationUrl": "string" }

Response Elements

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


The http status of the request.

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


The AWS request ID for this operation.

Type: String


The user name.

Type: User object


The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT.

Type: String


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


You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.

HTTP Status Code: 401


An internal failure occurred.

HTTP Status Code: 500


One or more parameters don't have a valid value.

HTTP Status Code: 400


A limit is exceeded.

HTTP Status Code: 409


One or more preconditions aren't met.

HTTP Status Code: 400


The resource specified doesn't exist.

HTTP Status Code: 409


One or more resources can't be found.

HTTP Status Code: 404


This resource is currently unavailable.

HTTP Status Code: 503


Access is throttled.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: