Service accounts are specialized user accounts designed for system integrations, automations, and non-human interactions. These accounts are typically assigned specific permissions to perform tasks like event creation, data synchronization, or application communication. This guide explains how to create and configure a service account, ensuring secure and efficient integration with EarthRanger.
Step 1: Create an Appropriate Permission Set
To ensure the service account has the correct level of access, you may need to create a dedicated permission set.
-
Access the Permission Sets Page
- Log in to the Earthranger Admin page.
- Navigate to User Accounts > Permission Sets.
- Check for an Existing Permission Set
- Search for a permission set that fits the needs of the integration or application.
- If a suitable permission set exists, proceed to the next step.
-
Add a New Permission Set (If Necessary)
- Click Add Permission Set in the top-right corner.
- Enter a descriptive name for the permission set (e.g., "Integration Service Account Permissions").
-
Assign Permissions
In the Permissions section, assign only the permissions needed for the service account to function. Typical permissions might include:- Can add event
- Can add event category
- Can add event type
- Can add message
- Can add observation
- Can add source
- Can add source provider
- Can add subject
- Can change event
- Can change event category
- Can change event type
- Can change message
- Can change observation
- Can change source
- Can change source provider
- Can change subject
- Can view event
- Can view event category
- Can view event type
- Can view message
- Can view observation
- Can view source
- Can view source provider
- Can view subject
-
Save the Permission Set
- Click Save to finalize the configuration.
Step 2: Create a Service Account
Once a permission set is ready, create the service account and assign the appropriate permissions.
-
Access the Users Page
- Navigate to User Accounts > Users in the Site Admin page.
-
Check for an Existing Service Account
- Search for an existing service account related to the application or integration.
- If the account exists, verify its configuration and permissions.
-
Add a New Service Account (If Necessary)
- Click Add User in the top-right corner.
- Complete the following fields:
- First Name: Enter a descriptive name (e.g., "Integration").
- Last Name: Specify the type of account (e.g., "Service Account").
- Username: Create a unique identifier (e.g., integration_serviceaccount).
- Permission Sets: Assign the previously created permission set.
- Active: Check this box to enable the account.
- Save the Account
- Click Save to create the account.
For more information on managing users in EarthRanger Admin, refer to Managing Users in EarthRanger Admin.