@workos/mcp-docs-server 0.1.0 → 0.2.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 (568) hide show
  1. package/.docs/organized/changelogs/workos-platform.json +125 -125
  2. package/.docs/organized/docs/admin-portal/custom-branding.mdx +2 -4
  3. package/.docs/organized/docs/admin-portal/example-apps.mdx +11 -11
  4. package/.docs/organized/docs/admin-portal/index.mdx +39 -33
  5. package/.docs/organized/docs/audit-logs/admin-portal.mdx +1 -1
  6. package/.docs/organized/docs/audit-logs/editing-events.mdx +1 -1
  7. package/.docs/organized/docs/audit-logs/exporting-events.mdx +1 -1
  8. package/.docs/organized/docs/audit-logs/index.mdx +17 -2
  9. package/.docs/organized/docs/audit-logs/log-streams.mdx +325 -1
  10. package/.docs/organized/docs/audit-logs/metadata-schema.mdx +1 -1
  11. package/.docs/organized/docs/authkit/_navigation.mdx +108 -0
  12. package/.docs/organized/docs/{user-management → authkit}/actions.mdx +3 -4
  13. package/.docs/organized/docs/authkit/add-ons/google-analytics.mdx +79 -0
  14. package/.docs/organized/docs/authkit/add-ons/segment.mdx +77 -0
  15. package/.docs/organized/docs/authkit/add-ons/stripe.mdx +103 -0
  16. package/.docs/organized/docs/authkit/api-keys.mdx +99 -0
  17. package/.docs/organized/docs/{user-management → authkit}/branding.mdx +220 -2
  18. package/.docs/organized/docs/authkit/cli-auth.mdx +76 -0
  19. package/.docs/organized/docs/authkit/cli-installer.mdx +157 -0
  20. package/.docs/organized/docs/authkit/connect/m2m.mdx +65 -0
  21. package/.docs/organized/docs/authkit/connect/oauth.mdx +88 -0
  22. package/.docs/organized/docs/authkit/connect/standalone.mdx +179 -0
  23. package/.docs/organized/docs/authkit/connect.mdx +65 -0
  24. package/.docs/organized/docs/authkit/custom-email-providers.mdx +141 -0
  25. package/.docs/organized/docs/{user-management → authkit}/custom-emails.mdx +15 -15
  26. package/.docs/organized/docs/authkit/directory-provisioning.mdx +89 -0
  27. package/.docs/organized/docs/{user-management → authkit}/domain-verification.mdx +5 -6
  28. package/.docs/organized/docs/{user-management → authkit}/email-password.mdx +2 -2
  29. package/.docs/organized/docs/authkit/email-verification.mdx +31 -0
  30. package/.docs/organized/docs/{user-management → authkit}/example-apps.mdx +3 -3
  31. package/.docs/organized/docs/authkit/hosted-ui.mdx +165 -0
  32. package/.docs/organized/docs/{user-management → authkit}/identity-linking.mdx +9 -9
  33. package/.docs/organized/docs/{user-management → authkit}/impersonation.mdx +8 -8
  34. package/.docs/organized/docs/{user-management → authkit}/index.mdx +141 -74
  35. package/.docs/organized/docs/{user-management → authkit}/invitations.mdx +4 -4
  36. package/.docs/organized/docs/{user-management → authkit}/invite-only-signup.mdx +3 -3
  37. package/.docs/organized/docs/authkit/jit-provisioning.mdx +42 -0
  38. package/.docs/organized/docs/{user-management → authkit}/jwt-templates.mdx +37 -3
  39. package/.docs/organized/docs/authkit/landing.mdx +22 -0
  40. package/.docs/organized/docs/{user-management → authkit}/magic-auth.mdx +3 -5
  41. package/.docs/organized/docs/{user-management → authkit}/mcp.mdx +46 -9
  42. package/.docs/organized/docs/{user-management → authkit}/metadata.mdx +9 -9
  43. package/.docs/organized/docs/{user-management → authkit}/mfa.mdx +2 -2
  44. package/.docs/organized/docs/{user-management → authkit}/migrations.mdx +4 -4
  45. package/.docs/organized/docs/{user-management → authkit}/modeling-your-app.mdx +11 -11
  46. package/.docs/organized/docs/{user-management → authkit}/organization-policies.mdx +3 -4
  47. package/.docs/organized/docs/authkit/overview.mdx +46 -0
  48. package/.docs/organized/docs/{user-management → authkit}/passkeys.mdx +3 -3
  49. package/.docs/organized/docs/authkit/pipes.mdx +75 -0
  50. package/.docs/organized/docs/{user-management → authkit}/radar.mdx +39 -4
  51. package/.docs/organized/docs/authkit/roles-and-permissions.mdx +208 -0
  52. package/.docs/organized/docs/{user-management → authkit}/sessions.mdx +32 -20
  53. package/.docs/organized/docs/{user-management → authkit}/social-login.mdx +16 -2
  54. package/.docs/organized/docs/{user-management → authkit}/sso-with-contractors.mdx +3 -4
  55. package/.docs/organized/docs/{user-management → authkit}/sso.mdx +2 -2
  56. package/.docs/organized/docs/authkit/users-organizations.mdx +107 -0
  57. package/.docs/organized/docs/custom-domains/admin-portal.mdx +0 -2
  58. package/.docs/organized/docs/custom-domains/authkit.mdx +0 -2
  59. package/.docs/organized/docs/custom-domains/email.mdx +2 -2
  60. package/.docs/organized/docs/deprecations/_navigation.mdx +8 -0
  61. package/.docs/organized/docs/deprecations/raw-attributes.mdx +136 -0
  62. package/.docs/organized/docs/directory-sync/attributes.mdx +50 -31
  63. package/.docs/organized/docs/directory-sync/example-apps.mdx +11 -11
  64. package/.docs/organized/docs/directory-sync/identity-provider-role-assignment.mdx +23 -26
  65. package/.docs/organized/docs/directory-sync/index.mdx +4 -2
  66. package/.docs/organized/docs/directory-sync/quick-start.mdx +3 -3
  67. package/.docs/organized/docs/directory-sync/understanding-events.mdx +2 -2
  68. package/.docs/organized/docs/domain-verification/api.mdx +8 -8
  69. package/.docs/organized/docs/domain-verification/index.mdx +3 -3
  70. package/.docs/organized/docs/email.mdx +49 -5
  71. package/.docs/organized/docs/events/data-syncing/events-api.mdx +3 -3
  72. package/.docs/organized/docs/events/data-syncing/index.mdx +2 -3
  73. package/.docs/organized/docs/events/data-syncing/webhooks.mdx +4 -4
  74. package/.docs/organized/docs/events/index.mdx +419 -33
  75. package/.docs/organized/docs/feature-flags/_navigation.mdx +10 -0
  76. package/.docs/organized/docs/feature-flags/index.mdx +80 -0
  77. package/.docs/organized/docs/feature-flags/slack-notifications.mdx +58 -0
  78. package/.docs/organized/docs/fga/_navigation.mdx +34 -54
  79. package/.docs/organized/docs/fga/access-checks.mdx +109 -0
  80. package/.docs/organized/docs/fga/assignments.mdx +124 -0
  81. package/.docs/organized/docs/fga/authkit-integration.mdx +92 -0
  82. package/.docs/organized/docs/fga/high-cardinality-entities.mdx +172 -0
  83. package/.docs/organized/docs/fga/idp-role-assignment.mdx +66 -0
  84. package/.docs/organized/docs/fga/index.mdx +94 -29
  85. package/.docs/organized/docs/fga/migration-openfga.mdx +306 -0
  86. package/.docs/organized/docs/fga/migration-oso.mdx +372 -0
  87. package/.docs/organized/docs/fga/migration-spicedb.mdx +364 -0
  88. package/.docs/organized/docs/fga/quick-start.mdx +283 -98
  89. package/.docs/organized/docs/fga/resource-discovery.mdx +78 -0
  90. package/.docs/organized/docs/fga/resource-types.mdx +165 -0
  91. package/.docs/organized/docs/fga/resources.mdx +179 -59
  92. package/.docs/organized/docs/fga/roles-and-permissions.mdx +122 -0
  93. package/.docs/organized/docs/fga/standalone-integration.mdx +176 -0
  94. package/.docs/organized/docs/glossary.mdx +7 -3
  95. package/.docs/organized/docs/integrations/access-people-hr.mdx +1 -1
  96. package/.docs/organized/docs/integrations/adp-oidc.mdx +1 -1
  97. package/.docs/organized/docs/integrations/apple.mdx +112 -69
  98. package/.docs/organized/docs/integrations/auth0-directory-sync.mdx +3 -1
  99. package/.docs/organized/docs/integrations/auth0-enterprise-connection.mdx +3 -1
  100. package/.docs/organized/docs/integrations/auth0-saml.mdx +3 -1
  101. package/.docs/organized/docs/integrations/bamboohr.mdx +4 -4
  102. package/.docs/organized/docs/integrations/breathe-hr.mdx +1 -1
  103. package/.docs/organized/docs/integrations/bubble.mdx +1 -1
  104. package/.docs/organized/docs/integrations/cas-saml.mdx +2 -2
  105. package/.docs/organized/docs/integrations/classlink-saml.mdx +2 -2
  106. package/.docs/organized/docs/integrations/clever-oidc.mdx +94 -0
  107. package/.docs/organized/docs/integrations/cloudflare-saml.mdx +35 -2
  108. package/.docs/organized/docs/integrations/cyberark-saml.mdx +2 -2
  109. package/.docs/organized/docs/integrations/cyberark-scim.mdx +1 -1
  110. package/.docs/organized/docs/integrations/duo-saml.mdx +2 -2
  111. package/.docs/organized/docs/integrations/entra-id-oidc.mdx +198 -0
  112. package/.docs/organized/docs/integrations/entra-id-saml.mdx +3 -3
  113. package/.docs/organized/docs/integrations/entra-id-scim.mdx +5 -1
  114. package/.docs/organized/docs/integrations/fourth.mdx +2 -2
  115. package/.docs/organized/docs/integrations/github-oauth.mdx +80 -33
  116. package/.docs/organized/docs/integrations/gitlab-oauth.mdx +86 -31
  117. package/.docs/organized/docs/integrations/google-directory-sync.mdx +5 -1
  118. package/.docs/organized/docs/integrations/google-oauth.mdx +87 -70
  119. package/.docs/organized/docs/integrations/google-oidc.mdx +142 -0
  120. package/.docs/organized/docs/integrations/google-saml.mdx +3 -3
  121. package/.docs/organized/docs/integrations/hibob.mdx +17 -4
  122. package/.docs/organized/docs/integrations/intuit-oauth.mdx +128 -0
  123. package/.docs/organized/docs/integrations/jumpcloud-saml.mdx +2 -2
  124. package/.docs/organized/docs/integrations/jumpcloud-scim.mdx +5 -1
  125. package/.docs/organized/docs/integrations/keycloak-saml.mdx +2 -2
  126. package/.docs/organized/docs/integrations/lastpass-saml.mdx +2 -2
  127. package/.docs/organized/docs/integrations/linkedin-oauth.mdx +69 -30
  128. package/.docs/organized/docs/integrations/microsoft-ad-fs-saml.mdx +2 -2
  129. package/.docs/organized/docs/integrations/microsoft-oauth.mdx +95 -38
  130. package/.docs/organized/docs/integrations/miniorange-saml.mdx +2 -2
  131. package/.docs/organized/docs/integrations/net-iq-saml.mdx +2 -2
  132. package/.docs/organized/docs/integrations/next-auth.mdx +1 -1
  133. package/.docs/organized/docs/integrations/oidc.mdx +37 -24
  134. package/.docs/organized/docs/integrations/okta-oidc.mdx +149 -0
  135. package/.docs/organized/docs/integrations/okta-saml.mdx +3 -3
  136. package/.docs/organized/docs/integrations/okta-scim.mdx +6 -2
  137. package/.docs/organized/docs/integrations/onelogin-saml.mdx +2 -2
  138. package/.docs/organized/docs/integrations/onelogin-scim.mdx +1 -1
  139. package/.docs/organized/docs/integrations/oracle-saml.mdx +2 -2
  140. package/.docs/organized/docs/integrations/pingfederate-saml.mdx +2 -2
  141. package/.docs/organized/docs/integrations/pingfederate-scim.mdx +1 -1
  142. package/.docs/organized/docs/integrations/pingone-saml.mdx +2 -2
  143. package/.docs/organized/docs/integrations/rippling-saml.mdx +2 -2
  144. package/.docs/organized/docs/integrations/rippling-scim.mdx +1 -1
  145. package/.docs/organized/docs/integrations/sailpoint-scim.mdx +77 -0
  146. package/.docs/organized/docs/integrations/salesforce-oauth.mdx +116 -0
  147. package/.docs/organized/docs/integrations/salesforce-saml.mdx +4 -4
  148. package/.docs/organized/docs/integrations/saml.mdx +43 -23
  149. package/.docs/organized/docs/integrations/scim.mdx +36 -24
  150. package/.docs/organized/docs/integrations/sftp.mdx +59 -36
  151. package/.docs/organized/docs/integrations/shibboleth-generic-saml.mdx +1 -1
  152. package/.docs/organized/docs/integrations/shibboleth-unsolicited-saml.mdx +1 -1
  153. package/.docs/organized/docs/integrations/simple-saml-php.mdx +2 -2
  154. package/.docs/organized/docs/integrations/slack-oauth.mdx +53 -49
  155. package/.docs/organized/docs/integrations/supabase-authkit.mdx +46 -0
  156. package/.docs/organized/docs/integrations/{supabase.mdx → supabase-sso.mdx} +6 -4
  157. package/.docs/organized/docs/integrations/vercel-oauth.mdx +120 -0
  158. package/.docs/organized/docs/integrations/vmware-saml.mdx +2 -2
  159. package/.docs/organized/docs/integrations/workday.mdx +1 -1
  160. package/.docs/organized/docs/integrations/xero-oauth.mdx +77 -32
  161. package/.docs/organized/docs/magic-link/example-apps.mdx +11 -11
  162. package/.docs/organized/docs/magic-link/index.mdx +2 -0
  163. package/.docs/organized/docs/mfa/example-apps.mdx +2 -2
  164. package/.docs/organized/docs/mfa/index.mdx +2 -2
  165. package/.docs/organized/docs/mfa/ux/enrollment.mdx +1 -1
  166. package/.docs/organized/docs/mfa/ux/sign-in.mdx +1 -1
  167. package/.docs/organized/docs/migrate/_navigation.mdx +21 -1
  168. package/.docs/organized/docs/migrate/auth0.mdx +5 -5
  169. package/.docs/organized/docs/migrate/aws-cognito.mdx +5 -5
  170. package/.docs/organized/docs/migrate/better-auth.mdx +282 -0
  171. package/.docs/organized/docs/migrate/clerk.mdx +9 -11
  172. package/.docs/organized/docs/migrate/descope.mdx +290 -0
  173. package/.docs/organized/docs/migrate/firebase.mdx +4 -4
  174. package/.docs/organized/docs/migrate/other-services.mdx +25 -6
  175. package/.docs/organized/docs/migrate/standalone-sso.mdx +14 -14
  176. package/.docs/organized/docs/migrate/stytch.mdx +363 -0
  177. package/.docs/organized/docs/migrate/supabase.mdx +255 -0
  178. package/.docs/organized/docs/on-prem-deployment.mdx +1 -1
  179. package/.docs/organized/docs/pipes/_navigation.mdx +12 -0
  180. package/.docs/organized/docs/pipes/index.mdx +75 -0
  181. package/.docs/organized/docs/pipes/providers.mdx +9 -0
  182. package/.docs/organized/docs/rbac/_navigation.mdx +16 -0
  183. package/.docs/organized/docs/rbac/configuration.mdx +80 -0
  184. package/.docs/organized/docs/rbac/idp-role-assignment.mdx +79 -0
  185. package/.docs/organized/docs/rbac/index.mdx +24 -0
  186. package/.docs/organized/docs/rbac/integration.mdx +59 -0
  187. package/.docs/organized/docs/rbac/organization-roles.mdx +38 -0
  188. package/.docs/organized/docs/rbac/quick-start.mdx +52 -0
  189. package/.docs/organized/docs/reference/_navigation.mdx +437 -284
  190. package/.docs/organized/docs/reference/admin-portal/portal-link/index.mdx +1 -1
  191. package/.docs/organized/docs/reference/admin-portal/provider-icons/index.mdx +3 -3
  192. package/.docs/organized/docs/reference/{api-keys.mdx → api-authentication/index.mdx} +3 -3
  193. package/.docs/organized/docs/reference/audit-logs/configuration/index.mdx +97 -0
  194. package/.docs/organized/docs/reference/audit-logs/{create-event.mdx → event/create.mdx} +12 -2
  195. package/.docs/organized/docs/reference/audit-logs/event/index.mdx +92 -0
  196. package/.docs/organized/docs/reference/audit-logs/{create-export.mdx → export/create.mdx} +1 -1
  197. package/.docs/organized/docs/reference/audit-logs/{get-export.mdx → export/get.mdx} +1 -1
  198. package/.docs/organized/docs/reference/audit-logs/{audit-log-export.mdx → export/index.mdx} +11 -12
  199. package/.docs/organized/docs/reference/audit-logs/{get-retention.mdx → retention/get.mdx} +1 -1
  200. package/.docs/organized/docs/reference/audit-logs/retention/index.mdx +25 -0
  201. package/.docs/organized/docs/reference/audit-logs/{set-retention.mdx → retention/set.mdx} +1 -1
  202. package/.docs/organized/docs/reference/audit-logs/{create-schema.mdx → schema/create.mdx} +1 -1
  203. package/.docs/organized/docs/reference/audit-logs/{audit-log-schema.mdx → schema/index.mdx} +5 -6
  204. package/.docs/organized/docs/reference/audit-logs/{list-actions.mdx → schema/list-actions.mdx} +2 -1
  205. package/.docs/organized/docs/reference/audit-logs/{list-schemas.mdx → schema/list.mdx} +1 -1
  206. package/.docs/organized/docs/reference/authkit/api-keys/create-for-organization.mdx +40 -0
  207. package/.docs/organized/docs/reference/authkit/api-keys/delete.mdx +23 -0
  208. package/.docs/organized/docs/reference/authkit/api-keys/index.mdx +275 -0
  209. package/.docs/organized/docs/reference/authkit/api-keys/list-for-organization.mdx +41 -0
  210. package/.docs/organized/docs/reference/authkit/api-keys/validate.mdx +77 -0
  211. package/.docs/organized/docs/reference/{user-management → authkit}/authentication/code.mdx +138 -18
  212. package/.docs/organized/docs/reference/{user-management → authkit}/authentication/email-verification.mdx +10 -10
  213. package/.docs/organized/docs/reference/{user-management → authkit}/authentication/get-authorization-url/error-codes.mdx +3 -3
  214. package/.docs/organized/docs/reference/{user-management → authkit}/authentication/get-authorization-url/index.mdx +64 -17
  215. package/.docs/organized/docs/reference/{user-management → authkit}/authentication/get-authorization-url/pkce.mdx +2 -2
  216. package/.docs/organized/docs/reference/authkit/authentication/get-authorization-url/redirect-uri.mdx +47 -0
  217. package/.docs/organized/docs/reference/{user-management → authkit}/authentication/index.mdx +19 -11
  218. package/.docs/organized/docs/reference/{user-management → authkit}/authentication/magic-auth.mdx +9 -9
  219. package/.docs/organized/docs/reference/{user-management → authkit}/authentication/organization-selection.mdx +9 -9
  220. package/.docs/organized/docs/reference/{user-management → authkit}/authentication/password.mdx +8 -8
  221. package/.docs/organized/docs/reference/{user-management → authkit}/authentication/refresh-and-seal-session-data.mdx +3 -3
  222. package/.docs/organized/docs/reference/{user-management → authkit}/authentication/refresh-token.mdx +17 -17
  223. package/.docs/organized/docs/reference/{user-management → authkit}/authentication/session-cookie.mdx +7 -3
  224. package/.docs/organized/docs/reference/{user-management → authkit}/authentication/totp.mdx +10 -10
  225. package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/email-verification-required-error.mdx +3 -3
  226. package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/index.mdx +1 -3
  227. package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/mfa-challenge-error.mdx +3 -3
  228. package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/mfa-enrollment-error.mdx +3 -3
  229. package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/organization-authentication-required-error.mdx +3 -3
  230. package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/organization-selection-error.mdx +3 -4
  231. package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/sso-required-error.mdx +3 -3
  232. package/.docs/organized/docs/reference/authkit/cli-auth/device-authorization.mdx +61 -0
  233. package/.docs/organized/docs/reference/authkit/cli-auth/device-code.mdx +57 -0
  234. package/.docs/organized/docs/reference/authkit/cli-auth/error-codes.mdx +31 -0
  235. package/.docs/organized/docs/reference/authkit/cli-auth/index.mdx +22 -0
  236. package/.docs/organized/docs/reference/{user-management → authkit}/email-verification/get.mdx +8 -8
  237. package/.docs/organized/docs/reference/{user-management → authkit}/email-verification/index.mdx +9 -11
  238. package/.docs/organized/docs/reference/{user-management → authkit}/identity/index.mdx +6 -9
  239. package/.docs/organized/docs/reference/{user-management → authkit}/identity/list.mdx +5 -6
  240. package/.docs/organized/docs/reference/authkit/index.mdx +13 -0
  241. package/.docs/organized/docs/reference/{user-management → authkit}/invitation/accept.mdx +5 -5
  242. package/.docs/organized/docs/reference/{user-management → authkit}/invitation/find-by-token.mdx +8 -8
  243. package/.docs/organized/docs/reference/{user-management → authkit}/invitation/get.mdx +8 -9
  244. package/.docs/organized/docs/reference/{user-management → authkit}/invitation/index.mdx +10 -15
  245. package/.docs/organized/docs/reference/{user-management → authkit}/invitation/list.mdx +10 -11
  246. package/.docs/organized/docs/reference/authkit/invitation/resend.mdx +109 -0
  247. package/.docs/organized/docs/reference/{user-management → authkit}/invitation/revoke.mdx +8 -8
  248. package/.docs/organized/docs/reference/{user-management → authkit}/invitation/send.mdx +23 -13
  249. package/.docs/organized/docs/reference/{user-management → authkit}/logout/get-logout-url-from-session-cookie.mdx +2 -2
  250. package/.docs/organized/docs/reference/{user-management → authkit}/logout/get-logout-url.mdx +8 -8
  251. package/.docs/organized/docs/reference/{user-management → authkit}/logout/index.mdx +4 -5
  252. package/.docs/organized/docs/reference/{user-management → authkit}/magic-auth/create.mdx +10 -10
  253. package/.docs/organized/docs/reference/{user-management → authkit}/magic-auth/get.mdx +9 -10
  254. package/.docs/organized/docs/reference/{user-management → authkit}/magic-auth/index.mdx +10 -15
  255. package/.docs/organized/docs/reference/{user-management → authkit}/mfa/authentication-challenge.mdx +9 -10
  256. package/.docs/organized/docs/reference/{user-management → authkit}/mfa/authentication-factor.mdx +11 -11
  257. package/.docs/organized/docs/reference/{user-management → authkit}/mfa/enroll-auth-factor.mdx +19 -15
  258. package/.docs/organized/docs/reference/authkit/mfa/index.mdx +11 -0
  259. package/.docs/organized/docs/reference/{user-management → authkit}/mfa/list-auth-factors.mdx +9 -9
  260. package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/create.mdx +27 -10
  261. package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/deactivate.mdx +10 -10
  262. package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/delete.mdx +8 -8
  263. package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/get.mdx +8 -8
  264. package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/index.mdx +107 -14
  265. package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/list.mdx +10 -10
  266. package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/reactivate.mdx +11 -11
  267. package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/update.mdx +25 -9
  268. package/.docs/organized/docs/reference/{user-management → authkit}/password-reset/create.mdx +8 -8
  269. package/.docs/organized/docs/reference/{user-management → authkit}/password-reset/get.mdx +8 -8
  270. package/.docs/organized/docs/reference/{user-management → authkit}/password-reset/index.mdx +10 -12
  271. package/.docs/organized/docs/reference/{user-management → authkit}/password-reset/reset-password.mdx +8 -8
  272. package/.docs/organized/docs/reference/authkit/session/index.mdx +128 -0
  273. package/.docs/organized/docs/reference/authkit/session/list.mdx +110 -0
  274. package/.docs/organized/docs/reference/authkit/session/revoke.mdx +73 -0
  275. package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/authenticate.mdx +22 -6
  276. package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/get-logout-url.mdx +5 -5
  277. package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/index.mdx +2 -2
  278. package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/load-sealed-session.mdx +4 -4
  279. package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/refresh.mdx +18 -6
  280. package/.docs/organized/docs/reference/{user-management → authkit}/session-tokens/access-token.mdx +16 -8
  281. package/.docs/organized/docs/reference/authkit/session-tokens/index.mdx +5 -0
  282. package/.docs/organized/docs/reference/{user-management → authkit}/session-tokens/jwks.mdx +8 -8
  283. package/.docs/organized/docs/reference/authkit/session-tokens/refresh-token.mdx +8 -0
  284. package/.docs/organized/docs/reference/{user-management → authkit}/user/create.mdx +36 -17
  285. package/.docs/organized/docs/reference/{user-management → authkit}/user/delete.mdx +8 -9
  286. package/.docs/organized/docs/reference/{user-management → authkit}/user/get-by-external-id.mdx +16 -4
  287. package/.docs/organized/docs/reference/{user-management → authkit}/user/get.mdx +8 -8
  288. package/.docs/organized/docs/reference/{user-management → authkit}/user/index.mdx +25 -15
  289. package/.docs/organized/docs/reference/{user-management → authkit}/user/list.mdx +9 -12
  290. package/.docs/organized/docs/reference/{user-management → authkit}/user/update.mdx +43 -20
  291. package/.docs/organized/docs/reference/{client-libraries.mdx → client-libraries/index.mdx} +2 -2
  292. package/.docs/organized/docs/reference/directory-sync/directory/index.mdx +1 -1
  293. package/.docs/organized/docs/reference/directory-sync/directory-group/index.mdx +1 -24
  294. package/.docs/organized/docs/reference/directory-sync/directory-user/index.mdx +1 -29
  295. package/.docs/organized/docs/reference/directory-sync/directory-user/list.mdx +1 -1
  296. package/.docs/organized/docs/reference/directory-sync/index.mdx +1 -1
  297. package/.docs/organized/docs/reference/domain-verification/create.mdx +35 -0
  298. package/.docs/organized/docs/reference/domain-verification/delete.mdx +55 -0
  299. package/.docs/organized/docs/reference/domain-verification/get.mdx +29 -0
  300. package/.docs/organized/docs/reference/domain-verification/index.mdx +57 -1
  301. package/.docs/organized/docs/reference/domain-verification/verify.mdx +29 -0
  302. package/.docs/organized/docs/reference/{errors.mdx → errors/index.mdx} +1 -1
  303. package/.docs/organized/docs/reference/events/list.mdx +5 -4
  304. package/.docs/organized/docs/reference/feature-flags/flag/disable.mdx +33 -0
  305. package/.docs/organized/docs/reference/feature-flags/flag/enable.mdx +33 -0
  306. package/.docs/organized/docs/reference/feature-flags/flag/get.mdx +32 -0
  307. package/.docs/organized/docs/reference/feature-flags/flag/index.mdx +116 -0
  308. package/.docs/organized/docs/reference/feature-flags/flag/list.mdx +67 -0
  309. package/.docs/organized/docs/reference/feature-flags/index.mdx +123 -0
  310. package/.docs/organized/docs/reference/feature-flags/targeting/add.mdx +43 -0
  311. package/.docs/organized/docs/reference/feature-flags/targeting/index.mdx +23 -0
  312. package/.docs/organized/docs/reference/feature-flags/targeting/list-for-organization.mdx +132 -0
  313. package/.docs/organized/docs/reference/feature-flags/targeting/list-for-user.mdx +94 -0
  314. package/.docs/organized/docs/reference/feature-flags/targeting/remove.mdx +43 -0
  315. package/.docs/organized/docs/reference/fga/access-check/check.mdx +102 -0
  316. package/.docs/organized/docs/reference/fga/access-check/index.mdx +6 -0
  317. package/.docs/organized/docs/reference/fga/access-check/list-memberships-by-external-id.mdx +143 -0
  318. package/.docs/organized/docs/reference/fga/access-check/list-memberships.mdx +127 -0
  319. package/.docs/organized/docs/reference/fga/access-check/list-resources.mdx +152 -0
  320. package/.docs/organized/docs/reference/fga/index.mdx +14 -2
  321. package/.docs/organized/docs/reference/fga/resource/create.mdx +74 -88
  322. package/.docs/organized/docs/reference/fga/resource/delete-by-external-id.mdx +78 -0
  323. package/.docs/organized/docs/reference/fga/resource/delete.mdx +38 -62
  324. package/.docs/organized/docs/reference/fga/resource/get-by-external-id.mdx +60 -0
  325. package/.docs/organized/docs/reference/fga/resource/get.mdx +15 -63
  326. package/.docs/organized/docs/reference/fga/resource/index.mdx +74 -73
  327. package/.docs/organized/docs/reference/fga/resource/list.mdx +90 -131
  328. package/.docs/organized/docs/reference/fga/resource/update-by-external-id.mdx +81 -0
  329. package/.docs/organized/docs/reference/fga/resource/update.mdx +29 -85
  330. package/.docs/organized/docs/reference/fga/role-assignment/create.mdx +89 -0
  331. package/.docs/organized/docs/reference/fga/role-assignment/delete-by-id.mdx +59 -0
  332. package/.docs/organized/docs/reference/fga/role-assignment/delete.mdx +90 -0
  333. package/.docs/organized/docs/reference/fga/role-assignment/index.mdx +106 -0
  334. package/.docs/organized/docs/reference/fga/role-assignment/list.mdx +86 -0
  335. package/.docs/organized/docs/reference/index.mdx +21 -12
  336. package/.docs/organized/docs/reference/magic-link/passwordless-session/index.mdx +1 -1
  337. package/.docs/organized/docs/reference/mfa/{challenge-factor.mdx → challenge/create.mdx} +1 -1
  338. package/.docs/organized/docs/reference/mfa/{authentication-challenge.mdx → challenge/index.mdx} +11 -14
  339. package/.docs/organized/docs/reference/mfa/{verify-challenge.mdx → challenge/verify.mdx} +10 -12
  340. package/.docs/organized/docs/reference/mfa/{delete-factor.mdx → factor/delete.mdx} +1 -1
  341. package/.docs/organized/docs/reference/mfa/{enroll-factor.mdx → factor/enroll.mdx} +1 -1
  342. package/.docs/organized/docs/reference/mfa/{get-factor.mdx → factor/get.mdx} +1 -1
  343. package/.docs/organized/docs/reference/mfa/{authentication-factor.mdx → factor/index.mdx} +11 -12
  344. package/.docs/organized/docs/reference/organization/create.mdx +1 -6
  345. package/.docs/organized/docs/reference/organization/get-by-external-id.mdx +1 -1
  346. package/.docs/organized/docs/reference/organization/index.mdx +5 -5
  347. package/.docs/organized/docs/reference/organization/update.mdx +1 -1
  348. package/.docs/organized/docs/reference/{pagination.mdx → pagination/index.mdx} +1 -3
  349. package/.docs/organized/docs/reference/pipes/access-token/get.mdx +174 -0
  350. package/.docs/organized/docs/reference/pipes/access-token/index.mdx +44 -0
  351. package/.docs/organized/docs/reference/pipes/connected-account/delete.mdx +42 -0
  352. package/.docs/organized/docs/reference/pipes/connected-account/get-authorize-url.mdx +49 -0
  353. package/.docs/organized/docs/reference/pipes/connected-account/get.mdx +42 -0
  354. package/.docs/organized/docs/reference/pipes/connected-account/index.mdx +69 -0
  355. package/.docs/organized/docs/reference/pipes/index.mdx +8 -0
  356. package/.docs/organized/docs/reference/pipes/provider/index.mdx +70 -0
  357. package/.docs/organized/docs/reference/pipes/provider/list.mdx +47 -0
  358. package/.docs/organized/docs/reference/radar/attempts/index.mdx +1 -1
  359. package/.docs/organized/docs/reference/radar/lists/index.mdx +1 -1
  360. package/.docs/organized/docs/reference/rate-limits/index.mdx +56 -0
  361. package/.docs/organized/docs/reference/roles/index.mdx +12 -262
  362. package/.docs/organized/docs/reference/roles/organization-role/add-permission.mdx +75 -0
  363. package/.docs/organized/docs/reference/roles/organization-role/create.mdx +95 -0
  364. package/.docs/organized/docs/reference/roles/organization-role/delete.mdx +47 -0
  365. package/.docs/organized/docs/reference/roles/organization-role/get.mdx +55 -0
  366. package/.docs/organized/docs/reference/roles/organization-role/index.mdx +148 -0
  367. package/.docs/organized/docs/reference/roles/organization-role/list.mdx +68 -0
  368. package/.docs/organized/docs/reference/roles/organization-role/remove-permission.mdx +68 -0
  369. package/.docs/organized/docs/reference/roles/organization-role/set-permissions.mdx +79 -0
  370. package/.docs/organized/docs/reference/roles/organization-role/update.mdx +85 -0
  371. package/.docs/organized/docs/reference/roles/permission/create.mdx +101 -0
  372. package/.docs/organized/docs/reference/roles/permission/delete.mdx +38 -0
  373. package/.docs/organized/docs/reference/roles/permission/get.mdx +45 -0
  374. package/.docs/organized/docs/reference/roles/permission/index.mdx +128 -0
  375. package/.docs/organized/docs/reference/roles/permission/list.mdx +91 -0
  376. package/.docs/organized/docs/reference/roles/permission/update.mdx +80 -0
  377. package/.docs/organized/docs/reference/roles/role/add-permission.mdx +63 -0
  378. package/.docs/organized/docs/reference/roles/role/create.mdx +103 -0
  379. package/.docs/organized/docs/reference/roles/role/get.mdx +52 -0
  380. package/.docs/organized/docs/reference/roles/role/index.mdx +135 -0
  381. package/.docs/organized/docs/reference/roles/role/list.mdx +56 -0
  382. package/.docs/organized/docs/reference/roles/role/set-permissions.mdx +67 -0
  383. package/.docs/organized/docs/reference/roles/role/update.mdx +78 -0
  384. package/.docs/organized/docs/reference/sso/connection/index.mdx +2 -2
  385. package/.docs/organized/docs/reference/sso/get-authorization-url/error-codes.mdx +5 -3
  386. package/.docs/organized/docs/reference/sso/get-authorization-url/index.mdx +24 -2
  387. package/.docs/organized/docs/reference/sso/get-authorization-url/redirect-uri.mdx +25 -1
  388. package/.docs/organized/docs/reference/sso/index.mdx +1 -1
  389. package/.docs/organized/docs/reference/sso/logout/authorize.mdx +0 -1
  390. package/.docs/organized/docs/reference/sso/logout/index.mdx +1 -2
  391. package/.docs/organized/docs/reference/sso/logout/redirect.mdx +0 -1
  392. package/.docs/organized/docs/reference/sso/profile/get-profile-and-token.mdx +13 -1
  393. package/.docs/organized/docs/reference/sso/profile/index.mdx +25 -24
  394. package/.docs/organized/docs/reference/{testing.mdx → testing/index.mdx} +1 -1
  395. package/.docs/organized/docs/reference/vault/key/create-data-key.mdx +29 -0
  396. package/.docs/organized/docs/reference/vault/key/decrypt-data-key.mdx +20 -0
  397. package/.docs/organized/docs/reference/vault/key/decrypt-data.mdx +24 -0
  398. package/.docs/organized/docs/reference/vault/key/encrypt-data.mdx +20 -0
  399. package/.docs/organized/docs/reference/vault/object/create.mdx +17 -0
  400. package/.docs/organized/docs/reference/vault/object/delete.mdx +12 -0
  401. package/.docs/organized/docs/reference/vault/object/get-by-name.mdx +61 -0
  402. package/.docs/organized/docs/reference/vault/object/get.mdx +11 -0
  403. package/.docs/organized/docs/reference/vault/object/index.mdx +50 -4
  404. package/.docs/organized/docs/reference/vault/object/list.mdx +40 -1
  405. package/.docs/organized/docs/reference/vault/object/update.mdx +18 -0
  406. package/.docs/organized/docs/reference/vault/object/version.mdx +15 -2
  407. package/.docs/organized/docs/reference/vault/object/versions.mdx +13 -0
  408. package/.docs/organized/docs/reference/widgets/get-token.mdx +8 -5
  409. package/.docs/organized/docs/reference/workos-connect/applications/client-secrets/create.mdx +55 -0
  410. package/.docs/organized/docs/reference/workos-connect/applications/client-secrets/delete.mdx +28 -0
  411. package/.docs/organized/docs/reference/workos-connect/applications/client-secrets/index.mdx +60 -0
  412. package/.docs/organized/docs/reference/workos-connect/applications/client-secrets/list.mdx +52 -0
  413. package/.docs/organized/docs/reference/workos-connect/applications/create.mdx +79 -0
  414. package/.docs/organized/docs/reference/workos-connect/applications/delete.mdx +28 -0
  415. package/.docs/organized/docs/reference/workos-connect/applications/get.mdx +59 -0
  416. package/.docs/organized/docs/reference/workos-connect/applications/index.mdx +40 -0
  417. package/.docs/organized/docs/reference/workos-connect/applications/list.mdx +49 -0
  418. package/.docs/organized/docs/reference/workos-connect/applications/m2m.mdx +52 -0
  419. package/.docs/organized/docs/reference/workos-connect/applications/oauth.mdx +85 -0
  420. package/.docs/organized/docs/reference/workos-connect/applications/update.mdx +59 -0
  421. package/.docs/organized/docs/reference/workos-connect/authorize/index.mdx +29 -1
  422. package/.docs/organized/docs/reference/workos-connect/cli-auth/authorize-device/index.mdx +81 -0
  423. package/.docs/organized/docs/reference/workos-connect/cli-auth/device-code-grant.mdx +74 -0
  424. package/.docs/organized/docs/reference/workos-connect/cli-auth/index.mdx +23 -0
  425. package/.docs/organized/docs/reference/workos-connect/index.mdx +1 -1
  426. package/.docs/organized/docs/reference/workos-connect/introspection/index.mdx +8 -3
  427. package/.docs/organized/docs/reference/workos-connect/metadata/index.mdx +1 -1
  428. package/.docs/organized/docs/reference/workos-connect/metadata/oauth-authorization-server/index.mdx +1 -1
  429. package/.docs/organized/docs/reference/workos-connect/standalone/complete.mdx +68 -0
  430. package/.docs/organized/docs/reference/workos-connect/standalone/index.mdx +9 -0
  431. package/.docs/organized/docs/reference/workos-connect/standalone/user-consent-options.mdx +41 -0
  432. package/.docs/organized/docs/reference/workos-connect/token/authorization-code-grant/access-token.mdx +6 -0
  433. package/.docs/organized/docs/reference/workos-connect/token/authorization-code-grant/id-token.mdx +1 -1
  434. package/.docs/organized/docs/reference/workos-connect/token/{authorization-code-grant/index.mdx → authorization-code-grant.mdx} +23 -2
  435. package/.docs/organized/docs/reference/workos-connect/token/client-credentials-grant/access-token.mdx +1 -1
  436. package/.docs/organized/docs/reference/workos-connect/token/{client-credentials-grant/index.mdx → client-credentials-grant.mdx} +2 -2
  437. package/.docs/organized/docs/reference/workos-connect/token/index.mdx +5 -4
  438. package/.docs/organized/docs/reference/workos-connect/token/refresh-token-grant.mdx +1 -1
  439. package/.docs/organized/docs/reference/workos-connect/userinfo/index.mdx +2 -2
  440. package/.docs/organized/docs/sdks/authkit-js.mdx +14 -0
  441. package/.docs/organized/docs/sdks/authkit-nextjs.mdx +14 -0
  442. package/.docs/organized/docs/sdks/authkit-react-router.mdx +14 -0
  443. package/.docs/organized/docs/sdks/authkit-react.mdx +14 -0
  444. package/.docs/organized/docs/sdks/authkit-remix.mdx +14 -0
  445. package/.docs/organized/docs/sdks/authkit-tanstack-start.mdx +14 -0
  446. package/.docs/organized/docs/sso/_navigation.mdx +8 -2
  447. package/.docs/organized/docs/sso/attributes.mdx +15 -3
  448. package/.docs/organized/docs/sso/domains.mdx +8 -6
  449. package/.docs/organized/docs/sso/example-apps.mdx +2 -2
  450. package/.docs/organized/docs/sso/identity-provider-role-assignment.mdx +30 -30
  451. package/.docs/organized/docs/sso/index.mdx +7 -6
  452. package/.docs/organized/docs/sso/it-team-faq.mdx +1 -1
  453. package/.docs/organized/docs/sso/jit-provisioning.mdx +2 -3
  454. package/.docs/organized/docs/sso/launch-checklist.mdx +2 -2
  455. package/.docs/organized/docs/sso/login-flows.mdx +3 -3
  456. package/.docs/organized/docs/sso/redirect-uris.mdx +22 -11
  457. package/.docs/organized/docs/sso/saml-security.mdx +1 -1
  458. package/.docs/organized/docs/sso/sign-in-consent.mdx +59 -0
  459. package/.docs/organized/docs/sso/signing-certificates.mdx +7 -7
  460. package/.docs/organized/docs/sso/single-logout.mdx +0 -1
  461. package/.docs/organized/docs/sso/ux/sessions.mdx +99 -0
  462. package/.docs/organized/docs/sso/ux/sign-in.mdx +1 -1
  463. package/.docs/organized/docs/vault/_navigation.mdx +2 -0
  464. package/.docs/organized/docs/vault/byok.mdx +140 -0
  465. package/.docs/organized/docs/vault/index.mdx +1 -1
  466. package/.docs/organized/docs/widgets/_navigation.mdx +48 -0
  467. package/.docs/organized/docs/widgets/admin-portal-domain-verification.mdx +24 -0
  468. package/.docs/organized/docs/widgets/admin-portal-sso-connection.mdx +20 -0
  469. package/.docs/organized/docs/widgets/api-keys.mdx +28 -0
  470. package/.docs/organized/docs/widgets/audit-log-streaming.mdx +25 -0
  471. package/.docs/organized/docs/widgets/directory-sync.mdx +23 -0
  472. package/.docs/organized/docs/widgets/index.mdx +12 -0
  473. package/.docs/organized/docs/widgets/localization.mdx +111 -0
  474. package/.docs/organized/docs/widgets/organization-switcher.mdx +47 -0
  475. package/.docs/organized/docs/widgets/pipes.mdx +27 -0
  476. package/.docs/organized/docs/widgets/quick-start.mdx +38 -0
  477. package/.docs/organized/docs/widgets/styling/css-customization.mdx +100 -0
  478. package/.docs/organized/docs/widgets/styling/index.mdx +29 -0
  479. package/.docs/organized/docs/widgets/styling/theme-customization.mdx +51 -0
  480. package/.docs/organized/docs/widgets/tokens.mdx +17 -0
  481. package/.docs/organized/docs/widgets/user-management.mdx +28 -0
  482. package/.docs/organized/docs/widgets/user-profile.mdx +30 -0
  483. package/.docs/organized/docs/widgets/user-security.mdx +31 -0
  484. package/.docs/organized/docs/widgets/user-sessions.mdx +26 -0
  485. package/LICENSE +21 -0
  486. package/README.md +14 -1
  487. package/dist/prepare.js +1 -1
  488. package/dist/prepare.js.map +1 -1
  489. package/package.json +2 -1
  490. package/.docs/organized/docs/dashboard.mdx +0 -244
  491. package/.docs/organized/docs/demo/_navigation.mdx +0 -26
  492. package/.docs/organized/docs/demo/accordion.mdx +0 -34
  493. package/.docs/organized/docs/demo/checklist.mdx +0 -33
  494. package/.docs/organized/docs/demo/code-block.mdx +0 -185
  495. package/.docs/organized/docs/demo/definition-list.mdx +0 -35
  496. package/.docs/organized/docs/demo/index.mdx +0 -7
  497. package/.docs/organized/docs/demo/punctuation.mdx +0 -37
  498. package/.docs/organized/docs/demo/replacements.mdx +0 -26
  499. package/.docs/organized/docs/demo/table.mdx +0 -26
  500. package/.docs/organized/docs/demo/tabs.mdx +0 -17
  501. package/.docs/organized/docs/fga/identity-provider-sessions.mdx +0 -68
  502. package/.docs/organized/docs/fga/local-development.mdx +0 -155
  503. package/.docs/organized/docs/fga/modeling/abac.mdx +0 -107
  504. package/.docs/organized/docs/fga/modeling/blocklist.mdx +0 -84
  505. package/.docs/organized/docs/fga/modeling/conditional-roles.mdx +0 -99
  506. package/.docs/organized/docs/fga/modeling/custom-roles.mdx +0 -90
  507. package/.docs/organized/docs/fga/modeling/entitlements.mdx +0 -127
  508. package/.docs/organized/docs/fga/modeling/managed-service-provider.mdx +0 -131
  509. package/.docs/organized/docs/fga/modeling/org-roles-and-permissions.mdx +0 -95
  510. package/.docs/organized/docs/fga/modeling/policy-context.mdx +0 -231
  511. package/.docs/organized/docs/fga/modeling/public-access.mdx +0 -61
  512. package/.docs/organized/docs/fga/modeling/shareable-content.mdx +0 -106
  513. package/.docs/organized/docs/fga/modeling/superusers.mdx +0 -74
  514. package/.docs/organized/docs/fga/modeling/user-groups.mdx +0 -92
  515. package/.docs/organized/docs/fga/operations-usage.mdx +0 -104
  516. package/.docs/organized/docs/fga/playground.mdx +0 -12
  517. package/.docs/organized/docs/fga/policies.mdx +0 -462
  518. package/.docs/organized/docs/fga/query-language.mdx +0 -112
  519. package/.docs/organized/docs/fga/schema-management.mdx +0 -224
  520. package/.docs/organized/docs/fga/schema.mdx +0 -388
  521. package/.docs/organized/docs/fga/warrant-tokens.mdx +0 -44
  522. package/.docs/organized/docs/fga/warrants.mdx +0 -92
  523. package/.docs/organized/docs/reference/fga/batch-check.mdx +0 -277
  524. package/.docs/organized/docs/reference/fga/check.mdx +0 -563
  525. package/.docs/organized/docs/reference/fga/policy/create.mdx +0 -27
  526. package/.docs/organized/docs/reference/fga/policy/delete.mdx +0 -18
  527. package/.docs/organized/docs/reference/fga/policy/get.mdx +0 -23
  528. package/.docs/organized/docs/reference/fga/policy/index.mdx +0 -52
  529. package/.docs/organized/docs/reference/fga/policy/list.mdx +0 -41
  530. package/.docs/organized/docs/reference/fga/policy/update.mdx +0 -26
  531. package/.docs/organized/docs/reference/fga/query.mdx +0 -375
  532. package/.docs/organized/docs/reference/fga/resource/batch-write.mdx +0 -175
  533. package/.docs/organized/docs/reference/fga/resource-type/apply.mdx +0 -35
  534. package/.docs/organized/docs/reference/fga/resource-type/create.mdx +0 -24
  535. package/.docs/organized/docs/reference/fga/resource-type/delete.mdx +0 -22
  536. package/.docs/organized/docs/reference/fga/resource-type/get.mdx +0 -23
  537. package/.docs/organized/docs/reference/fga/resource-type/index.mdx +0 -68
  538. package/.docs/organized/docs/reference/fga/resource-type/list.mdx +0 -36
  539. package/.docs/organized/docs/reference/fga/resource-type/update.mdx +0 -23
  540. package/.docs/organized/docs/reference/fga/schema/apply.mdx +0 -42
  541. package/.docs/organized/docs/reference/fga/schema/get.mdx +0 -24
  542. package/.docs/organized/docs/reference/fga/schema/index.mdx +0 -39
  543. package/.docs/organized/docs/reference/fga/warrant/batch-write.mdx +0 -226
  544. package/.docs/organized/docs/reference/fga/warrant/create.mdx +0 -215
  545. package/.docs/organized/docs/reference/fga/warrant/delete.mdx +0 -212
  546. package/.docs/organized/docs/reference/fga/warrant/index.mdx +0 -186
  547. package/.docs/organized/docs/reference/fga/warrant/list.mdx +0 -282
  548. package/.docs/organized/docs/reference/idempotency.mdx +0 -21
  549. package/.docs/organized/docs/reference/organization-domain.mdx +0 -189
  550. package/.docs/organized/docs/reference/rate-limits.mdx +0 -50
  551. package/.docs/organized/docs/reference/roles/list-for-organization.mdx +0 -152
  552. package/.docs/organized/docs/reference/user-management/access-token/index.mdx +0 -13
  553. package/.docs/organized/docs/reference/user-management/authentication/get-authorization-url/redirect-uri.mdx +0 -23
  554. package/.docs/organized/docs/reference/user-management/index.mdx +0 -13
  555. package/.docs/organized/docs/reference/user-management/mfa/index.mdx +0 -5
  556. package/.docs/organized/docs/reference/user-management/session-tokens/index.mdx +0 -5
  557. package/.docs/organized/docs/reference/user-management/session-tokens/refresh-token.mdx +0 -8
  558. package/.docs/organized/docs/user-management/_navigation.mdx +0 -87
  559. package/.docs/organized/docs/user-management/authkit.mdx +0 -69
  560. package/.docs/organized/docs/user-management/connect.mdx +0 -110
  561. package/.docs/organized/docs/user-management/directory-provisioning.mdx +0 -78
  562. package/.docs/organized/docs/user-management/email-verification.mdx +0 -29
  563. package/.docs/organized/docs/user-management/entitlements.mdx +0 -46
  564. package/.docs/organized/docs/user-management/jit-provisioning.mdx +0 -36
  565. package/.docs/organized/docs/user-management/overview.mdx +0 -46
  566. package/.docs/organized/docs/user-management/roles-and-permissions.mdx +0 -155
  567. package/.docs/organized/docs/user-management/users-organizations.mdx +0 -91
  568. package/.docs/organized/docs/user-management/widgets.mdx +0 -190
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Events
3
- description: "Respond to activity that occurs within WorkOS and third-party\_providers."
3
+ description: Respond to activity that occurs within WorkOS and third-party providers.
4
4
  originalPath: .tmp-workos-clone/packages/docs/content/events/index.mdx
5
5
  ---
6
6
 
@@ -16,10 +16,29 @@ All event objects share a similar structure.
16
16
  | `id` | Unique identifier for the event. |
17
17
  | `data` | Event payload. Payloads match the corresponding [API objects](/reference). |
18
18
  | `created_at` | Timestamp of when the event occurred. |
19
+ | `context` | An optional object of extra information relevant to the event. |
20
+
21
+ ## API key events {{ "url": "api-key" }}
22
+
23
+ Events emitted when [API keys](/authkit/api-keys) are created or revoked.
24
+
25
+ <Event.Root>
26
+ <Event.Details name="api_key.created">
27
+ <CodeBlock title="API key created event" file="event-api-key-created" />
28
+ </Event.Details>
29
+ <Event.Description>Triggered when an API key is created.</Event.Description>
30
+ </Event.Root>
31
+
32
+ <Event.Root>
33
+ <Event.Details name="api_key.revoked">
34
+ <CodeBlock title="API key revoked event" file="event-api-key-revoked" />
35
+ </Event.Details>
36
+ <Event.Description>Triggered when an API key is revoked.</Event.Description>
37
+ </Event.Root>
19
38
 
20
39
  ## Authentication events {{ "url": "authentication" }}
21
40
 
22
- Each step in the [authentication](/reference/user-management/authentication) flow emits an authentication event. Authentication success events are emitted even when additional steps, such as MFA, are required to complete the process.
41
+ Each step in the [authentication](/reference/authkit/authentication) flow emits an authentication event. Authentication success events are emitted even when additional steps, such as MFA, are required to complete the process.
23
42
 
