Create a service user

Overview

Service user accounts are used by external application integrations to gain access to Skedulo APIs to perform their function effectively. A service user differs from the API user, which is configured for purposes internal to the Skedulo application.

Prerequisites

  • You have created a new user account with the Administrator role has been created to be your integration service account.

    • If, for example, the user is for a Zendesk integration, then you might name this account “Zendesk Integration User”. You will need to use a unique email address for this user account.
    • Administrator is a temporary role assignment that must be updated in later steps to help limit security risks associated with the account.

  • You have created a new custom role has been created for the your integration service account.

    • This role must have the minimum permissions required by your integration to help prevent security risks. We recommend that web app access and mobile app access permissions are always deselected; that is, that the role has no access to the web or mobile apps.

Steps

Configure a user account to be the service user

To create a service user for an external integration, do the following steps:

  1. Log into the web app as the new integration service user by following the steps in the activation email.

  2. Navigate to Settings > Developer tools > API tokens.

  3. Create a new long-lived API token to use for the integration.

  4. Log out of the web app and log back in as a Skedulo admin; that is, not as your integration service user.

  5. Change the integration user’s role from Administrator to the custom role with reduced permissions. See the section that follows for details on how to do this.

Edit a user account’s role

  1. Navigate to Settings > Users & roles > Users and locate your integration service user in the list.
  2. Click the vertical ellipse icon vertical ellipse icon on the user record, and then click Edit. c. Under Roles, click the x to remove the Administrator role and then select the custom role to replace it.