API Service Accounts

This introduction article will guide administrators in configuring API Service Accounts within TDAdmin. The user must have access to TDAdmin to create a Service Account. Additionally, to create an Administrator Service Account, Add BE Admins permissions must also be enabled in addition to TDAdmin access.

Overview

TeamDynamix supports two types of service accounts for working with the API.

• A service account is similar to a user, with its own security role and application permissions.
• An admin service account has broad access to the system and is required for certain API endpoints. This article describes how to set up both types of service accounts.

Where to Find This

Service Accounts and Administrator Service Accounts can only be configured within TDAdmin. Service Accounts are configured within the Users & Roles section of TDAdmin, and Administrator Service Accounts are located on the main TDAdmin page of your organization / institution within the Security tab.

Using API Service Accounts

Service Accounts

Use a regular service account when you want to access the API with specific permissions, but do not want the API to act on behalf of a specific user.

Service Accounts do not have an email address, meaning that you cannot include them in notifications or other areas of the system that send email (e.g. report delivery, workflow steps).

To configure a service account:

1. In TDAdmin, navigate to > Users & Roles > Users.
2. Click Create > Create Service Account.
3. Enter a Username. This must be unique among all the usernames in the system
4. Click Next.
5. Fill in the required fields:
   1. First Name and Last Name - Service accounts require a separate first and last name (like a user) so that they can display in lists of users and accounts.
   2. Security Role - The selected security role will be applied to actions taken by the service account.
   3. Password
6. Click Finish to create the service account.
7. Use the Applications tab to add applications the account can access.
8. Use the Accts/Depts tab to add Accounts/Departments the account is associated with.

Admin Service Accounts

Use an admin service account when you want or need to have broad permissions for the API.

The Add BE Admins permission is required to create admin service accounts.

To configure an admin service account:

1. From the main details page of TDAdmin, click the Security tab.
2. Click Add Admin Service Account.
3. Provide a First Name and Last Name - Admin service accounts require a separate first and last name (like a user) so that they can display in lists of users and accounts.
4. Click Save.