Skip to content

UserContext

Used by
Source code in docs_src/capo_kendra/types/user_context.py 
14
15
16
17
18
19
20
21
22
23
24
class UserContext(TypedDict, closed=True):
    token: NotRequired["capo_kendra.types.token.Token"]
    """<p>The user context token for filtering search results for a user. It must be a JWT or a JSON token.</p>"""
    user_id: NotRequired["capo_kendra.types.principal_name.PrincipalName"]
    """<p>The identifier of the user you want to filter search results based on their access to documents.</p>"""
    groups: NotRequired["capo_kendra.types.groups.Groups"]
    """<p>The list of groups you want to filter search results based on the groups' access to documents.</p>"""
    data_source_groups: NotRequired[
        "capo_kendra.types.data_source_groups.DataSourceGroups"
    ]
    """<p>The list of data source groups you want to filter search results based on groups' access to documents in that data source.</p>"""

data_source_groups instance-attribute 

data_source_groups: NotRequired[DataSourceGroups]

The list of data source groups you want to filter search results based on groups' access to documents in that data source.

groups instance-attribute 

groups: NotRequired[Groups]

The list of groups you want to filter search results based on the groups' access to documents.

token instance-attribute 

token: NotRequired[Token]

The user context token for filtering search results for a user. It must be a JWT or a JSON token.

user_id instance-attribute 

user_id: NotRequired[PrincipalName]

The identifier of the user you want to filter search results based on their access to documents.