Service accounts are specialized user accounts used for system integrations, automations, and other non-human operations. They enable secure interaction between EarthRanger and external systems by performing tasks such as event creation, data synchronization, or application communication.
This guide explains how to create and configure a service account in EarthRanger, ensuring it has the appropriate permissions for secure and efficient integration.
Steps Overview
- Identify or create a suitable Permission Set.
- Create a Service Account and assign the Permission Set.
Step 1: Select or 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.
Explore existing Permission Sets and decide if any of them fit the needs for your Service Account:
- 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, take note of its name and proceed to “Step 2: Create the Service Account”.
Create a Permission Set:
- Add a New Permission Set
- Click Add Permission Set in the top-right corner.
- Enter a descriptive name for the Permission Set (e.g., "Elephant Trackers Service Account").
- 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 the Service Account
Once a permission set is ready, create the service account and assign the appropriate permission set.
- Access the Users page
- Navigate to User Accounts > Users in the EarthRanger Admin page.
- 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., "Elephant Trackers").
- Last Name: Specify the type of account (e.g., "Service Account").
- Username: Create a unique identifier (e.g., elephanttrackers_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.
Additionally, note that the Service Account user created in this process is linked to an Authentication Token (see Create an Authentication Token) for use in system integrations.