Amazon QuickSight Quicksight Users API
The Quicksight Users API from Amazon QuickSight — 2 operation(s) for quicksight users.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/amazon-quicksight:amazon-quicksight-users-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.1.0
info:
title: Amazon QuickSight Users API
version: '2018-04-01'
description: Generated from AWS's published Smithy model for Amazon QuickSight. 5 operation(s).
contact:
name: Amazon Web Services
url: https://aws.amazon.com/contact-us/
license:
name: Apache 2.0
identifier: Apache-2.0
url: https://github.com/aws/api-models-aws/blob/main/LICENSE
servers:
- url: https://quicksight.{region}.amazonaws.com
variables:
region:
default: us-east-1
security:
- sigv4: []
paths:
/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}:
delete:
operationId: DeleteUser
summary: Delete User
description: Deletes the Amazon Quick Sight user that is associated with the identity of the IAM user or role that's
making the call. The IAM user isn't deleted as a result of this call.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteUserResponse'
'401':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'400':
description: InvalidParameterValueException; PreconditionNotMetException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'503':
description: ResourceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnavailableException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteUserRequest'
tags:
- Users
get:
operationId: DescribeUser
summary: Describe User
description: Returns information about a user, given the user name.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeUserResponse'
'401':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'400':
description: InvalidParameterValueException; PreconditionNotMetException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'503':
description: ResourceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnavailableException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeUserRequest'
tags:
- Users
put:
operationId: UpdateUser
summary: Update User
description: Updates an Amazon Quick Sight user.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserResponse'
'401':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'400':
description: InvalidParameterValueException; PreconditionNotMetException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'503':
description: ResourceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnavailableException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateUserRequest'
tags:
- Users
/accounts/{AwsAccountId}/namespaces/{Namespace}/users:
get:
operationId: ListUsers
summary: List Users
description: Returns a list of all of the Amazon Quick Sight users belonging to this account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListUsersResponse'
'401':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'400':
description: InvalidNextTokenException; InvalidParameterValueException; PreconditionNotMetException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidNextTokenException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'503':
description: ResourceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnavailableException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListUsersRequest'
tags:
- Users
post:
operationId: RegisterUser
summary: Register User
description: Creates an Amazon Quick Sight user whose identity is associated with the Identity and Access Management
(IAM) identity or role specified in the request. When you register a new user from the Quick Sight API, Quick Sight
generates a registration URL. The user accesses this registration URL to create their account. Quick Sight doesn't
send a registration email to users who are registered from the Quick Sight API. If you want new users to receive a
registration email, then add those users in the Quick Sight console. For more information on registering a new user
in the Quick Sight console, see Inviting users to access Quick Sight.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterUserResponse'
'401':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'400':
description: InvalidParameterValueException; PreconditionNotMetException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
'409':
description: LimitExceededException; ResourceExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/LimitExceededException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'503':
description: ResourceUnavailableException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceUnavailableException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RegisterUserRequest'
tags:
- Users
components:
securitySchemes:
sigv4:
type: apiKey
in: header
name: Authorization
description: AWS Signature Version 4. The Authorization header carries an AWS4-HMAC-SHA256 signature over the canonical
request, with X-Amz-Date (and X-Amz-Security-Token for temporary credentials). Not a bearer token.
x-aws-sigv4:
signingName: quicksight
schemas:
AccessDeniedException:
type: object
properties:
Message:
type: string
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
DeleteUserRequest:
type: object
properties:
UserName:
type: string
description: The name of the user that you want to delete.
AwsAccountId:
type: string
description: The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon
Web Services account that contains your Amazon Quick Sight account.
Namespace:
type: string
description: The namespace. Currently, you should set this to default.
required:
- UserName
- AwsAccountId
- Namespace
DeleteUserResponse:
type: object
properties:
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
Status:
type: integer
description: The HTTP status of the request.
DescribeUserRequest:
type: object
properties:
UserName:
type: string
description: The name of the user that you want to describe.
AwsAccountId:
type: string
description: The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon
Web Services account that contains your Amazon Quick Sight account.
Namespace:
type: string
description: The namespace. Currently, you should set this to default.
required:
- UserName
- AwsAccountId
- Namespace
DescribeUserResponse:
type: object
properties:
User:
$ref: '#/components/schemas/User'
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
Status:
type: integer
description: The HTTP status of the request.
InternalFailureException:
type: object
properties:
Message:
type: string
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
InvalidNextTokenException:
type: object
properties:
Message:
type: string
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
InvalidParameterValueException:
type: object
properties:
Message:
type: string
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
LimitExceededException:
type: object
properties:
Message:
type: string
ResourceType:
type: string
enum:
- USER
- GROUP
- NAMESPACE
- ACCOUNT_SETTINGS
- IAMPOLICY_ASSIGNMENT
- DATA_SOURCE
- DATA_SET
- VPC_CONNECTION
- INGESTION
description: Limit exceeded.
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
ListUsersRequest:
type: object
properties:
AwsAccountId:
type: string
description: The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon
Web Services account that contains your Amazon Quick Sight account.
NextToken:
type: string
description: A pagination token that can be used in a subsequent request.
MaxResults:
type: integer
description: The maximum number of results to return from this request.
Namespace:
type: string
description: The namespace. Currently, you should set this to default.
required:
- AwsAccountId
- Namespace
ListUsersResponse:
type: object
properties:
UserList:
type: array
items:
$ref: '#/components/schemas/User'
description: The list of users.
NextToken:
type: string
description: A pagination token that can be used in a subsequent request.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
Status:
type: integer
description: The HTTP status of the request.
RegisterUserRequest:
type: object
properties:
IdentityType:
type: string
enum:
- IAM
- QUICKSIGHT
- IAM_IDENTITY_CENTER
description: The identity type that your Quick Sight account uses to manage the identity of users.
Email:
type: string
description: The email address of the user that you want to register.
UserRole:
type: string
enum:
- ADMIN
- AUTHOR
- READER
- RESTRICTED_AUTHOR
- RESTRICTED_READER
- ADMIN_PRO
- AUTHOR_PRO
- READER_PRO
description: 'The Amazon Quick Sight role for 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, datasets, analyses, and dashboards.
ADMIN: A user who is an author, who can also manage Amazon Quick Sight settings. READER_PRO: Reader Pro adds Generative
BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, can build stories with
Amazon Q, and can generate executive summaries from dashboards. AUTHOR_PRO: Author Pro adds Generative BI capabilities
to the Author role. Author Pro'
IamArn:
type: string
description: The ARN of the IAM user or role that you are registering with Amazon Quick Sight.
SessionName:
type: string
description: 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 Quick Sight 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 CLI Reference.
AwsAccountId:
type: string
description: The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon
Web Services account that contains your Amazon Quick Sight account.
Namespace:
type: string
description: The namespace. Currently, you should set this to default.
UserName:
type: string
description: The Amazon Quick Sight user name that you want to create for the user you are registering.
CustomPermissionsName:
type: string
description: '(Enterprise edition only) The name of the custom permissions profile that you want to assign to this
user. Customized permissions allows you to control a user''s access by restricting access the following operations:
Create and update data sources Create and update datasets Create and update email reports Subscribe to email reports
To add custom permissions to an existing user, use UpdateUser instead. A set of custom permissions includes any
combination of these restrictions. Currently, you need to create the profile names for custom permission sets
by using the Quick Sight console. Then, you u'
ExternalLoginFederationProviderType:
type: string
description: 'The type of supported external login provider that provides identity to let a user federate into Amazon
Quick Sight with an associated Identity and Access Management(IAM) role. The type of supported external login
provider can be one of the following. COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed
when the external provider is custom. CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC
type, use the CustomFederationProviderU'
CustomFederationProviderUrl:
type: string
description: The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate
into Quick Sight with an associated Identity and Access Management(IAM) role. This parameter should only be used
when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
ExternalLoginId:
type: string
description: The identity ID for a user in the external login provider.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: The tags to associate with the user.
required:
- IdentityType
- Email
- UserRole
- AwsAccountId
- Namespace
RegisterUserResponse:
type: object
properties:
User:
$ref: '#/components/schemas/User'
UserInvitationUrl:
type: string
description: The URL the user visits to complete registration and provide a password. This is returned only for
users with an identity type of QUICKSIGHT.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
Status:
type: integer
description: The HTTP status of the request.
ResourceNotFoundException:
type: object
properties:
Message:
type: string
ResourceType:
type: string
enum:
- USER
- GROUP
- NAMESPACE
- ACCOUNT_SETTINGS
- IAMPOLICY_ASSIGNMENT
- DATA_SOURCE
- DATA_SET
- VPC_CONNECTION
- INGESTION
description: The resource type for this request.
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
ResourceUnavailableException:
type: object
properties:
Message:
type: string
ResourceType:
type: string
enum:
- USER
- GROUP
- NAMESPACE
- ACCOUNT_SETTINGS
- IAMPOLICY_ASSIGNMENT
- DATA_SOURCE
- DATA_SET
- VPC_CONNECTION
- INGESTION
description: The resource type for this request.
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
Tag:
type: object
properties:
Key:
type: string
description: Tag key.
Value:
type: string
description: Tag value.
required:
- Key
- Value
ThrottlingException:
type: object
properties:
Message:
type: string
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
UpdateUserRequest:
type: object
properties:
UserName:
type: string
description: The Amazon Quick Sight user name that you want to update.
AwsAccountId:
type: string
description: The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon
Web Services account that contains your Amazon Quick Sight account.
Namespace:
type: string
description: The namespace. Currently, you should set this to default.
Email:
type: string
description: The email address of the user that you want to update.
Role:
type: string
enum:
- ADMIN
- AUTHOR
- READER
- RESTRICTED_AUTHOR
- RESTRICTED_READER
- ADMIN_PRO
- AUTHOR_PRO
- READER_PRO
description: 'The Amazon Quick Sight role of the user. The role can be one of the following default security cohorts:
READER: A user who has read-only access to dashboards. AUTHOR: A user who can create data sources, datasets, analyses,
and dashboards. ADMIN: A user who is an author, who can also manage Amazon Quick Sight settings. READER_PRO: Reader
Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, can
build stories with Amazon Q, and can generate executive summaries from dashboards. AUTHOR_PRO: Author Pro adds
Generative BI capabilities to the Auth'
CustomPermissionsName:
type: string
description: '(Enterprise edition only) The name of the custom permissions profile that you want to assign to this
user. Customized permissions allows you to control a user''s access by restricting access the following operations:
Create and update data sources Create and update datasets Create and update email reports Subscribe to email reports
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the
profile names for custom permission sets by using the Quick Sight console. Then, you use the RegisterUser API
operation to assign the named set of permission'
UnapplyCustomPermissions:
type: boolean
description: A flag that you use to indicate that you want to remove all custom permissions from this user. Using
this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter
defaults to NULL and it doesn't accept any other value.
ExternalLoginFederationProviderType:
type: string
description: 'The type of supported external login provider that provides identity to let a user federate into Quick
Sight with an associated Identity and Access Management(IAM) role. The type of supported external login provider
can be one of the following. COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When
choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed
when the external provider is custom. CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC
type, use the CustomFederationProviderUrl para'
CustomFederationProviderUrl:
type: string
description: The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate
into Quick Sight with an associated Identity and Access Management(IAM) role. This parameter should only be used
when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
ExternalLoginId:
type: string
description: The identity ID for a user in the external login provider.
required:
- UserName
- AwsAccountId
- Namespace
- Email
- Role
UpdateUserResponse:
type: object
properties:
User:
$ref: '#/components/schemas/User'
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
Status:
type: integer
description: The HTTP status of the request.
User:
type: object
properties:
Arn:
type: string
description: The Amazon Resource Name (ARN) for the user.
UserName:
type: string
description: The user's user name. This value is required if you are registering a user that will be managed in
Quick Sight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding
IAM user is deleted.
Email:
type: string
description: The user's email address.
Role:
type: string
enum:
- ADMIN
- AUTHOR
- READER
- RESTRICTED_AUTHOR
- RESTRICTED_READER
- ADMIN_PRO
- AUTHOR_PRO
- READER_PRO
description: 'The Quick Sight role for 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, datasets, analyses, and dashboards.
ADMIN: A user who is an author, who can also manage Amazon Quick Sight settings. READER_PRO: Reader Pro adds Generative
BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Quick Sight, can build stories with
Amazon Q, and can generate executive summaries from dashboards. AUTHOR_PRO: Author Pro adds Generative BI capabilities
to the Author role. Author Pros can '
IdentityType:
type: string
enum:
- IAM
- QUICKSIGHT
- IAM_IDENTITY_CENTER
description: The type of identity authentication used by the user.
Active:
type: boolean
description: The active status of user. When you create an Quick Sight user that's not an IAM user or an Active
Directory user, that user is inactive until they sign in and provide a password.
PrincipalId:
type: string
description: The principal ID of the user.
CustomPermissionsName:
type: string
description: The custom permissions profile associated with this user.
ExternalLoginFederationProviderType:
type: string
description: 'The type of supported external login provider that provides identity to let the user federate into
Quick Sight with an associated IAM role. The type can be one of the following. COGNITO: Amazon Cognito. The provider
URL is cognito-identity.amazonaws.com. CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.'
ExternalLoginFederationProviderUrl:
type: string
description: The URL of the external login provider.
ExternalLoginId:
type: string
description: The identity ID for the user in the external login provider.
x-provenance:
method: harvested
publisher: Amazon Web Services
source: https://raw.githubusercontent.com/aws/api-models-aws/582e55931c45b944739742a2c1620b6026dd2d13/models/quicksight/service/2018-04-01/quicksight-2018-04-01.json
note: converted by smithy-to-openapi.py from AWS's Smithy model (roadmap#1001)