@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,228 @@
1
+ ---
2
+ descriptions:
3
+ verify_challenge:
4
+ authentication_challenge_id: The unique ID of the authentication Challenge.
5
+ code: The 6 digit code to be verified.
6
+ challenge: >-
7
+ The relevant [Authentication
8
+ Challenge](/reference/mfa/authentication-challenge).
9
+ valid: Indicates whether the code was correct.
10
+ reference:
11
+ curl:
12
+ - key: verify_challenge
13
+ id: verify_challenge
14
+ url: /reference/mfa/verify-challenge
15
+ title: '/auth/challenges/:id/verify'
16
+ type: POST
17
+ parameters:
18
+ - key: authentication_challenge_id
19
+ type: string
20
+ description: (verify_challenge.authentication_challenge_id)
21
+ - key: code
22
+ type: string
23
+ description: (verify_challenge.code)
24
+ returns:
25
+ - key: anonymous
26
+ type: object
27
+ unwrap: true
28
+ properties:
29
+ - key: challenge
30
+ type: challenge
31
+ description: (verify_challenge.challenge)
32
+ - key: valid
33
+ type: boolean
34
+ description: (verify_challenge.valid)
35
+ dotnet:
36
+ - key: VerifyChallenge
37
+ id: verify_challenge
38
+ url: /reference/mfa/verify-challenge
39
+ title: mfaService.VerifyChallenge()
40
+ parameters:
41
+ - key: options
42
+ type: VerifyChallengeOptions
43
+ expanded: true
44
+ properties:
45
+ - key: ChallengeId
46
+ type: string
47
+ description: (verify_challenge.authentication_challenge_id)
48
+ - key: Code
49
+ type: string
50
+ description: (verify_challenge.code)
51
+ - (cancellationToken)
52
+ returns:
53
+ - key: Task<VerifyChallengeResponse>
54
+ title: class VerifyChallengeResponse
55
+ expanded: true
56
+ properties:
57
+ - key: Challenge
58
+ type: Challenge
59
+ description: (verify_challenge.challenge)
60
+ - key: Valid
61
+ type: bool
62
+ description: (verify_challenge.valid)
63
+ ruby:
64
+ - key: verify_challenge
65
+ id: verify_challenge
66
+ url: /reference/mfa/verify-challenge
67
+ title: MFA.verify_challenge()
68
+ parameters:
69
+ - key: authentication_challenge_id
70
+ type: String
71
+ description: (verify_challenge.authentication_challenge_id)
72
+ - key: code
73
+ type: String
74
+ description: (verify_challenge.code)
75
+ returns:
76
+ - key: VerifyChallenge
77
+ type: Struct
78
+ unwrap: true
79
+ properties:
80
+ - key: challenge
81
+ type: Challenge
82
+ description: (verify_challenge.challenge)
83
+ - key: valid
84
+ type: bool
85
+ description: (verify_challenge.valid)
86
+ python:
87
+ - key: verify_challenge
88
+ id: verify_challenge
89
+ url: /reference/mfa/verify-challenge
90
+ title: mfa.verify_challenge()
91
+ parameters:
92
+ - key: authentication_challenge_id
93
+ type: str
94
+ description: (verify_challenge.authentication_challenge_id)
95
+ - key: code
96
+ type: str
97
+ description: (verify_challenge.code)
98
+ returns:
99
+ - key: anonymous
100
+ type: dict
101
+ unwrap: true
102
+ properties:
103
+ - key: challenge
104
+ type: authentication_challenge
105
+ description: (verify_challenge.challenge)
106
+ - key: valid
107
+ type: bool
108
+ description: (verify_challenge.valid)
109
+ js:
110
+ - key: verifyChallenge
111
+ id: verify_challenge
112
+ url: /reference/mfa/verify-challenge
113
+ title: mfa.verifyChallenge()
114
+ parameters:
115
+ - key: options
116
+ type: object
117
+ unwrap: true
118
+ properties:
119
+ - key: authenticationChallengeId
120
+ type: string
121
+ description: (verify_challenge.authentication_challenge_id)
122
+ - key: code
123
+ type: string
124
+ description: (verify_challenge.code)
125
+ returns:
126
+ - key: anonymous
127
+ type: object
128
+ unwrap: true
129
+ properties:
130
+ - key: challenge
131
+ type: Challenge
132
+ description: (verify_challenge.challenge)
133
+ - key: valid
134
+ type: boolean
135
+ description: (verify_challenge.valid)
136
+ php:
137
+ - key: verifyChallenge
138
+ id: verify_challenge
139
+ url: /reference/mfa/verify-challenge
140
+ title: $mfa->verifyChallenge()
141
+ parameters:
142
+ - key: authenticationChallengeId
143
+ type: string
144
+ description: (verify_challenge.authentication_challenge_id)
145
+ - key: code
146
+ type: string
147
+ description: (verify_challenge.code)
148
+ returns:
149
+ - key: anonymous
150
+ type: array
151
+ unwrap: true
152
+ properties:
153
+ - key: challenge
154
+ type: Challenge
155
+ description: (verify_challenge.challenge)
156
+ - key: valid
157
+ type: bool
158
+ description: (verify_challenge.valid)
159
+ java:
160
+ - key: verifyChallenge
161
+ id: verify_challenge
162
+ url: /reference/mfa/verify-challenge
163
+ title: mfa.verifyChallenge()
164
+ parameters:
165
+ - key: options
166
+ type: VerifyChallengeOptions
167
+ expanded: true
168
+ properties:
169
+ - key: authenticationChallengeId
170
+ type: String
171
+ description: (verify_challenge.authentication_challenge_id)
172
+ - key: code
173
+ type: String
174
+ description: (verify_challenge.code)
175
+ - key: builder()
176
+ type: VerifyChallengeOptionsBuilder
177
+ description: (java.builder)
178
+ returns:
179
+ - key: response
180
+ type: VerifyChallengeResponse
181
+ expanded: true
182
+ properties:
183
+ - key: challenge
184
+ type: Challenge
185
+ description: (verify_challenge.challenge)
186
+ - key: valid
187
+ type: Boolean
188
+ description: (verify_challenge.valid)
189
+ go:
190
+ - key: VerifyChallenge
191
+ id: verify_challenge
192
+ url: /reference/mfa/verify-challenge
193
+ title: mfa.VerifyChallenge()
194
+ parameters:
195
+ - (ctx)
196
+ - key: opts
197
+ type: mfa.VerifyChallengeOpts
198
+ expanded: true
199
+ properties:
200
+ - key: ChallengeID
201
+ type: string
202
+ description: (verify_challenge.authentication_challenge_id)
203
+ - key: Code
204
+ type: string
205
+ description: (verify_challenge.code)
206
+ returns:
207
+ - key: verify
208
+ type: mfa.VerifyChallengeResponse
209
+ expanded: true
210
+ properties:
211
+ - key: Challenge
212
+ type: mfa.Challenge
213
+ description: (verify_challenge.challenge)
214
+ - key: Valid
215
+ type: bool
216
+ description: (verify_challenge.valid)
217
+ - (err)
218
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/mfa/verify-challenge.mdx
219
+ ---
220
+
221
+ ## Verify Challenge
222
+
223
+ Verify Authentication Challenge.
224
+
225
+ <CodeBlock referenceId="verify_challenge">
226
+ <CodeBlockTab title="Request" file="verify-challenge-request" />
227
+ <CodeBlockTab title="Response" file="verify-challenge-response" />
228
+ </CodeBlock>
@@ -0,0 +1,216 @@
1
+ ---
2
+ descriptions:
3
+ domains_parameter: The domains of the Organization.
4
+ reference:
5
+ curl:
6
+ - key: create_organization
7
+ type: POST
8
+ id: create_organization
9
+ url: /reference/organization/create
10
+ title: /organizations
11
+ parameters:
12
+ - (organization.name)
13
+ - key: domain_data
14
+ optional: true
15
+ type: array
16
+ properties:
17
+ - key: domain
18
+ type: string
19
+ description: (domain_data.domain)
20
+ - key: state
21
+ type: '"pending" | "verified"'
22
+ description: (domain_data.state)
23
+ - key: external_id
24
+ optional: true
25
+ type: string
26
+ description: (organization.external_id)
27
+ - key: metadata
28
+ optional: true
29
+ type: object
30
+ description: (organization.metadata)
31
+ returns:
32
+ - (organization)
33
+ js:
34
+ - key: createOrganization
35
+ id: create_organization
36
+ url: /reference/organization/create
37
+ title: organizations.createOrganization()
38
+ parameters:
39
+ - key: options
40
+ type: object
41
+ unwrap: true
42
+ properties:
43
+ - (Organization.name)
44
+ - key: domainData
45
+ optional: true
46
+ type: 'object[]'
47
+ properties:
48
+ - key: domain
49
+ type: string
50
+ description: (domain_data.domain)
51
+ - key: state
52
+ type: '"pending" | "verified"'
53
+ description: (domain_data.state)
54
+ - key: externalId
55
+ optional: true
56
+ type: string
57
+ description: (organization.external_id)
58
+ - key: metadata
59
+ optional: true
60
+ type: object
61
+ description: (organization.metadata)
62
+ returns:
63
+ - (Organization)
64
+ go:
65
+ - key: CreateOrganization
66
+ id: create_organization
67
+ url: /reference/organization/create
68
+ title: organizations.CreateOrganization()
69
+ parameters:
70
+ - (ctx)
71
+ - key: opts
72
+ type: organizations.CreateOrganizationOpts
73
+ expanded: true
74
+ properties:
75
+ - (Organization.Name)
76
+ - key: DomainData
77
+ optional: true
78
+ type: '[]OrganizationDomainData'
79
+ properties:
80
+ - key: Domain
81
+ type: string
82
+ description: (domain_data.domain)
83
+ - key: State
84
+ type: OrganizationDomainDataState
85
+ description: (domain_data.state)
86
+ returns:
87
+ - key: org
88
+ type: organizations.Organization
89
+ description: (organization.self)
90
+ - (err)
91
+ java:
92
+ - key: createOrganization
93
+ id: create_organization
94
+ url: /reference/organization/create
95
+ title: organizations.createOrganization()
96
+ parameters:
97
+ - key: options
98
+ type: CreateOrganizationOptions
99
+ expanded: true
100
+ properties:
101
+ - (Organization.name)
102
+ - key: domainData
103
+ optional: true
104
+ type: List<OrganizationDomainDataOptions>
105
+ properties:
106
+ - key: domain
107
+ type: String
108
+ description: (domain_data.domain)
109
+ - key: state
110
+ type: OrganizationDomainDataState
111
+ description: (domain_data.state)
112
+ - key: builder()
113
+ type: CreateOrganizationOptionsBuilder
114
+ description: (java.builder)
115
+ returns:
116
+ - (Organization)
117
+ ruby:
118
+ - key: create_organization
119
+ id: create_organization
120
+ url: /reference/organization/create
121
+ title: Organizations.create_organization()
122
+ parameters:
123
+ - (Organization.name)
124
+ - key: domain_data
125
+ optional: true
126
+ type: 'Array[Hash]'
127
+ properties:
128
+ - key: domain
129
+ type: String
130
+ description: (domain_data.domain)
131
+ - key: state
132
+ type: '"pending" | "verified"'
133
+ description: (domain_data.state)
134
+ returns:
135
+ - (Organization)
136
+ python:
137
+ - key: create_organization
138
+ id: create_organization
139
+ url: /reference/organization/create
140
+ title: organizations.create_organization()
141
+ parameters:
142
+ - (Organization.name)
143
+ - key: domain_data
144
+ optional: true
145
+ type: 'Sequence[DomainDataInput]'
146
+ properties:
147
+ - key: domain
148
+ type: string
149
+ description: (domain_data.domain)
150
+ - key: state
151
+ type: '"pending" | "verified"'
152
+ description: (domain_data.state)
153
+ - key: idempotency_key
154
+ optional: true
155
+ type: str
156
+ description: (idempotency_key)
157
+ returns:
158
+ - (Organization)
159
+ php:
160
+ - key: createOrganization
161
+ id: create_organization
162
+ url: /reference/organization/create
163
+ title: $organizations->createOrganization()
164
+ parameters:
165
+ - (Organization.name)
166
+ - key: domain_data
167
+ optional: true
168
+ type: 'object[]'
169
+ properties:
170
+ - key: domain
171
+ type: string
172
+ description: (domain_data.domain)
173
+ - key: state
174
+ type: '"pending" | "verified"'
175
+ description: (domain_data.state)
176
+ returns:
177
+ - (Organization)
178
+ dotnet:
179
+ - key: CreateOrganization
180
+ id: create_organization
181
+ url: /reference/organization/create
182
+ title: organizationsService.CreateOrganization()
183
+ parameters:
184
+ - key: options
185
+ type: CreateOrganizationOptions
186
+ expanded: true
187
+ properties:
188
+ - (Organization.Name)
189
+ - key: DomainData
190
+ type: 'OrganizationDomainDataOptions[]'
191
+ optional: true
192
+ properties:
193
+ - key: Domain
194
+ type: string
195
+ description: (domain_data.domain)
196
+ - key: State
197
+ type: OrganizationDomainDataState
198
+ description: (domain_data.state)
199
+ - (idempotencyKey)
200
+ - (cancellationToken)
201
+ returns:
202
+ - key: Task<Organization>
203
+ description: (organization.self)
204
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/organization/create.mdx
205
+ ---
206
+
207
+ ## Create an Organization
208
+
209
+ Creates a new organization in the current environment.
210
+
211
+ You can include one or more domains to associate with the organization, but you should [verify the ownership](/user-management/domain-verification) of every domain before setting its state to `verified`.
212
+
213
+ <CodeBlock referenceId="create_organization">
214
+ <CodeBlockTab title="Request" file="create-organization-request" />
215
+ <CodeBlockTab title="Response" file="create-organization-response" />
216
+ </CodeBlock>
@@ -0,0 +1,89 @@
1
+ ---
2
+ reference:
3
+ curl:
4
+ - key: delete_organization
5
+ id: delete_organization
6
+ url: /reference/organization/delete
7
+ title: '/organizations/:id'
8
+ type: DELETE
9
+ parameters:
10
+ - (organization.id)
11
+ js:
12
+ - key: deleteOrganization
13
+ id: delete_organization
14
+ url: /reference/organization/delete
15
+ title: organizations.deleteOrganization()
16
+ parameters:
17
+ - (Organization.id)
18
+ go:
19
+ - key: DeleteOrganization
20
+ id: delete_organization
21
+ url: /reference/organization/delete
22
+ title: organizations.DeleteOrganization()
23
+ parameters:
24
+ - (ctx)
25
+ - key: opts
26
+ type: organizations.DeleteOrganizationOpts
27
+ expanded: true
28
+ properties:
29
+ - key: Organization
30
+ type: string
31
+ description: (organization.id)
32
+ returns:
33
+ - (err)
34
+ java:
35
+ - key: deleteOrganization
36
+ id: delete_organization
37
+ url: /reference/organization/delete
38
+ title: organizations.deleteOrganization()
39
+ parameters:
40
+ - (Organization.id)
41
+ ruby:
42
+ - key: delete_organization
43
+ id: delete_organization
44
+ url: /reference/organization/delete
45
+ title: Organizations.delete_organization()
46
+ parameters:
47
+ - (Organization.id)
48
+ python:
49
+ - key: delete_organization
50
+ id: delete_organization
51
+ url: /reference/organization/delete
52
+ title: organizations.delete_organization()
53
+ parameters:
54
+ - key: organization
55
+ type: str
56
+ description: (organization.id)
57
+ php:
58
+ - key: deleteOrganization
59
+ id: delete_organization
60
+ url: /reference/organization/delete
61
+ title: $organizations->deleteOrganization()
62
+ parameters:
63
+ - key: organization
64
+ type: string
65
+ description: (organization.id)
66
+ dotnet:
67
+ - key: DeleteOrganization
68
+ id: delete_organization
69
+ url: /reference/organization/delete
70
+ title: organizationsService.DeleteOrganization()
71
+ parameters:
72
+ - key: id
73
+ type: string
74
+ description: (organization.id)
75
+ - (cancellationToken)
76
+ returns:
77
+ - (Task)
78
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/organization/delete.mdx
79
+ ---
80
+
81
+ ## Delete an Organization
82
+
83
+ Permanently deletes an organization in the current environment. It cannot be undone.
84
+
85
+ <CodeBlock
86
+ title="Request"
87
+ file="delete-organization"
88
+ referenceId="delete_organization"
89
+ />
@@ -0,0 +1,40 @@
1
+ ---
2
+ reference:
3
+ curl:
4
+ - key: get_organization_by_external_id
5
+ id: get_organization_by_external_id
6
+ url: /reference/organization/get-by-external-id
7
+ title: '/organizations/external_id/:external_id'
8
+ type: GET
9
+ parameters:
10
+ - key: external_id
11
+ type: string
12
+ description: (organization.external_id)
13
+ returns:
14
+ - (organization)
15
+ js:
16
+ - key: getOrganizationByExternalId
17
+ id: get_organization_by_external_id
18
+ url: /reference/organization/get-by-external-id
19
+ title: organizations.getOrganizationByExternalId()
20
+ parameters:
21
+ - key: externalId
22
+ type: string
23
+ description: (organization.external_id)
24
+ returns:
25
+ - (Organization)
26
+ originalPath: >-
27
+ .tmp-workos-clone/packages/docs/content/reference/organization/get-by-external-id.mdx
28
+ ---
29
+
30
+ ## Get an Organization by External ID
31
+
32
+ Get the details of an existing organization by an [external identifier](/user-management/metadata/external-identifiers).
33
+
34
+ <CodeBlock referenceId="get_organization_by_external_id">
35
+ <CodeBlockTab
36
+ title="Request"
37
+ file="get-organization-by-external-id-request"
38
+ />
39
+ <CodeBlockTab title="Response" file="get-organization-response" />
40
+ </CodeBlock>
@@ -0,0 +1,104 @@
1
+ ---
2
+ reference:
3
+ curl:
4
+ - key: get_organization
5
+ id: get_organization
6
+ url: /reference/organization/get
7
+ title: '/organizations/:id'
8
+ type: GET
9
+ parameters:
10
+ - (organization.id)
11
+ returns:
12
+ - (organization)
13
+ js:
14
+ - key: getOrganization
15
+ id: get_organization
16
+ url: /reference/organization/get
17
+ title: organizations.getOrganization()
18
+ parameters:
19
+ - (Organization.id)
20
+ returns:
21
+ - (Organization)
22
+ go:
23
+ - key: GetOrganization
24
+ id: get_organization
25
+ url: /reference/organization/get
26
+ title: organizations.GetOrganization()
27
+ parameters:
28
+ - (ctx)
29
+ - key: opts
30
+ type: organizations.GetOrganizationOpts
31
+ expanded: true
32
+ properties:
33
+ - key: Organization
34
+ type: string
35
+ description: (organization.id)
36
+ returns:
37
+ - key: org
38
+ type: organizations.Organization
39
+ description: (organization.self)
40
+ - (err)
41
+ java:
42
+ - key: getOrganization
43
+ id: get_organization
44
+ url: /reference/organization/get
45
+ title: organizations.getOrganization()
46
+ parameters:
47
+ - (Organization.id)
48
+ returns:
49
+ - (Organization)
50
+ ruby:
51
+ - key: get_organization
52
+ id: get_organization
53
+ url: /reference/organization/get
54
+ title: Organizations.get_organization()
55
+ parameters:
56
+ - (Organization.id)
57
+ returns:
58
+ - (Organization)
59
+ python:
60
+ - key: get_organization
61
+ id: get_organization
62
+ url: /reference/organization/get
63
+ title: organizations.get_organization()
64
+ parameters:
65
+ - key: organization_id
66
+ type: str
67
+ description: (organization.id)
68
+ returns:
69
+ - (Organization)
70
+ php:
71
+ - key: getOrganization
72
+ id: get_organization
73
+ url: /reference/organization/get
74
+ title: $organizations->getOrganization()
75
+ parameters:
76
+ - key: organization
77
+ type: string
78
+ description: (organization.id)
79
+ returns:
80
+ - (Organization)
81
+ dotnet:
82
+ - key: GetOrganization
83
+ id: get_organization
84
+ url: /reference/organization/get
85
+ title: organizationsService.GetOrganization()
86
+ parameters:
87
+ - key: id
88
+ type: string
89
+ description: (organization.id)
90
+ - (cancellationToken)
91
+ returns:
92
+ - key: Task<Organization>
93
+ description: (organization.self)
94
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/organization/get.mdx
95
+ ---
96
+
97
+ ## Get an Organization
98
+
99
+ Get the details of an existing organization.
100
+
101
+ <CodeBlock referenceId="get_organization">
102
+ <CodeBlockTab title="Request" file="get-organization-request" />
103
+ <CodeBlockTab title="Response" file="get-organization-response" />
104
+ </CodeBlock>