24
43
  <Event.Root mt="5">
25
44
  <Event.Details name="authentication.email_verification_failed" comingSoon>
@@ -388,7 +407,9 @@ Events emitted when directory-related resources are changed. To learn what exact
388
407
  Payload `data` contains a `user` which corresponds to the [Directory
389
408
  User](/reference/directory-sync/directory-user) object and a `group` which
390
409
  corresponds to the [Directory
391
- Group](/reference/directory-sync/directory-group) object.
410
+ Group](/reference/directory-sync/directory-group) object. The `groups`
411
+ field is omitted from the `user` object to avoid performance issues in
412
+ large directories.
392
413
  </Event.Description>
393
414
  </Event.Details>
394
415
  <Event.Description>
@@ -407,7 +428,9 @@ Events emitted when directory-related resources are changed. To learn what exact
407
428
  Payload `data` contains a `user` which corresponds to the [Directory
408
429
  User](/reference/directory-sync/directory-user) object and a `group` which
409
430
  corresponds to the [Directory
410
- Group](/reference/directory-sync/directory-group) object.
431
+ Group](/reference/directory-sync/directory-group) object. The `groups`
432
+ field is omitted from the `user` object to avoid performance issues in
433
+ large directories.
411
434
  </Event.Description>
412
435
  </Event.Details>
413
436
  <Event.Description>
@@ -424,7 +447,8 @@ Events emitted when directory-related resources are changed. To learn what exact
424
447
  />
425
448
  <Event.Description>
426
449
  Payload `data` corresponds to the [Directory
427
- User](/reference/directory-sync/directory-user) object.
450
+ User](/reference/directory-sync/directory-user) object. The `groups` field
451
+ is omitted to avoid performance issues in large directories.
428
452
  </Event.Description>
429
453
  </Event.Details>
430
454
  <Event.Description>
@@ -441,7 +465,8 @@ Events emitted when directory-related resources are changed. To learn what exact
441
465
  />
442
466
  <Event.Description>
443
467
  Payload `data` corresponds to the [Directory
444
- User](/reference/directory-sync/directory-user) object.
468
+ User](/reference/directory-sync/directory-user) object. The `groups` field
469
+ is omitted to avoid performance issues in large directories.
445
470
  </Event.Description>
446
471
  </Event.Details>
447
472
  <Event.Description>
@@ -459,7 +484,8 @@ Events emitted when directory-related resources are changed. To learn what exact
459
484
  />
460
485
  <Event.Description>
461
486
  Payload `data` corresponds to the [Directory
462
- User](/reference/directory-sync/directory-user) object.
487
+ User](/reference/directory-sync/directory-user) object. The `groups` field
488
+ is omitted to avoid performance issues in large directories.
463
489
  </Event.Description>
