RegisterUser

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 -\-email=pat@example.com -\-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.

AwsAccountId

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}$

Namespace

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

Pattern: default

Request Body

The request accepts the following data in JSON format.

Email

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

Type: String

Required: Yes

IdentityType

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

UserRole

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

Valid Values: ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER

Required: Yes

IamArn

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

Type: String

Required: No

SessionName

The name of the session with the assumed IAM role. By using this parameter, you can register multiple users with the same IAM role, provided that each has a different session name. For more information on assuming IAM roles, see assume-role in the AWS CLI Reference.

Type: String

Required: No

UserName

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", "Role": "string", "UserName": "string" } }

Response Elements

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

Status

The http status of the request.

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

RequestId

The AWS request ID for this operation.

Type: String

User

The user name.

Type: User object

Errors

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

AccessDeniedException

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

InternalFailureException

An internal failure occurred.

HTTP Status Code: 500

InvalidParameterValueException

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

HTTP Status Code: 400

LimitExceededException

A limit is exceeded.

HTTP Status Code: 409

PreconditionNotMetException

One or more preconditions aren't met.

HTTP Status Code: 400

ResourceExistsException

The resource specified doesn't exist.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

ResourceUnavailableException

This resource is currently unavailable.

HTTP Status Code: 503

ThrottlingException

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: