View a markdown version of this page

AccessControlApplication - AWS Quick

AccessControlApplication

An access control application. It defines how an external client signs in to Quick Sight with OAuth 2.0. Client secret values are never included.

Contents

Note

In the following list, the required parameters are described first.

ApplicationId

The ID of the access control application.

Type: String

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

Pattern: [\w\-]+

Required: Yes

Arn

The ARN of the access control application.

Type: String

Required: Yes

AuthenticationType

The authentication protocol that the access control application uses.

Type: String

Valid Values: OIDC

Required: Yes

CreatedTime

The time when the access control application was created.

Type: Timestamp

Required: Yes

LastUpdatedTime

The time when the access control application was last updated.

Type: Timestamp

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 that the access control application belongs to.

Type: String

Required: Yes

Status

The status of the access control application.

Type: String

Valid Values: ENABLED | DISABLED

Required: Yes

TenantUrl

The tenant URL of the access control application. This URL hosts the OAuth 2.0 and OpenID Connect endpoints for the application, such as /authorize, /token, /.well-known/openid-configuration, and /jwks.

Type: String

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

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 IdpAuthorizingType is IDC_AUTH_CODE, or when a trusted token issuer is configured.

Type: String

Required: No

IdpAuthorizingConfiguration

The identity provider configuration of the access control application. Client secret values are never included.

Type: IdpAuthorizingConfig object

Required: No

QuickAuthenticationConfiguration

The Quick Sight authentication configuration of the access control application. Client secret values are never included.

Type: QuickAuthenticationConfig object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: