Skip to content
Dashboard
Theme
Theme

Start connecting a directory source through OAuth

POST /v1/directories/{dir}/source/oauth/start: Start connecting a directory source through OAuth.

View Markdown

POST /v1/directories/{dir}/source/oauth/start

Starts the OAuth connection of a gusto, bamboohr or google_admin_sdk directory through the OhAuthCat app of that provider (provider google for google_admin_sdk: Connect Google). Gusto: authorization code with a PKCE S256 challenge. Google: authorization code with PKCE S256 at accounts.google.com, access_type=offline, prompt=consent, scopes openid, email and the Admin SDK Directory user, group and group member read-only scopes; optional domain is only the hd hint. Google Workspace has no service-account key connection. BambooHR: authorization code on the company’s domain (subdomain is required), scopes openid, email, offline_access, employee, employee:name, employee:job, employee:contact and employee_directory; BambooHR documents no PKCE, so none is sent. BambooHR has no API-key connection. Send the IT admin’s browser to authorization_url within 30 minutes: it is the OhAuthCat confirm page (GET /v1/directory_sources/oauth/confirm), which names the organization and environment and continues to the provider only after the person presses Continue; a callback for a flow that was never confirmed answers directory_source_oauth_confirm_required. For Google, the approving Workspace domain (hd) must be a verified domain of the directory’s organization, else directory_source_oauth_domain_unverified and nothing is stored. Gusto returns to the OhAuthCat callback, which exchanges the code, stores the tokens sealed, saves the source and redirects to return_url with ohauthcat_oauth set to connected, choose_company or error (with error_code) and directory_id. The state is bound to this environment and directory and works once. Answers service_unavailable when the Gusto OAuth app is not configured; a directory of another provider answers directory_source_mismatch.

Scope
directories:write
Auth
Secret key (sk_…)
Since
1.0
  • dir string Required

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • return_url string (uri) Required

    Where the callback sends the browser afterwards: an https URL (http only for localhost in local deployments), without a fragment.

    max length 2000

  • subdomain string

    Required for a bamboohr directory: the company’s BambooHR domain, the part before .bamboohr.com. BambooHR’s sign-in page is on that domain. Ignored for gusto and google_admin_sdk.

  • domain string

    Optional for a google_admin_sdk directory: the Google Workspace domain, sent to Google only as the hd sign-in hint. Never trusted for identity: the Workspace domain is taken from the verified ID token. Ignored for other providers.

    max length 253

Errors share one shape; see the error code catalogue.

curl -X POST \
"https://api.ohauthcat.com/v1/directories/dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/source/oauth/start" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"return_url": "https://app.acme.com/callback"
}'
Response 201
{
"object": "directory_source_oauth_start",
"directory_id": "dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"provider": "gusto",
"authorization_url": "https://app.acme.com/callback",
"expires_at": "2026-01-15T09:30:00Z"
}