Skip to content

CheckDocumentAccessResponse

Source code in docs_src/capo_qbusiness/types/check_document_access_response.py 
13
14
15
16
17
18
19
20
21
class CheckDocumentAccessResponse(TypedDict, closed=True):
    user_groups: NotRequired["capo_qbusiness.types.associated_groups.AssociatedGroups"]
    """<p>An array of groups the user is part of for the specified data source. Each group has a name and type.</p>"""
    user_aliases: NotRequired["capo_qbusiness.types.associated_users.AssociatedUsers"]
    """<p>An array of aliases associated with the user. This includes both global and local aliases, each with a name and type.</p>"""
    has_access: NotRequired["bool"]
    """<p>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.</p>"""
    document_acl: NotRequired["capo_qbusiness.types.document_acl.DocumentAcl"]
    """<p>The Access Control List (ACL) associated with the document. Includes allowlist and denylist conditions that determine user access.</p>"""

document_acl instance-attribute 

document_acl: NotRequired[DocumentAcl]

The Access Control List (ACL) associated with the document. Includes allowlist and denylist conditions that determine user access.

has_access instance-attribute 

has_access: NotRequired[bool]

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.

user_aliases instance-attribute 

user_aliases: NotRequired[AssociatedUsers]

An array of aliases associated with the user. This includes both global and local aliases, each with a name and type.

user_groups instance-attribute 

user_groups: NotRequired[AssociatedGroups]

An array of groups the user is part of for the specified data source. Each group has a name and type.