API Access User

The API Access tab can be used to create and manage API Access Users. API Access Users are a tool that can be used to interact and integrate with Vasion Automate Pro outside of the user interface. For more information on the API endpoints that are available, see the API Reference page.

API Users tab in the User Management page.

To view and test the API endpoints for your Vasion Automate Pro environment, select the API Documentation link to navigate to your environment's Swagger API page.

Create a New API User

  1. Select Security & Permissions in the side navigation.
  2. Select User Management.
  3. Select the API tab.
  4. Select New API User.

  5. Enter information about the new user. Required fields are indicated by an asterisk (*). Here are some additional details:

    1. Username — the name used to log in for this user.
    2. Active — deselect this box to deactivate the user and prevent access to Vasion Automate Pro.

  6. Select the Save button.

    Create API user modal.

  7. In the API Tokens modal that appears, select Generate Token.

    API tokens Modal after creating a new API user.

  8. Enter a name in the Token Name field.
  9. Select an expiration date for the API token.

  10. Select Create.

  11. Select the Copy button to copy the API token to the clipboard.
    This is the only time that this token will be available to be copied. Make sure to copy it now.

  12. Select the Done button to exit the API User Token Created modal.

  13. Select Done to exit the API Tokens modal.

Edit API User

To edit an existing API User:

  1. Select the More icon More button. next to the user to be edited.
  2. Select Edit User.
  3. Edit the username or email of the API user.
  4. Unselect the Active checkbox to prevent this API user from accessing Vasion Automate Pro.

  5. Select Save.

    Edit API User modal.

Assign Roles

API users can be assigned roles in Vasion Automate Pro to limit what they are able to do. For more information about what roles and what they do, see Roles.

To assign roles to an API User:

  1. Select the More button More button. for the user to whom you want to assign roles and select Assign Roles.
  2. To add roles:
    1. Select the role(s) in the Defined Roles list that you’d like to assign to the user. You can select more than one.

    2. Select the right arrow button Right arrow icon. to move the selected role to the Assigned Roles list.

  3. To remove roles:

    1. Select the role(s) in the Assigned Roles list that you’d like to unassign from the user. You can select more than one.

    2. Select the left arrow button Left arrow icon. to move the selected role to the Defined Roles list.

      If you’d like to add all of the available roles, select Add All. If you’d like to remove all of the roles from the Assigned Roles list, select Remove All.

  4. Select the OK button.

Assign Roles to API User Modal.

Manage Tokens

Each API user can have multiple tokens associated with it for multiple authorized apps. Within the Manage Tokens modal, generate new tokens or delete existing tokens. To manage an existing API User's tokens:

  1. Select the More icon More button. next to the API user for which to manage the tokens.
  2. Select Manage Tokens.

Generate a New Token

To generate a new token:

  1. In the API Tokens modal that appears, select Generate Token.

    API tokens Modal after creating a new API user.

  2. Enter a name in the Token Name field.
  3. Select an expiration date for the API token.

  4. Select Create.

  5. Select the Copy button to copy the API token to the clipboard.
    This is the only time that this token will be available to be copied. Make sure to copy it now.

  6. Select the Done button to exit the API User Token Created modal.

  7. Select Done to exit the API Tokens modal.

Delete Tokens

To delete an existing token:

  1. Select the Delete icon Delete icon..

  2. Select Yes, Delete Token.

    Confirm delete of API Token modal.

  3. Select Done to exit the API Tokens Modal.

Export

To export a list of the API Access Users:

  1. Select the Export drop-down
  2. Select either CSV or PDF

The exported API Access Users file lists each:

  • Username
  • Full name
  • Email

Make an API Access User Inactive

When a user is made inactive, they are no longer an authorized user and cannot log into Vasion Automate Pro.

  1. From the User Management page, select the More button More button. for the user you want to edit and select Edit User.
  2. Select on the Active box to deselect it.
  3. Select the OK button.

Delete a API Access User

Deleting a user from Vasion only removes the user from the list in User Management but it does not delete the user record so the integrity of security and audit trails can be maintained.

  1. From the User Management page, select the More button More button. for the user you want to edit and select Delete User.

  2. In the confirmation modal select Yes

    Delete confirmation.