> ## 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.

# Oyster HR OAuth 2.0 connector profile – StackOne setup guide

> Set up the OAuth 2.0 connector profile for Oyster HR in StackOne. One-time admin setup required before your users can link Oyster HR accounts via Hub.

<section data-guide-section data-guide-scopes="">
  <h2>Create an Oyster Developer App</h2>

  <p>Create a Developer App in the Oyster Developer Portal to obtain your OAuth credentials. Create the app from the same environment (Production or Sandbox) you intend to use in StackOne.</p>

  <Steps>
    <Step title="Sign in to OysterHR">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Sign in to your OysterHR account using the URL for your environment.</p>

        <ul>
          <li>For the <strong>Production</strong> environment, sign in at <a href="https://app.oysterhr.com" target="_blank" rel="noopener noreferrer">[https://app.oysterhr.com](https://app.oysterhr.com)</a>.</li>
          <li>For the <strong>Sandbox</strong> environment, sign in at <a href="https://sandbox.oysterhr.com/users/sign_in" target="_blank" rel="noopener noreferrer">[https://sandbox.oysterhr.com/users/sign\_in](https://sandbox.oysterhr.com/users/sign_in)</a>.</li>
        </ul>
      </div>
    </Step>

    <Step title="Navigate to Developer Portal">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Navigate to the Developer section to create a new application.</p>

        <ul>
          <li>In the sidebar, navigate to <strong>Company</strong> → <strong>Developer</strong>.</li>
          <li>Click <strong>Create new Developer Application</strong>.</li>
        </ul>
      </div>
    </Step>

    <Step title="Create a new Developer App">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Fill in the application details. The <strong>Name</strong> field is required to create the application successfully.</p>

        <ul>
          <li>Enter a <strong>Name</strong> (e.g., StackOne Integration).</li>
          <li>Optionally enter a <strong>Description</strong>.</li>
          <li>Set the <strong>Redirect URL</strong> to `https://api.stackone.com/connect/oauth2/oysterhr/callback`.</li>
          <li>Under <strong>Permissions</strong>, select the permissions required for your integration.</li>
          <li>⚠️ Important: The first permission — <strong>Read all information on the Oyster Platform</strong> — is mandatorily required in order to connect the account successfully.</li>
          <li>Accept the <strong>Developer Terms of Service</strong>.</li>
          <li>Click <strong>Submit</strong>.</li>
        </ul>
      </div>
    </Step>

    <Step title="Copy Client ID and Client Secret">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>After clicking Save, the <strong>Client ID</strong> and <strong>Client Secret</strong> will be shown in the dialog. Store them securely as they won't be shown again.</p>
      </div>
    </Step>

    <Step title="Copy Authorization URL">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>After successful creation, the application will appear in the Applications table.</p>

        <ul>
          <li>Find your application in the table and click the <strong>Copy</strong> button next to the <strong>Authorization URL</strong>.</li>
        </ul>
      </div>
    </Step>
  </Steps>
</section>

<section data-guide-section data-guide-scopes="">
  <h2>Select Environment</h2>

  <p>In the StackOne connector profile, select the environment matching your Oyster HR account.</p>

  <Steps>
    <Step title="Choose your environment">
      <div data-guide-step data-guide-scopes="" data-guide-display-scopes-list="">
        <p>Select the environment that corresponds to the Oyster HR account you signed into.</p>

        <ul>
          <li>Select <strong>Production</strong> if you are connecting to a live Oyster HR account.</li>
          <li>Select <strong>Sandbox</strong> if you are connecting to a sandbox account for testing.</li>
        </ul>
      </div>
    </Step>
  </Steps>
</section>

## Creating the StackOne Connector Profile

To create the Connector Profile in StackOne for <strong>Oyster HR</strong>:

<Steps>
  <Step title="Navigate to Connector Profiles">
    Login to StackOne and navigate to [Connector Profiles](https://app.stackone.com/connector_profiles)
  </Step>

  <Step title="Create New Connector Profile">
    <ul>
      <li>Click <strong>+ Connector Profile</strong></li>
      <li>Search for and select <strong>Oyster HR</strong></li>
      <li>Select <strong>Type</strong> as <strong>OAuth 2.0</strong></li>

      <li>
        Fill out the fields using details retrieved from your provider:

        <ul style={{ marginLeft: '20px' }}>
          <li><strong>Client ID</strong></li>
          <li><strong>Client Secret</strong></li>
          <li><strong>Authorization URL</strong></li>
        </ul>
      </li>

      <li>(Optional) Select <strong>Actions</strong> to be enabled for this Connector Profile</li>
      <li>Click <strong>Create profile</strong></li>
    </ul>
  </Step>
</Steps>

Congratulations! The new Connector Profile will now show up in your project ready to be used. You can now continue to <a href="/guides/accounts-section#linking-accounts">Link Accounts</a> for <strong>Oyster HR</strong>.