464
490
  </Event.Details>
465
491
  <Event.Description>
@@ -480,8 +506,7 @@ Events emitted when a user is required to verify their email.
480
506
  />
481
507
  <Event.Description>
482
508
  Payload `data` corresponds to the [Email
483
- verification](/user-management/email-verification) object with the `code`
484
- omitted.
509
+ verification](/authkit/email-verification) object with the `code` omitted.
485
510
  </Event.Description>
486
511
  </Event.Details>
487
512
  <Event.Description>
@@ -490,9 +515,94 @@ Events emitted when a user is required to verify their email.
490
515
  </Event.Description>
491
516
  </Event.Root>
492
517
 
518
+ ## Feature flag events {{ "url": "feature-flags" }}
519
+
520
+ Events emitted when WorkOS feature flags are created, updated, deleted, or their rules are updated.
521
+
522
+ <Event.Root>
523
+ <Event.Details name="flag.created">
524
+ <CodeBlock
525
+ title="Feature flag created event"
526
+ file="event-feature-flag-created"
527
+ />
528
+ <Event.Description>
529
+ Payload `data` corresponds to the [Feature Flag](/reference/feature-flags)
530
+ object.
531
+ </Event.Description>
532
+ </Event.Details>
533
+ <Event.Description>
534
+ Triggered when a feature flag is created.
535
+ </Event.Description>
536
+ </Event.Root>
537
+
538
+ <Event.Root>
539
+ <Event.Details name="flag.updated">
540
+ <CodeBlock
541
+ title="Feature flag updated event"
542
+ file="event-feature-flag-updated"
543
+ />
544
+ <Event.Description>
545
+ Payload `data` corresponds to the [Feature Flag](/reference/feature-flags)
546
+ object.
547
+ </Event.Description>
548
+ </Event.Details>
549
+ <Event.Description>
550
+ Triggered when a feature flag is updated.
551
+ </Event.Description>
552
+ </Event.Root>
553
+
554
+ <Event.Root>
555
+ <Event.Details name="flag.deleted">
556
+ <CodeBlock
557
+ title="Feature flag deleted event"
558
+ file="event-feature-flag-deleted"
559
+ />
560
+ <Event.Description>
561
+ Payload `data` corresponds to the [Feature Flag](/reference/feature-flags)
562
+ object.
563
+ </Event.Description>
564
+ </Event.Details>
565
+ <Event.Description>
566
+ Triggered when a feature flag is deleted.
567
+ </Event.Description>
568
+ </Event.Root>
569
+
570
+ <Event.Root>
571
+ <Event.Details name="flag.rule_updated">
572
+ <CodeBlock
573
+ title="Feature flag rule updated event"
574
+ file="event-feature-flag-rule-updated"
575
+ />
576
+ <Event.Description>
577
+ Payload `data` corresponds to the [Feature Flag](/reference/feature-flags)
578
+ object.
579
+ </Event.Description>
580
+ </Event.Details>
581
+ <Event.Description>
582
+ Triggered when a feature flag's rules are modified.
583
+ </Event.Description>
584
+ </Event.Root>
585
+
493
586
  ## Invitation events {{ "url": "invitation" }}
