{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Ashby Identity Configuration Guide","siteUrl":"https://docs.synqly.com","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide helps you configure an integration for Ashby ATS."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"prerequisites","__idx":0},"children":["Prerequisites"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before you begin, ensure that you have:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Access to an Ashby account with Organization Admin permissions."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Permission to create and manage API keys in Ashby."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A secure place to store the generated API key. Ashby shows the key only once when it is created."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"required-api-scopes","__idx":1},"children":["Required API Scopes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Module"},"children":["Module"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Scope"},"children":["Scope"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Organization"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve and read data about the organization's users"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"generate-an-api-key","__idx":2},"children":["Generate an API Key"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Log in to Ashby as an Organization Admin."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Navigate to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Admin > Integrations > API Keys"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["+ New"]}," to open the API key setup wizard."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter a name for the key and select an integration partner if your Ashby setup requires one."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["API Scopes"]}," step, select the modules and scopes listed in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#required-api-scopes"},"children":["Required API Scopes"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save and Continue"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Copy the API key from the final step and store it securely."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information on generating Ashby API keys, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://docs.ashbyhq.com/how-do-i-generate-an-api-key"},"children":["How do I generate an API key?"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"configure-the-integration","__idx":3},"children":["Configure the Integration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create your integration by supplying the following configuration values."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Integration Parameter"},"children":["Integration Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Secret"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["This is the API key value generated from executing the steps above."]}]}]}]}]}]},"headings":[{"value":"Prerequisites","id":"prerequisites","depth":2},{"value":"Required API Scopes","id":"required-api-scopes","depth":2},{"value":"Generate an API Key","id":"generate-an-api-key","depth":2},{"value":"Configure the Integration","id":"configure-the-integration","depth":2}],"frontmatter":{"slug":"guides/provider-configuration/ashby-identity-setup","seo":{"title":"Ashby Identity Configuration Guide"}},"lastModified":"2026-09-07T22:23:07.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/provider-configuration/ashby-identity-setup","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}