> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Connect Eploy with OAuth 2.0 – StackOne Hub

> Link a Eploy account in the StackOne Hub using OAuth 2.0. End-user guide to authorize the integration and start using Eploy actions.

<Warning>Ensure you have Admin privileges for your Eploy account.</Warning>

<section data-guide-section data-guide-scopes="">
  <h2>Getting your Subdomain</h2>

  <p>Your subdomain is used to identify your Eploy instance.</p>

  <Steps>
    <Step title="Find the Subdomain">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>You can find the subdomain in the URL of your Eploy account by taking the portion that appears before `.eploy.net` and after `https://`.</p>

        <ul>
          <li>Example URL: `https://stackone.eploy.net/`</li>
          <li>Subdomain value: `stackone`</li>
        </ul>
      </div>
    </Step>
  </Steps>
</section>

<section data-guide-section data-guide-scopes="">
  <h2>Generating Client ID and Client Secret</h2>

  <p>You need to create an API key in Eploy to generate the Client ID and Client Secret.</p>

  <Steps>
    <Step title="Navigate to API Keys">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>In the top navigation bar go to <strong>Admin</strong> → <strong>System / Security Settings</strong> → <strong>API Keys</strong>.</p>
      </div>
    </Step>

    <Step title="Create a New API Key">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>On the top-right select <strong>New</strong> → <strong>Rest API</strong>.</p>
      </div>
    </Step>

    <Step title="Name the API Key">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Enter a title for the API Key, for example: `StackOne`.</p>

        <ul>
          <li>Select an <strong>API User</strong> for your API Key to use</li>
          <li>Click <strong>Save</strong></li>
        </ul>
      </div>
    </Step>

    <Step title="Record Client ID and Client Secret">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Your <strong>Client ID</strong> and <strong>Client Secret</strong> will be generated and displayed to you.</p>

        <ul>
          <li>Copy both values and store them securely for use later</li>
          <li>These credentials are only shown once</li>
        </ul>
      </div>
    </Step>

    <Step title="Assign API Permissions">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Assign API permissions based on the integration requirements by clicking on the <strong>Add</strong> button.</p>

        <ul>
          <li>Select and enable each required API permission (Actions, Applications, Candidates, Companies, Contacts, Files, Placements, Timesheets, Users, Vacancies, etc.)</li>
          <li>Click <strong>Save</strong> for each permission added</li>
        </ul>
      </div>
    </Step>
  </Steps>
</section>

<section data-guide-section data-guide-scopes="">
  <h2>Configuring Scopes (Optional)</h2>

  <p>You can optionally restrict API access by specifying scopes.</p>

  <Steps>
    <Step title="Understanding Scopes">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Scopes control which API operations are allowed. If not specified, all scopes assigned to the API key will be available.</p>

        <ul>
          <li>Format: comma-separated list (e.g., `candidates.read,candidates.insert,applications.read`)</li>
          <li>Only scopes assigned during API key configuration will be allowed</li>
          <li>Leave blank to use all available scopes</li>
        </ul>
      </div>
    </Step>
  </Steps>
</section>

<div data-whitelabel-hide>
  <h2>Linking the Account from the Hub</h2>

  <Steps>
    <Step title="Navigate to the Hub">
      Use one of the three <a href="/guides/accounts-section#linking-accounts">Linking Account Methods</a> to access the Hub.
    </Step>

    <Step title="Fill out the fields">
      Fill out the following fields using details from your provider:

      <ul>
        <li><strong>Subdomain</strong></li>
        <li><strong>Client Id</strong></li>
        <li><strong>Client Secret</strong></li>
        <li><strong>Scope</strong> (Optional)</li>
      </ul>
    </Step>

    <Step title="Connect">
      <ul>
        <li>Click <strong>Connect</strong></li>
        <li>If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider's authorization flow.</li>
        <li>Once authorization is successful, you will see a confirmation popup</li>
      </ul>
    </Step>
  </Steps>

  <p>If the account linking is successful, you will see the newly linked account in your <a href="/guides/accounts-section">Accounts</a> page.</p>
</div>