@workos/mcp-docs-server 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (455) hide show
  1. package/.docs/organized/changelogs/workos-platform.json +277 -0
  2. package/.docs/organized/docs/admin-portal/_navigation.mdx +16 -0
  3. package/.docs/organized/docs/admin-portal/custom-branding.mdx +111 -0
  4. package/.docs/organized/docs/admin-portal/example-apps.mdx +46 -0
  5. package/.docs/organized/docs/admin-portal/index.mdx +240 -0
  6. package/.docs/organized/docs/audit-logs/_navigation.mdx +22 -0
  7. package/.docs/organized/docs/audit-logs/admin-portal.mdx +20 -0
  8. package/.docs/organized/docs/audit-logs/editing-events.mdx +27 -0
  9. package/.docs/organized/docs/audit-logs/exporting-events.mdx +29 -0
  10. package/.docs/organized/docs/audit-logs/index.mdx +110 -0
  11. package/.docs/organized/docs/audit-logs/log-streams.mdx +56 -0
  12. package/.docs/organized/docs/audit-logs/metadata-schema.mdx +21 -0
  13. package/.docs/organized/docs/custom-domains/_navigation.mdx +16 -0
  14. package/.docs/organized/docs/custom-domains/admin-portal.mdx +38 -0
  15. package/.docs/organized/docs/custom-domains/auth-api.mdx +59 -0
  16. package/.docs/organized/docs/custom-domains/authkit.mdx +36 -0
  17. package/.docs/organized/docs/custom-domains/email.mdx +41 -0
  18. package/.docs/organized/docs/custom-domains/index.mdx +19 -0
  19. package/.docs/organized/docs/dashboard.mdx +244 -0
  20. package/.docs/organized/docs/demo/_navigation.mdx +26 -0
  21. package/.docs/organized/docs/demo/accordion.mdx +34 -0
  22. package/.docs/organized/docs/demo/checklist.mdx +33 -0
  23. package/.docs/organized/docs/demo/code-block.mdx +185 -0
  24. package/.docs/organized/docs/demo/definition-list.mdx +35 -0
  25. package/.docs/organized/docs/demo/index.mdx +7 -0
  26. package/.docs/organized/docs/demo/punctuation.mdx +37 -0
  27. package/.docs/organized/docs/demo/replacements.mdx +26 -0
  28. package/.docs/organized/docs/demo/table.mdx +26 -0
  29. package/.docs/organized/docs/demo/tabs.mdx +17 -0
  30. package/.docs/organized/docs/directory-sync/_navigation.mdx +28 -0
  31. package/.docs/organized/docs/directory-sync/attributes.mdx +209 -0
  32. package/.docs/organized/docs/directory-sync/example-apps.mdx +46 -0
  33. package/.docs/organized/docs/directory-sync/handle-inactive-users.mdx +52 -0
  34. package/.docs/organized/docs/directory-sync/identity-provider-role-assignment.mdx +134 -0
  35. package/.docs/organized/docs/directory-sync/index.mdx +107 -0
  36. package/.docs/organized/docs/directory-sync/quick-start.mdx +129 -0
  37. package/.docs/organized/docs/directory-sync/understanding-events.mdx +209 -0
  38. package/.docs/organized/docs/domain-verification/_navigation.mdx +10 -0
  39. package/.docs/organized/docs/domain-verification/api.mdx +60 -0
  40. package/.docs/organized/docs/domain-verification/index.mdx +67 -0
  41. package/.docs/organized/docs/email.mdx +109 -0
  42. package/.docs/organized/docs/events/_navigation.mdx +22 -0
  43. package/.docs/organized/docs/events/data-syncing/data-reconciliation.mdx +56 -0
  44. package/.docs/organized/docs/events/data-syncing/events-api.mdx +114 -0
  45. package/.docs/organized/docs/events/data-syncing/index.mdx +66 -0
  46. package/.docs/organized/docs/events/data-syncing/webhooks.mdx +173 -0
  47. package/.docs/organized/docs/events/index.mdx +783 -0
  48. package/.docs/organized/docs/events/observability/datadog.mdx +76 -0
  49. package/.docs/organized/docs/fga/_navigation.mdx +64 -0
  50. package/.docs/organized/docs/fga/identity-provider-sessions.mdx +68 -0
  51. package/.docs/organized/docs/fga/index.mdx +60 -0
  52. package/.docs/organized/docs/fga/local-development.mdx +155 -0
  53. package/.docs/organized/docs/fga/modeling/abac.mdx +107 -0
  54. package/.docs/organized/docs/fga/modeling/blocklist.mdx +84 -0
  55. package/.docs/organized/docs/fga/modeling/conditional-roles.mdx +99 -0
  56. package/.docs/organized/docs/fga/modeling/custom-roles.mdx +90 -0
  57. package/.docs/organized/docs/fga/modeling/entitlements.mdx +127 -0
  58. package/.docs/organized/docs/fga/modeling/managed-service-provider.mdx +131 -0
  59. package/.docs/organized/docs/fga/modeling/org-roles-and-permissions.mdx +95 -0
  60. package/.docs/organized/docs/fga/modeling/policy-context.mdx +231 -0
  61. package/.docs/organized/docs/fga/modeling/public-access.mdx +61 -0
  62. package/.docs/organized/docs/fga/modeling/shareable-content.mdx +106 -0
  63. package/.docs/organized/docs/fga/modeling/superusers.mdx +74 -0
  64. package/.docs/organized/docs/fga/modeling/user-groups.mdx +92 -0
  65. package/.docs/organized/docs/fga/operations-usage.mdx +104 -0
  66. package/.docs/organized/docs/fga/playground.mdx +12 -0
  67. package/.docs/organized/docs/fga/policies.mdx +462 -0
  68. package/.docs/organized/docs/fga/query-language.mdx +112 -0
  69. package/.docs/organized/docs/fga/quick-start.mdx +174 -0
  70. package/.docs/organized/docs/fga/resources.mdx +92 -0
  71. package/.docs/organized/docs/fga/schema-management.mdx +224 -0
  72. package/.docs/organized/docs/fga/schema.mdx +388 -0
  73. package/.docs/organized/docs/fga/warrant-tokens.mdx +44 -0
  74. package/.docs/organized/docs/fga/warrants.mdx +92 -0
  75. package/.docs/organized/docs/glossary.mdx +184 -0
  76. package/.docs/organized/docs/integrations/_navigation.mdx +6 -0
  77. package/.docs/organized/docs/integrations/access-people-hr.mdx +87 -0
  78. package/.docs/organized/docs/integrations/adp-oidc.mdx +103 -0
  79. package/.docs/organized/docs/integrations/apple.mdx +169 -0
  80. package/.docs/organized/docs/integrations/auth0-directory-sync.mdx +78 -0
  81. package/.docs/organized/docs/integrations/auth0-enterprise-connection.mdx +92 -0
  82. package/.docs/organized/docs/integrations/auth0-saml.mdx +81 -0
  83. package/.docs/organized/docs/integrations/aws-cognito.mdx +81 -0
  84. package/.docs/organized/docs/integrations/bamboohr.mdx +90 -0
  85. package/.docs/organized/docs/integrations/breathe-hr.mdx +89 -0
  86. package/.docs/organized/docs/integrations/bubble.mdx +129 -0
  87. package/.docs/organized/docs/integrations/cas-saml.mdx +65 -0
  88. package/.docs/organized/docs/integrations/cezanne.mdx +74 -0
  89. package/.docs/organized/docs/integrations/classlink-saml.mdx +100 -0
  90. package/.docs/organized/docs/integrations/cloudflare-saml.mdx +164 -0
  91. package/.docs/organized/docs/integrations/cyberark-saml.mdx +138 -0
  92. package/.docs/organized/docs/integrations/cyberark-scim.mdx +100 -0
  93. package/.docs/organized/docs/integrations/duo-saml.mdx +127 -0
  94. package/.docs/organized/docs/integrations/entra-id-saml.mdx +156 -0
  95. package/.docs/organized/docs/integrations/entra-id-scim.mdx +218 -0
  96. package/.docs/organized/docs/integrations/firebase.mdx +98 -0
  97. package/.docs/organized/docs/integrations/fourth.mdx +66 -0
  98. package/.docs/organized/docs/integrations/github-oauth.mdx +85 -0
  99. package/.docs/organized/docs/integrations/gitlab-oauth.mdx +81 -0
  100. package/.docs/organized/docs/integrations/google-directory-sync.mdx +86 -0
  101. package/.docs/organized/docs/integrations/google-oauth.mdx +173 -0
  102. package/.docs/organized/docs/integrations/google-saml.mdx +135 -0
  103. package/.docs/organized/docs/integrations/hibob.mdx +98 -0
  104. package/.docs/organized/docs/integrations/jumpcloud-saml.mdx +96 -0
  105. package/.docs/organized/docs/integrations/jumpcloud-scim.mdx +106 -0
  106. package/.docs/organized/docs/integrations/keycloak-saml.mdx +128 -0
  107. package/.docs/organized/docs/integrations/lastpass-saml.mdx +134 -0
  108. package/.docs/organized/docs/integrations/linkedin-oauth.mdx +77 -0
  109. package/.docs/organized/docs/integrations/login-gov-oidc.mdx +103 -0
  110. package/.docs/organized/docs/integrations/microsoft-ad-fs-saml.mdx +96 -0
  111. package/.docs/organized/docs/integrations/microsoft-oauth.mdx +101 -0
  112. package/.docs/organized/docs/integrations/miniorange-saml.mdx +124 -0
  113. package/.docs/organized/docs/integrations/net-iq-saml.mdx +75 -0
  114. package/.docs/organized/docs/integrations/next-auth.mdx +257 -0
  115. package/.docs/organized/docs/integrations/oidc.mdx +64 -0
  116. package/.docs/organized/docs/integrations/okta-saml.mdx +144 -0
  117. package/.docs/organized/docs/integrations/okta-scim.mdx +210 -0
  118. package/.docs/organized/docs/integrations/onelogin-saml.mdx +131 -0
  119. package/.docs/organized/docs/integrations/onelogin-scim.mdx +150 -0
  120. package/.docs/organized/docs/integrations/oracle-saml.mdx +76 -0
  121. package/.docs/organized/docs/integrations/pingfederate-saml.mdx +103 -0
  122. package/.docs/organized/docs/integrations/pingfederate-scim.mdx +150 -0
  123. package/.docs/organized/docs/integrations/pingone-saml.mdx +86 -0
  124. package/.docs/organized/docs/integrations/react-native-expo.mdx +93 -0
  125. package/.docs/organized/docs/integrations/rippling-saml.mdx +174 -0
  126. package/.docs/organized/docs/integrations/rippling-scim.mdx +148 -0
  127. package/.docs/organized/docs/integrations/salesforce-saml.mdx +143 -0
  128. package/.docs/organized/docs/integrations/saml.mdx +64 -0
  129. package/.docs/organized/docs/integrations/scim.mdx +64 -0
  130. package/.docs/organized/docs/integrations/sftp.mdx +150 -0
  131. package/.docs/organized/docs/integrations/shibboleth-generic-saml.mdx +84 -0
  132. package/.docs/organized/docs/integrations/shibboleth-unsolicited-saml.mdx +84 -0
  133. package/.docs/organized/docs/integrations/simple-saml-php.mdx +78 -0
  134. package/.docs/organized/docs/integrations/slack-oauth.mdx +102 -0
  135. package/.docs/organized/docs/integrations/supabase.mdx +68 -0
  136. package/.docs/organized/docs/integrations/vmware-saml.mdx +100 -0
  137. package/.docs/organized/docs/integrations/workday.mdx +156 -0
  138. package/.docs/organized/docs/integrations/xero-oauth.mdx +83 -0
  139. package/.docs/organized/docs/magic-link/_navigation.mdx +16 -0
  140. package/.docs/organized/docs/magic-link/example-apps.mdx +46 -0
  141. package/.docs/organized/docs/magic-link/index.mdx +199 -0
  142. package/.docs/organized/docs/magic-link/launch-checklist.mdx +27 -0
  143. package/.docs/organized/docs/mfa/_navigation.mdx +18 -0
  144. package/.docs/organized/docs/mfa/example-apps.mdx +46 -0
  145. package/.docs/organized/docs/mfa/index.mdx +140 -0
  146. package/.docs/organized/docs/mfa/ux/enrollment.mdx +74 -0
  147. package/.docs/organized/docs/mfa/ux/sign-in.mdx +30 -0
  148. package/.docs/organized/docs/migrate/_navigation.mdx +6 -0
  149. package/.docs/organized/docs/migrate/auth0.mdx +98 -0
  150. package/.docs/organized/docs/migrate/aws-cognito.mdx +115 -0
  151. package/.docs/organized/docs/migrate/clerk.mdx +106 -0
  152. package/.docs/organized/docs/migrate/firebase.mdx +80 -0
  153. package/.docs/organized/docs/migrate/other-services.mdx +179 -0
  154. package/.docs/organized/docs/migrate/standalone-sso.mdx +105 -0
  155. package/.docs/organized/docs/on-prem-deployment.mdx +119 -0
  156. package/.docs/organized/docs/postman.mdx +90 -0
  157. package/.docs/organized/docs/reference/_navigation.mdx +527 -0
  158. package/.docs/organized/docs/reference/admin-portal/index.mdx +6 -0
  159. package/.docs/organized/docs/reference/admin-portal/portal-link/generate.mdx +268 -0
  160. package/.docs/organized/docs/reference/admin-portal/portal-link/index.mdx +15 -0
  161. package/.docs/organized/docs/reference/admin-portal/provider-icons/index.mdx +52 -0
  162. package/.docs/organized/docs/reference/api-keys.mdx +22 -0
  163. package/.docs/organized/docs/reference/audit-logs/audit-log-export.mdx +239 -0
  164. package/.docs/organized/docs/reference/audit-logs/audit-log-schema.mdx +69 -0
  165. package/.docs/organized/docs/reference/audit-logs/create-event.mdx +673 -0
  166. package/.docs/organized/docs/reference/audit-logs/create-export.mdx +308 -0
  167. package/.docs/organized/docs/reference/audit-logs/create-schema.mdx +95 -0
  168. package/.docs/organized/docs/reference/audit-logs/get-export.mdx +117 -0
  169. package/.docs/organized/docs/reference/audit-logs/get-retention.mdx +34 -0
  170. package/.docs/organized/docs/reference/audit-logs/index.mdx +6 -0
  171. package/.docs/organized/docs/reference/audit-logs/list-actions.mdx +40 -0
  172. package/.docs/organized/docs/reference/audit-logs/list-schemas.mdx +40 -0
  173. package/.docs/organized/docs/reference/audit-logs/set-retention.mdx +39 -0
  174. package/.docs/organized/docs/reference/client-libraries.mdx +19 -0
  175. package/.docs/organized/docs/reference/directory-sync/directory/delete.mdx +90 -0
  176. package/.docs/organized/docs/reference/directory-sync/directory/get.mdx +105 -0
  177. package/.docs/organized/docs/reference/directory-sync/directory/index.mdx +385 -0
  178. package/.docs/organized/docs/reference/directory-sync/directory/list.mdx +281 -0
  179. package/.docs/organized/docs/reference/directory-sync/directory-group/get.mdx +105 -0
  180. package/.docs/organized/docs/reference/directory-sync/directory-group/index.mdx +277 -0
  181. package/.docs/organized/docs/reference/directory-sync/directory-group/list.mdx +295 -0
  182. package/.docs/organized/docs/reference/directory-sync/directory-user/get.mdx +112 -0
  183. package/.docs/organized/docs/reference/directory-sync/directory-user/index.mdx +470 -0
  184. package/.docs/organized/docs/reference/directory-sync/directory-user/list.mdx +304 -0
  185. package/.docs/organized/docs/reference/directory-sync/index.mdx +10 -0
  186. package/.docs/organized/docs/reference/domain-verification/create.mdx +38 -0
  187. package/.docs/organized/docs/reference/domain-verification/get.mdx +32 -0
  188. package/.docs/organized/docs/reference/domain-verification/index.mdx +84 -0
  189. package/.docs/organized/docs/reference/domain-verification/verify.mdx +36 -0
  190. package/.docs/organized/docs/reference/errors.mdx +30 -0
  191. package/.docs/organized/docs/reference/events/index.mdx +9 -0
  192. package/.docs/organized/docs/reference/events/list.mdx +246 -0
  193. package/.docs/organized/docs/reference/fga/batch-check.mdx +277 -0
  194. package/.docs/organized/docs/reference/fga/check.mdx +563 -0
  195. package/.docs/organized/docs/reference/fga/index.mdx +6 -0
  196. package/.docs/organized/docs/reference/fga/policy/create.mdx +27 -0
  197. package/.docs/organized/docs/reference/fga/policy/delete.mdx +18 -0
  198. package/.docs/organized/docs/reference/fga/policy/get.mdx +23 -0
  199. package/.docs/organized/docs/reference/fga/policy/index.mdx +52 -0
  200. package/.docs/organized/docs/reference/fga/policy/list.mdx +41 -0
  201. package/.docs/organized/docs/reference/fga/policy/update.mdx +26 -0
  202. package/.docs/organized/docs/reference/fga/query.mdx +375 -0
  203. package/.docs/organized/docs/reference/fga/resource/batch-write.mdx +175 -0
  204. package/.docs/organized/docs/reference/fga/resource/create.mdx +130 -0
  205. package/.docs/organized/docs/reference/fga/resource/delete.mdx +86 -0
  206. package/.docs/organized/docs/reference/fga/resource/get.mdx +88 -0
  207. package/.docs/organized/docs/reference/fga/resource/index.mdx +98 -0
  208. package/.docs/organized/docs/reference/fga/resource/list.mdx +188 -0
  209. package/.docs/organized/docs/reference/fga/resource/update.mdx +115 -0
  210. package/.docs/organized/docs/reference/fga/resource-type/apply.mdx +35 -0
  211. package/.docs/organized/docs/reference/fga/resource-type/create.mdx +24 -0
  212. package/.docs/organized/docs/reference/fga/resource-type/delete.mdx +22 -0
  213. package/.docs/organized/docs/reference/fga/resource-type/get.mdx +23 -0
  214. package/.docs/organized/docs/reference/fga/resource-type/index.mdx +68 -0
  215. package/.docs/organized/docs/reference/fga/resource-type/list.mdx +36 -0
  216. package/.docs/organized/docs/reference/fga/resource-type/update.mdx +23 -0
  217. package/.docs/organized/docs/reference/fga/schema/apply.mdx +42 -0
  218. package/.docs/organized/docs/reference/fga/schema/get.mdx +24 -0
  219. package/.docs/organized/docs/reference/fga/schema/index.mdx +39 -0
  220. package/.docs/organized/docs/reference/fga/warrant/batch-write.mdx +226 -0
  221. package/.docs/organized/docs/reference/fga/warrant/create.mdx +215 -0
  222. package/.docs/organized/docs/reference/fga/warrant/delete.mdx +212 -0
  223. package/.docs/organized/docs/reference/fga/warrant/index.mdx +186 -0
  224. package/.docs/organized/docs/reference/fga/warrant/list.mdx +282 -0
  225. package/.docs/organized/docs/reference/idempotency.mdx +21 -0
  226. package/.docs/organized/docs/reference/index.mdx +194 -0
  227. package/.docs/organized/docs/reference/magic-link/index.mdx +8 -0
  228. package/.docs/organized/docs/reference/magic-link/passwordless-session/create.mdx +268 -0
  229. package/.docs/organized/docs/reference/magic-link/passwordless-session/index.mdx +203 -0
  230. package/.docs/organized/docs/reference/magic-link/passwordless-session/send-email.mdx +158 -0
  231. package/.docs/organized/docs/reference/mfa/authentication-challenge.mdx +217 -0
  232. package/.docs/organized/docs/reference/mfa/authentication-factor.mdx +381 -0
  233. package/.docs/organized/docs/reference/mfa/challenge-factor.mdx +170 -0
  234. package/.docs/organized/docs/reference/mfa/delete-factor.mdx +93 -0
  235. package/.docs/organized/docs/reference/mfa/enroll-factor.mdx +241 -0
  236. package/.docs/organized/docs/reference/mfa/get-factor.mdx +108 -0
  237. package/.docs/organized/docs/reference/mfa/index.mdx +8 -0
  238. package/.docs/organized/docs/reference/mfa/verify-challenge.mdx +228 -0
  239. package/.docs/organized/docs/reference/organization/create.mdx +216 -0
  240. package/.docs/organized/docs/reference/organization/delete.mdx +89 -0
  241. package/.docs/organized/docs/reference/organization/get-by-external-id.mdx +40 -0
  242. package/.docs/organized/docs/reference/organization/get.mdx +104 -0
  243. package/.docs/organized/docs/reference/organization/index.mdx +274 -0
  244. package/.docs/organized/docs/reference/organization/list.mdx +258 -0
  245. package/.docs/organized/docs/reference/organization/update.mdx +236 -0
  246. package/.docs/organized/docs/reference/organization-domain.mdx +189 -0
  247. package/.docs/organized/docs/reference/pagination.mdx +244 -0
  248. package/.docs/organized/docs/reference/radar/attempts/create.mdx +115 -0
  249. package/.docs/organized/docs/reference/radar/attempts/index.mdx +7 -0
  250. package/.docs/organized/docs/reference/radar/attempts/update.mdx +34 -0
  251. package/.docs/organized/docs/reference/radar/index.mdx +8 -0
  252. package/.docs/organized/docs/reference/radar/lists/delete.mdx +36 -0
  253. package/.docs/organized/docs/reference/radar/lists/index.mdx +7 -0
  254. package/.docs/organized/docs/reference/radar/lists/update.mdx +36 -0
  255. package/.docs/organized/docs/reference/rate-limits.mdx +50 -0
  256. package/.docs/organized/docs/reference/roles/index.mdx +268 -0
  257. package/.docs/organized/docs/reference/roles/list-for-organization.mdx +152 -0
  258. package/.docs/organized/docs/reference/sso/connection/delete.mdx +89 -0
  259. package/.docs/organized/docs/reference/sso/connection/get.mdx +104 -0
  260. package/.docs/organized/docs/reference/sso/connection/index.mdx +388 -0
  261. package/.docs/organized/docs/reference/sso/connection/list.mdx +320 -0
  262. package/.docs/organized/docs/reference/sso/get-authorization-url/error-codes.mdx +28 -0
  263. package/.docs/organized/docs/reference/sso/get-authorization-url/index.mdx +434 -0
  264. package/.docs/organized/docs/reference/sso/get-authorization-url/redirect-uri.mdx +21 -0
  265. package/.docs/organized/docs/reference/sso/index.mdx +8 -0
  266. package/.docs/organized/docs/reference/sso/logout/authorize.mdx +47 -0
  267. package/.docs/organized/docs/reference/sso/logout/index.mdx +14 -0
  268. package/.docs/organized/docs/reference/sso/logout/redirect.mdx +32 -0
  269. package/.docs/organized/docs/reference/sso/profile/get-profile-and-token.mdx +229 -0
  270. package/.docs/organized/docs/reference/sso/profile/get-user-profile.mdx +127 -0
  271. package/.docs/organized/docs/reference/sso/profile/index.mdx +364 -0
  272. package/.docs/organized/docs/reference/testing.mdx +8 -0
  273. package/.docs/organized/docs/reference/user-management/access-token/index.mdx +13 -0
  274. package/.docs/organized/docs/reference/user-management/authentication/code.mdx +448 -0
  275. package/.docs/organized/docs/reference/user-management/authentication/email-verification.mdx +359 -0
  276. package/.docs/organized/docs/reference/user-management/authentication/get-authorization-url/error-codes.mdx +25 -0
  277. package/.docs/organized/docs/reference/user-management/authentication/get-authorization-url/index.mdx +425 -0
  278. package/.docs/organized/docs/reference/user-management/authentication/get-authorization-url/pkce.mdx +9 -0
  279. package/.docs/organized/docs/reference/user-management/authentication/get-authorization-url/redirect-uri.mdx +23 -0
  280. package/.docs/organized/docs/reference/user-management/authentication/index.mdx +66 -0
  281. package/.docs/organized/docs/reference/user-management/authentication/magic-auth.mdx +353 -0
  282. package/.docs/organized/docs/reference/user-management/authentication/organization-selection.mdx +349 -0
  283. package/.docs/organized/docs/reference/user-management/authentication/password.mdx +350 -0
  284. package/.docs/organized/docs/reference/user-management/authentication/refresh-and-seal-session-data.mdx +57 -0
  285. package/.docs/organized/docs/reference/user-management/authentication/refresh-token.mdx +381 -0
  286. package/.docs/organized/docs/reference/user-management/authentication/session-cookie.mdx +79 -0
  287. package/.docs/organized/docs/reference/user-management/authentication/totp.mdx +369 -0
  288. package/.docs/organized/docs/reference/user-management/authentication-errors/email-verification-required-error.mdx +42 -0
  289. package/.docs/organized/docs/reference/user-management/authentication-errors/index.mdx +20 -0
  290. package/.docs/organized/docs/reference/user-management/authentication-errors/mfa-challenge-error.mdx +44 -0
  291. package/.docs/organized/docs/reference/user-management/authentication-errors/mfa-enrollment-error.mdx +37 -0
  292. package/.docs/organized/docs/reference/user-management/authentication-errors/organization-authentication-required-error.mdx +68 -0
  293. package/.docs/organized/docs/reference/user-management/authentication-errors/organization-selection-error.mdx +44 -0
  294. package/.docs/organized/docs/reference/user-management/authentication-errors/sso-required-error.mdx +51 -0
  295. package/.docs/organized/docs/reference/user-management/email-verification/get.mdx +88 -0
  296. package/.docs/organized/docs/reference/user-management/email-verification/index.mdx +227 -0
  297. package/.docs/organized/docs/reference/user-management/identity/index.mdx +74 -0
  298. package/.docs/organized/docs/reference/user-management/identity/list.mdx +52 -0
  299. package/.docs/organized/docs/reference/user-management/index.mdx +13 -0
  300. package/.docs/organized/docs/reference/user-management/invitation/accept.mdx +39 -0
  301. package/.docs/organized/docs/reference/user-management/invitation/find-by-token.mdx +87 -0
  302. package/.docs/organized/docs/reference/user-management/invitation/get.mdx +87 -0
  303. package/.docs/organized/docs/reference/user-management/invitation/index.mdx +374 -0
  304. package/.docs/organized/docs/reference/user-management/invitation/list.mdx +247 -0
  305. package/.docs/organized/docs/reference/user-management/invitation/revoke.mdx +90 -0
  306. package/.docs/organized/docs/reference/user-management/invitation/send.mdx +230 -0
  307. package/.docs/organized/docs/reference/user-management/logout/get-logout-url-from-session-cookie.mdx +52 -0
  308. package/.docs/organized/docs/reference/user-management/logout/get-logout-url.mdx +147 -0
  309. package/.docs/organized/docs/reference/user-management/logout/index.mdx +26 -0
  310. package/.docs/organized/docs/reference/user-management/magic-auth/create.mdx +148 -0
  311. package/.docs/organized/docs/reference/user-management/magic-auth/get.mdx +88 -0
  312. package/.docs/organized/docs/reference/user-management/magic-auth/index.mdx +225 -0
  313. package/.docs/organized/docs/reference/user-management/mfa/authentication-challenge.mdx +194 -0
  314. package/.docs/organized/docs/reference/user-management/mfa/authentication-factor.mdx +324 -0
  315. package/.docs/organized/docs/reference/user-management/mfa/enroll-auth-factor.mdx +296 -0
  316. package/.docs/organized/docs/reference/user-management/mfa/index.mdx +5 -0
  317. package/.docs/organized/docs/reference/user-management/mfa/list-auth-factors.mdx +194 -0
  318. package/.docs/organized/docs/reference/user-management/organization-membership/create.mdx +155 -0
  319. package/.docs/organized/docs/reference/user-management/organization-membership/deactivate.mdx +106 -0
  320. package/.docs/organized/docs/reference/user-management/organization-membership/delete.mdx +76 -0
  321. package/.docs/organized/docs/reference/user-management/organization-membership/get.mdx +95 -0
  322. package/.docs/organized/docs/reference/user-management/organization-membership/index.mdx +265 -0
  323. package/.docs/organized/docs/reference/user-management/organization-membership/list.mdx +291 -0
  324. package/.docs/organized/docs/reference/user-management/organization-membership/reactivate.mdx +106 -0
  325. package/.docs/organized/docs/reference/user-management/organization-membership/update.mdx +119 -0
  326. package/.docs/organized/docs/reference/user-management/password-reset/create.mdx +108 -0
  327. package/.docs/organized/docs/reference/user-management/password-reset/get.mdx +88 -0
  328. package/.docs/organized/docs/reference/user-management/password-reset/index.mdx +227 -0
  329. package/.docs/organized/docs/reference/user-management/password-reset/reset-password.mdx +144 -0
  330. package/.docs/organized/docs/reference/user-management/session-helpers/authenticate.mdx +176 -0
  331. package/.docs/organized/docs/reference/user-management/session-helpers/get-logout-url.mdx +42 -0
  332. package/.docs/organized/docs/reference/user-management/session-helpers/index.mdx +14 -0
  333. package/.docs/organized/docs/reference/user-management/session-helpers/load-sealed-session.mdx +105 -0
  334. package/.docs/organized/docs/reference/user-management/session-helpers/refresh.mdx +213 -0
  335. package/.docs/organized/docs/reference/user-management/session-tokens/access-token.mdx +90 -0
  336. package/.docs/organized/docs/reference/user-management/session-tokens/index.mdx +5 -0
  337. package/.docs/organized/docs/reference/user-management/session-tokens/jwks.mdx +110 -0
  338. package/.docs/organized/docs/reference/user-management/session-tokens/refresh-token.mdx +8 -0
  339. package/.docs/organized/docs/reference/user-management/user/create.mdx +327 -0
  340. package/.docs/organized/docs/reference/user-management/user/delete.mdx +76 -0
  341. package/.docs/organized/docs/reference/user-management/user/get-by-external-id.mdx +39 -0
  342. package/.docs/organized/docs/reference/user-management/user/get.mdx +103 -0
  343. package/.docs/organized/docs/reference/user-management/user/index.mdx +322 -0
  344. package/.docs/organized/docs/reference/user-management/user/list.mdx +260 -0
  345. package/.docs/organized/docs/reference/user-management/user/update.mdx +344 -0
  346. package/.docs/organized/docs/reference/vault/index.mdx +6 -0
  347. package/.docs/organized/docs/reference/vault/key/create-data-key.mdx +106 -0
  348. package/.docs/organized/docs/reference/vault/key/decrypt-data-key.mdx +84 -0
  349. package/.docs/organized/docs/reference/vault/key/decrypt-data.mdx +52 -0
  350. package/.docs/organized/docs/reference/vault/key/encrypt-data.mdx +58 -0
  351. package/.docs/organized/docs/reference/vault/key/index.mdx +25 -0
  352. package/.docs/organized/docs/reference/vault/object/create.mdx +62 -0
  353. package/.docs/organized/docs/reference/vault/object/delete.mdx +75 -0
  354. package/.docs/organized/docs/reference/vault/object/get.mdx +50 -0
  355. package/.docs/organized/docs/reference/vault/object/index.mdx +174 -0
  356. package/.docs/organized/docs/reference/vault/object/list.mdx +105 -0
  357. package/.docs/organized/docs/reference/vault/object/metadata.mdx +52 -0
  358. package/.docs/organized/docs/reference/vault/object/update.mdx +67 -0
  359. package/.docs/organized/docs/reference/vault/object/version.mdx +87 -0
  360. package/.docs/organized/docs/reference/vault/object/versions.mdx +83 -0
  361. package/.docs/organized/docs/reference/widgets/get-token.mdx +185 -0
  362. package/.docs/organized/docs/reference/widgets/index.mdx +6 -0
  363. package/.docs/organized/docs/reference/workos-connect/authorize/index.mdx +75 -0
  364. package/.docs/organized/docs/reference/workos-connect/index.mdx +33 -0
  365. package/.docs/organized/docs/reference/workos-connect/introspection/index.mdx +122 -0
  366. package/.docs/organized/docs/reference/workos-connect/metadata/index.mdx +25 -0
  367. package/.docs/organized/docs/reference/workos-connect/metadata/oauth-authorization-server/index.mdx +99 -0
  368. package/.docs/organized/docs/reference/workos-connect/metadata/openid-configuration/index.mdx +70 -0
  369. package/.docs/organized/docs/reference/workos-connect/token/authorization-code-grant/access-token.mdx +53 -0
  370. package/.docs/organized/docs/reference/workos-connect/token/authorization-code-grant/id-token.mdx +60 -0
  371. package/.docs/organized/docs/reference/workos-connect/token/authorization-code-grant/index.mdx +69 -0
  372. package/.docs/organized/docs/reference/workos-connect/token/client-credentials-grant/access-token.mdx +46 -0
  373. package/.docs/organized/docs/reference/workos-connect/token/client-credentials-grant/index.mdx +56 -0
  374. package/.docs/organized/docs/reference/workos-connect/token/index.mdx +39 -0
  375. package/.docs/organized/docs/reference/workos-connect/token/refresh-token-grant.mdx +69 -0
  376. package/.docs/organized/docs/reference/workos-connect/userinfo/index.mdx +46 -0
  377. package/.docs/organized/docs/sdks/dotnet.mdx +6 -0
  378. package/.docs/organized/docs/sdks/elixir.mdx +6 -0
  379. package/.docs/organized/docs/sdks/go.mdx +6 -0
  380. package/.docs/organized/docs/sdks/java.mdx +9 -0
  381. package/.docs/organized/docs/sdks/laravel.mdx +6 -0
  382. package/.docs/organized/docs/sdks/node.mdx +9 -0
  383. package/.docs/organized/docs/sdks/php.mdx +6 -0
  384. package/.docs/organized/docs/sdks/python.mdx +6 -0
  385. package/.docs/organized/docs/sdks/ruby.mdx +9 -0
  386. package/.docs/organized/docs/sso/_navigation.mdx +44 -0
  387. package/.docs/organized/docs/sso/_sequence-diagrams/saml-protocol-security-considerations.md +59 -0
  388. package/.docs/organized/docs/sso/attributes.mdx +110 -0
  389. package/.docs/organized/docs/sso/domains.mdx +111 -0
  390. package/.docs/organized/docs/sso/example-apps.mdx +46 -0
  391. package/.docs/organized/docs/sso/identity-provider-role-assignment.mdx +113 -0
  392. package/.docs/organized/docs/sso/index.mdx +295 -0
  393. package/.docs/organized/docs/sso/it-team-faq.mdx +35 -0
  394. package/.docs/organized/docs/sso/jit-provisioning.mdx +101 -0
  395. package/.docs/organized/docs/sso/launch-checklist.mdx +71 -0
  396. package/.docs/organized/docs/sso/login-flows.mdx +101 -0
  397. package/.docs/organized/docs/sso/redirect-uris.mdx +44 -0
  398. package/.docs/organized/docs/sso/saml-security.mdx +122 -0
  399. package/.docs/organized/docs/sso/signing-certificates.mdx +121 -0
  400. package/.docs/organized/docs/sso/single-logout.mdx +45 -0
  401. package/.docs/organized/docs/sso/test-sso.mdx +73 -0
  402. package/.docs/organized/docs/sso/ux/sign-in.mdx +44 -0
  403. package/.docs/organized/docs/user-management/_navigation.mdx +87 -0
  404. package/.docs/organized/docs/user-management/actions.mdx +169 -0
  405. package/.docs/organized/docs/user-management/authkit.mdx +69 -0
  406. package/.docs/organized/docs/user-management/branding.mdx +143 -0
  407. package/.docs/organized/docs/user-management/connect.mdx +110 -0
  408. package/.docs/organized/docs/user-management/custom-emails.mdx +164 -0
  409. package/.docs/organized/docs/user-management/directory-provisioning.mdx +78 -0
  410. package/.docs/organized/docs/user-management/domain-verification.mdx +28 -0
  411. package/.docs/organized/docs/user-management/email-password.mdx +42 -0
  412. package/.docs/organized/docs/user-management/email-verification.mdx +29 -0
  413. package/.docs/organized/docs/user-management/entitlements.mdx +46 -0
  414. package/.docs/organized/docs/user-management/example-apps.mdx +39 -0
  415. package/.docs/organized/docs/user-management/identity-linking.mdx +52 -0
  416. package/.docs/organized/docs/user-management/impersonation.mdx +82 -0
  417. package/.docs/organized/docs/user-management/index.mdx +525 -0
  418. package/.docs/organized/docs/user-management/invitations.mdx +60 -0
  419. package/.docs/organized/docs/user-management/invite-only-signup.mdx +72 -0
  420. package/.docs/organized/docs/user-management/jit-provisioning.mdx +36 -0
  421. package/.docs/organized/docs/user-management/jwt-templates.mdx +278 -0
  422. package/.docs/organized/docs/user-management/magic-auth.mdx +36 -0
  423. package/.docs/organized/docs/user-management/mcp.mdx +146 -0
  424. package/.docs/organized/docs/user-management/metadata.mdx +119 -0
  425. package/.docs/organized/docs/user-management/mfa.mdx +32 -0
  426. package/.docs/organized/docs/user-management/migrations.mdx +20 -0
  427. package/.docs/organized/docs/user-management/modeling-your-app.mdx +149 -0
  428. package/.docs/organized/docs/user-management/organization-policies.mdx +33 -0
  429. package/.docs/organized/docs/user-management/overview.mdx +46 -0
  430. package/.docs/organized/docs/user-management/passkeys.mdx +42 -0
  431. package/.docs/organized/docs/user-management/radar.mdx +127 -0
  432. package/.docs/organized/docs/user-management/roles-and-permissions.mdx +155 -0
  433. package/.docs/organized/docs/user-management/sessions.mdx +101 -0
  434. package/.docs/organized/docs/user-management/social-login.mdx +34 -0
  435. package/.docs/organized/docs/user-management/sso-with-contractors.mdx +85 -0
  436. package/.docs/organized/docs/user-management/sso.mdx +96 -0
  437. package/.docs/organized/docs/user-management/users-organizations.mdx +91 -0
  438. package/.docs/organized/docs/user-management/widgets.mdx +190 -0
  439. package/.docs/organized/docs/vault/_navigation.mdx +14 -0
  440. package/.docs/organized/docs/vault/index.mdx +38 -0
  441. package/.docs/organized/docs/vault/key-context.mdx +32 -0
  442. package/.docs/organized/docs/vault/quick-start.mdx +82 -0
  443. package/README.md +252 -0
  444. package/dist/chunk-64GKEK6G.js +48 -0
  445. package/dist/chunk-64GKEK6G.js.map +1 -0
  446. package/dist/get-tools.d.ts +23 -0
  447. package/dist/get-tools.js +8 -0
  448. package/dist/get-tools.js.map +1 -0
  449. package/dist/index.d.ts +1 -0
  450. package/dist/index.js +552 -0
  451. package/dist/index.js.map +1 -0
  452. package/dist/prepare.d.ts +2 -0
  453. package/dist/prepare.js +269 -0
  454. package/dist/prepare.js.map +1 -0
  455. package/package.json +49 -0
