@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,194 @@
1
+ ---
2
+ descriptions:
3
+ list_auth_factors:
4
+ user_id: The user ID to list the authentication factors for.
5
+ data: >-
6
+ List of [authentication
7
+ factors](/reference/user-management/mfa/authentication-factor).
8
+ reference:
9
+ curl:
10
+ - key: list_auth_factors
11
+ id: list_auth_factors
12
+ url: /reference/user-management/mfa/list-auth-factors
13
+ title: '/user_management/users/:id/auth_factors'
14
+ type: GET
15
+ parameters:
16
+ - key: id
17
+ type: string
18
+ description: (list_auth_factors.user_id)
19
+ returns:
20
+ - key: anonymous
21
+ type: object
22
+ unwrap: true
23
+ properties:
24
+ - key: data
25
+ type: array
26
+ description: (list_auth_factors.data)
27
+ - key: list_metadata
28
+ type: object
29
+ properties:
30
+ - (before)
31
+ - (after)
32
+ js:
33
+ - key: listAuthFactors
34
+ id: list_auth_factors
35
+ url: /reference/user-management/mfa/list-auth-factors
36
+ title: userManagement.listAuthFactors()
37
+ parameters:
38
+ - key: userId
39
+ type: string
40
+ description: (list_auth_factors.user_id)
41
+ - (limit)
42
+ - (before)
43
+ - (after)
44
+ - (order)
45
+ returns:
46
+ - key: anonymous
47
+ type: object
48
+ unwrap: true
49
+ properties:
50
+ - key: data
51
+ type: 'Factor[]'
52
+ description: (list_auth_factors.data)
53
+ - key: listMetadata
54
+ type: object
55
+ properties:
56
+ - (before)
57
+ - (after)
58
+ go:
59
+ - key: ListAuthFactors
60
+ patternBefore: usermanagement.
61
+ id: list_auth_factors
62
+ url: /reference/user-management/mfa/list-auth-factors
63
+ title: usermanagement.ListAuthFactors()
64
+ parameters:
65
+ - (ctx)
66
+ - key: opts
67
+ type: usermanagement.ListAuthFactorsOpts
68
+ unwrap: true
69
+ properties:
70
+ - key: User
71
+ type: string
72
+ description: (list_auth_factors.user_id)
73
+ - (Limit)
74
+ - (Before)
75
+ - (After)
76
+ - (Order)
77
+ returns:
78
+ - key: response
79
+ type: ListAuthFactorsResponse
80
+ unwrap: true
81
+ properties:
82
+ - key: Data
83
+ type: 'Factor[]'
84
+ description: (list_auth_factors.data)
85
+ - key: ListMetadata
86
+ type: ListMetadata
87
+ properties:
88
+ - (Before)
89
+ - (After)
90
+ - (err)
91
+ python:
92
+ - key: list_auth_factors
93
+ id: list_auth_factors
94
+ url: /reference/user-management/mfa/list-auth-factors
95
+ title: user_management.list_auth_factors()
96
+ parameters:
97
+ - key: user_id
98
+ type: str
99
+ description: (list_auth_factors.user_id)
100
+ - (after)
101
+ - (before)
102
+ - (limit)
103
+ - (order)
104
+ returns:
105
+ - key: anonymous
106
+ type: WorkOSListResource
107
+ unwrap: true
108
+ properties:
109
+ - key: data
110
+ type: 'list[AuthenticationFactor]'
111
+ description: (list_auth_factors.data)
112
+ - key: list_metadata
113
+ type: ListMetadata
114
+ properties:
115
+ - (before)
116
+ - (after)
117
+ php:
118
+ - key: listAuthFactors
119
+ id: list_auth_factors
120
+ url: /reference/user-management/mfa/list-auth-factors
121
+ title: $userManagement->listAuthFactors()
122
+ parameters:
123
+ - key: userId
124
+ type: string
125
+ description: (list_auth_factors.user_id)
126
+ returns:
127
+ - key: anonymous
128
+ type: object
129
+ unwrap: true
130
+ properties:
131
+ - key: data
132
+ type: 'UserAuthenticationFactorTotp[]'
133
+ description: (list_auth_factors.data)
134
+ ruby:
135
+ - key: list_auth_factors
136
+ id: list_auth_factors
137
+ url: /reference/user-management/mfa/list-auth-factors
138
+ title: UserManagement.list_auth_factors()
139
+ parameters:
140
+ - key: user_id
141
+ type: String
142
+ description: (list_auth_factors.user_id)
143
+ - (limit)
144
+ - (before)
145
+ - (after)
146
+ - (order)
147
+ returns:
148
+ - key: anonymous
149
+ type: object
150
+ unwrap: true
151
+ properties:
152
+ - key: data
153
+ type: 'Factor[]'
154
+ description: (list_auth_factors.data)
155
+ - key: listMetadata
156
+ type: object
157
+ properties:
158
+ - (before)
159
+ - (after)
160
+ java:
161
+ - key: listAuthFactors
162
+ id: list_auth_factors
163
+ url: /reference/user-management/mfa/list-auth-factors
164
+ title: userManagement.listAuthFactors()
165
+ parameters:
166
+ - key: id
167
+ type: String
168
+ description: (list_auth_factors.user_id)
169
+ returns:
170
+ - key: anonymous
171
+ type: AuthenticationFactors
172
+ unwrap: true
173
+ properties:
174
+ - key: data
175
+ type: 'AuthenticationFactor[]'
176
+ description: (list_auth_factors.data)
177
+ - key: listMetadata
178
+ type: ListMetadata
179
+ properties:
180
+ - (before)
181
+ - (after)
182
+ originalPath: >-
183
+ .tmp-workos-clone/packages/docs/content/reference/user-management/mfa/list-auth-factors.mdx
184
+ ---
185
+
186
+ ## List authentication factors
187
+
188
+ Lists the authentication factors for a user.
189
+
190
+ <CodeBlock
191
+ title="Request"
192
+ referenceId="list_auth_factors"
193
+ file="list-auth-factors"
194
+ />
@@ -0,0 +1,155 @@
1
+ ---
2
+ descriptions:
3
+ create_organization_membership:
4
+ role_slug: The unique role identifier. Defaults to `member`.
5
+ reference:
6
+ curl:
7
+ - key: create_organization_membership
8
+ id: create_organization_membership
9
+ url: /reference/user-management/organization-membership/create
10
+ title: /user_management/organization_memberships
11
+ type: POST
12
+ parameters:
13
+ - key: user_id
14
+ type: string
15
+ description: (organization_membership.user_id)
16
+ - key: organization_id
17
+ type: string
18
+ description: (organization_membership.organization_id)
19
+ - key: role_slug
20
+ type: string
21
+ description: (create_organization_membership.role_slug)
22
+ optional: true
23
+ returns:
24
+ - (organization_membership)
25
+ js:
26
+ - key: createOrganizationMembership
27
+ id: create_organization_membership
28
+ url: /reference/user-management/organization-membership/create
29
+ title: userManagement.createOrganizationMembership()
30
+ parameters:
31
+ - key: options
32
+ type: object
33
+ unwrap: true
34
+ properties:
35
+ - (OrganizationMembership.userId)
36
+ - (OrganizationMembership.organizationId)
37
+ - key: roleSlug
38
+ type: string
39
+ optional: true
40
+ description: (create_organization_membership.role_slug)
41
+ returns:
42
+ - (OrganizationMembership)
43
+ go:
44
+ - key: CreateOrganizationMembership
45
+ id: create_organization_membership
46
+ url: /reference/user-management/organization-membership/create
47
+ title: usermanagement.CreateOrganizationMembership()
48
+ parameters:
49
+ - (ctx)
50
+ - key: opts
51
+ type: usermanagement.CreateOrganizationMembershipOpts
52
+ unwrap: true
53
+ properties:
54
+ - key: UserId
55
+ type: string
56
+ description: (organization_membership.user_id)
57
+ - key: OrganizationID
58
+ type: string
59
+ description: (organization_membership.organization_id)
60
+ - key: RoleSlug
61
+ type: string
62
+ description: (create_organization_membership.role_slug)
63
+ optional: true
64
+ returns:
65
+ - key: organizationMembership
66
+ type: usermanagement.OrganizationMembership
67
+ description: (organization_membership.self)
68
+ - (err)
69
+ php:
70
+ - key: createOrganizationMembership
71
+ id: create_organization_membership
72
+ url: /reference/user-management/organization-membership/create
73
+ title: $userManagement->createOrganizationMembership()
74
+ parameters:
75
+ - key: userId
76
+ type: string
77
+ description: (organization_membership.user_id)
78
+ - key: organizationId
79
+ type: string
80
+ description: (organization_membership.organization_id)
81
+ - key: roleSlug
82
+ type: string
83
+ optional: true
84
+ description: (create_organization_membership.role_slug)
85
+ python:
86
+ - key: create_organization_membership
87
+ id: create_organization_membership
88
+ url: /reference/user-management/organization-membership/create
89
+ title: user_management.create_organization_membership()
90
+ parameters:
91
+ - key: user_id
92
+ type: str
93
+ description: (organization_membership.user_id)
94
+ - key: organization_id
95
+ type: str
96
+ description: (organization_membership.organization_id)
97
+ - key: role_slug
98
+ type: str
99
+ optional: true
100
+ description: (create_organization_membership.role_slug)
101
+ returns:
102
+ - (OrganizationMembership)
103
+ ruby:
104
+ - key: create_organization_membership
105
+ id: create_organization_membership
106
+ url: /reference/user-management/organization-membership/create
107
+ title: UserManagement.create_organization_membership()
108
+ parameters:
109
+ - (OrganizationMembership.user_id)
110
+ - (OrganizationMembership.organization_id)
111
+ - key: role_slug
112
+ type: String
113
+ optional: true
114
+ description: (create_organization_membership.role_slug)
115
+ returns:
116
+ - (OrganizationMembership)
117
+ java:
118
+ - key: createOrganizationMembership
119
+ id: create_organization_membership
120
+ url: /reference/user-management/organization-membership/create
121
+ title: userManagement.createOrganizationMembership()
122
+ parameters:
123
+ - key: options
124
+ type: CreateOrganizationMembershipOptions
125
+ unwrap: true
126
+ properties:
127
+ - key: userId
128
+ type: String
129
+ description: (organization_membership.user_id)
130
+ - key: organizationId
131
+ type: String
132
+ description: (organization_membership.organization_id)
133
+ - key: roleSlug
134
+ type: String
135
+ optional: true
136
+ description: (organization_membership.role.slug)
137
+ returns:
138
+ - (OrganizationMembership)
139
+ originalPath: >-
140
+ .tmp-workos-clone/packages/docs/content/reference/user-management/organization-membership/create.mdx
141
+ ---
142
+
143
+ ## Create an organization membership
144
+
145
+ Creates a new `active` organization membership for the given organization and user.
146
+
147
+ Calling this API with an organization and user that match an `inactive` organization membership will activate the membership with the specified role.
148
+
149
+ <CodeBlock referenceId="create_organization_membership">
150
+ <CodeBlockTab title="Request" file="create-organization-membership-request" />
151
+ <CodeBlockTab
152
+ title="Response"
153
+ file="create-organization-membership-response"
154
+ />
155
+ </CodeBlock>
@@ -0,0 +1,106 @@
1
+ ---
2
+ reference:
3
+ curl:
4
+ - key: deactivate_organization_membership
5
+ id: deactivate_organization_membership
6
+ url: /reference/user-management/organization-membership/deactivate
7
+ title: '/user_management/organization_memberships/:id/deactivate'
8
+ type: PUT
9
+ parameters:
10
+ - (organization_membership.id)
11
+ returns:
12
+ - (organization_membership)
13
+ js:
14
+ - key: deactivateOrganizationMembership
15
+ id: deactivate_organization_membership
16
+ url: /reference/user-management/organization-membership/deactivate
17
+ title: userManagement.deactivateOrganizationMembership()
18
+ parameters:
19
+ - key: options
20
+ type: object
21
+ unwrap: true
22
+ properties:
23
+ - (OrganizationMembership.id)
24
+ returns:
25
+ - (OrganizationMembership)
26
+ go:
27
+ - key: deactivateOrganizationMembership
28
+ patternBefore: usermanagement.
29
+ id: deactivate_organization_membership
30
+ url: /reference/user-management/organization-membership/deactivate
31
+ title: usermanagement.deactivateOrganizationMembership()
32
+ parameters:
33
+ - (ctx)
34
+ - key: opts
35
+ type: usermanagement.deactivateOrganizationMembershipOpts
36
+ unwrap: true
37
+ properties:
38
+ - key: OrganizationMembership
39
+ type: string
40
+ description: (organization_membership.id)
41
+ returns:
42
+ - key: organizationMembership
43
+ type: usermanagement.OrganizationMembership
44
+ description: (organization_membership.self)
45
+ - (err)
46
+ php:
47
+ - key: deactivateOrganizationMembership
48
+ id: deactivate_organization_membership
49
+ url: /reference/user-management/organization-membership/deactivate
50
+ title: $userManagement->deactivateOrganizationMembership()
51
+ parameters:
52
+ - (OrganizationMembership.id)
53
+ returns:
54
+ - (OrganizationMembership)
55
+ python:
56
+ - key: deactivate_organization_membership
57
+ id: deactivate_organization_membership
58
+ url: /reference/user-management/organization-membership/deactivate
59
+ title: user_management.deactivate_organization_membership()
60
+ parameters:
61
+ - key: organization_membership_id
62
+ type: str
63
+ description: (organization_membership.id)
64
+ returns:
65
+ - (OrganizationMembership)
66
+ ruby:
67
+ - key: deactivate_organization_membership
68
+ id: deactivate_organization_membership
69
+ url: /reference/user-management/organization-membership/deactivate
70
+ title: UserManagement.deactivate_organization_membership()
71
+ parameters:
72
+ - (OrganizationMembership.id)
73
+ returns:
74
+ - (OrganizationMembership)
75
+ java:
76
+ - key: deactivateOrganizationMembership
77
+ id: deactivate_organization_membership
78
+ url: /reference/user-management/organization-membership/deactivate
79
+ title: userManagement.deactivateOrganizationMembership()
80
+ parameters:
81
+ - (OrganizationMembership.id)
82
+ returns:
83
+ - (OrganizationMembership)
84
+ originalPath: >-
85
+ .tmp-workos-clone/packages/docs/content/reference/user-management/organization-membership/deactivate.mdx
86
+ ---
87
+
88
+ ## Deactivate an organization membership
89
+
90
+ Deactivates an `active` organization membership. Emits an [organization_membership.updated](/events/organization-membership) event upon successful deactivation.
91
+
92
+ - Deactivating an `inactive` membership is a no-op and does not emit an event.
93
+ - Deactivating a `pending` membership returns an error. This membership should be [deleted](/reference/user-management/organization-membership/delete) instead.
94
+
95
+ See the [membership management documentation](/user-management/users-organizations/organizations/membership-management) for additional details.
96
+
97
+ <CodeBlock referenceId="deactivate_organization_membership">
98
+ <CodeBlockTab
99
+ title="Request"
100
+ file="deactivate-organization-membership-request"
101
+ />
102
+ <CodeBlockTab
103
+ title="Response"
104
+ file="deactivate-organization-membership-response"
105
+ />
106
+ </CodeBlock>
@@ -0,0 +1,76 @@
1
+ ---
2
+ reference:
3
+ curl:
4
+ - key: delete_organization_membership
5
+ id: delete_organization_membership
6
+ url: /reference/user-management/organization-membership/delete
7
+ title: '/user_management/organization_memberships/:id'
8
+ type: DELETE
9
+ parameters:
10
+ - (organization_membership.id)
11
+ js:
12
+ - key: deleteOrganizationMembership
13
+ id: delete_organization_membership
14
+ url: /reference/user-management/organization-membership/delete
15
+ title: userManagement.deleteOrganizationMembership()
16
+ parameters:
17
+ - (OrganizationMembership.id)
18
+ go:
19
+ - key: DeleteOrganizationMembership
20
+ id: delete_organization_membership
21
+ url: /reference/user-management/organization-membership/delete
22
+ title: usermanagement.DeleteOrganizationMembership()
23
+ parameters:
24
+ - (ctx)
25
+ - key: opts
26
+ type: usermanagement.DeleteOrganizationMembershipOpts
27
+ unwrap: true
28
+ properties:
29
+ - key: OrganizationMembership
30
+ type: string
31
+ description: (organization_membership.id)
32
+ returns:
33
+ - (err)
34
+ php:
35
+ - key: deleteOrganizationMembership
36
+ id: delete_organization_membership
37
+ url: /reference/user-management/organization-membership/delete
38
+ title: $userManagement->deleteOrganizationMembership()
39
+ parameters:
40
+ - (OrganizationMembership.id)
41
+ python:
42
+ - key: delete_organization_membership
43
+ id: delete_organization_membership
44
+ url: /reference/user-management/organization-membership/delete
45
+ title: user_management.delete_organization_membership()
46
+ parameters:
47
+ - key: organization_membership_id
48
+ type: str
49
+ description: (organization_membership.id)
50
+ ruby:
51
+ - key: delete_organization_membership
52
+ id: delete_organization_membership
53
+ url: /reference/user-management/organization-membership/delete
54
+ title: UserManagement.delete_organization_membership()
55
+ parameters:
56
+ - (OrganizationMembership.id)
57
+ java:
58
+ - key: deleteOrganizationMembership
59
+ id: delete_organization_membership
60
+ url: /reference/user-management/organization-membership/delete
61
+ title: userManagement.deleteOrganizationMembership()
62
+ parameters:
63
+ - (OrganizationMembership.id)
64
+ originalPath: >-
65
+ .tmp-workos-clone/packages/docs/content/reference/user-management/organization-membership/delete.mdx
66
+ ---
67
+
68
+ ## Delete an organization membership
69
+
70
+ Permanently deletes an existing organization membership. It cannot be undone.
71
+
72
+ <CodeBlock
73
+ title="Request"
74
+ file="delete-organization-membership-request"
75
+ referenceId="delete_organization_membership"
76
+ />
@@ -0,0 +1,95 @@
1
+ ---
2
+ reference:
3
+ curl:
4
+ - key: get_organization_membership
5
+ id: get_organization_membership
6
+ url: /reference/user-management/organization-membership/get
7
+ title: '/user_management/organization_memberships/:id'
8
+ type: GET
9
+ parameters:
10
+ - (organization_membership.id)
11
+ returns:
12
+ - (organization_membership)
13
+ js:
14
+ - key: getOrganizationMembership
15
+ id: get_organization_membership
16
+ url: /reference/user-management/organization-membership/get
17
+ title: userManagement.getOrganizationMembership()
18
+ parameters:
19
+ - key: options
20
+ type: object
21
+ unwrap: true
22
+ properties:
23
+ - (OrganizationMembership.id)
24
+ returns:
25
+ - (OrganizationMembership)
26
+ go:
27
+ - key: GetOrganizationMembership
28
+ patternBefore: usermanagement.
29
+ id: get_organization_membership
30
+ url: /reference/user-management/organization-membership/get
31
+ title: usermanagement.GetOrganizationMembership()
32
+ parameters:
33
+ - (ctx)
34
+ - key: opts
35
+ type: usermanagement.GetOrganizationMembershipOpts
36
+ unwrap: true
37
+ properties:
38
+ - key: OrganizationMembership
39
+ type: string
40
+ description: (organization_membership.id)
41
+ returns:
42
+ - key: organizationMembership
43
+ type: usermanagement.OrganizationMembership
44
+ description: (organization_membership.self)
45
+ - (err)
46
+ php:
47
+ - key: getOrganizationMembership
48
+ id: get_organization_membership
49
+ url: /reference/user-management/organization-membership/get
50
+ title: $userManagement->getOrganizationMembership()
51
+ parameters:
52
+ - (OrganizationMembership.id)
53
+ returns:
54
+ - (OrganizationMembership)
55
+ python:
56
+ - key: get_organization_membership
57
+ id: get_organization_membership
58
+ url: /reference/user-management/organization-membership/get
59
+ title: user_management.get_organization_membership()
60
+ parameters:
61
+ - key: organization_membership_id
62
+ type: str
63
+ description: (organization_membership.id)
64
+ returns:
65
+ - (OrganizationMembership)
66
+ ruby:
67
+ - key: get_organization_membership
68
+ id: get_organization_membership
69
+ url: /reference/user-management/organization-membership/get
70
+ title: UserManagement.get_organization_membership()
71
+ parameters:
72
+ - (OrganizationMembership.id)
73
+ returns:
74
+ - (OrganizationMembership)
75
+ java:
76
+ - key: getOrganizationMembership
77
+ id: get_organization_membership
78
+ url: /reference/user-management/organization-membership/get
79
+ title: userManagement.getOrganizationMembership()
80
+ parameters:
81
+ - (OrganizationMembership.id)
82
+ returns:
83
+ - (OrganizationMembership)
84
+ originalPath: >-
85
+ .tmp-workos-clone/packages/docs/content/reference/user-management/organization-membership/get.mdx
86
+ ---
87
+
88
+ ## Get an organization membership
89
+
90
+ Get the details of an existing organization membership.
91
+
92
+ <CodeBlock referenceId="get_organization_membership">
93
+ <CodeBlockTab title="Request" file="get-organization-membership-request" />
94
+ <CodeBlockTab title="Response" file="get-organization-membership-response" />
95
+ </CodeBlock>