Set up MicroStrategy
Configure authentication to set up a MicroStrategy connection in Atlan. You can choose between basic authentication using a username and password, or API token authentication for enhanced security.
Prerequisites
Before you begin, make sure you have:
- Access to your MicroStrategy Workstation
- A MicroStrategy administrator to help if you don't have the required permissions yourself
- For basic authentication: The ability to create a user account with appropriate permissions
- For API token authentication: A user account with one of the following privileges:
DssPrivilegesGenerateAPITokens(299)DssPrivilegesUseUserManager
Configure authentication
Atlan supports two authentication methods for fetching metadata from MicroStrategy. Choose the authentication method that best fits your security requirements.
- Basic authentication
- API token authentication
You need to create a user in your MicroStrategy Workstation and assign minimum permissions for integrating with Atlan.
To create a new user for crawling MicroStrategy:
-
Open the Workstation window with the navigation pane in smart mode.
-
From the left navigation menu, click Users and Groups.
-
In the upper left of the Users and Groups page, click the Select an Environment dropdown and select your environment.
-
In the left menu of your selected environment, next to All Users, click the + button to create a new user.
-
In the Create New User dialog:
-
For Account and Credentials, enter the following details:
- For Full Name, enter a meaningful name for the new user.
- For Email Address, enter an email address for the new user.
- (Optional) For Description, enter a description.
- For Username (Login), enter a username for the new user.
- For Password, create a password for the new user and confirm it in the next step.
- Check the User can't change password box to prevent the new user from changing their password.
- Check the Active User box at the bottom left of the form.
-
For User Groups, all users are automatically members of the Everyone group, which typically has read permission for most objects. To assign additional permissions:
- In the top right of User Groups, click Manage User Group to add a new user group.
- Click Update to confirm your selections.
-
To assign user privileges, in the left menu, click Privileges and check the following boxes:
- Use Architect Editors: For fetching attribute, fact, and table definitions
- Use Library Web: For fetching project metadata
- Web Report SQL: For fetching SQL statements
- Web use Metric Editor: For fetching metric definitions
- Web run Document: For fetching document definitions
- Web run Dossier: For fetching dossier definitions
-
Click Save to complete setup.
-
API token authentication provides enhanced security by using a generated token instead of username and password credentials. Each token is valid for 30 days and only one token can be active per user at a time.
To enable API token authentication in MicroStrategy:
-
Modify the
authModessetting to include the value4096in yourconfigOverride.propertiesfile within the Strategy Library application.Alternatively, you can add this via the
PUT /api/mstrServices/library/authendpoint. -
Restart the Library Web Server to apply the changes.
-
Generate an API token:
-
Create a session from the Library to obtain the
X-MSTR-AuthToken:- Use the
/api/auth/loginendpoint to retrieve this token.
- Use the
-
Use the
X-MSTR-AuthTokento call the/api/auth/apiTokensendpoint:- For the current user: Leave the request body blank or use an empty object
{}. - For another user: Include the user ID in the request body.
- For the current user: Leave the request body blank or use an empty object
-
The API generates a token that you can use to authenticate with Atlan.
Next steps
- Crawl MicroStrategy: Configure and run the crawler to extract metadata from MicroStrategy