API Accounts

Vasion Automate Pro allows for integration with other applications to enhance the abilities of it's Automation Platform and analysis capabilities. An API account will need to be created within Vasion Automate Pro to allow for these integrations.

Creating a new API Account

To create an API account:

  1. Navigate to the Admin application.
  2. Select Integrations.
  3. Select the Add Account button.
    API Accounts page.
  4. Enter an identifiable name in the Configuration Name textbox.
  5. Select the kind of authentication from the Authentication Type drop-down.
    Edit API Account modal.
  6. Refer to the Basic, Token, and OAuth configurations below to set up the various supported authentication types.

Basic Authentication

  1. Enter the user name for the service being connected in the Username field.
  2. Enter the password for the service being connected in the Password field.
  3. Select Save.

Basic API Account configuration modal.

Token Authentication

  1. Select the location for the token from the Token Location drop-down.
    1. Select Authorization Header to send the token in the header of the request.
    2. Select Query to send the token as part of the query.
  2. Enter the token prefix in the Key field.
  3. Enter the token value in the Value field.

Token API Account configuration modal.

OAuth Authentication

  1. Enter the client ID in the Client ID field.
  2. Enter the secret in the Client Secret field.
  3. If the OAuth provider has a discovery endpoint:
    1. Enter the OAuth discovery endpoint in the OAuth Discovery Endpoint field.
    2. Select the Discover OAuth button.
  4. Enter the OAuth URL in the OAuth URL field.
  5. Enter the token URL in the Token URL field.
  6. Enter the relevant scopes in the Scopes field.
  7. Select Authorize to complete the authorization process.
If there are errors in the OAuth Discovery Endpoint, OAuth URL, Token URL, or Scopes fields, select the Clear OAuth button to clear all these fields.

OAuth API Account configuration modal.

Permissions

You can change who can view, edit, and use the API account by assigning user or group permissions. If you leave all users and groups in the left column, then the API account can be seen by all users and groups that have access to the Admin app by default.

You can change who can see or edit the api account by assigning user or group permissions. If you leave all users and groups in the left column, then the api account can be seen by all users and groups by default.

  1. Select the Permissions tab at the top of the screen.
  2. Select the users and / or groups you would like to have permission to access the api account and select the right arrow button Right arrow icon..
  3. Add or remove all users or groups by selecting on the Add All or Remove All buttons above each column.
  4. Select Save.

API Account permissions modal.