API Applications
On this page
An API application is the account a program uses to call the Alloy Navigator API. It is not a person's account. Each API application consists of an account, which holds a generated application ID and secret, and a service person record that carries the application's name.
The program presents the application ID and secret to the API to get a token; see Authentication. The API accepts them only for an active application.
You register and manage API applications in the Admin Center and in the Settings App. For how the two applications relate, see Admin Center and Settings App.
When you generate a new secret for an existing application, update every instance of that application's client configuration to use the new secret.
Accounts that are not people
API applications and service accounts are not the accounts of people:
- API applications sign in to the API with their application ID and secret. They are listed on their own Applications list.
- Service accounts do not sign in. The background components of Alloy Navigator do their work under service sessions, and service accounts are how that work is attributed. In the Settings App, service accounts are listed on the Accounts list with the other accounts; API applications are not.
Alloy Navigator creates eleven service person records with every database, so that records created by a background component have a real author: Automation Server, Active Directory Integration, Alloy Discovery Integration, AlloyScan, Archiving, Mail Connector, Scheduled Reports, Self Service Portal, Import Wizard, Alloy Navigator API, and Scheduled Task Agent. Whether a person is a service person is not shown on the person form and cannot be changed.
For account types in general, see Accounts.
API calls with technician credentials
When a technician calls the API with their own credentials, the calls are filtered exactly as in the technician's Web App session. For roles, see Security Roles.
In the Admin Center
The Accounts and Roles page has three tabs: Accounts, Roles, and Applications. API applications are on the Applications tab and open in the Applications drawer.
In the drawer, Name is the only field you type in. Application ID and Secret are read-only.
Register an application
- On the Applications tab, add an application. The drawer opens with the Application ID and the Secret already generated.
- Enter the Name.
- Save the application.
Generate a new secret
- Open the application in the drawer.
- Click Generate New Secret and confirm the change.
- Save the application.
The confirmation appears every time you generate a secret for an existing application, even when nothing else has changed. For a new application, the secret is regenerated without a confirmation.
Deactivate or reactivate an application
In the drawer, switch the application's status between active and inactive, then save the application. Changing the status does not show the secret confirmation.
The drawer protects unsaved changes when you leave it.
Delete applications
On the Applications tab, select one or more applications and click Delete.
In the Settings App
API applications are listed under Users & Security > Accounts and Roles > Applications, beside Accounts and Roles. The list has its own New, Edit, and Delete commands.
Register an application
- Go to Users & Security > Accounts and Roles > Applications and click New. The Application window opens with a 20-character application ID and a 40-character secret already generated.
- Enter the Application Name:. It is mandatory.
- Click OK.
A new application starts active. OK writes the name to the application's service person record and saves the application. Cancel discards every change. OK refuses an empty name. For a new application, OK is available from the start; for an existing application, it becomes available once you change the name, the status, or the secret.
Generate a new secret
- Select the application and click Edit.
- Under Application ID: and Secret:, click Generate New Secret and confirm.
- Click OK.
Deactivate or reactivate an application
Do one of the following:
- In the Application window, click Make Inactive on an active application, or Make Active on an inactive one, and click OK. The Status group shows Active or Inactive, and the change is saved only when you click OK.
- In the list, select one or more applications, right-click, and choose Disable or Enable. The change is saved at once.
Delete an application
Select the application and click Delete.