Skip to content

Commit

Permalink
docs(ingest/mode): add details on authentication/permissions for mode
Browse files Browse the repository at this point in the history
  • Loading branch information
hsheth2 committed Jan 30, 2025
1 parent a155470 commit 54afbb9
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
1 change: 0 additions & 1 deletion metadata-ingestion/docs/sources/mode/mode.md

This file was deleted.

21 changes: 21 additions & 0 deletions metadata-ingestion/docs/sources/mode/mode_pre.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
### Authentication

See Mode's [Authentication documentation](https://mode.com/developer/api-reference/authentication/) on how to generate an API `token` and `password`.

Mode does not support true "service accounts", so you must use a user account for authentication.
Depending on your requirements, you may want to create a dedicated user account for usage with DataHub ingestion.

### Permissions

DataHub ingestion requires the user to have the following permissions:

- Have at least the "Member" role.
- For each Connection, have at least"View" access.

To check Connection permissions, navigate to "Workspace Settings" → "Manage Connections". For each connection in the list, click on the connection → "Permissions". If the default workspace access is "View" or "Query", you're all set for that connection. If it's "Restricted", you'll need to individually grant your ingestion user View access.

- For each Space, have at least "View" access.

To check Collection permissions, navigate to the "My Collections" page as an Admin user. For each collection with Workspace Access set to "Restricted" access, the ingestion user must be manually granted the "Viewer" access in the "Manage Access" dialog. Collections with "All Members can View/Edit" do not need to be manually granted access.

Note that if the ingestion user has "Admin" access, then it will automatically have "View" access for all connections and collections.

0 comments on commit 54afbb9

Please sign in to comment.