Skip to main content
Version: NG-3.2

Service Accounts

The Service Accounts tab shows the Service Accounts available in the platform. A Service Account is used for programmatic access by OmniAgent or integrations and is managed separately from a user account. Service Accounts cannot be used to log in to the vuSmartMaps user interface and do not have passwords, password-reset options, or SSO bindings. They receive functional permissions through one or more assigned Roles and data-level permissions through one Data Access Role.

The Service Accounts tab displays:

  • Status – Indicates whether the Service Account is enabled or disabled.
  • Name – Name assigned to the Service Account.
  • Roles – Roles assigned to the Service Account.
  • Description – Description of the Service Account's purpose.
  • Type – Identifies the purpose of the Service Account, such as Integration or Omniagent.
  • Created By – Identity that created the Service Account.
  • Keys – Number of API keys owned by the Service Account.
  • Created – Date and time when the Service Account was created.
  • Last Used – Most recent recorded use of an API key owned by the Service Account.
  • Actions – Available management actions for the Service Account.

Use the search field to locate a Service Account. You can also filter the list by Enabled or Disabled status, export the displayed information in JSON or CSV format, and use Bulk Enable or Bulk Disable to update multiple Service Accounts together. A Service Account can have multiple Roles, and the permissions from those Roles are combined. Only one assigned Role can be selected as the Data Access Role, which determines the data-level access applied to the Service Account.

The Service Account details drawer contains the following tabs:

  • Details: Displays the Name, Description, Roles, Data access role, Type, Status, Created, Created by, Last used, and Keys owned information.
  • API Keys: Displays the API Keys owned by the Service Account.
  • Audit Log: Displays recorded lifecycle events for the Service Account.

Select View effective permissions to review the Service Account permissions under the Modules, Object, and Data tabs.

note

The Service Account Type cannot be changed after creation.

System-Provided Service Accounts​

vuSmartMaps automatically provides the following system Service Accounts:

  • system-sa-omniagent: Used for OmniAgent authentication and associated with the system-provided role-omniagent Role.
  • system-sa-integration: Used for supported integration and programmatic API-access requirements and associated with the system-provided role-integration Role.

System-provided Service Accounts are created and maintained by the platform. Their identity configuration, type, and assigned system role cannot be modified, and they cannot be deleted.

Step-by-Step Instructions​

Creating a Service Account​

  1. Navigate to Account Management > Identity & Access.
  2. Open the Service Accounts tab.
  3. Click Service Account.
  4. Enter the required Name.
  5. Enter an optional Description.
  6. Select the required Type:
    • OmniAgent
    • Integration
  7. For an Integration Service Account, select one or more Roles. The permissions from the selected Roles are combined. Then select one Data Access Role from the assigned Roles.
  8. For an OmniAgent Service Account, the Role and Data Access Role options are disabled. The platform automatically assigns the system-provided OmniAgent Role.
  9. Click Save.

The Service Account is created with an Enabled status. API Keys are not created automatically and must be created separately from the API Keys tab.

note

The Service Account Type cannot be changed after creation.

Updating a Service Account​

  1. Open the Service Accounts tab.
  2. Locate the Service Account that you want to update.
  3. Click Edit.
  4. Update the permitted fields, such as the name, description, or assigned roles.
  5. Review the effective permissions.
  6. Save the changes.

The effective permissions of the Service Account are updated based on the revised group assignments. All API keys owned by the Service Account inherit the updated permissions.

note

The Service Account Type cannot be changed after creation.

Disabling or Enabling a Service Account​

Disabling a Service Account​

  1. Open the Service Accounts tab.
  2. Locate the required Service Account.
  3. Click Disable.
  4. Confirm the action.

Enabling a Service Account​

  1. Locate the disabled Service Account.
  2. Click Enable.
  3. Confirm the action.

Viewing Service Account Details​

  1. Open the Service Accounts tab.
  2. Click the name of the required Service Account.
  3. Review the available details:
    • Details
    • API Keys
    • Audit Log

Deleting a Custom Service Account​

A custom Service Account can be deleted only when it does not own an API key in the Active or Rotating state.

  1. Open the Service Accounts tab.
  2. Locate the required custom Service Account.
  3. Verify that it does not own any Active or Rotating API keys.
  4. Revoke or remove the applicable keys when required.
  5. Click the Delete action.
  6. Confirm the deletion.

The Service Account and its remaining associated records are removed.

note
  • A system-provided Service Account cannot be deleted.
  • Deletion is blocked when an Active or Rotating API key exists.