Skip to main content

Register a Serraview Service Account

Eptura Knowledge Center

Register a Serraview Service Account

Level: System Administrator

The Serraview Service Account is used when you are setting up access to the Serraview V2 API. For more information, refer to Access Serraview APIs.

Before you can use OAuth 2.0 with your application, you will need to create a service account within Serraview. After you have created the service account, write down the service account's id and store the service account's private key in a location accessible to your application. Your application needs these to make authorized API calls.

If you do not have a private key, you will need to create a new service account.

Serraview does NOT store private keys.

Step 1. Add a service account

To create a service account, complete the following.

  1. Navigate to Resources > User Security.
  2. Click the Service Accounticon_service_account.png icon.
  3. Click the + Add Service Account icon. The Add Service Account form displays.

clipboard_ec7d3022def441aae0ac920b55283e66f.png

4. Complete the following:

Field Description
Email field

Enter the email address.

The service account must be a separate email address (do not use an existing email address).

At this time the email is only used to satisfy the requirement that the field be populated. You can use a fake address such as placeholder@serraview.com.

Description field

Enter a description. For example 2020Apr09 Service Account.

The Description field becomes the User Account First Name and the Last Name remains blank. If you add a date it will make it much easier to identify the most recent User Account.

5. Click the Add Service Account icon. The New Service Account Created dialog displays.

clipboard_e926eb90928171ab33c112e75699ade9d.png

6. Click the Copy Account ID to Clipboard button to keep copy of the Private Key and then paste the Private Key in a secured file.

Do not send this Private Key via email. Email is not a secure method of transferring information and receiving them may be in breach of Serraview's or your organization's security protocols. If you want to send a file to Serraview, then use the File Upload.

7. Click the Okay, got it button. The service account is created.

When you create a service account a user account is also created. You will need to ensure the user's role has the required secured actions then you will have the ability to access Serraview.

Step 2. Assign the role to the user account for the service

There is a role existing role called Service Account that can be used to gain access to the Serraview API, and this role contains the secured action called API - Access. Either assign the role to the user account or assign the secured action to a custom role.

The service account for the API will need to be assigned the Service Account role.

  1. Click the Users icon_users.pngicon.
  2. In the search field, enter service. This will search for the user accounts with the User Type of Service.
  3. Select the user account for the service. The user form displays.
  4. In the Add Role area, click the Filter icon_filter.pngicon.
  5. In the filter field, enter service account. The list is filtered.
  6. Click the role checkbox to select the role.

clipboard_eaea8521b5e9e3724ecd76372aeda5c99.png

  1. Click the Update User button.

Optional - Step 3. Assign the report's role to the user account for the service

If you require the API access to particular reports, then you will need to assign the report's secure action to the Service Account role.

  1. Click the Roles icon_roles.png icon.
  2. In the search field, enter service account.
  3. Click the service account role. The Edit Role form displays.
  4. In the Add Secured Actions area, click the Filter icon_filter.pngicon.
  5. In the filter field, enter in the name of the report's secured actions. The list is filtered.
  6. Click the report's secured role checkbox to select the secured role(s).
  7. Click the Update Role button.

For example, the Add Secured Actions list is filtered for 61 Buildings and Floors report's secured actions.

clipboard_eb2326821b6a08165d9948c65f4b99d61.png