Administration

API Keys

Create, rotate, and delete the keys that give scripts and tools access to the DigiUsher API.

An API key lets a script or a tool call the DigiUsher API without a person who signs in. Each key belongs to your organization.

To open the page, go to System > User Management in the left sidebar. Then click Manage API Keys. Only admins can manage API keys.

To read the endpoints of the API, click API Reference on the API Keys page.

MCP clients do not use API keys. They connect with your DigiUsher sign-in. Read MCP Authentication.

Create a key

Open the form

On the API Keys page, click Create Key.

Name the key and set its validity

  1. In Key Name, enter a name that tells your team what uses the key.
  2. In Expires In, select a period from One Day to Ten Years. The default is One Year.
  3. Click Create.

You cannot change the validity of a key after you create it.

Copy the key

Click Copy, and keep the key in a secure location. Then click Done.

Copy the key before you click Done. DigiUsher shows the full key one time only.

Use a key

Send the key as a bearer token in the Authorization header of each request:

Authorization: Bearer <your-api-key>

The keys table

ColumnDescription
NameName of the key
OwnerThe member who owns the key
Key PrefixFirst part of the key, to identify it
Created AtDate and time of creation
Expires AtDate and time when the key stops working
Rotated AtDate and time of the last rotation, if any

An expired key does not appear in the table. If a member leaves the organization, the Admin who removes the member becomes the owner of their keys.

Rotate a key

Rotate a key to replace its secret value. The name and the expiry date stay the same.

  1. In the Actions column, click the rotate icon.
  2. Type the name of the key to confirm.
  3. Click Rotate.
  4. Copy the new key, then click Done.

The old value stops working immediately. Update every script that uses it.

Delete a key

  1. In the Actions column, click the delete icon.
  2. Type the name of the key to confirm.
  3. Click Delete.

Do not delete a key that a script still uses. The deletion is permanent, and the script cannot call the API after it.

On this page