Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483595482.8 KB

Verifies if a user has access permissions for a specified document and returns the actual ACL attached to the document. Resolves user access on the document via user aliases and groups when verifying user access.

get/applications/{applicationId}/index/{indexId}/users/{userId}/documents/{documentId}/check-document-access

Path parameters

applicationIdstring required

The unique identifier of the application. This is required to identify the specific Amazon Q Business application context for the document access check.

indexIdstring required

The unique identifier of the index. Used to locate the correct index within the application where the document is stored.

userIdstring required

The unique identifier of the user. Used to check the access permissions for this specific user against the document's ACL.

documentIdstring required

The unique identifier of the document. Specifies which document's access permissions are being checked.

Query parameters

dataSourceIdstring

The unique identifier of the data source. Identifies the specific data source from which the document originates. Should not be used when a document is uploaded directly with BatchPutDocument, as no dataSourceId is available or necessary.

Response

Success

hasAccessboolean

A boolean value indicating whether the specified user has access to the document, either direct access or transitive access via groups and aliases attached to the document.