Skip to content

feat(directory-sync): support on-demand directory syncing - #1713

Draft
katie-west wants to merge 1 commit into
mainfrom
katie/feat-3084-directory-sync-api
Draft

katie-west wants to merge 1 commit into
mainfrom
katie/feat-3084-directory-sync-api

Conversation

@katie-west

Copy link
Copy Markdown

Why

I added workos.directorySync.syncDirectory(id) so Node applications can request an on-demand directory sync through the public API.

  • It returns the typed queued response from HTTP 202 and uses the existing SDK error classes, including RateLimitExceededException.retryAfter for cooldowns.
  • The method is provider-neutral; the API initially supports Google Workspace. Acceptance does not mean the pull has completed.
  • Existing directory types, serializers, and methods remain unchanged.

Not covered by CI

  • Release after the public endpoint is deployed and verify against a configured Google Workspace directory.
  • Confirm the API reference's Node example calls syncDirectory(id) and explains queued versus completed.

Proof

No live Google Workspace request captured. Before release, call the method with a linked directory, inspect the queued result, and confirm a subsequent real pull completes. Repeated calls should expose the existing conflict or rate-limit exceptions, not another success response.

Fixes FEAT-3084

@linear-code

linear-code Bot commented Sep 25, 2026

Copy link
Copy Markdown

FEAT-3084

@katie-west

Copy link
Copy Markdown
Author

Coordinated draft set: API/docs https://github.com/workos/workos/pull/74202 and SDK generation policy workos/openapi-spec#193. Keep releases after the API deployment. The API draft contains the full companion list; no SDK packages have been published.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant