@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,119 @@
1
+ ---
2
+ descriptions:
3
+ update_organization_membership:
4
+ role_slug: The unique role identifier.
5
+ reference:
6
+ curl:
7
+ - key: update_organization_membership
8
+ id: update_organization_membership
9
+ url: /reference/user-management/organization-membership/update
10
+ title: '/user_management/organization_memberships/:id'
11
+ type: PUT
12
+ parameters:
13
+ - (organization_membership.id)
14
+ - key: role_slug
15
+ type: string
16
+ description: (update_organization_membership.role_slug)
17
+ returns:
18
+ - (organization_membership)
19
+ js:
20
+ - key: updateOrganizationMembership
21
+ id: update_organization_membership
22
+ url: /reference/user-management/organization-membership/update
23
+ title: userManagement.updateOrganizationMembership()
24
+ parameters:
25
+ - key: options
26
+ type: string
27
+ unwrap: true
28
+ properties:
29
+ - (OrganizationMembership.id)
30
+ - key: roleSlug
31
+ type: string
32
+ description: (update_organization_membership.role_slug)
33
+ returns:
34
+ - (OrganizationMembership)
35
+ go:
36
+ - key: UpdateOrganizationMembership
37
+ id: update_organization_membership
38
+ url: /reference/user-management/organization-membership/update
39
+ title: usermanagement.UpdateOrganizationMembership()
40
+ parameters:
41
+ - (ctx)
42
+ - key: opts
43
+ type: usermanagement.UpdateOrganizationMembershipOpts
44
+ unwrap: true
45
+ properties:
46
+ - key: RoleSlug
47
+ type: string
48
+ optional: true
49
+ description: (update_organization_membership.role_slug)
50
+ returns:
51
+ - key: organization_membership
52
+ type: usermanagement.OrganizationMembership
53
+ description: (organization_membership.self)
54
+ - (err)
55
+ php:
56
+ - key: updateOrganizationMembership
57
+ id: update_organization_membership
58
+ url: /reference/user-management/organization-membership/update
59
+ title: $userManagement->updateOrganizationMembership()
60
+ parameters:
61
+ - (OrganizationMembership.id)
62
+ - key: roleSlug
63
+ type: string
64
+ description: (update_organization_membership.role_slug)
65
+ returns:
66
+ - (OrganizationMembership)
67
+ python:
68
+ - key: update_organization_membership
69
+ id: update_organization_membership
70
+ url: /reference/user-management/organization-membership/update
71
+ title: user_management.update_organization_membership()
72
+ parameters:
73
+ - key: organization_membership_id
74
+ type: str
75
+ description: (organization_membership.id)
76
+ - key: role_slug
77
+ type: str
78
+ description: (update_organization_membership.role_slug)
79
+ returns:
80
+ - (OrganizationMembership)
81
+ ruby:
82
+ - key: update_organization_membership
83
+ id: update_organization_membership
84
+ url: /reference/user-management/organization-membership/update
85
+ title: UserManagement.update_organization_membership()
86
+ parameters:
87
+ - (OrganizationMembership.id)
88
+ - key: role_slug
89
+ type: String
90
+ description: (update_organization_membership.role_slug)
91
+ returns:
92
+ - (OrganizationMembership)
93
+ java:
94
+ - key: updateOrganizationMembership
95
+ id: update_organization_membership
96
+ url: /reference/user-management/organization-membership/update
97
+ title: userManagement.updateOrganizationMembership()
98
+ parameters:
99
+ - (OrganizationMembership.id)
100
+ - key: roleSlug
101
+ type: String
102
+ description: (update_organization_membership.role_slug)
103
+ returns:
104
+ - (OrganizationMembership)
105
+ originalPath: >-
106
+ .tmp-workos-clone/packages/docs/content/reference/user-management/organization-membership/update.mdx
107
+ ---
108
+
109
+ ## Update an organization membership
110
+
111
+ Update the details of an existing organization membership.
112
+
113
+ <CodeBlock referenceId="update_organization_membership">
114
+ <CodeBlockTab title="Request" file="update-organization-membership-request" />
115
+ <CodeBlockTab
116
+ title="Response"
117
+ file="update-organization-membership-response"
118
+ />
119
+ </CodeBlock>
@@ -0,0 +1,108 @@
1
+ ---
2
+ reference:
3
+ curl:
4
+ - key: create_password_reset
5
+ id: create_password_reset
6
+ url: /reference/user-management/password-reset/create
7
+ title: /user_management/password_reset
8
+ type: POST
9
+ sendsEmail: true
10
+ parameters:
11
+ - key: email
12
+ type: string
13
+ description: (password_reset.email)
14
+ returns:
15
+ - (password_reset)
16
+ js:
17
+ - key: createPasswordReset
18
+ id: create_password_reset
19
+ url: /reference/user-management/password-reset/create
20
+ title: userManagement.createPasswordReset()
21
+ sendsEmail: true
22
+ parameters:
23
+ - key: options
24
+ type: object
25
+ unwrap: true
26
+ properties:
27
+ - key: email
28
+ type: string
29
+ description: (password_reset.email)
30
+ returns:
31
+ - (PasswordReset)
32
+ go:
33
+ - key: CreatePasswordReset
34
+ id: create_password_reset
35
+ url: /reference/user-management/password-reset/create
36
+ title: usermanagement.CreatePasswordReset()
37
+ parameters:
38
+ - (ctx)
39
+ - key: opts
40
+ type: usermanagement.CreatePasswordResetOpts
41
+ unwrap: true
42
+ properties:
43
+ - key: Email
44
+ type: string
45
+ description: (password_reset.email)
46
+ returns:
47
+ - (PasswordReset)
48
+ - (err)
49
+ php:
50
+ - key: createPasswordReset
51
+ id: create_password_reset
52
+ url: /reference/user-management/password-reset/create
53
+ title: $userManagement->createPasswordReset()
54
+ sendsEmail: true
55
+ parameters:
56
+ - key: email
57
+ type: string
58
+ description: (password_reset.email)
59
+ returns:
60
+ - (PasswordReset)
61
+ python:
62
+ - key: create_password_reset
63
+ id: create_password_reset
64
+ url: /reference/user-management/password-reset/create
65
+ title: user_management.create_password_reset()
66
+ sendsEmail: true
67
+ parameters:
68
+ - key: email
69
+ type: str
70
+ description: (password_reset.email)
71
+ returns:
72
+ - (PasswordReset)
73
+ ruby:
74
+ - key: create_password_reset
75
+ id: create_password_reset
76
+ url: /reference/user-management/password-reset/create
77
+ title: UserManagement.create_password_reset()
78
+ sendsEmail: true
79
+ parameters:
80
+ - key: email
81
+ type: String
82
+ description: (password_reset.email)
83
+ returns:
84
+ - (PasswordReset)
85
+ java:
86
+ - key: createPasswordReset
87
+ id: create_password_reset
88
+ url: /reference/user-management/password_reset/create
89
+ title: userManagement.createPasswordReset()
90
+ sendsEmail: true
91
+ parameters:
92
+ - key: email
93
+ type: String
94
+ description: (password_reset.email)
95
+ returns:
96
+ - (PasswordReset)
97
+ originalPath: >-
98
+ .tmp-workos-clone/packages/docs/content/reference/user-management/password-reset/create.mdx
99
+ ---
100
+
101
+ ## Create a password reset token
102
+
103
+ Creates a one-time token that can be used to reset a user's password.
104
+
105
+ <CodeBlock referenceId="create_password_reset">
106
+ <CodeBlockTab title="Request" file="create-password-reset-request" />
107
+ <CodeBlockTab title="Response" file="create-password-reset-response" />
108
+ </CodeBlock>
@@ -0,0 +1,88 @@
1
+ ---
2
+ reference:
3
+ curl:
4
+ - key: get_password_reset
5
+ id: get_password_reset
6
+ url: /reference/user-management/password-reset/get
7
+ title: '/user_management/password_reset/:id'
8
+ type: GET
9
+ parameters:
10
+ - (password_reset.id)
11
+ returns:
12
+ - (password_reset)
13
+ js:
14
+ - key: getPasswordReset
15
+ id: get_password_reset
16
+ url: /reference/user-management/password-reset/get
17
+ title: userManagement.getPasswordReset()
18
+ parameters:
19
+ - (PasswordReset.id)
20
+ returns:
21
+ - (PasswordReset)
22
+ go:
23
+ - key: getPasswordReset
24
+ id: get_password_reset
25
+ url: /reference/user-management/password-reset/get
26
+ title: usermanagement.GetPasswordReset()
27
+ parameters:
28
+ - (ctx)
29
+ - key: opts
30
+ type: usermanagement.GetPasswordResetOpts
31
+ unwrap: true
32
+ properties:
33
+ - key: PasswordReset
34
+ type: string
35
+ description: (password_reset.id)
36
+ returns:
37
+ - (PasswordReset)
38
+ - (err)
39
+ php:
40
+ - key: getPasswordReset
41
+ id: get_password_reset
42
+ url: /reference/user-management/password-reset/get
43
+ title: $userManagement->getPasswordReset()
44
+ parameters:
45
+ - (PasswordReset.id)
46
+ returns:
47
+ - (PasswordReset)
48
+ python:
49
+ - key: get_password_reset
50
+ id: get_password_reset
51
+ url: /reference/user-management/password-reset/get
52
+ title: user_management.get_password_reset()
53
+ parameters:
54
+ - key: password_reset_id
55
+ type: str
56
+ description: (password_reset.id)
57
+ returns:
58
+ - (PasswordReset)
59
+ ruby:
60
+ - key: get_password_reset
61
+ id: get_password_reset
62
+ url: /reference/user-management/password-reset/get
63
+ title: UserManagement.get_password_reset()
64
+ parameters:
65
+ - (PasswordReset.id)
66
+ returns:
67
+ - (PasswordReset)
68
+ java:
69
+ - key: getPasswordReset
70
+ id: get_password_reset
71
+ url: /reference/user-management/password_reset/get
72
+ title: userManagement.getPasswordReset()
73
+ parameters:
74
+ - (PasswordReset.id)
75
+ returns:
76
+ - (PasswordReset)
77
+ originalPath: >-
78
+ .tmp-workos-clone/packages/docs/content/reference/user-management/password-reset/get.mdx
79
+ ---
80
+
81
+ ## Get a password reset token
82
+
83
+ Get the details of an existing password reset token that can be used to reset a user's password.
84
+
85
+ <CodeBlock referenceId="get_password_reset">
86
+ <CodeBlockTab title="Request" file="get-password-reset-request" />
87
+ <CodeBlockTab title="Response" file="get-password-reset-response" />
88
+ </CodeBlock>
@@ -0,0 +1,227 @@
1
+ ---
2
+ descriptions:
3
+ password_reset:
4
+ self: >-
5
+ The corresponding [password
6
+ reset](/reference/user-management/password-reset) object.
7
+ object: Distinguishes the password reset object.
8
+ id: The unique ID of the password reset object.
9
+ user_id: The unique ID of the user.
10
+ email: The email address of the user.
11
+ password_reset_token: The token used to reset the password.
12
+ password_reset_url: The URL where the user can reset their password.
13
+ expires_at: The timestamp when the password reset token expires.
14
+ created_at: The timestamp when the password reset token was created.
15
+ reference:
16
+ curl:
17
+ - url: /reference/user-management/password-reset
18
+ key: password_reset
19
+ id: password_reset
20
+ title: password_reset
21
+ properties:
22
+ - key: id
23
+ type: string
24
+ description: (password_reset.id)
25
+ - key: user_id
26
+ type: string
27
+ description: (password_reset.user_id)
28
+ - key: email
29
+ type: string
30
+ description: (password_reset.email)
31
+ - key: password_reset_token
32
+ type: string
33
+ description: (password_reset.password_reset_token)
34
+ - key: password_reset_url
35
+ type: string
36
+ description: (password_reset.password_reset_url)
37
+ - key: expires_at
38
+ type: string
39
+ description: (password_reset.expires_at)
40
+ - key: created_at
41
+ type: string
42
+ description: (password_reset.created_at)
43
+ js:
44
+ - url: /reference/user-management/password-reset
45
+ key: PasswordReset
46
+ id: password_reset
47
+ title: interface PasswordReset
48
+ properties:
49
+ - key: object
50
+ type: '"password_reset"'
51
+ description: (password_reset.object)
52
+ - key: id
53
+ type: string
54
+ description: (password_reset.id)
55
+ - key: userId
56
+ type: string
57
+ description: (password_reset.user_id)
58
+ - key: email
59
+ type: string
60
+ description: (password_reset.email)
61
+ - key: passwordResetToken
62
+ type: string
63
+ description: (password_reset.password_reset_token)
64
+ - key: passwordResetUrl
65
+ type: string
66
+ description: (password_reset.password_reset_url)
67
+ - key: expiresAt
68
+ type: string
69
+ description: (password_reset.expires_at)
70
+ - key: createdAt
71
+ type: string
72
+ description: (password_reset.created_at)
73
+ go:
74
+ - url: /reference/user-management/password-reset
75
+ key: PasswordReset
76
+ id: password_reset
77
+ title: usermanagement.PasswordReset
78
+ properties:
79
+ - key: ID
80
+ type: string
81
+ description: (password_reset.id)
82
+ - key: UserId
83
+ type: string
84
+ description: (password_reset.user_id)
85
+ - key: Email
86
+ type: string
87
+ description: (password_reset.email)
88
+ - key: PasswordResetToken
89
+ type: string
90
+ description: (password_reset.password_reset_token)
91
+ - key: PasswordResetUrl
92
+ type: string
93
+ description: (password_reset.password_reset_url)
94
+ - key: ExpiresAt
95
+ type: string
96
+ description: (password_reset.expires_at)
97
+ - key: CreatedAt
98
+ type: string
99
+ description: (password_reset.created_at)
100
+ php:
101
+ - url: /reference/user-management/password-reset
102
+ key: PasswordReset
103
+ id: password_reset
104
+ title: WorkOS\Resource\PasswordReset
105
+ properties:
106
+ - key: object
107
+ type: '"password_reset"'
108
+ description: (password_reset.object)
109
+ - key: id
110
+ type: string
111
+ description: (password_reset.id)
112
+ - key: userId
113
+ type: string
114
+ description: (password_reset.user_id)
115
+ - key: email
116
+ type: string
117
+ description: (password_reset.email)
118
+ - key: passwordResetToken
119
+ type: string
120
+ description: (password_reset.password_reset_token)
121
+ - key: passwordResetUrl
122
+ type: string
123
+ description: (password_reset.password_reset_url)
124
+ - key: expiresAt
125
+ type: string
126
+ description: (password_reset.expires_at)
127
+ - key: createdAt
128
+ type: string
129
+ description: (password_reset.created_at)
130
+ python:
131
+ - url: /reference/user-management/password-reset
132
+ key: PasswordReset
133
+ id: password_reset
134
+ title: PasswordReset
135
+ properties:
136
+ - key: id
137
+ type: str
138
+ description: (password_reset.id)
139
+ - key: user_id
140
+ type: str
141
+ description: (password_reset.user_id)
142
+ - key: email
143
+ type: str
144
+ description: (password_reset.email)
145
+ - key: password_reset_token
146
+ type: str
147
+ description: (password_reset.password_reset_token)
148
+ - key: password_reset_url
149
+ type: str
150
+ description: (password_reset.password_reset_url)
151
+ - key: expires_at
152
+ type: str
153
+ description: (password_reset.expires_at)
154
+ - key: created_at
155
+ type: str
156
+ description: (password_reset.created_at)
157
+ ruby:
158
+ - url: /reference/user-management/password-reset
159
+ key: PasswordReset
160
+ id: password_reset
161
+ title: class PasswordReset
162
+ properties:
163
+ - key: id
164
+ type: String
165
+ description: (password_reset.id)
166
+ - key: user_id
167
+ type: String
168
+ description: (password_reset.user_id)
169
+ - key: email
170
+ type: String
171
+ description: (password_reset.email)
172
+ - key: password_reset_token
173
+ type: String
174
+ description: (password_reset.password_reset_token)
175
+ - key: password_reset_url
176
+ type: String
177
+ description: (password_reset.password_reset_url)
178
+ - key: expires_at
179
+ type: String
180
+ description: (password_reset.expires_at)
181
+ - key: created_at
182
+ type: String
183
+ description: (password_reset.created_at)
184
+ java:
185
+ - url: /reference/user-management/password-reset
186
+ key: PasswordReset
187
+ id: password_reset
188
+ title: class PasswordReset
189
+ properties:
190
+ - key: id
191
+ type: String
192
+ description: (password_reset.id)
193
+ - key: userId
194
+ type: String
195
+ description: (password_reset.user_id)
196
+ - key: email
197
+ type: String
198
+ description: (password_reset.email)
199
+ - key: expiresAt
200
+ type: String
201
+ description: (password_reset.expires_at)
202
+ - key: passwordResetToken
203
+ type: String
204
+ description: (password_reset.password_reset_token)
205
+ - key: passwordResetUrl
206
+ type: String
207
+ description: (password_reset.password_reset_url)
208
+ - key: createdAt
209
+ type: String
210
+ description: (password_reset.created_at)
211
+ originalPath: >-
212
+ .tmp-workos-clone/packages/docs/content/reference/user-management/password-reset/index.mdx
213
+ ---
214
+
215
+ ---
216
+
217
+ # Password reset
218
+
219
+ Create a password reset token for a user and reset the user's password.
220
+
221
+ > When a user’s password is reset, all of their active sessions are revoked.
222
+
223
+ <CodeBlock
224
+ title="Example Password reset"
225
+ referenceId="password_reset"
226
+ file="password-reset"
227
+ />
@@ -0,0 +1,144 @@
1
+ ---
2
+ descriptions:
3
+ reset_password:
4
+ token: The `token` query parameter from the password reset URL.
5
+ new_password: The new password to set for the user.
6
+ reference:
7
+ curl:
8
+ - key: reset_password
9
+ id: reset_password
10
+ url: /reference/user-management/password-reset/reset-password
11
+ title: /user_management/password_reset/confirm
12
+ type: POST
13
+ parameters:
14
+ - key: token
15
+ type: string
16
+ description: (reset_password.token)
17
+ - key: new_password
18
+ type: string
19
+ description: (reset_password.new_password)
20
+ returns:
21
+ - key: anonymous
22
+ type: object
23
+ unwrap: true
24
+ properties:
25
+ - key: user
26
+ type: user
27
+ description: (user.self)
28
+ js:
29
+ - key: resetPassword
30
+ id: reset_password
31
+ url: /reference/user-management/password-reset/reset-password
32
+ title: userManagement.resetPassword()
33
+ parameters:
34
+ - key: token
35
+ type: string
36
+ description: (reset_password.token)
37
+ - key: newPassword
38
+ type: string
39
+ description: (reset_password.new_password)
40
+ returns:
41
+ - key: anonymous
42
+ type: object
43
+ unwrap: true
44
+ properties:
45
+ - key: user
46
+ type: User
47
+ description: (user.self)
48
+ go:
49
+ - key: ResetPassword
50
+ id: reset_password
51
+ url: /reference/user-management/password-reset/reset-password
52
+ title: usermanagement.ResetPassword()
53
+ parameters:
54
+ - (ctx)
55
+ - key: opts
56
+ type: usermanagement.ResetPasswordOpts
57
+ unwrap: true
58
+ properties:
59
+ - key: Token
60
+ type: string
61
+ description: (reset_password.token)
62
+ - key: NewPassword
63
+ type: string
64
+ description: (reset_password.new_password)
65
+ returns:
66
+ - key: user
67
+ type: UserResponse
68
+ unwrap: true
69
+ properties:
70
+ - key: User
71
+ type: User
72
+ description: (user.self)
73
+ - (err)
74
+ python:
75
+ - key: reset_password
76
+ id: reset_password
77
+ url: /reference/user-management/password-reset/reset-password
78
+ title: user_management.reset_password()
79
+ parameters:
80
+ - key: token
81
+ type: str
82
+ description: (reset_password.token)
83
+ - key: new_password
84
+ type: str
85
+ description: (reset_password.new_password)
86
+ returns:
87
+ - (User)
88
+ php:
89
+ - key: resetPassword
90
+ id: reset_password
91
+ url: /reference/user-management/password-reset/reset-password
92
+ title: $userManagement->resetPassword()
93
+ parameters:
94
+ - key: token
95
+ type: string
96
+ description: (reset_password.token)
97
+ - key: newPassword
98
+ type: string
99
+ description: (reset_password.new_password)
100
+ returns:
101
+ - key: user
102
+ type: User
103
+ description: (user.self)
104
+ ruby:
105
+ - key: reset_password
106
+ id: reset_password
107
+ url: /reference/user-management/password-reset/reset-password
108
+ title: UserManagement.reset_password()
109
+ parameters:
110
+ - key: token
111
+ type: String
112
+ description: (reset_password.token)
113
+ - key: new_password
114
+ type: String
115
+ description: (reset_password.new_password)
116
+ returns:
117
+ - (User)
118
+ java:
119
+ - key: resetPassword
120
+ id: reset_password
121
+ url: /reference/user-management/password-reset/reset-password
122
+ title: userManagement.resetPassword()
123
+ parameters:
124
+ - key: token
125
+ type: String
126
+ description: (reset_password.token)
127
+ - key: newPassword
128
+ type: String
129
+ description: (reset_password.new_password)
130
+ returns:
131
+ - (User)
132
+ originalPath: >-
133
+ .tmp-workos-clone/packages/docs/content/reference/user-management/password-reset/reset-password.mdx
134
+ ---
135
+
136
+ ## Reset the password
137
+
138
+ Sets a new password using the `token` query parameter from the link that the user received. Successfully resetting the password will verify a user's email, if it hasn't been verified yet.
139
+
140
+ <CodeBlock
141
+ title="Request"
142
+ referenceId="reset_password"
143
+ file="reset-password-request"
144
+ />