Amazon QuickSight Quicksight Oauth Client Applications API
The Quicksight Oauth Client Applications API from Amazon QuickSight — 2 operation(s) for quicksight oauth client applications.
The Quicksight Oauth Client Applications API from Amazon QuickSight — 2 operation(s) for quicksight oauth client applications.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/amazon-quicksight:amazon-quicksight-oauth-client-applications-api"
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.
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: 3.1.0
info:
title: Amazon QuickSight Oauth Client Applications 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}/oauth-client-applications:
post:
operationId: CreateOAuthClientApplication
summary: Create OAuth Client Application
description: Creates an OAuthClientApplication.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOAuthClientApplicationResponse'
'401':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException; LimitExceededException; ResourceExistsException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'400':
description: InvalidParameterValueException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOAuthClientApplicationRequest'
tags:
- Oauth Client Applications
get:
operationId: ListOAuthClientApplications
summary: List OAuth Client Applications
description: Lists all OAuthClientApplications in the current Amazon Web Services Region that belong to this Amazon
Web Services account.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ListOAuthClientApplicationsResponse'
'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
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidNextTokenException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ListOAuthClientApplicationsRequest'
tags:
- Oauth Client Applications
/accounts/{AwsAccountId}/oauth-client-applications/{OAuthClientApplicationId}:
delete:
operationId: DeleteOAuthClientApplication
summary: Delete OAuth Client Application
description: Deletes an OAuthClientApplication.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteOAuthClientApplicationResponse'
'401':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'400':
description: InvalidParameterValueException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteOAuthClientApplicationRequest'
tags:
- Oauth Client Applications
get:
operationId: DescribeOAuthClientApplication
summary: Describe OAuth Client Application
description: Describes an OAuthClientApplication.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeOAuthClientApplicationResponse'
'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
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeOAuthClientApplicationRequest'
tags:
- Oauth Client Applications
put:
operationId: UpdateOAuthClientApplication
summary: Update OAuth Client Application
description: Updates an OAuthClientApplication.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateOAuthClientApplicationResponse'
'401':
description: AccessDeniedException
content:
application/json:
schema:
$ref: '#/components/schemas/AccessDeniedException'
'409':
description: ConflictException; LimitExceededException
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictException'
'500':
description: InternalFailureException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalFailureException'
'400':
description: InvalidParameterValueException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidParameterValueException'
'404':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'429':
description: ThrottlingException
content:
application/json:
schema:
$ref: '#/components/schemas/ThrottlingException'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateOAuthClientApplicationRequest'
tags:
- Oauth Client Applications
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.
ConflictException:
type: object
properties:
Message:
type: string
RequestId:
type: string
description: The Amazon Web Services request ID for this request.
CreateOAuthClientApplicationRequest:
type: object
properties:
AwsAccountId:
type: string
description: The Amazon Web Services account ID.
OAuthClientApplicationId:
type: string
description: An ID for the OAuthClientApplication that you want to create. This ID is unique per Amazon Web Services
Region for each Amazon Web Services account.
Name:
type: string
description: The display name for the OAuthClientApplication.
OAuthClientAuthenticationType:
type: string
enum:
- TOKEN
description: The authentication type to use for the OAuthClientApplication. This determines the OAuth 2.0 grant
flow that is used when the data source connects to the identity provider. Valid values are TOKEN.
ClientId:
type: string
description: The client ID of the OAuth application that is registered with the identity provider.
ClientSecret:
type: string
description: The client secret of the OAuth application that is registered with the identity provider.
OAuthTokenEndpointUrl:
type: string
description: The token endpoint URL of the identity provider that is used to obtain access tokens.
OAuthAuthorizationEndpointUrl:
type: string
description: The authorization endpoint URL of the identity provider that is used to obtain authorization codes.
OAuthScopes:
type: string
description: The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the
identity provider.
DataSourceType:
type: string
enum:
- ADOBE_ANALYTICS
- AMAZON_ELASTICSEARCH
- ATHENA
- AURORA
- AURORA_POSTGRESQL
- AWS_IOT_ANALYTICS
- GITHUB
- JIRA
- MARIADB
- MYSQL
- ORACLE
- POSTGRESQL
- PRESTO
- REDSHIFT
- S3
- S3_TABLES
- SALESFORCE
- SERVICENOW
- SNOWFLAKE
- SPARK
- SQLSERVER
- TERADATA
- TWITTER
- TIMESTREAM
- AMAZON_OPENSEARCH
- EXASOL
- DATABRICKS
- STARBURST
- TRINO
- BIGQUERY
- GOOGLESHEETS
- GOOGLE_DRIVE
- CONFLUENCE
- SHAREPOINT
- ONE_DRIVE
- WEB_CRAWLER
- S3_KNOWLEDGE_BASE
- QBUSINESS
description: The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.
IdentityProviderVpcConnectionProperties:
$ref: '#/components/schemas/VpcConnectionProperties'
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: Contains a map of the key-value pairs for the resource tag or tags assigned to the OAuthClientApplication.
required:
- AwsAccountId
- OAuthClientApplicationId
- Name
- OAuthClientAuthenticationType
- ClientId
- ClientSecret
- OAuthTokenEndpointUrl
CreateOAuthClientApplicationResponse:
type: object
properties:
Arn:
type: string
description: The Amazon Resource Name (ARN) of the OAuthClientApplication.
OAuthClientApplicationId:
type: string
description: The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon
Web Services account.
CreationStatus:
type: string
enum:
- CREATION_IN_PROGRESS
- CREATION_SUCCESSFUL
- CREATION_FAILED
- UPDATE_IN_PROGRESS
- UPDATE_SUCCESSFUL
- UPDATE_FAILED
- DELETED
description: The status of creating the OAuthClientApplication.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
Status:
type: integer
description: The HTTP status of the request.
DeleteOAuthClientApplicationRequest:
type: object
properties:
AwsAccountId:
type: string
description: The Amazon Web Services account ID.
OAuthClientApplicationId:
type: string
description: The ID of the OAuthClientApplication that you want to delete.
required:
- AwsAccountId
- OAuthClientApplicationId
DeleteOAuthClientApplicationResponse:
type: object
properties:
Arn:
type: string
description: The Amazon Resource Name (ARN) of the OAuthClientApplication that you deleted.
OAuthClientApplicationId:
type: string
description: The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon
Web Services account.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
Status:
type: integer
description: The HTTP status of the request.
DescribeOAuthClientApplicationRequest:
type: object
properties:
AwsAccountId:
type: string
description: The Amazon Web Services account ID.
OAuthClientApplicationId:
type: string
description: The ID of the OAuthClientApplication that you want to describe.
required:
- AwsAccountId
- OAuthClientApplicationId
DescribeOAuthClientApplicationResponse:
type: object
properties:
OAuthClientApplication:
$ref: '#/components/schemas/OAuthClientApplication'
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.
ListOAuthClientApplicationsRequest:
type: object
properties:
AwsAccountId:
type: string
description: The Amazon Web Services account ID.
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.
required:
- AwsAccountId
ListOAuthClientApplicationsResponse:
type: object
properties:
OAuthClientApplications:
type: array
items:
$ref: '#/components/schemas/OAuthClientApplicationSummary'
description: A list of OAuthClientApplication summaries.
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.
OAuthClientApplication:
type: object
properties:
OAuthClientApplicationId:
type: string
description: The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon
Web Services account.
Name:
type: string
description: The display name of the OAuthClientApplication.
OAuthClientAuthenticationType:
type: string
enum:
- TOKEN
description: The OAuth client authentication type used by the OAuthClientApplication. Valid values are TOKEN.
OAuthTokenEndpointUrl:
type: string
description: The token endpoint URL of the identity provider that is used to obtain access tokens.
OAuthAuthorizationEndpointUrl:
type: string
description: The authorization endpoint URL of the identity provider that is used to obtain authorization codes.
OAuthScopes:
type: string
description: The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the
identity provider.
DataSourceType:
type: string
enum:
- ADOBE_ANALYTICS
- AMAZON_ELASTICSEARCH
- ATHENA
- AURORA
- AURORA_POSTGRESQL
- AWS_IOT_ANALYTICS
- GITHUB
- JIRA
- MARIADB
- MYSQL
- ORACLE
- POSTGRESQL
- PRESTO
- REDSHIFT
- S3
- S3_TABLES
- SALESFORCE
- SERVICENOW
- SNOWFLAKE
- SPARK
- SQLSERVER
- TERADATA
- TWITTER
- TIMESTREAM
- AMAZON_OPENSEARCH
- EXASOL
- DATABRICKS
- STARBURST
- TRINO
- BIGQUERY
- GOOGLESHEETS
- GOOGLE_DRIVE
- CONFLUENCE
- SHAREPOINT
- ONE_DRIVE
- WEB_CRAWLER
- S3_KNOWLEDGE_BASE
- QBUSINESS
description: The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.
IdentityProviderVpcConnectionProperties:
$ref: '#/components/schemas/VpcConnectionProperties'
CreatedTime:
type: string
format: date-time
description: The time that the OAuthClientApplication was created.
LastUpdatedTime:
type: string
format: date-time
description: The time that the OAuthClientApplication was last updated.
Arn:
type: string
description: The Amazon Resource Name (ARN) of the OAuthClientApplication.
OAuthClientApplicationSummary:
type: object
properties:
OAuthClientApplicationId:
type: string
description: The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon
Web Services account.
Name:
type: string
description: The display name of the OAuthClientApplication.
OAuthClientAuthenticationType:
type: string
enum:
- TOKEN
description: The OAuth client authentication type used by the OAuthClientApplication. Valid values are TOKEN.
DataSourceType:
type: string
enum:
- ADOBE_ANALYTICS
- AMAZON_ELASTICSEARCH
- ATHENA
- AURORA
- AURORA_POSTGRESQL
- AWS_IOT_ANALYTICS
- GITHUB
- JIRA
- MARIADB
- MYSQL
- ORACLE
- POSTGRESQL
- PRESTO
- REDSHIFT
- S3
- S3_TABLES
- SALESFORCE
- SERVICENOW
- SNOWFLAKE
- SPARK
- SQLSERVER
- TERADATA
- TWITTER
- TIMESTREAM
- AMAZON_OPENSEARCH
- EXASOL
- DATABRICKS
- STARBURST
- TRINO
- BIGQUERY
- GOOGLESHEETS
- GOOGLE_DRIVE
- CONFLUENCE
- SHAREPOINT
- ONE_DRIVE
- WEB_CRAWLER
- S3_KNOWLEDGE_BASE
- QBUSINESS
description: The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.
IdentityProviderVpcConnectionProperties:
$ref: '#/components/schemas/VpcConnectionProperties'
CreatedTime:
type: string
format: date-time
description: The time that the OAuthClientApplication was created.
LastUpdatedTime:
type: string
format: date-time
description: The time that the OAuthClientApplication was last updated.
Arn:
type: string
description: The Amazon Resource Name (ARN) of the OAuthClientApplication.
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.
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.
UpdateOAuthClientApplicationRequest:
type: object
properties:
AwsAccountId:
type: string
description: The Amazon Web Services account ID.
OAuthClientApplicationId:
type: string
description: The ID of the OAuthClientApplication that you want to update.
Name:
type: string
description: The display name for the OAuthClientApplication.
ClientId:
type: string
description: The client ID of the OAuth application that is registered with the identity provider.
ClientSecret:
type: string
description: The client secret of the OAuth application that is registered with the identity provider.
OAuthTokenEndpointUrl:
type: string
description: The token endpoint URL of the identity provider that is used to obtain access tokens.
OAuthAuthorizationEndpointUrl:
type: string
description: The authorization endpoint URL of the identity provider that is used to obtain authorization codes.
OAuthScopes:
type: string
description: The OAuth scopes that are requested when the OAuthClientApplication obtains an access token from the
identity provider.
DataSourceType:
type: string
enum:
- ADOBE_ANALYTICS
- AMAZON_ELASTICSEARCH
- ATHENA
- AURORA
- AURORA_POSTGRESQL
- AWS_IOT_ANALYTICS
- GITHUB
- JIRA
- MARIADB
- MYSQL
- ORACLE
- POSTGRESQL
- PRESTO
- REDSHIFT
- S3
- S3_TABLES
- SALESFORCE
- SERVICENOW
- SNOWFLAKE
- SPARK
- SQLSERVER
- TERADATA
- TWITTER
- TIMESTREAM
- AMAZON_OPENSEARCH
- EXASOL
- DATABRICKS
- STARBURST
- TRINO
- BIGQUERY
- GOOGLESHEETS
- GOOGLE_DRIVE
- CONFLUENCE
- SHAREPOINT
- ONE_DRIVE
- WEB_CRAWLER
- S3_KNOWLEDGE_BASE
- QBUSINESS
description: The type of data source that the OAuthClientApplication is used with. Valid values are SNOWFLAKE.
IdentityProviderVpcConnectionProperties:
$ref: '#/components/schemas/VpcConnectionProperties'
required:
- AwsAccountId
- OAuthClientApplicationId
- Name
UpdateOAuthClientApplicationResponse:
type: object
properties:
Arn:
type: string
description: The Amazon Resource Name (ARN) of the OAuthClientApplication.
OAuthClientApplicationId:
type: string
description: The ID of the OAuthClientApplication. This ID is unique per Amazon Web Services Region for each Amazon
Web Services account.
UpdateStatus:
type: string
enum:
- CREATION_IN_PROGRESS
- CREATION_SUCCESSFUL
- CREATION_FAILED
- UPDATE_IN_PROGRESS
- UPDATE_SUCCESSFUL
- UPDATE_FAILED
- DELETED
description: The status of updating the OAuthClientApplication.
RequestId:
type: string
description: The Amazon Web Services request ID for this operation.
Status:
type: integer
description: The HTTP status of the request.
VpcConnectionProperties:
type: object
properties:
VpcConnectionArn:
type: string
description: The Amazon Resource Name (ARN) for the VPC connection.
required:
- VpcConnectionArn
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)