494
587
 
495
- Events emitted when a [User Management user](/reference/user-management/user) is invited to join an organization.
588
+ Events emitted when an [AuthKit user](/reference/authkit/user) is invited to join an organization.
589
+
590
+ <Event.Root>
591
+ <Event.Details name="invitation.accepted">
592
+ <CodeBlock
593
+ title="Invitation accepted event"
594
+ file="event-invitation-accepted"
595
+ />
596
+ <Event.Description>
597
+ Payload `data` corresponds to the
598
+ [Invitation](/reference/authkit/invitation) object with the `token` and
599
+ `accept_invitation_url` omitted.
600
+ </Event.Description>
601
+ </Event.Details>
602
+ <Event.Description>
603
+ Triggered when a user accepts an invitation.
604
+ </Event.Description>
605
+ </Event.Root>
496
606
 
497
607
  <Event.Root>
498
608
  <Event.Details name="invitation.created">
@@ -502,8 +612,8 @@ Events emitted when a [User Management user](/reference/user-management/user) is
502
612
  />
503
613
  <Event.Description>
504
614
  Payload `data` corresponds to the
505
- [Invitation](/reference/user-management/invitation) object with the
506
- `token` omitted.
615
+ [Invitation](/reference/authkit/invitation) object with the `token` and
616
+ `accept_invitation_url` omitted.
507
617
  </Event.Description>
