Skip to main content

How to create and whitelist an API User

Shanie Grancioso avatar
Written by Shanie Grancioso
Updated over a week ago

You will need Sapia.ai's list of IP addresses to be whitelisted. Have this ready to complete this step!

You can get the Sapia.ai's list of IP addresses here (requires login through Sapia.ai's TalentHub).

  1. Create a user with the username and user ID = sapiaAPI in the Basic User Data file.

  2. Grant the following permissions to the sapiaAPI user:

    • Manage Integration Tools > Event Notification Subscription

    • Recruiting Permissions > SFAPI Retrieve Assessment Order Permission

    • Recruiting Permissions > SFAPI Update Assessment Report Permission

    • General User Permissions > SFAPI User Login

    • Recruiting Permissions > SFAPI Retrieve Candidate Permission

    • Recruiting Permissions > SFAPI Retrieve Job Application Permission

    • Recruiting Permissions > SFAPI Update Job Application Permission

    • Recruiting Permissions > SFAPI Retrieve Job Requisition Permission

    • Recruiting Permissions > OData API Application Export

    • Recruiting Permissions > OData API Application Update

    • Recruiting Permissions > OData API Application Create

    • Recruiting Permissions > OData API Candidate Export

    • Recruiting Permissions > OData API Job Requisition Export

    • Manage System Properties > Picklist Management and Picklists Mappings Set Up

  3. Navigate to Admin Tools > Password & Login Policy Settings > Set API Login Exceptions, then click Add.

  4. Set the following:

    • Username: Select the sapiaAPI integration user

    • Maximum password age (days): Set this option to -1

    • IP Address Restrictions: provide the list of Sapia.ai's list of IP addresses for the correct region/environment

  5. Click Save & Close

Related Articles
PageUp: What You Need to Get Started
How to manage/setup the automatic trigger in Teamtailor for Sapia.ai's assessment
Did this answer your question?