Skip to content
Dashboard
Theme
Theme

Confirm step of a directory source connect link

GET /v1/directory_sources/oauth/confirm: Confirm step of a directory source connect link.

View Markdown

GET /v1/directory_sources/oauth/confirm

The authorization_url of a Connect Gusto, BambooHR or Google start. It shows a page naming the organization and environment the directory grant will attach to, with a Continue button. It never redirects to the provider. It sets a short-lived HttpOnly, SameSite=Strict cookie that the form posts back with. An unknown, expired or used state answers directory_source_oauth_state_invalid (400): an HTML page for a browser, JSON otherwise.

Scope
public
Auth
None
Since
1.1
  • state string

    max length 256

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • 200 The confirm page.
  • 400 <a href="/errors/directory_source_oauth_state_invalid/">directory_source_oauth_state_invalid</a>. Error
  • 429 Code: rate_limited. Retry-After is set. Error
  • 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
  • default Any other error, including internal_error. Every code is in the error catalogue. Error

Errors share one shape; see the error code catalogue.

curl -X GET \
"https://api.ohauthcat.com/v1/directory_sources/oauth/confirm"

Response 200: no body.