508
618
  </Event.Details>
509
619
  <Event.Description>
@@ -511,6 +621,35 @@ Events emitted when a [User Management user](/reference/user-management/user) is
511
621
  </Event.Description>
512
622
  </Event.Root>
513
623
 
624
+ <Event.Root>
625
+ <Event.Details name="invitation.resent">
626
+ <CodeBlock title="Invitation resent event" file="event-invitation-resent" />
627
+ <Event.Description>
628
+ Payload `data` corresponds to the
629
+ [Invitation](/reference/authkit/invitation) object with the `token` and
630
+ `accept_invitation_url` omitted.
631
+ </Event.Description>
632
+ </Event.Details>
633
+ <Event.Description>Triggered when an invitation is resent.</Event.Description>
634
+ </Event.Root>
635
+
636
+ <Event.Root>
637
+ <Event.Details name="invitation.revoked">
638
+ <CodeBlock
639
+ title="Invitation revoked event"
640
+ file="event-invitation-revoked"
641
+ />
642
+ <Event.Description>
643
+ Payload `data` corresponds to the
644
+ [Invitation](/reference/authkit/invitation) object with the `token` and
645
+ `accept_invitation_url` omitted.
646
+ </Event.Description>
647
+ </Event.Details>
648
+ <Event.Description>
649
+ Triggered when an invitation is revoked.
650
+ </Event.Description>
651
+ </Event.Root>
652
+
514
653
  ## Magic Auth events {{ "url": "magic-auth" }}
515
654
 
516
655
  Events emitted when a user requests a Magic Auth code.
@@ -523,8 +662,7 @@ Events emitted when a user requests a Magic Auth code.
523
662
  />
524
663
  <Event.Description>
525
664
  Payload `data` corresponds to the [Magic
526
- Auth](/reference/user-management/magic-auth) object with the `code`
527
- omitted.
665
+ Auth](/reference/authkit/magic-auth) object with the `code` omitted.
528
666
  </Event.Description>
529
667
  </Event.Details>
530
668
  <Event.Description>
@@ -578,9 +716,57 @@ Events emitted when WorkOS organizations are created, updated, or deleted.
578
716
 
579
717
  ## Organization domain events {{ "url": "organization-domain" }}
580
718
 
581
- Events emitted when verification status of an organization domain changes.
719
+ Events emitted when organization domains are created, updated, deleted, or their verification status changes.
582
720
 
583
721
  <Event.Root mt="5">
722
+ <Event.Details name="organization_domain.created">
723
+ <CodeBlock
724
+ title="Organization domain created event"
725
+ file="event-organization-domain-created"
726
+ />
727
+ <Event.Description>
728
+ Payload `data` corresponds to the [Organization
729
+ Domain](/reference/domain-verification) object.
730
+ </Event.Description>
731
+ </Event.Details>
732
+ <Event.Description>
733
+ Triggered when an organization domain is created.
734
+ </Event.Description>
735
+ </Event.Root>
736
+
737
+ <Event.Root>
738
+ <Event.Details name="organization_domain.updated">
739
+ <CodeBlock
740
+ title="Organization domain updated event"
741
+ file="event-organization-domain-updated"
742
+ />
743
+ <Event.Description>
744
+ Payload `data` corresponds to the [Organization
745
+ Domain](/reference/domain-verification) object.
746
+ </Event.Description>
747
+ </Event.Details>
748
+ <Event.Description>
749
+ Triggered when an organization domain is updated.
750
+ </Event.Description>
751
+ </Event.Root>
752
+
753
+ <Event.Root>
754
+ <Event.Details name="organization_domain.deleted">
755
+ <CodeBlock
756
+ title="Organization domain deleted event"
757
+ file="event-organization-domain-deleted"
758
+ />
759
+ <Event.Description>
760
+ Payload `data` corresponds to the [Organization
761
+ Domain](/reference/domain-verification) object.
762
+ </Event.Description>
763
+ </Event.Details>
764
+ <Event.Description>
765
+ Triggered when an organization domain is deleted.
766
+ </Event.Description>
767
+ </Event.Root>
768
+
769
+ <Event.Root>
584
770
  <Event.Details name="organization_domain.verified">
585
771
  <CodeBlock
586
772
  title="Organization domain verified event"
@@ -615,7 +801,7 @@ Events emitted when verification status of an organization domain changes.
615
801
 
616
802
  ## Organization membership events {{ "url": "organization-membership" }}
617
803
 
618
- Events emitted when a [User Management user](/reference/user-management/user) joins or leaves an organization.
804
+ Events emitted when an [AuthKit user](/reference/authkit/user) joins or leaves an organization.
619
805
 
620
806
  <Event.Root>
621
807
  <Event.Details name="organization_membership.created">
@@ -625,7 +811,7 @@ Events emitted when a [User Management user](/reference/user-management/user) jo
625
811
  />
626
812
  <Event.Description>
627
813
  Payload `data` corresponds to the [Organization
628
- Membership](/reference/user-management/organization-membership) object.
814
+ Membership](/reference/authkit/organization-membership) object.
629
815
  </Event.Description>
630
816
  </Event.Details>
631
817
  <Event.Description>
@@ -641,7 +827,7 @@ Events emitted when a [User Management user](/reference/user-management/user) jo
641
827
  />
642
828
  <Event.Description>
643
829
  Payload `data` corresponds to the [Organization
644
- Membership](/reference/user-management/organization-membership) object.
830
+ Membership](/reference/authkit/organization-membership) object.
645
831
  </Event.Description>
646
832
  </Event.Details>
647
833
  <Event.Description>
@@ -657,7 +843,7 @@ Events emitted when a [User Management user](/reference/user-management/user) jo
657
843
  />
658
844
  <Event.Description>
659
845
  Payload `data` corresponds to the [Organization
660
- Membership](/reference/user-management/organization-membership) object.
846
+ Membership](/reference/authkit/organization-membership) object.
661
847
  </Event.Description>
662
848
  </Event.Details>
663
849
  <Event.Description>
@@ -665,6 +851,55 @@ Events emitted when a [User Management user](/reference/user-management/user) jo
665
851
  </Event.Description>
666
852
  </Event.Root>
667
853
 
854
+ ## Organization role events {{ "url": "organization-role" }}
855
+
856
+ Events emitted when [organization roles](/reference/roles/organization-role) are created, updated, or deleted.
857
+
858
+ <Event.Root>
859
+ <Event.Details name="organization_role.created">
860
+ <CodeBlock
861
+ title="Organization role created event"
862
+ file="event-organization-role-created"
863
+ />
864
+ <Event.Description>
865
+ Payload `data` corresponds to the organization role object.
866
+ </Event.Description>
867
+ </Event.Details>
868
+ <Event.Description>
869
+ Triggered when an organization role is created.
870
+ </Event.Description>
871
+ </Event.Root>
872
+
873
+ <Event.Root>
874
+ <Event.Details name="organization_role.deleted">
875
+ <CodeBlock
876
+ title="Organization role deleted event"
877
+ file="event-organization-role-deleted"
878
+ />
879
+ <Event.Description>
880
+ Payload `data` corresponds to the organization role object.
881
+ </Event.Description>
882
+ </Event.Details>
883
+ <Event.Description>
884
+ Triggered when an organization role is deleted.
885
+ </Event.Description>
886
+ </Event.Root>
887
+
888
+ <Event.Root>
889
+ <Event.Details name="organization_role.updated">
890
+ <CodeBlock
891
+ title="Organization role updated event"
892
+ file="event-organization-role-updated"
893
+ />
894
+ <Event.Description>
895
+ Payload `data` corresponds to the organization role object.
896
+ </Event.Description>
897
+ </Event.Details>
898
+ <Event.Description>
899
+ Triggered when an organization role is updated.
900
+ </Event.Description>
901
+ </Event.Root>
902
+
668
903
  ## Password reset events {{ "url": "password-reset" }}
669
904
 
670
905
  Events emitted when a user requests to reset their password.
@@ -677,8 +912,8 @@ Events emitted when a user requests to reset their password.
677
912
  />
678
913
  <Event.Description>
679
914
  Payload `data` corresponds to the [Organization
680
- Membership](/reference/user-management/password-reset) object with the
681
- `token` omitted.
915
+ Membership](/reference/authkit/password-reset) object with the `token`
916
+ omitted.
682
917
  </Event.Description>
683
918
  </Event.Details>
684
919
  <Event.Description>
@@ -694,8 +929,7 @@ Events emitted when a user requests to reset their password.
694
929
  />
695
930
  <Event.Description>
696
931
  Payload `data` corresponds to the [Password
697
- Reset](/reference/user-management/password-reset) object with the `token`
698
- omitted.
932
+ Reset](/reference/authkit/password-reset) object with the `token` omitted.
699
933
  </Event.Description>
700
934
  </Event.Details>
701
935
  <Event.Description>
@@ -703,9 +937,52 @@ Events emitted when a user requests to reset their password.
703
937
  </Event.Description>
704
938
  </Event.Root>
705
939
 
940
+ ## Permission events {{ "url": "permission" }}
941
+
942
+ Events emitted when [permissions](/reference/roles/permission) are created, updated, or deleted.
943
+
944
+ <Event.Root>
945
+ <Event.Details name="permission.created">
946
+ <CodeBlock
947
+ title="Permission created event"
948
+ file="event-permission-created"
949
+ />
950
+ <Event.Description>
951
+ Payload `data` corresponds to the permission object.
952
+ </Event.Description>
953
+ </Event.Details>
954
+ <Event.Description>Triggered when a permission is created.</Event.Description>
955
+ </Event.Root>
956
+
957
+ <Event.Root>
958
+ <Event.Details name="permission.deleted">
959
+ <CodeBlock
960
+ title="Permission deleted event"
961
+ file="event-permission-deleted"
962
+ />
963
+ <Event.Description>
964
+ Payload `data` corresponds to the permission object.
965
+ </Event.Description>
966
+ </Event.Details>
967
+ <Event.Description>Triggered when a permission is deleted.</Event.Description>
968
+ </Event.Root>
969
+
970
+ <Event.Root>
971
+ <Event.Details name="permission.updated">
972
+ <CodeBlock
973
+ title="Permission updated event"
974
+ file="event-permission-updated"
975
+ />
976
+ <Event.Description>
977
+ Payload `data` corresponds to the permission object.
978
+ </Event.Description>
979
+ </Event.Details>
980
+ <Event.Description>Triggered when a permission is updated.</Event.Description>
981
+ </Event.Root>
982
+
706
983
  ## Role events {{ "url": "role" }}
707
984
 
708
- Events emitted when roles are created or deleted in the WorkOS dashboard.
985
+ Events emitted when [environment roles](/reference/roles/role) are created, updated, or deleted.
709
986
 
710
987
  <Event.Root>
711
988
  <Event.Details name="role.created">
@@ -732,7 +1009,7 @@ Events emitted when roles are created or deleted in the WorkOS dashboard.
732
1009
 
733
1010
  ## Session events {{ "url": "session" }}
734
1011
 
735
- Events emitted when User Management sessions are created.
1012
+ Events emitted when AuthKit sessions are created.
736
1013
 
737
1014
  <Event.Root>
738
1015
  <Event.Details name="session.created">
@@ -740,21 +1017,29 @@ Events emitted when User Management sessions are created.
740
1017
  </Event.Details>
741
1018
  <Event.Description>
742
1019
  Triggered when a session is created. Sessions started using
743
- [impersonation](/user-management/impersonation) will include an additional
1020
+ [impersonation](/authkit/impersonation) will include an additional
744
1021
  `impersonator` field with data about the impersonator.
745
1022
  </Event.Description>
746
1023
  </Event.Root>
747
1024
 
1025
+ <Event.Root>
1026
+ <Event.Details name="session.revoked">
1027
+ <CodeBlock title="Session revoked event" file="event-session-revoked" />
1028
+ </Event.Details>
1029
+ <Event.Description>
1030
+ Triggered when an issued session is revoked for a user.
1031
+ </Event.Description>
1032
+ </Event.Root>
1033
+
748
1034
  ## User events {{ "url": "user" }}
749
1035
 
750
- Events emitted when [User Management users](/reference/user-management/user) are created, updated, or deleted.
1036
+ Events emitted when [AuthKit users](/reference/authkit/user) are created, updated, or deleted.
751
1037
 
752
1038
  <Event.Root>
753
1039
  <Event.Details name="user.created">
754
1040
  <CodeBlock title="User created event" file="event-user-created" />
755
1041
  <Event.Description>
756
- Payload `data` corresponds to the [User](/reference/user-management/user)
757
- object.
1042
+ Payload `data` corresponds to the [User](/reference/authkit/user) object.
758
1043
  </Event.Description>
759
1044
  </Event.Details>
760
1045
  <Event.Description>Triggered when a user is created.</Event.Description>
@@ -764,8 +1049,7 @@ Events emitted when [User Management users](/reference/user-management/user) are
764
1049
  <Event.Details name="user.deleted">
765
1050
  <CodeBlock title="User deleted event" file="event-user-deleted" />
766
1051
  <Event.Description>
767
- Payload `data` corresponds to the [User](/reference/user-management/user)
768
- object.
1052
+ Payload `data` corresponds to the [User](/reference/authkit/user) object.
769
1053
  </Event.Description>
770
1054
  </Event.Details>
771
1055
  <Event.Description>Triggered when a user is deleted.</Event.Description>
@@ -775,9 +1059,111 @@ Events emitted when [User Management users](/reference/user-management/user) are
775
1059
  <Event.Details name="user.updated">
776
1060
  <CodeBlock title="User updated event" file="event-user-updated" />
777
1061
  <Event.Description>
778
- Payload `data` corresponds to the [User](/reference/user-management/user)
779
- object.
1062
+ Payload `data` corresponds to the [User](/reference/authkit/user) object.
780
1063
  </Event.Description>
781
1064
  </Event.Details>
782
1065
  <Event.Description>Triggered when a user is updated.</Event.Description>
783
1066
  </Event.Root>
1067
+
1068
+ ## Vault events {{ "url": "vault" }}
1069
+
1070
+ Events emitted when [Vault](/vault) data, keys, or metadata are accessed or modified. Each event payload includes an `actor_id`, `actor_source`, and `actor_name` identifying who performed the action.
1071
+
1072
+ <Event.Root mt="5">
1073
+ <Event.Details name="vault.data.created">
1074
+ <CodeBlock
1075
+ title="Vault data created event"
1076
+ file="event-vault-data-created"
1077
+ />
1078
+ </Event.Details>
1079
+ <Event.Description>
1080
+ Triggered when a new encrypted object is stored in Vault.
1081
+ </Event.Description>
1082
+ </Event.Root>
1083
+
1084
+ <Event.Root>
1085
+ <Event.Details name="vault.data.deleted">
1086
+ <CodeBlock
1087
+ title="Vault data deleted event"
1088
+ file="event-vault-data-deleted"
1089
+ />
1090
+ </Event.Details>
1091
+ <Event.Description>
1092
+ Triggered when an encrypted object is deleted from Vault.
1093
+ </Event.Description>
1094
+ </Event.Root>
1095
+
1096
+ <Event.Root>
1097
+ <Event.Details name="vault.data.read">
1098
+ <CodeBlock title="Vault data read event" file="event-vault-data-read" />
1099
+ </Event.Details>
1100
+ <Event.Description>
1101
+ Triggered when an encrypted object is read from Vault.
1102
+ </Event.Description>
1103
+ </Event.Root>
1104
+
1105
+ <Event.Root>
1106
+ <Event.Details name="vault.data.updated">
1107
+ <CodeBlock
1108
+ title="Vault data updated event"
1109
+ file="event-vault-data-updated"
1110
+ />
1111
+ </Event.Details>
1112
+ <Event.Description>
1113
+ Triggered when an existing encrypted object is updated in Vault.
1114
+ </Event.Description>
1115
+ </Event.Root>
1116
+
1117
+ <Event.Root>
1118
+ <Event.Details name="vault.dek.decrypted">
1119
+ <CodeBlock
1120
+ title="Vault DEK decrypted event"
1121
+ file="event-vault-dek-decrypted"
1122
+ />
1123
+ </Event.Details>
1124
+ <Event.Description>
1125
+ Triggered when a data encryption key (DEK) is decrypted.
1126
+ </Event.Description>
1127
+ </Event.Root>
1128
+
1129
+ <Event.Root>
1130
+ <Event.Details name="vault.dek.read">
1131
+ <CodeBlock title="Vault DEK read event" file="event-vault-dek-read" />
1132
+ </Event.Details>
1133
+ <Event.Description>
1134
+ Triggered when one or more data encryption keys (DEKs) are read.
1135
+ </Event.Description>
1136
+ </Event.Root>
1137
+
1138
+ <Event.Root>
1139
+ <Event.Details name="vault.kek.created">
1140
+ <CodeBlock title="Vault KEK created event" file="event-vault-kek-created" />
1141
+ </Event.Details>
1142
+ <Event.Description>
1143
+ Triggered when a new key encryption key (KEK) is created.
1144
+ </Event.Description>
1145
+ </Event.Root>
1146
+
1147
+ <Event.Root>
1148
+ <Event.Details name="vault.metadata.read">
1149
+ <CodeBlock
1150
+ title="Vault metadata read event"
1151
+ file="event-vault-metadata-read"
1152
+ />
1153
+ </Event.Details>
1154
+ <Event.Description>
1155
+ Triggered when metadata for a Vault store is read.
1156
+ </Event.Description>
1157
+ </Event.Root>
1158
+
1159
+ <Event.Root>
1160
+ <Event.Details name="vault.names.listed">
1161
+ <CodeBlock
1162
+ title="Vault names listed event"
1163
+ file="event-vault-names-listed"
1164
+ />
1165
+ </Event.Details>
1166
+ <Event.Description>
1167
+ Triggered when the list of Vault store names is retrieved.
1168
+ </Event.Description>
1169
+ </Event.Root>
@@ -0,0 +1,10 @@
1
+ ---
2
+ title: Feature Flags
3
+ links:
4
+ - title: Quick Start
5
+ url: /feature-flags
6
+ - title: Slack Notifications
7
+ url: /feature-flags/slack-notifications
8
+ originalPath: .tmp-workos-clone/packages/docs/content/feature-flags/_navigation.mdx
9
+ ---
10
+