Service Accounts
Overview
Service Accounts, similar to Custom Dashboards, are intended to be used for external applications to communicate with Aria. Instead of authenticating via passwords, Service Accounts use generated keys to authenticate.
Service accounts in the Aria ecosystem represent machine-to-machine authentication credentials using OAuth 2.0 client credential flow. Service Account components include:
- Service Account ID = OAuth 2.0
client_id - Service Account Key = OAuth 2.0
client_secret
Configuring Service Accounts
You must first create a new Service Account before key generation to allow your external application to connect with Aria Billing's data.
Creating a New Service Account
Getting here: Configuration > Security > Service Accounts
- To create a new service account navigate to Service Accounts from the Configuration menu. Select the New button.

- Enter a unique name for your service account and fill out all required fields (indicated by the red asterisk).

The expected naming convention for service accounts is ########-abcdefghijklmnopqrstu where ######## is your client number. Client numbers can be found in Configuration > Integrations > Web Service API listed at the top of the page.
Note: This naming convention will be enforced in upcoming enhancements. - Select an Account Status for this new Service Account:
Active: (default) Account will be active and ready to use.
Locked: Account is created but cannot be used until set to Active.
Archived: Account is not available in the UI and cannot be used. - Select one or more Roles, one of which must be enabled for Billie CUI.
- Specific Account Number/Client Account ID, when checked, will require an Aria account number or Client Account ID to obtain a valid token to make successful calls.
- Click the Save button.
- Once the service account has been saved, it will populate on the Service Accounts page.
- Select the service account from the list to open the detailed view.

- Select the Generate Key button.

- A pop up will open prompting you to save the generated key for use in your external application.

- Close the pop up. You can now enter the generated key into your external application to authorize communication between it and Aria Billing.
Access Control
Service Accounts enforce strict access control in the following ways:
-
JWT token
client_nomust match requestclient_no -
JWT token
account_nomust match requested account (if specified) -
API key validation against client credentials