How to set up Mode

Invite a user

To invite a user for Atlan to use when integrating with Mode:

1. From the upper left corner of your Mode instance, click the drop-down with your workspace name and name, and then Invite to Mode....
2. For Email Address enter a valid email address, for example for the service account.
3. Click the Invite button.
4. In your service account's email, open the email from Mode and click Accept invite.
5. For Set up your account enter details about the service account:
   1. For Full name enter a name for the service account, such as Atlan Crawler.
   2. For Username enter a username for the service account, such as atlan_crawler.
   3. For Password and Confirm password enter the same password to use for the service account.
6. At the bottom of the form, click the Continue button.

Set permissions

To set the minimum permissions required to crawl Mode:

1. Log into Mode as an administrator again. (If you just completed the steps above, you'll need to logout from the service account, first.)
2. From the upper left corner of your Mode instance, click the drop-down with your workspace name and name, and then Workspace settings.
3. Under the People heading on the left, click Members.
4. Next to the Search box, click the drop-down and select Current members.
5. Confirm the user you invited is listed with Member under the Status column.
   • If not, change the Search box drop-down to Pending members and confirm the invitation has been accepted.
   • If so, change the Search box drop-down to Former members & requests, click the 3-dots to the far right of the service account's row, and then Reinvite to org.
6. Under the Data heading on the left, click Manage Connections.
7. From the Manage Connections table, for each connection you want to access in Atlan:
   1. Click the row for that connection.
   2. Change to the Permissions tab.
   3. At the top of the the Connection Access table, click the Add Members button.
   4. Search for and select the service account user, and change the drop-down for access type to Query.
   5. At the bottom of the form, click the Add members button.

Generate API token

Atlan supports both workspace and personal API tokens generated in Mode for authentication.

Workspace token

To generate a workspace API token for crawling Mode:

1. Log in to Mode as an administrator.
2. From the upper left corner of your Mode instance, click the dropdown with your workspace name and name, and then click Workspace settings.
3. Under the Workspace heading on the left, click Default Settings.
4. From the tabs along the top of the Default Settings page, click the API tab.
5. Next to Workspace API Keys, click the gear icon and then click Create new API token.
6. For New token name, enter a meaningful name, such as atlan-crawler.
7. Click the Create token button.
   🚨 Careful! Copy the Token and Password values now and save them. You will not be able to see them again in Mode after leaving this screen.

Personal token

To generate a personal API token for crawling Mode:

1. Log in to Mode as the service account user. (If you just completed the steps above, you'll need to logout from the administrator account, first.)
2. From the upper left corner of your Mode instance, click the dropdown with your workspace name and name, and then click My Account settings.
3. Under the Community heading on the left, click API Tokens.
4. For New token name enter a meaningful name, such as atlan-crawler.
5. Click the Create token button.
   🚨 Careful! Copy the Token and Password values now and save them. You will not be able to see them again in Mode after leaving this screen.