CreateAccessControlApplication
Creates an access control application in an Amazon Quick Sight account. You use an access control application to define how an external client signs in to Quick Sight with OAuth 2.0.
To connect a client to Quick Sight through an inbound connector, associate the access control application with the connector by using the UpdateInboundConnectorApplicationAssociations operation.
Request Syntax
POST /accounts/AwsAccountId/access-control-applications HTTP/1.1
Content-type: application/json
{
"ApplicationId": "string",
"AuthenticationType": "string",
"Description": "string",
"IdpAuthorizingConfiguration": {
"IdcTrustedTokenIssuerConfiguration": {
"IdcTrustedTokenIssuerArn": "string"
},
"IdpAuthorizingConfigurationDetailInput": { ... },
"IdpAuthorizingType": "string"
},
"Name": "string",
"Namespace": "string",
"QuickAuthenticationConfiguration": {
"QuickAuthenticationConfigurationDetailInput": { ... },
"QuickAuthenticationType": "string"
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
URI Request Parameters
The request uses the following URI parameters.
- AwsAccountId
-
The ID of the AWS account that contains the Quick Sight account.
Length Constraints: Fixed length of 12.
Pattern:
^[0-9]{12}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- ApplicationId
-
The ID for the access control application. This ID is unique per AWS Region for each AWS account.
Quick Sight reserves IDs that start with
quick-aca-for the access control application of the Quick Sight desktop application. To create one, the ID must bequick-aca-followed by your AWS account ID and the namespace, separated by a hyphen. For example,quick-aca-111122223333-default. In addition,QuickAuthenticationTypemust beQUICK_MANAGED_PUBLIC_AUTH_CODEwithhttp://localhost:18080as the only redirect URI, andIdpAuthorizingTypemust beIDC_AUTH_CODEorQUICK_MANAGED_AUTH_CODE.Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
[\w\-]+Required: Yes
- AuthenticationType
-
The authentication protocol that the access control application uses.
Type: String
Valid Values:
OIDCRequired: Yes
- IdpAuthorizingConfiguration
-
The identity provider configuration of the access control application.
Type: IdpAuthorizingConfigInput object
Required: Yes
- Name
-
The name of the access control application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Required: Yes
- Namespace
-
The Quick Sight namespace for the access control application.
Type: String
Length Constraints: Maximum length of 64.
Pattern:
^[a-zA-Z0-9._-]*$Required: Yes
- QuickAuthenticationConfiguration
-
The Quick Sight authentication configuration of the access control application. You provide redirect URIs, and Quick Sight generates the client ID.
Type: QuickAuthenticationConfigInput object
Required: Yes
- Description
-
The description of the access control application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[A-Za-z0-9 _.,!?\-]*Required: No
- Tags
-
The tags to assign to the access control application.
Type: Array of Tag objects
Array Members: Minimum number of 1 item. Maximum number of 200 items.
Required: No
Response Syntax
HTTP/1.1 Status
Content-type: application/json
{
"AccessControlApplicationStatus": "string",
"ApplicationId": "string",
"Arn": "string",
"CreatedTime": number,
"IdcApplicationArn": "string",
"QuickAuthenticationConfiguration": {
"QuickAuthenticationConfigurationDetailCreateOutput": { ... },
"QuickAuthenticationType": "string"
},
"RequestId": "string",
"TenantUrl": "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.
- AccessControlApplicationStatus
-
The status of the access control application. A new application is always
ENABLED.Type: String
Valid Values:
ENABLED | DISABLED - ApplicationId
-
The ID of the access control application.
Type: String
- Arn
-
The ARN of the access control application.
Type: String
- CreatedTime
-
The time when the access control application was created.
Type: Timestamp
- RequestId
-
The AWS request ID for this operation.
Type: String
- TenantUrl
-
The tenant URL of the access control application.
Type: String
- IdcApplicationArn
-
The ARN of the AWS IAM Identity Center application that Quick Sight manages for this access control application. This value is present when the
IdpAuthorizingTypeisIDC_AUTH_CODE, or when a trusted token issuer is configured.Type: String
- QuickAuthenticationConfiguration
-
The generated Quick Sight authentication configuration. It contains the generated client ID.
Type: QuickAuthenticationConfigCreateOutput object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- AccessDeniedException
-
You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 401
- ConflictException
-
Updating or deleting a resource can cause an inconsistent state.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 409
- InternalFailureException
-
An internal failure occurred.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 500
- InvalidParameterValueException
-
One or more parameters has a value that isn't valid.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 400
- LimitExceededException
-
A limit is exceeded.
- RequestId
-
The AWS request ID for this request.
- ResourceType
-
Limit exceeded.
HTTP Status Code: 409
- ResourceNotFoundException
-
One or more resources can't be found.
- RequestId
-
The AWS request ID for this request.
- ResourceType
-
The resource type for this request.
HTTP Status Code: 404
- ThrottlingException
-
Access is throttled.
- RequestId
-
The AWS request ID for this request.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: