This article provides instructions on how to integrate Auvik to Lifecycle Manager to pull configuration items from Auvik. API keys should be associated with a user account that is separate from your Auvik administrative account.
Prerequisites
The following is required for integrating Auvik with Lifecycle Manager:
-
You must have Administrator user credentials for your Auvik account
-
You must have Administrator user credentials for your Lifecycle Manager account or member permissions of Manage Sync Settings selected
Auvik administrator accounts must not be used to generate API credentials. As the user account for creating the API credentials will be assigned an API access-only role (with limited permissions), a separate user must be created with a working email.
To successfully integrate Auvik with Lifecycle Manager, please follow these steps in each article section:
Integration steps in Auvik
Integration steps in Lifecycle Manager
An important aspect of the Auvik integration is that it’s an API key that can only be used to access data through the API- it’s not possible to sign into Auvik with an API key, nor can permissions be changed on it. To minimize any potential risk concerns when making requests to the API, we strongly suggest creating a user with an API-access role.
Integration steps in Auvik
Create a Lifecycle Manager integration user
You need to create an Auvik user that will be associated with your Lifecycle Manager integration (we recommend doing this as it makes managing users easier).
A valid user account requires that you have been invited to at least one active Auvik account. An administrator on your Auvik account can submit an invitation request for you.
Once you’ve received the invitation email, click Accept the invitation, or copy and paste the link into your browser address bar. After accepting the invitation, we recommend creating your new user with a set password.
-
Fill out the user setup screen by entering your first name and last name.
-
Enter a password. Retype the password.
-
In addition to one uppercase letter, one lowercase letter, and one number, passwords must contain at least 10 characters.
-
Click the Create User button.
-
Auvik requires two-factor authentication (2FA) when logging in with a username and password.
-
-
Set up Auvik's two-factor authentication
Two-factor authentication (2FA) must be enabled for the newly created Lifecycle Manager integration user account as Auvik requires two-factor authentication (2FA) when users log in with an Auvik username and password.
Auvik’s two-factor authentication uses the time-based one-time password (TOTP) algorithm to ensure compatibility with mobile apps like Authy and Google Authenticator.
-
When you log in for the first time, you’ll be asked to scan a QR code and enter a one-time code.
-
If you’re having problems scanning the QR code, click Can’t scan the QR code? to reveal the key for the QR code.
-
-
On subsequent logins, you’ll be presented with the two-factor authentication page where you’ll only need to enter the one-time code.
-
Enter your code provided by the authenticator app.
-
If you’ve lost your Auvik two-factor access because you no longer have the phone to which it was connected and are no longer able to login, ask an administrator on your Auvik account to reset your 2FA token.
How to reset your 2FA (two-factor authentication
If you’re currently logged into Auvik and need to reset your 2FA token, have your phone ready and follow the steps below:
-
From the side navigation bar, click your username.
-
Click Reset Two-Factor Authentication.
-
Scan a QR code and enter a one-time code.
-
If you’re having problems scanning the QR code, click Can’t scan the QR code? to reveal the key for the QR code. The key can be entered into an authenticator that accepts keys.
-
Enable API access-only role
We recommend making the dedicated Lifecycle Manager integration user account an API access-only account.
-
Click Manage Users in the side navigation bar. Click Roles.
-
Click Add Role.
-
Enter a name for the role. i.e., Lifecycle Manager
-
Select API Role Only
-
Click the arrow to expand a section.
-
Click the appropriate circle to adjust the permission levels, if desired.
-
To adjust all permission levels, click the pointer to increase the levels.
-
-
Repeat steps 5 and 6 for each section of permissions to be set.
-
Click Save.
Generate an API Key
For each user requiring API access, an API Key must be generated.
-
Sign in to Auvik as an Administrator
-
Within the Auvik menu, click your username.
-
In the API Key section, click the Generate button.
-
The generated API key appears in the Generate API Key window.
-
Once the key is generated, take note of the API key and manually copy the generated API key by clicking Copy.
-
The API Key will be hidden for security reasons after navigating away from this page. Once the key is generated, take note of the API credentials and copy the API credentials
-
-
Click Save.
In case you forget your API key, simply return to the page and click Regenerate. Any previously generated API key will be invalidated. Similarly, clicking the Revoke button revokes access altogether.
Integration steps in Lifecycle Manager
Add Auvik credentials to Lifecycle Manager
-
From Lifecycle Manager, navigate to Integrations and click the Add integration button.
-
The Add integration page will open. Select Auvik.
-
Enter your API Key into the Auvik add integration page.
-
On the Auvik add integration page, fill in the following:
-
Username
-
API Key
-
Primary Auvik Domain Prefix
-
-
Select your Client Relationship Mapping from the drop-down menu
-
Click Save Auvik Setup.
When you click Save Auvik Setup, Lifecycle Manager performs a full sync. When finished, you should be able to view your hardware assets in your account.