📖Access Control
Control who can access your organization's data.
Access Control is an Enterprise-only feature. Please contact us to learn more about our Enterprise offering.
tldr: Users with AccountAdmin
role has full access to everything in your organization. Users with AccountUser
role has read-only access to collections. By default, all new users are assigned AccountUser
role.
Role-Based Access Control (RBAC)
ChatBees implements Role-Based Access Control to help administrators control who has access to their organization's data. In simple terms, you can assign Roles
to Users
. These Roles
contain Privileges
that allow Users
to access resources.
Privileges
Read
: Able to retrieve a resource (e.g. Get, List, Describe)Write
: Able to modify a resource (e.g. Create, Update, Delete)Admin
: Able to retrieve or modify resources of other users (e.g. delete or invite user)
Roles
AccountAdmin
: GrantsRead
,Write
andAdmin
privileges to all resources in the accountAccountUser
: GrantsRead
privilege to all resources in the account
By default, new users are assigned AccountUser
role (except for the first user of the account). AccountAdmin
can modify roles assigned to other users
Table below shows all API endpoints and the required privilege.
API | Description | Req. Priv. |
---|---|---|
| Creates registration token to onboard new users |
|
| Returns user's information |
|
| Updates a user's role |
|
| Deletes a user |
|
| Lists all existing users |
|
| Create a personal API key | - |
| Deletes a personal API key | - |
| Lists personal API keys | - |
| Creates a Collection |
|
| Updates a Collection's configuration |
|
| Deletes a Collection |
|
| Lists all Collections |
|
| Describes a Collection |
|
| Lists connected connectors |
|
| Delete a connector |
|
| Lists account access logs |
|
| Get account usage summary |
|
| Adds a local or hosted document from an online source to a collection |
|
| Deletes a document from a collection |
|
| Lists documents in the collection |
|
| Asks a question in a collection |
|
| Semantic search in a collection |
|
| Summarize a document in a collection |
|
| Lists Q/A history of a collection |
|
| Configures persona etc of a collection. Affects future |
|
| Create a task to ingest from a data source |
|
| Gets the current ingest task progress |
|
| Indexes (trains) ingested data into collection |
|
| Deletes indexed (trained), ingested data from collection |
|
Last updated