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 dropdown with your workspace name and name, and then click 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 log out from the service account first.)
2. From the upper left corner of your Mode instance, click the dropdown 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 dropdown and select Current members.
5. Confirm the user you invited is listed with Member under the Status column.
   • If not, change the Search box dropdown to Pending members and confirm the invitation has been accepted.
   • If yes, change the Search box dropdown to Former members & requests, click the three-dots icon 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 Connection access table, click the Add members button.
   4. Search for and select the service account user, and change the dropdown for access type to View. Learn more about the View permission in Mode documentation.
   5. At the bottom of the form, click the Add members button.

Generate API token

Atlan supports the following API tokens generated in Mode for authentication in Atlan:

• Workspace token
• Member token
• Personal token

Workspace token

Workspace tokens allow admin access to the workspace. You will need to be an admin user in Mode to create and manage a 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 Features heading on the left, click API Keys.
4. On the API Keys page, under Workspace API Keys, click the Create API key button.
5. In the Create new API key dialog, enter the following details:
   1. For Display name, enter a meaningful name — for example, atlan-crawler.
   2. For Key expiration, keep the default selection or set a longer expiration period.
   3. Click the Create button.
   4. From the corresponding Key secret dialog, copy the values for Key ID and Secret and store them in a secure location. You will not be able to see them again in Mode after leaving this screen.

Member token

Member tokens match an individual user's permissions to access workspace resources in Mode.

To generate a member API token for crawling Mode:

1. Log in to Mode as a member.
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 Personal.
4. Under the Personal heading on the left, click My API Keys.
5. In the upper right of the API Keys page, click the Create API key button.
6. In the Create new API key dialog, enter the following details:
   1. For Display name, enter a meaningful name — for example, atlan-crawler.
   2. For Key expiration, keep the default selection or set a longer expiration period.
   3. Click the Create button.
   4. From the corresponding Key secret dialog, copy the values for Key ID and Secret and store them in a secure location. You will not be able to see them again in Mode after leaving this screen.

Personal token