Managing service accounts

A service account is necessary for an application or a script to use ThingPark OSS API or the legacy DX-API.

Only administrators can create and manage service accounts.

Creating a service account

The service account generates the client ID and the client secret to give to the developer to authenticate with ThingPark API.

important

The client secret can be used as many times as needed with the service account it belongs but can only be regenerated if lost. For more information, see Regenerating the client secret.

As for the users, you can configure the permissions of the service account using:

• Roles ,
• Domain restrictions, if the segregation based on domains has been enabled. See About domains.

Set the permissions of the service account according to the requirements of the application.

---

1. Select Administration > Service Accounts.

2. Click ADD SERVICE ACCOUNT.

3. Type a Name and a Client ID for your service account. You can only provide the suffix of the client ID.

4. (Optional) Add domain restrictions to restrict resources accessible by the service account. Only available if the segregation based on domains has been enabled. For more information, see About domains.

   

5. Select the role you want to give to the service account to define the resource types that the service account is allowed to manage.

6. When finished, click ADD.

7. In the new service account that displays, go to the CREDENTIALS section to copy the Client secret.

   important

   For security reasons, the client secret will not display again and can only be regenerated if lost.

8. Give the following service account's information to the developer to follow the instructions given on this Quickstart page:

   • client ID
   • client secret

Viewing service accounts

In the Service Accounts list, you can display all the active and deactivated service accounts and customize the list.

---

1. Select Administration > Service Accounts.
2. To customize the list to your needs, click Show/Hide columns. Your selection is saved in your web navigator and applies to the same computer.

Exporting service accounts

You can export all the service accounts of your account in a CSV file. It exports all the information regardless of the hiding columns in the Service Accounts list.

---

1. Select Administration > Service Accounts.
2. Click Export as CSV.

Viewing and changing a service account

You can access the service account's information from the Service Account list.

You can change any service account's information except:

• The client ID's prefix
• The client secret. For more information, see Regenerating the client secret.

---

1. Select Administration > Service Accounts.
2. Do one of the following:
   1. Click the name of the service account you want to change.
   2. Hover your pointer over the name of the service account you want to change, and click Open in a new tab.
3. On the service account page, check or change the information you want.

Regenerating the client secret

If the client secret of the service account is lost, you can generate it again.

---

1. Select Administration > Service Accounts.
2. Click the name of the service account you want to regenerate the client secret.
3. In CREDENTIALS, click REGENERATE.
4. Click REGENERATE to confirm.
5. In Client secret, click Copy, then save the client secret.

Deactivating/activating a service account

If you are not sure a service account is still being used, you can first deactivate it, then delete or activate it when confirmed.

If you are told that a service account does not work, you can check it still exists on the account, then activate it again.

important

When the service account is deactivated, the client secret is kept and can be used again when the service account is reactivated.

---

1. Select Administration > Service Accounts.

2. Click the name of the service account you want to deactivate or activate.

3. Click the arrow next to the ACTIVE or DEACTIVATED badge, and click Deactivate or Activate.

   -> The service account badge changes state.

Deleting a service account

You can stop the use of a service account by deleting it:

• Either from the Service Accounts list
• Or from the service account page.

---

1. Select Administration > Service Accounts.
2. In the Service Accounts list that displays, do one of the following:

   1. To delete the service account from the Service Accounts list:

      On the row of the service account you want to delete, click ..., then Delete.

   2. To delete the service account from the service account page:

      1. Click the name of the service account.
      2. On the service account page, click Delete.
3. Click Delete to confirm.