Skip to main content

Sage People - User Guide

In this article, you will understand step by step how to integrate Scytale with Sage People

Sage People is a cloud-based HR and people management (HCM) platform. It covers the full employee lifecycle - onboarding, employee records, performance, time off, and core HR.

Required Permissions

  • Assign the Sage People–provided Employee API permission set to the integration user (the Run-As user on the Connected App). This grants Apex Class Access to the spapi REST class.

  • Grant the integration user View All access on fHCM2__Team_Member__c records. Required to retrieve the full company population.

  • Assign the Sage People managed package license to the integration user (Setup → Installed Packages → Sage People → Manage Licenses).

Scytale follows the least-privilege principle, limiting permission scopes strictly to what's required for audit evidence collection.

How to Connect

  1. In Scytale, go to 'Integrations'.

  2. Search for Sage People and select 'Connect'.

  3. Paste your Instance URL, Client ID & Client Secret.

  4. Add a connection name — this will be used to differentiate between your connections — and then select 'Connect'.

You have now successfully connected to Sage People.

How to Generate Credentials in Sage People

Step 1 — Create a Connected App in Salesforce

  1. In the customer's Salesforce org, go to Setup → App Manager → New Connected App

  2. Fill in:

    • Connected App Name: Scytale Integration

    • API Name: scytale_integration

    • Contact Email: the email of the Salesforce admin creating this Connected App

  3. Under API (Enable OAuth Settings), check Enable OAuth Settings

  4. Set Callback URL — use the value that matches the Scytale region your account is in:

    Salesforce requires this field to be non-empty so "Enable OAuth Settings" passes form validation; the Client Credentials Flow never redirects to it, so it isn't invoked at runtime. Still, please use the region-correct value above.

  5. Under Selected OAuth Scopes, add:

    • Access and manage your data (api)

    • Perform requests on your behalf at any time (refresh_token, offline_access)

  6. Click Save — copy the Consumer Key (client_id) and Consumer Secret (client_secret)

Step 2 — Enable Client Credentials Flow on the Connected App

  1. Go to Setup → App Manager, find the Scytale Integration app, click Manage

  2. Click Edit Policies

  3. Under Client Credentials Flow, check Enable Client Credentials Flow

  4. Set Run As to the integration user (created in Step 3)

  5. Click Save

The Client Credentials Flow requires Salesforce API version 56.0 or later (Spring '23+).

Step 3 — Create the Integration User and assign Sage People API permissions

  1. Go to Setup → Users → New User

  2. Fill in:

    • Username: scytale-integration@<customer-domain>

    • Email: integration owner's email

    • User License: Salesforce (or Salesforce Integration, if available)

    • Profile: Standard User (or Minimum Access - Salesforce)

  3. Click Save

  4. Assign the Sage People–provided permission set for the Employee API (exact name TBD — confirm with Sage People admin)

  5. Assign the Sage People managed package license (Setup → Installed Packages → Sage People → Manage Licenses)

Step 4 — Configure Additional Fields field set (optional)

  1. Go to Setup → Object Manager → Team Member → Field Sets

  2. Select Employee API Additional Fields

  3. Drag the needed fields into the In the Field Set box (e.g. fHCM2__Manager__c)

  4. Click Save — those fields will then appear in the additionalFields array on each employee record.

Step 5 — Find the Instance URL

  1. In the customer's Salesforce org, the instance URL is visible in the browser address bar after login

  2. It typically follows the format https://<customer-name>.my.salesforce.com

  3. Sandbox orgs end in .sandbox.my.salesforce.com — no separate sandbox flag is needed; the same instance URL is used for both the OAuth token mint and the API call regardless of sandbox vs production.

Step 6 — Enter credentials in Scytale

Provide the following values:

  • Instance URL — from Step 5 (must end in .my.salesforce.com or .sandbox.my.salesforce.com)

  • Client ID — Consumer Key from Step 1

  • Client Secret — Consumer Secret from Step 1

You now have your Instance URL, Client ID & Client Secret — enter these in Scytale using the How to Connect steps above.

Did this answer your question?