Skip to main content

​
Intro

The API Clients feature in the Admin Settings allows you to create and manage your own API clients and allows admin users to manage all API clients for your instance. API Clients displays a list of clients with their scopes and allows you to revoke clients that are no longer needed.

​
Required Grants

You must have ONE of the following grants to access the API Clients feature:
  • Create API OAuth Clients — Allows you to view and revoke your own API clients. You must have this grant to create API clients.
  • (Admin-only) Manage All Access Tokens and API Clients — Allows admins to view and revoke all API clients in your Domo instance.
This table highlights the differences between the grants.

Access

Create API
OAuth Clients

Manage All Access Tokens
and API Clients

Create clients

checkmark.jpeg

red x.jpeg

View clients you own

checkmark.jpeg

checkmark.jpeg

View all clients in the instance

red x.jpeg

checkmark.jpeg

Delete/revoke clients you create

checkmark.jpeg

checkmark.jpeg

Revoke access for all clients in the instance

red x.jpeg

checkmark.jpeg

​
Access API Clients

Navigate to Admin > Authentication > API Clients.

​
Create API Clients

Note: While API clients can also currently be created in the Domo developer portal , this functionality will be removed in the future.
Users with the Create API OAuth Clients grant can follow these steps to create a client:
  1. Access the API Clients feature and select Create to open the creation modal.
  2. In the modal, enter a unique name and description for your client. To facilitate proper client governance, pick a name and description that captures the planned usage of the API client.
    Screenshot 2025-01-17 at 11.55.54 AM.png
  3. Select which scopes you want to give the client.
Note: Domo recommends adhering to the principle of least privilege by giving your client only those scopes required by your use case.
Screenshot 2025-01-17 at 11.56.03 AM.png
  1. Select Create. Upon confirmation, the ID and secret for your new client appear. Important: This is the only time the client secret displays.
    Warning: The client ID and secret are highly sensitive because they grant access to your Domo instance. Treat these credentials in accordance with your organization’s security policies.
    Screenshot 2025-01-13 at 8.47.30 AM.png

​
View and Manage API Clients

The API Clients page lists active API clients in the Domo instance, depending on your grants. The list only displays partial client IDs, and the client secret is hidden to ensure security. The client’s scope and owner are also displayed.

​
Delete a Client

API clients can’t be edited, but you can delete a client, depending on your grants. To delete a client, follow these steps:
  1. On the row for the client you want to delete, select More (three vertical dots icon) > Delete.
  2. In the confirmation dialog, select Revoke.
    Screenshot 2025-01-13 at 9.49.28 AM.png
    Important: There is no warning dialog when you select Revoke —the client is removed. Ensure you are revoking the correct client, as this action cannot be undone. Note that existing sessions continue to be valid until they expire.