Service accounts

The Service accounts page allows you to manage the authenticated application accounts. This area is only available if you are an administrator.

Service accounts are used by applications that need to get access tokens for their own use rather than on behalf of a user. These access tokens can then be used to make authenticated requests to APIs. The APIs that service accounts can get access tokens for are:

  • Authentication Server API – A service account must be created for any applications that integrate with the Authentication Server API. For more details, see the Authentication Server configuration guide.
  • Blue Prism API – A service account must be created for any third-party applications that integrate with the Blue Prism API. For more details, see the Blue Prism API install guide.
  • Decision API – A service account must be created for Blue Prism to use the Decision models that have been trained and calibrated in the Decision plugin. For more details, see the Blue Prism Decision install guide.
  • Interact Remote API – A service account must be created for any applications that integrate with the Interact Remote API, such as the Blue Prism interactive client. For more details, see the Interact Web API Service user guide.

To open the Service accounts page, click your profile icon to open the Settings page, and then click Service accounts.

The Service accounts page provides you with the following information and functions:

  1. Edit view – Define the columns that are displayed. You can then show or hide the columns using the toggle switches.

  2. Filter – Filter the information that is displayed. You can turn on the required filters and enter or select the appropriate information for display, for example, you could turn on the Permissions filter and select Blue Prism API.
  3. Save view – Save your current column settings. You can enter a name for your view to make it easily identifiable when loading views.

  4. Load view – Load a saved view. You can select the required view and click Apply.

  5. Regenerate secretCreate a new secret for an existing service account.
  6. Add accountAdd a new service account.
  7. Edit accountEdit the details of an existing service account.
  8. Delete account(s) – Delete one or more service accounts.
  9. Rows per page – Enter a number, or use the up and down arrows, to change the number of rows seen on a page.

  10. Previous and Next – Click Previous or Next to move through the pages of service accounts.

Add a service account

  1. On the Service accounts page, click Add account.
  2. Enter a unique ID for the client application and a friendly name for the client in the Authentication Server database.
  3. Under Permissions, select the appropriate option:

    • Blue Prism API – The service account secret is used to get an access token to authenticate with the Blue Prism API.
    • Authentication Server API – The service account secret is used to make authenticated requests to the Authentication Server API.
    • Interact Remote API – The service account secret is used to get an access token to authenticate with the Interact Remote API.
    • Decision API – The service account secret is used to get an access token to authenticate with the Decision Web API.
    • Director API – This permission does not have a function. It is reserved for future functionality.
  4. Click Create service account.

    The Add a service account dialog displays with a generated secret, which will be used to get the access token to the selected API(s).

  5. Click the Copy to Clipboard icon to copy the generated secret to your clipboard.

  6. Click OK to close the dialog.

    The Service accounts page displays with the newly created account.

When you create a service account for use with the Blue Prism API, you must ensure that the secret does not contain a plus sign (+). If it does, it will fail to authenticate.

Regenerate secret

If you have misplaced a previously generated secret for an existing service account, you can generate a new secret.

  1. On the Service accounts page, select the required service account and click Regenerate secret.

    The new secret for the service account displays.

  2. Click the Copy to Clipboard icon to copy the generated secret to your clipboard.

  3. Click OK to close the dialog.

Edit a service account

  1. On the Service accounts page, select the required service account and click Edit account.
  2. Change the information as required.

    You cannot change the client ID for a service account.

  3. Click Save to apply your changes.

Delete service accounts

  1. On the Service accounts page, select the required service account(s) and click Delete account(s).

    A message displays asking you to confirm the deletion.

  2. Click Yes to delete the selected account(s) or No to cancel.

Use the filters

The filters enable you to easily find a specific service account based on the selected criteria.

  1. On the Service accounts page, click Filter to open the Filter panel.
  2. Use the toggle to turn on the required filter and complete the information to find the service account. You can apply multiple filters at the same time.

    The available filters are:

    Filter

    Description

    Friendly Name

    Enter the service account name, or part of a name.

    ID

    Enter the service account identifier, or part of the identifier.

    Permissions

    Select the appropriate permission level option. You can select more than one option. If you do not select any permission levels, all levels are included on the Service accounts page.

    The information on the Service accounts page is immediately filtered.

    If you have set the filters but want to view the unfiltered information again, either click Reset filters in the panel, or turn off the required filters, or remove any settings within the filter so that it is blank.

  3. Click Close drawer to close the filter panel.