Summary

This guide explains how to create and manage a Service Account in Launchpad, including setting permissions, generating access keys, configuring expiration settings, and handling key and account lifecycle management.

Accessing the Service Account Section

To create a Service Account:

• Log in to Launchpad.

• Navigate to the Company section.

• Click on Service Account.

Creating a New Service Account

To create a new service account:

• Click on “+ Add Services”.

• Enter a Name for your service account.

• Example: Site A Service Account.

• Add a Description.

• Example: Service account for Site A to get and write points.

• Select the Site/s where the service account should have access:

• Choose All Sites or a Specific Site.

• In this example, select Site A.

• Click Save to finalize the setup.

Generating and Managing Keys

After the service account is created, you are redirected to the Service Account Details page, where you can manage keys.

Creating a Key

• Click Add Key.

• Choose to:

• Generate a new key, or

• Add your own public key.

• Use the Copy button to quickly store the key in a secure location.
  

• Click Save to complete the key setup.

Key and Account Management Options

Multiple Keys per Service Account

• A single service account can have multiple keys.

• Each key can have its own expiration date and notification settings.

• Click on the 3 dots icon at the far right of the key row.

• Select Edit from the drop down menu.

Expiration and Notifications

• Configure how long a key is valid.

• Specify notification recipients to be alerted before expiration.

Key Lifecycle Actions

• Disable a key to revoke its access temporarily.

• Re-enable a disabled key if needed.

• Delete a disabled key to remove it permanently.

Service Account Lifecycle

• Similar actions apply to the service account itself:

• Disable the account.

• Delete it after disabling it.

Service Account Permissions

You can customize the permissions set for each Service Account created. This enables better security, allows developers to manage specific scopes per integration, and provides visibility into who is doing what across different services.

Granular Permissions with Access Levels

Service Accounts use access levels to manage access to specific resources. This provides precise control over what each account can read, write, or create.

Below are some examples of available scopes:

• Read Buildings (Required for all other permissions to function)

• Read Devices, Add Devices

• Read Building Areas

• Read Point Metadata, Add Points, Write Points

• Read Timeseries, Create Timeseries

Each permission can be enabled independently to give developers just the right level of access needed for their integrations.

Steps to Review and Customize Permissions

• Go to the specific Service Account you want to manage.

• Click on the Permissions tab to view the current available permissions.

• By default, no permissions are enabled for new Service Accounts. 

• Click the Edit button at the top right of the page to begin customizing.

• Use the checkboxes to enable Read or Write permissions for each group (e.g., PointsPublic, TimeseriesPublic, DevicesPublic, etc.).

• Once your desired permissions are selected, click Save at the bottom right corner of the screen.

• 🟢 Green = Read enabled
  

• 🟠 Orange = Write enabled

Review and Add Sites to Service Account

To review and add additional sites for a specific Service Account, follow these steps:

• Go to KODE OS.

• Click on Settings from the main left sidebar.

• Click on Users.

• Search and select by Service Account name.

• Click on Buildings at the top right of the page.

• Existing sites will show up on the list. 

• To add more sites click + Assign Buildings.

• Select the sites that you want to add.

• Click on Save.

Conclusion

The Service Account feature in Launchpad allows you to securely manage system integrations and control access through keys and permissions. Proper setup and key management ensure secure and streamlined API interactions.