Step 1: Confirm User Setup & Account Configuration
Overview
This guide walks you through the steps to configure Signed Link SSO. Before utilizing Signed Link Single Sign-On, you must complete the following steps:
Step 1: Make sure users are set up correctly
- Create users in Yext. To add users via the platform, see
Add a new user
, or
Add users in bulk
. To do this via the API, visit
Users: Create
endpoint.
- If you need to create a custom user role, visit Create a Custom User Role for instructions.
- Take note of the ID (
id
in the Users: List endpoint of the Management API) of the User that you create. You will need this ID when generating the Signed Single Sign-On Link.- For most clients, the
roleId
is typically 9 or 20, Account Manager. You can also follow the steps in the Manage Users Guide to retrieve Available Roles. - Note: If you have a 1:1 relationship between user and entity or account, then the user ID should be equal to the entity ID or account ID.
- For most clients, the
Step 2: Make sure your account has been configured to use Signed Link SSO
- Your account needs to be explicitly configured by Yext Technical Operations to use the Signed Link Single Sign-On option. Please email apisupport@yext.com, with your Account Manager copied, to enable this for your account.
- Yext will provide you with a secret code (
secret
) that you will use to sign login requests, as described in the next section.
Feedback
<% elem.innerText %>