@@ -0,0 +1,90 @@
1
+ ---
2
+ reference:
3
+ curl:
4
+ - key: delete_directory
5
+ id: delete_directory
6
+ url: /reference/directory-sync/directory/delete
7
+ title: '/directories/:id'
8
+ type: DELETE
9
+ parameters:
10
+ - (directory.id)
11
+ dotnet:
12
+ - key: DeleteDirectory
13
+ id: delete_directory
14
+ url: /reference/directory-sync/directory/delete
15
+ title: directorySyncService.DeleteDirectory()
16
+ parameters:
17
+ - key: id
18
+ type: string
19
+ description: (directory.id)
20
+ - (cancellationToken)
21
+ returns:
22
+ - (Task)
23
+ ruby:
24
+ - key: delete_directory
25
+ id: delete_directory
26
+ url: /reference/directory-sync/directory/delete
27
+ title: DirectorySync.delete_directory()
28
+ parameters:
29
+ - (Directory.id)
30
+ python:
31
+ - key: delete_directory
32
+ id: delete_directory
33
+ url: /reference/directory-sync/directory/delete
34
+ title: directory_sync.delete_directory()
35
+ parameters:
36
+ - key: directory_id
37
+ type: str
38
+ description: (directory.id)
39
+ js:
40
+ - key: deleteDirectory
41
+ id: delete_directory
42
+ url: /reference/directory-sync/directory/delete
43
+ title: directorySync.deleteDirectory()
44
+ parameters:
45
+ - (Directory.id)
46
+ go:
47
+ - key: DeleteDirectory
48
+ id: delete_directory
49
+ url: /reference/directory-sync/directory/delete
50
+ title: directorysync.DeleteDirectory()
51
+ parameters:
52
+ - (ctx)
53
+ - key: opts
54
+ type: directorysync.DeleteDirectoryOpts
55
+ expanded: true
56
+ properties:
57
+ - key: Directory
58
+ type: string
59
+ description: (directory.id)
60
+ returns:
61
+ - (err)
62
+ php:
63
+ - key: deleteDirectory
64
+ id: delete_directory
65
+ url: /reference/directory-sync/directory/delete
66
+ title: $ds->deleteDirectory()
67
+ parameters:
68
+ - key: directory
69
+ type: string
70
+ description: (directory.id)
71
+ java:
72
+ - key: deleteDirectory
73
+ id: delete_directory
74
+ url: /reference/directory-sync/directory/delete
75
+ title: directorySync.deleteDirectory()
76
+ parameters:
77
+ - (Directory.id)
78
+ originalPath: >-
79
+ .tmp-workos-clone/packages/docs/content/reference/directory-sync/directory/delete.mdx
80
+ ---
81
+
82
+ ## Delete a Directory
83
+
84
+ Permanently deletes an existing directory. It cannot be undone.
85
+
86
+ <CodeBlock
87
+ title="Request"
88
+ file="delete-directory-request"
89
+ referenceId="delete_directory"
90
+ />
@@ -0,0 +1,105 @@
1
+ ---
2
+ reference:
3
+ curl:
4
+ - key: get_directory
5
+ id: get_directory
6
+ url: /reference/directory-sync/directory/get
7
+ title: '/directory/:id'
8
+ type: GET
9
+ parameters:
10
+ - (directory.id)
11
+ returns:
12
+ - (directory)
13
+ dotnet:
14
+ - key: GetDirectory
15
+ id: get_directory
16
+ url: /reference/directory-sync/directory/get
17
+ title: directorySyncService.GetDirectory()
18
+ parameters:
19
+ - key: id
20
+ type: string
21
+ description: (directory.id)
22
+ - (cancellationToken)
23
+ returns:
24
+ - key: Task<Directory>
25
+ description: (directory.self)
26
+ ruby:
27
+ - key: get_directory
28
+ id: get_directory
29
+ url: /reference/directory-sync/directory/get
30
+ title: DirectorySync.get_directory()
31
+ parameters:
32
+ - (Directory.id)
33
+ returns:
34
+ - (Directory)
35
+ python:
36
+ - key: get_directory
37
+ id: get_directory
38
+ url: /reference/directory-sync/directory/get
39
+ title: directory_sync.get_directory()
40
+ parameters:
41
+ - key: directory_id
42
+ type: str
43
+ description: (directory.id)
44
+ returns:
45
+ - (Directory)
46
+ js:
47
+ - key: getDirectory
48
+ id: get_directory
49
+ url: /reference/directory-sync/directory/get
50
+ title: directorySync.getDirectory()
51
+ parameters:
52
+ - (Directory.id)
53
+ returns:
54
+ - (Directory)
55
+ go:
56
+ - key: GetDirectory
57
+ id: get_directory
58
+ url: /reference/directory-sync/directory/get
59
+ title: directorysync.GetDirectory()
60
+ parameters:
61
+ - (ctx)
62
+ - key: opts
63
+ type: directorysync.GetDirectoryOpts
64
+ expanded: true
65
+ properties:
66
+ - key: Directory
67
+ type: string
68
+ description: (directory.id)
69
+ returns:
70
+ - key: dir
71
+ type: Directory
72
+ description: (directory.self)
73
+ - (err)
74
+ php:
75
+ - key: getDirectory
76
+ id: get_directory
77
+ url: /reference/directory-sync/directory/get
78
+ title: $ds->getDirectory()
79
+ parameters:
80
+ - key: directory
81
+ type: string
82
+ description: (directory.id)
83
+ returns:
84
+ - (Directory)
85
+ java:
86
+ - key: getDirectory
87
+ id: get_directory
88
+ url: /reference/directory-sync/directory/get
89
+ title: directorySync.getDirectory()
90
+ parameters:
91
+ - (Directory.id)
92
+ returns:
93
+ - (Directory)
94
+ originalPath: >-
95
+ .tmp-workos-clone/packages/docs/content/reference/directory-sync/directory/get.mdx
96
+ ---
97
+
98
+ ## Get a Directory
99
+
100
+ Get the details of an existing directory.
101
+
102
+ <CodeBlock referenceId="get_directory">
103
+ <CodeBlockTab title="Request" file="get-directory-request" />
104
+ <CodeBlockTab title="Response" file="get-directory-response" />
105
+ </CodeBlock>
@@ -0,0 +1,385 @@
1
+ ---
2
+ descriptions:
3
+ directory:
4
+ self: 'The [Directory](/reference/directory-sync/directory) object.'
5
+ object: Distinguishes the Directory object.
6
+ id: Unique identifier for the Directory.
7
+ domain: The URL associated with an Enterprise Client.
8
+ external_key: External Key for the Directory.
9
+ name: The name of the directory.
10
+ organization_id: The unique identifier for the Organization in which the directory resides.
11
+ state:
12
+ lowercase: >
13
+ Describes whether the Directory has been successfully connected to an
14
+ external provider.
15
+
16
+ The states `linked` and `unlinked` are equivalent to the Directory
17
+ states `active`
18
+
19
+ and `inactive` respectively in webhooks.
20
+
21
+ - `linked`
22
+
23
+ - `unlinked`
24
+
25
+ - `validating`
26
+
27
+ - `deleting`
28
+
29
+ - `invalid_credentials`
30
+ lowercaseNormalized: >
31
+ Describes whether the Directory has been successfully connected to an
32
+ external provider.
33
+
34
+ - `active`
35
+
36
+ - `inactive`
37
+
38
+ - `validating`
39
+
40
+ - `deleting`
41
+
42
+ - `invalid_credentials`
43
+ titlecase: >
44
+ Describes whether the Directory has been successfully connected to an
45
+ external provider.
46
+
47
+ The states `linked` and `unlinked` are equivalent to the Directory
48
+ states `active`
49
+
50
+ and `inactive` respectively in webhooks.
51
+
52
+ - `Active`
53
+
54
+ - `Validating`
55
+
56
+ - `Inactive`
57
+
58
+ - `Deleting`
59
+
60
+ - `InvalidCredentials`
61
+
62
+ - `Linked`
63
+
64
+ - `Unlinked`
65
+ type:
66
+ lowercase: |
67
+ The type of external Directory Provider integrated with.
68
+ - `azure scim v2.0`
69
+ - `bamboohr`
70
+ - `breathe hr`
71
+ - `cezanne hr`
72
+ - `generic scim v2.0`
73
+ - `gsuite directory`
74
+ - `jump cloud scim v2.0`
75
+ - `okta scim v2.0`
76
+ - `onelogin scim v2.0`
77
+ - `people hr`
78
+ - `pingfederate scim v2.0`
79
+ - `workday`
80
+ titlecase: |
81
+ The type of external Directory Provider integrated with.
82
+ - `AzureSCIMV2_0`
83
+ - `BambooHr`
84
+ - `BreatheHr`
85
+ - `Cezanne HR`
86
+ - `CyberarkSCIMV2_0`
87
+ - `FourthHr`
88
+ - `GenericSCIMV2_0`
89
+ - `GSuiteDirectory`
90
+ - `Gusto`
91
+ - `Hibob`
92
+ - `JumpCloudSCIM2_0`
93
+ - `OktaSCIMV2_0`
94
+ - `OneLoginSCIMV2_0`
95
+ - `PeopleHR`
96
+ - `PingFederateSCIMV2_0`
97
+ - `Rippling`
98
+ - `Workday`
99
+ created_at: The timestamp when the Directory was created.
100
+ updated_at: The timestamp when the Directory was last updated.
101
+ reference:
102
+ curl:
103
+ - url: /reference/directory-sync/directory
104
+ key: directory
105
+ id: directory
106
+ title: directory
107
+ properties:
108
+ - key: id
109
+ type: string
110
+ description: (directory.id)
111
+ - key: domain
112
+ type: string
113
+ description: (directory.domain)
114
+ - key: name
115
+ type: string
116
+ description: (directory.name)
117
+ - key: organization_id
118
+ optional: true
119
+ type: string
120
+ description: (directory.organization_id)
121
+ - key: state
122
+ type: enum
123
+ description: (directory.state.lowercase)
124
+ - key: type
125
+ type: enum
126
+ description: (directory.type.lowercase)
127
+ - key: created_at
128
+ type: string
129
+ description: (directory.created_at)
130
+ - key: updated_at
131
+ type: string
132
+ description: (directory.updated_at)
133
+ dotnet:
134
+ - url: /reference/directory-sync/directory
135
+ key: Directory
136
+ id: directory
137
+ title: class Directory
138
+ properties:
139
+ - key: Object
140
+ type: '"directory"'
141
+ description: (directory.object)
142
+ - key: Id
143
+ type: string
144
+ description: (directory.id)
145
+ - key: Domain
146
+ type: string
147
+ description: (directory.domain)
148
+ - key: Name
149
+ type: string
150
+ description: (directory.name)
151
+ - key: OrganizationId
152
+ optional: true
153
+ type: string
154
+ description: (directory.organization_id)
155
+ - key: State
156
+ type: string
157
+ description: (directory.state.lowercase)
158
+ - key: Type
159
+ type: string
160
+ description: (directory.type.lowercase)
161
+ - key: CreatedAt
162
+ type: string
163
+ description: (directory.created_at)
164
+ - key: UpdatedAt
165
+ type: string
166
+ description: (directory.updated_at)
167
+ ruby:
168
+ - url: /reference/directory-sync/directory
169
+ key: Directory
170
+ id: directory
171
+ title: class Directory
172
+ properties:
173
+ - key: id
174
+ type: String
175
+ description: (directory.id)
176
+ - key: domain
177
+ type: String
178
+ description: (directory.domain)
179
+ - key: name
180
+ type: String
181
+ description: (directory.name)
182
+ - key: organization_id
183
+ optional: true
184
+ type: String
185
+ description: (directory.organization_id)
186
+ - key: state
187
+ type: String
188
+ description: (directory.state.lowercase)
189
+ - key: type
190
+ type: String
191
+ description: (directory.type.lowercase)
192
+ - key: created_at
193
+ type: String
194
+ description: (directory.created_at)
195
+ - key: updated_at
196
+ type: String
197
+ description: (directory.updated_at)
198
+ python:
199
+ - url: /reference/directory-sync/directory
200
+ key: Directory
201
+ id: directory
202
+ title: Directory
203
+ properties:
204
+ - key: object
205
+ type: '"directory"'
206
+ description: (directory.id)
207
+ - key: id
208
+ type: str
209
+ description: (directory.id)
210
+ - key: domain
211
+ type: str
212
+ description: (directory.domain)
213
+ - key: name
214
+ type: str
215
+ description: (directory.name)
216
+ - key: organization_id
217
+ optional: true
218
+ type: str
219
+ description: (directory.organization_id)
220
+ - key: state
221
+ type: str
222
+ description: (directory.state.lowercase)
223
+ - key: type
224
+ type: str
225
+ description: (directory.type.lowercase)
226
+ - key: created_at
227
+ type: str
228
+ description: (directory.created_at)
229
+ - key: updated_at
230
+ type: str
231
+ description: (directory.updated_at)
232
+ js:
233
+ - url: /reference/directory-sync/directory
234
+ key: Directory
235
+ id: directory
236
+ title: interface Directory
237
+ properties:
238
+ - key: object
239
+ type: '"directory"'
240
+ description: (directory.object)
241
+ - key: id
242
+ type: string
243
+ description: (directory.id)
244
+ - key: domain
245
+ type: string
246
+ description: (directory.domain)
247
+ - key: externalKey
248
+ type: string
249
+ description: (directory.external_key)
250
+ - key: name
251
+ type: string
252
+ description: (directory.name)
253
+ - key: organizationId
254
+ optional: true
255
+ type: string
256
+ description: (directory.organization_id)
257
+ - key: state
258
+ type: DirectoryState
259
+ description: (directory.state.lowercaseNormalized)
260
+ - key: type
261
+ type: string
262
+ description: (directory.type.lowercase)
263
+ - key: createdAt
264
+ type: string
265
+ description: (directory.created_at)
266
+ - key: updatedAt
267
+ type: string
268
+ description: (directory.updated_at)
269
+ go:
270
+ - url: /reference/directory-sync/directory
271
+ key: Directory
272
+ id: directory
273
+ title: directorysync.Directory
274
+ properties:
275
+ - key: ID
276
+ type: string
277
+ description: (directory.id)
278
+ - key: Domain
279
+ type: string
280
+ description: (directory.domain)
281
+ - key: ExternalKey
282
+ type: string
283
+ description: (directory.external_key)
284
+ - key: Name
285
+ type: string
286
+ description: (directory.name)
287
+ - key: OrganizationID
288
+ optional: true
289
+ type: string
290
+ description: (directory.organization_id)
291
+ - key: State
292
+ type: directorysync.DirectoryState
293
+ description: (directory.state.lowercase)
294
+ - key: Type
295
+ type: directorysync.DirectoryType
296
+ description: (directory.type.lowercase)
297
+ - key: CreatedAt
298
+ type: string
299
+ description: (directory.created_at)
300
+ - key: UpdatedAt
301
+ type: string
302
+ description: (directory.updated_at)
303
+ php:
304
+ - url: /reference/directory-sync/directory
305
+ key: Directory
306
+ id: directory
307
+ title: WorkOS\Resource\Directory
308
+ properties:
309
+ - key: id
310
+ type: string
311
+ description: (directory.id)
312
+ - key: domain
313
+ type: string
314
+ description: (directory.domain)
315
+ - key: name
316
+ type: string
317
+ description: (directory.name)
318
+ - key: organizationId
319
+ optional: true
320
+ type: string
321
+ description: (directory.organization_id)
322
+ - key: state
323
+ type: string
324
+ description: (directory.state.lowercase)
325
+ - key: type
326
+ type: string
327
+ description: (directory.type.lowercase)
328
+ - key: createdAt
329
+ type: string
330
+ description: (directory.created_at)
331
+ - key: updatedAt
332
+ type: string
333
+ description: (directory.updated_at)
334
+ java:
335
+ - url: /reference/directory-sync/directory
336
+ key: Directory
337
+ id: directory
338
+ title: class Directory
339
+ properties:
340
+ - key: obj
341
+ type: '"directory"'
342
+ description: (directory.object)
343
+ - key: id
344
+ type: String
345
+ description: (directory.id)
346
+ - key: name
347
+ type: String
348
+ description: (directory.name)
349
+ - key: domain
350
+ optional: true
351
+ type: String
352
+ description: (directory.domain)
353
+ - key: externalKey
354
+ type: String
355
+ optional: true
356
+ description: (directory.external_key)
357
+ - key: organizationId
358
+ optional: true
359
+ type: String
360
+ description: (directory.organization_id)
361
+ - key: state
362
+ type: DirectoryState
363
+ description: (directory.state.titlecase)
364
+ - key: type
365
+ type: DirectoryType
366
+ description: (directory.type.titlecase)
367
+ - key: createdAt
368
+ type: String
369
+ description: (directory.created_at)
370
+ - key: updatedAt
371
+ type: String
372
+ description: (directory.updated_at)
373
+ originalPath: >-
374
+ .tmp-workos-clone/packages/docs/content/reference/directory-sync/directory/index.mdx
375
+ ---
376
+
377
+ ## Directory
378
+
379
+ A directory stores information about an organization's employee management system.
380
+
381
+ Synchronizing with a directory enables you to receive changes to an organization’s [user](/reference/directory-sync/directory-user) and [group](/reference/directory-sync/directory-group) structure.
382
+
383
+ Directory providers vary in implementation details and may require different sets of fields for integration, such as API keys, subdomains, endpoints, usernames, etc. Where available, the WorkOS API will provide these fields when fetching directory records.
384
+
385
+ <CodeBlock title="Example Directory" file="directory" referenceId="directory" />