Skip to main content
A Service Account is a non-human identity, such as an agent, that is authorized to interact with Connect AI. Service accounts authenticate via OAuth 2.0 Client Credentials. Use them to grant programmatic access to scripts, jobs, and external services.
Service Accounts
The Service Accounts tab contains the following information:
  • A search bar for entering a service account name.
  • Drop-down lists for filtering by workspace name and service account status.
  • A row for every service account in your account:
    • Name is the service account name.
    • Workspace displays the workspace or workspaces containing the service account.
    • Client Id is the unique identifier used to authenticate the service account via OAuth 2.0 Client Credentials.
    • Status is the status of the service account (active or inactive). If you deactivate a service account, any services or automations using these credentials fail on the next request. The service account remains in the registry for audit purposes.
    • Created is the date and time the service account was created.
    • Rotate, edit, and delete icons for the service account. When you rotate credentials, the current credentials stop working immediately. You must update dependent services before the next request.

Add a Service Account

1
In the Service Accounts tab of the Identities page, click + Add Account to open the Add Service Account page.
Add a Service Account
2
Enter the Name of the service account.
3
Enter a short Description of the service account.
4
Select an Authentication Type of Client Secret or Public Key. If you select Public Key, you are asked to upload the public key (PEM) file (RS256 or ES256).
5
Click Confirm to save the service account.
6
If you selected Client Secret, an Add Service Account dialog appears. Copy the Client Id and Client Secret. The Client Secret only appears once.
Share these credentials with the developer who will authenticate the service account using OAuth 2.0. See Service Account Setup for details.
7
Click Done. An Edit Service Account page appears.
Edit a Service Account
8
(Optional) Select a Workspace to apply the access to.
9
(Optional) Click + Add to Workspace to add the service account to another workspace. See Add a Service Account to a Workspace for details.
10
(Optional) Add an Access Role to the service account. Selecting an access role automatically updates the Permissions to the entities below.
11
(Optional) In Permissions, manually select the service account’s permissions to entities (data connections and virtual schemas) in your Connect AI instance. For more information about permissions, see Permissions and Access Control.
12
Click Save Changes to save the service account settings.

Edit a Service Account

You can modify any service account, rotate credentials, or delete a service account at any time by clicking the rotate, edit, or delete icons in the Service Accounts list. In the Edit Service Account page, you can do the following:
  • Edit the Name and Description fields.
  • Add the service account to a workspace.
  • Add and remove access roles for the selected workspace.
  • Manually update permissions for the selected workspace.
  • Rotate credentials (the current credentials stop working immediately).
  • Delete the entire service account.

Add a Service Account to a Workspace

A service account must be added to a workspace before you can assign it an access role in that workspace.
1
In the Workspaces section of the Edit Service Account page, click + Add to Workspace to open the Add Service Account to Workspace dialog.
2
Select the Workspace to add the service account to. Click Next.
3
Select an Access Role (optional) for the service account in the workspace. See Roles for information on creating access roles.
4
Click Add to add the service account to the workspace.

Delete a Service Account

To delete a service account, click Delete on the Edit Service Account page.
Last modified on October 14, 2026