View a markdown version of this page

CreateAccessControlApplicationSecret - AWS Quick

CreateAccessControlApplicationSecret

Creates a client secret for an access control application. An access control application can have up to two client secrets, so that you can rotate a secret without downtime.

Provide the AWS Secrets Manager (Secrets Manager) secret ARN for each Region where the client secret, issued by your identity provider (IdP), is stored.

Request Syntax

POST /accounts/AwsAccountId/access-control-applications/ApplicationId/client-secrets HTTP/1.1 Content-type: application/json { "ClientSecretConfiguration": { "ClientSecretConfigurationDetail": { ... }, "ClientSecretSourceType": "string" }, "Description": "string" }

URI Request Parameters

The request uses the following URI parameters.

ApplicationId

The ID of the access control application.

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

Required: Yes

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.

ClientSecretConfiguration

The source of the client secret, which is your IdP, and the AWS Secrets Manager ARNs of the secret.

Type: ClientSecretConfiguration object

Required: Yes

Description

A description of the client secret, for example rotation-june-2026. If you don't provide a description, the client secret has no description.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [A-Za-z0-9 _.,!?\-]*

Required: No

Response Syntax

HTTP/1.1 Status Content-type: application/json { "ClientSecretId": "string", "CreatedAt": number, "RequestId": "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.

ClientSecretId

The ID of the client secret.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

CreatedAt

The time when the client secret was created.

Type: Timestamp

RequestId

The AWS request ID for this operation.

Type: String

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: