# Save the credentials of a pulled directory source

<div class="api-op" data-api-operation>
<div class="api-op__main">

<p class="api-endpoint"><span class="method method-put">PUT</span> <code>/v1/directories/&#123;dir&#125;/source</code></p>

Checks the credentials with one read call to the source, then stores them sealed and schedules a sync now; the worker then polls every 5 minutes, backing off up to an hour after failures. `bamboohr` takes no pasted credentials: it connects only through POST /v1/directories/&#123;dir&#125;/source/oauth/start (Connect BambooHR), and a PUT answers `directory_source_method_unavailable`. `rippling_hris`: `api_token`. `google_admin_sdk` (Google Workspace) takes no pasted credentials either: it connects only through Connect Google (POST /v1/directories/&#123;dir&#125;/source/oauth/start), and a PUT answers `directory_source_method_unavailable`. `workday`: `report_url` (an https RaaS report URL on a workday.com or myworkday.com host, JSON format, with columns employee_id, email, first_name, last_name and optional title, department, manager_id, active), `username` and `password` of the integration system user. `hibob`: `service_user_id`, `token`. `personio`: `client_id`, `client_secret`. `gusto`: `access_token`, `company_id` (legacy: a pasted access token expires and is never refreshed; connect Gusto with POST /v1/directories/&#123;dir&#125;/source/oauth/start instead). `sftp_csv`: `host`, optional `port` (default 22), `username`, `host_key_fingerprint` (required; the server's SHA256 host key fingerprint as `ssh-keygen -l` prints it; the first connection never trusts an unknown key), `path` (an absolute file path; the last segment may be a glob, and the newest matching file is read), and `private_key` (an OpenSSH or PEM Ed25519 or RSA key) unless a key pair was generated with POST /v1/directories/&#123;dir&#125;/source/ssh_key, whose private key is then used. The file is parsed and applied with the CSV import rules (10 MiB, 50,000 users). Only public addresses are reached. Optional `sync_interval_minutes` (5 to 1440) sets the poll interval. Refused or malformed credentials answer `directory_source_credentials_invalid`, an unreachable source `directory_source_unavailable`; nothing is stored then. A directory of another provider answers `directory_source_mismatch`.

<dl class="api-facts"><div><dt>Scope</dt><dd><code>directories:write</code></dd></div><div><dt>Auth</dt><dd>Secret key (<code>sk_…</code>)</dd></div><div><dt>Since</dt><dd>1.0</dd></div></dl>

## Path parameters

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">dir</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>
</li>
</ul>

## Headers

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">OhAuthCat-Version</code> <span class="api-field__type">string</span></p>
Minor version; defaults to the environment's pin.
</li>
</ul>

## Request body

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">credentials</code> <span class="api-field__type">object</span> <span class="api-field__required">Required</span></p>
The source's credentials (see the operation); never returned or logged.
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">sync_interval_minutes</code> <span class="api-field__type">integer</span></p>
Minutes between successful polls; default 5.

<p class="api-field__chips">min 5 · max 1440</p>
</li>
</ul>

## Responses

<ul class="api-responses">
<li class="api-response"><span class="api-status api-status--ok">200</span> <span>OK <span class="api-field__type">DirectorySource</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">400</span> <span>Invalid request. Codes: <a href="/errors/parameter_invalid/">parameter_invalid</a>, <a href="/errors/parameter_missing/">parameter_missing</a>, <a href="/errors/version_unsupported/">version_unsupported</a> and resource-specific codes from the catalogue. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">401</span> <span>Codes: <a href="/errors/authentication_required/">authentication_required</a>, <a href="/errors/api_key_invalid/">api_key_invalid</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">403</span> <span>Codes: <a href="/errors/api_key_scope_missing/">api_key_scope_missing</a>, <a href="/errors/ip_not_allowed/">ip_not_allowed</a>, <a href="/errors/plan_limit_reached/">plan_limit_reached</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">404</span> <span>Code: <a href="/errors/resource_not_found/">resource_not_found</a> (also returned for other tenants' IDs); a path no endpoint serves answers <a href="/errors/route_not_found/">route_not_found</a>. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">409</span> <span>Codes: <a href="/errors/idempotency_key_reused/">idempotency_key_reused</a> and resource-specific conflicts. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">429</span> <span>Code: <a href="/errors/rate_limited/">rate_limited</a>. Retry-After is set. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">503</span> <span>Code: <a href="/errors/service_unavailable/">service_unavailable</a>. Retry-After is set; writes are paused. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--neutral">default</span> <span>Any other error, including <a href="/errors/internal_error/">internal_error</a>. Every code is in the error catalogue. <span class="api-field__type">Error</span></span></li>
</ul>

Errors share one shape; see the [error code catalogue](/errors/).

</div>
<div class="api-op__code">

**curl**

```sh wrap
curl -X PUT \
  "https://api.ohauthcat.com/v1/directories/dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/source" \
  -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "credentials": {}
}'
```

**Node**

```javascript wrap
const response = await fetch(
  "https://api.ohauthcat.com/v1/directories/dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/source",
  {
    method: "PUT",
    headers: {
      Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      credentials: {},
    }),
  },
);
const data = await response.json();
```

**Python**

```python wrap
import os
import requests

response = requests.put(
    "https://api.ohauthcat.com/v1/directories/dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/source",
    headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},
    json={
        "credentials": {},
    },
)
data = response.json()
```

```json title="Response 200" wrap
{
  "object": "directory_source",
  "directory_id": "dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
  "kind": "bamboohr",
  "next_sync_at": "2026-01-15T09:30:00Z",
  "last_synced_at": "2026-01-15T09:30:00Z",
  "last_error": "saml_signature_invalid",
  "failures": 1,
  "sync_interval_minutes": 1,
  "last_result": {},
  "last_skipped": [
    {
      "external_id": "acme-123",
      "name": "Acme Corp",
      "reason": "no_id"
    }
  ]
}
```

</div>
</div>
