Skip to content

Principal

Source code in docs_src/capo_kendra/types/principal.py 
16
17
18
19
20
21
22
23
24
class Principal(TypedDict, closed=True):
    name: "capo_kendra.types.principal_name.PrincipalName"
    """<p>The name of the user or group.</p>"""
    type: "capo_kendra.types.principal_type.PrincipalType"
    """<p>The type of principal.</p>"""
    access: "capo_kendra.types.read_access_type.ReadAccessType"
    """<p>Whether to allow or deny document access to the principal.</p>"""
    data_source_id: NotRequired["capo_kendra.types.data_source_id.DataSourceId"]
    """<p>The identifier of the data source the principal should access documents from.</p>"""

access instance-attribute 

access: ReadAccessType

Whether to allow or deny document access to the principal.

data_source_id instance-attribute 

data_source_id: NotRequired[DataSourceId]

The identifier of the data source the principal should access documents from.

name instance-attribute 

name: PrincipalName

The name of the user or group.

type instance-attribute 

type: PrincipalType

The type of principal.