Skip to content

DeleteGroupRequest

Source code in docs_src/capo_qbusiness/types/delete_group_request.py 
14
15
16
17
18
19
20
21
22
class DeleteGroupRequest(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The identifier of the application in which the group mapping belongs.</p>"""
    index_id: "capo_qbusiness.types.index_id.IndexId"
    """<p>The identifier of the index you want to delete the group from.</p>"""
    group_name: "capo_qbusiness.types.group_name.GroupName"
    """<p>The name of the group you want to delete.</p>"""
    data_source_id: NotRequired["capo_qbusiness.types.data_source_id.DataSourceId"]
    """<p>The identifier of the data source linked to the group</p> <p>A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.</p>"""

application_id instance-attribute 

application_id: ApplicationId

The identifier of the application in which the group mapping belongs.

data_source_id instance-attribute 

data_source_id: NotRequired[DataSourceId]

The identifier of the data source linked to the group

A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.

group_name instance-attribute 

group_name: GroupName

The name of the group you want to delete.

index_id instance-attribute 

index_id: IndexId

The identifier of the index you want to delete the group from.