@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
@@ -157,7 +157,7 @@ reference:
157
157
  type: mfa.Challenge
158
158
  description: (authentication_challenge.self)
159
159
  - (err)
160
- originalPath: .tmp-workos-clone/packages/docs/content/reference/mfa/challenge-factor.mdx
160
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/mfa/challenge/create.mdx
161
161
  ---
162
162
 
163
163
  ## Challenge Factor
@@ -1,9 +1,7 @@
1
1
  ---
2
2
  descriptions:
3
3
  authentication_challenge:
4
- self: >-
5
- The [Authentication Challenge](/reference/mfa/authentication-challenge)
6
- object.
4
+ self: 'The [Authentication Challenge](/reference/mfa/challenge) object.'
7
5
  object: Distinguishes the Authentication Challenge object.
8
6
  id: The unique ID of the Authentication Challenge.
9
7
  created_at: The timestamp when the Challenge was created.
@@ -14,7 +12,7 @@ descriptions:
14
12
  authentication_factor_id: The unique ID of the Authentication Factor the Challenge belongs to.
15
13
  reference:
16
14
  curl:
17
- - url: /reference/mfa/authentication-challenge
15
+ - url: /reference/mfa/challenge
18
16
  key: authentication_challenge
19
17
  id: authentication_challenge
20
18
  title: authentication_challenge
@@ -38,7 +36,7 @@ reference:
38
36
  type: string
39
37
  description: (authentication_challenge.authentication_factor_id)
40
38
  dotnet:
41
- - url: /reference/mfa/authentication-challenge
39
+ - url: /reference/mfa/challenge
42
40
  key: Challenge
43
41
  id: authentication_challenge
44
42
  title: class Challenge
@@ -62,7 +60,7 @@ reference:
62
60
  type: string
63
61
  description: (authentication_challenge.authentication_factor_id)
64
62
  ruby:
65
- - url: /reference/mfa/authentication-challenge
63
+ - url: /reference/mfa/challenge
66
64
  key: Challenge
67
65
  id: authentication_challenge
68
66
  title: class Challenge
@@ -86,7 +84,7 @@ reference:
86
84
  type: String
87
85
  description: (authentication_challenge.authentication_factor_id)
88
86
  python:
89
- - url: /reference/mfa/authentication-challenge
87
+ - url: /reference/mfa/challenge
90
88
  key: AuthenticationChallenge
91
89
  id: authentication_challenge
92
90
  title: AuthenticationChallenge
@@ -110,7 +108,7 @@ reference:
110
108
  type: str
111
109
  description: (authentication_challenge.authentication_factor_id)
112
110
  js:
113
- - url: /reference/mfa/authentication-challenge
111
+ - url: /reference/mfa/challenge
114
112
  key: Challenge
115
113
  id: authentication_challenge
116
114
  title: interface Challenge
@@ -134,7 +132,7 @@ reference:
134
132
  type: string
135
133
  description: (authentication_challenge.authentication_factor_id)
136
134
  php:
137
- - url: /reference/mfa/authentication-challenge
135
+ - url: /reference/mfa/challenge
138
136
  key: AuthenticationChallenge
139
137
  id: authentication_challenge
140
138
  title: WorkOS\Resource\AuthenticationChallenge
@@ -158,7 +156,7 @@ reference:
158
156
  type: string
159
157
  description: (authentication_challenge.authentication_factor_id)
160
158
  java:
161
- - url: /reference/mfa/authentication-challenge
159
+ - url: /reference/mfa/challenge
162
160
  key: Challenge
163
161
  id: authentication_challenge
164
162
  title: class Challenge
@@ -182,7 +180,7 @@ reference:
182
180
  type: String
183
181
  description: (authentication_challenge.authentication_factor_id)
184
182
  go:
185
- - url: /reference/mfa/authentication-challenge
183
+ - url: /reference/mfa/challenge
186
184
  key: Challenge
187
185
  id: authentication_challenge
188
186
  title: mfa.Challenge
@@ -202,11 +200,10 @@ reference:
202
200
  - key: FactorID
203
201
  type: string
204
202
  description: (authentication_challenge.authentication_factor_id)
205
- originalPath: >-
206
- .tmp-workos-clone/packages/docs/content/reference/mfa/authentication-challenge.mdx
203
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/mfa/challenge/index.mdx
207
204
  ---
208
205
 
209
- ## Authentication Challenge
206
+ # Authentication Challenge
210
207
 
211
208
  An object representing a Challenge of an Authentication Factor.
212
209
 
@@ -3,15 +3,13 @@ descriptions:
3
3
  verify_challenge:
4
4
  authentication_challenge_id: The unique ID of the authentication Challenge.
5
5
  code: The 6 digit code to be verified.
6
- challenge: >-
7
- The relevant [Authentication
8
- Challenge](/reference/mfa/authentication-challenge).
6
+ challenge: 'The relevant [Authentication Challenge](/reference/mfa/challenge).'
9
7
  valid: Indicates whether the code was correct.
10
8
  reference:
11
9
  curl:
12
10
  - key: verify_challenge
13
11
  id: verify_challenge
14
- url: /reference/mfa/verify-challenge
12
+ url: /reference/mfa/challenge/verify
15
13
  title: '/auth/challenges/:id/verify'
16
14
  type: POST
17
15
  parameters:
@@ -35,7 +33,7 @@ reference:
35
33
  dotnet:
36
34
  - key: VerifyChallenge
37
35
  id: verify_challenge
38
- url: /reference/mfa/verify-challenge
36
+ url: /reference/mfa/challenge/verify
39
37
  title: mfaService.VerifyChallenge()
40
38
  parameters:
41
39
  - key: options
@@ -63,7 +61,7 @@ reference:
63
61
  ruby:
64
62
  - key: verify_challenge
65
63
  id: verify_challenge
66
- url: /reference/mfa/verify-challenge
64
+ url: /reference/mfa/challenge/verify
67
65
  title: MFA.verify_challenge()
68
66
  parameters:
69
67
  - key: authentication_challenge_id
@@ -86,7 +84,7 @@ reference:
86
84
  python:
87
85
  - key: verify_challenge
88
86
  id: verify_challenge
89
- url: /reference/mfa/verify-challenge
87
+ url: /reference/mfa/challenge/verify
90
88
  title: mfa.verify_challenge()
91
89
  parameters:
92
90
  - key: authentication_challenge_id
@@ -109,7 +107,7 @@ reference:
109
107
  js:
110
108
  - key: verifyChallenge
111
109
  id: verify_challenge
112
- url: /reference/mfa/verify-challenge
110
+ url: /reference/mfa/challenge/verify
113
111
  title: mfa.verifyChallenge()
114
112
  parameters:
115
113
  - key: options
@@ -136,7 +134,7 @@ reference:
136
134
  php:
137
135
  - key: verifyChallenge
138
136
  id: verify_challenge
139
- url: /reference/mfa/verify-challenge
137
+ url: /reference/mfa/challenge/verify
140
138
  title: $mfa->verifyChallenge()
141
139
  parameters:
142
140
  - key: authenticationChallengeId
@@ -159,7 +157,7 @@ reference:
159
157
  java:
160
158
  - key: verifyChallenge
161
159
  id: verify_challenge
162
- url: /reference/mfa/verify-challenge
160
+ url: /reference/mfa/challenge/verify
163
161
  title: mfa.verifyChallenge()
164
162
  parameters:
165
163
  - key: options
@@ -189,7 +187,7 @@ reference:
189
187
  go:
190
188
  - key: VerifyChallenge
191
189
  id: verify_challenge
192
- url: /reference/mfa/verify-challenge
190
+ url: /reference/mfa/challenge/verify
193
191
  title: mfa.VerifyChallenge()
194
192
  parameters:
195
193
  - (ctx)
@@ -215,7 +213,7 @@ reference:
215
213
  type: bool
216
214
  description: (verify_challenge.valid)
217
215
  - (err)
218
- originalPath: .tmp-workos-clone/packages/docs/content/reference/mfa/verify-challenge.mdx
216
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/mfa/challenge/verify.mdx
219
217
  ---
220
218
 
221
219
  ## Verify Challenge
@@ -79,7 +79,7 @@ reference:
79
79
  description: (authentication_factor.id)
80
80
  returns:
81
81
  - (err)
82
- originalPath: .tmp-workos-clone/packages/docs/content/reference/mfa/delete-factor.mdx
82
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/mfa/factor/delete.mdx
83
83
  ---
84
84
 
85
85
  ## Delete Factor
@@ -228,7 +228,7 @@ reference:
228
228
  type: mfa.Factor
229
229
  description: (authentication_factor.self)
230
230
  - (err)
231
- originalPath: .tmp-workos-clone/packages/docs/content/reference/mfa/enroll-factor.mdx
231
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/mfa/factor/enroll.mdx
232
232
  ---
233
233
 
234
234
  ## Enroll Factor
@@ -95,7 +95,7 @@ reference:
95
95
  type: mfa.Factor
96
96
  description: (authentication_factor.self)
97
97
  - (err)
98
- originalPath: .tmp-workos-clone/packages/docs/content/reference/mfa/get-factor.mdx
98
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/mfa/factor/get.mdx
99
99
  ---
100
100
 
101
101
  ## Get Factor
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  descriptions:
3
3
  authentication_factor:
4
- self: 'The [Authentication Factor](/reference/mfa/authentication-factor) object.'
4
+ self: 'The [Authentication Factor](/reference/mfa/factor) object.'
5
5
  object: Distinguishes the Authentication Factor object.
6
6
  id: The unique ID of the Factor.
7
7
  created_at: The timestamp when the Factor was created.
@@ -17,7 +17,7 @@ descriptions:
17
17
  sms_phone_number: Phone number that the Factor was enrolled with.
18
18
  reference:
19
19
  curl:
20
- - url: /reference/mfa/authentication-factor
20
+ - url: /reference/mfa/factor
21
21
  key: authentication_factor
22
22
  id: authentication_factor
23
23
  title: authentication_factor
@@ -61,7 +61,7 @@ reference:
61
61
  type: string
62
62
  description: (authentication_factor.sms_phone_number)
63
63
  dotnet:
64
- - url: /reference/mfa/authentication-factor
64
+ - url: /reference/mfa/factor
65
65
  key: Factor
66
66
  id: authentication_factor
67
67
  title: class Factor
@@ -105,7 +105,7 @@ reference:
105
105
  type: string
106
106
  description: (authentication_factor.sms_phone_number)
107
107
  ruby:
108
- - url: /reference/mfa/authentication-factor
108
+ - url: /reference/mfa/factor
109
109
  key: Factor
110
110
  id: authentication_factor
111
111
  title: class Factor
@@ -149,7 +149,7 @@ reference:
149
149
  type: String
150
150
  description: (authentication_factor.sms_phone_number)
151
151
  python:
152
- - url: /reference/mfa/authentication-factor
152
+ - url: /reference/mfa/factor
153
153
  key: AuthenticationFactor
154
154
  id: authentication_factor
155
155
  title: AuthenticationFactor
@@ -192,7 +192,7 @@ reference:
192
192
  type: str
193
193
  description: (authentication_factor.sms_phone_number)
194
194
  js:
195
- - url: /reference/mfa/authentication-factor
195
+ - url: /reference/mfa/factor
196
196
  key: Factor
197
197
  id: authentication_factor
198
198
  title: interface Factor
@@ -236,7 +236,7 @@ reference:
236
236
  type: string
237
237
  description: (authentication_factor.sms_phone_number)
238
238
  php:
239
- - url: /reference/mfa/authentication-factor
239
+ - url: /reference/mfa/factor
240
240
  key: AuthenticationFactor
241
241
  id: authentication_factor
242
242
  title: WorkOS\Resource\AuthenticationFactor
@@ -280,7 +280,7 @@ reference:
280
280
  type: string
281
281
  description: (authentication_factor.sms_phone_number)
282
282
  java:
283
- - url: /reference/mfa/authentication-factor
283
+ - url: /reference/mfa/factor
284
284
  key: Factor
285
285
  id: authentication_factor
286
286
  title: class Factor
@@ -327,7 +327,7 @@ reference:
327
327
  type: String
328
328
  description: (authentication_factor.sms_phone_number)
329
329
  go:
330
- - url: /reference/mfa/authentication-factor
330
+ - url: /reference/mfa/factor
331
331
  key: Factor
332
332
  id: authentication_factor
333
333
  title: mfa.Factor
@@ -366,11 +366,10 @@ reference:
366
366
  - key: phone_number
367
367
  type: string
368
368
  description: (authentication_factor.sms_phone_number)
369
- originalPath: >-
370
- .tmp-workos-clone/packages/docs/content/reference/mfa/authentication-factor.mdx
369
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/mfa/factor/index.mdx
371
370
  ---
372
371
 
373
- ## Authentication Factor
372
+ # Authentication Factor
374
373
 
375
374
  An object representing an Authentication Factor.
376
375
 
@@ -150,10 +150,6 @@ reference:
150
150
  - key: state
151
151
  type: '"pending" | "verified"'
152
152
  description: (domain_data.state)
153
- - key: idempotency_key
154
- optional: true
155
- type: str
156
- description: (idempotency_key)
157
153
  returns:
158
154
  - (Organization)
159
155
  php:
@@ -196,7 +192,6 @@ reference:
196
192
  - key: State
197
193
  type: OrganizationDomainDataState
198
194
  description: (domain_data.state)
199
- - (idempotencyKey)
200
195
  - (cancellationToken)
201
196
  returns:
202
197
  - key: Task<Organization>
@@ -208,7 +203,7 @@ originalPath: .tmp-workos-clone/packages/docs/content/reference/organization/cre
208
203
 
209
204
  Creates a new organization in the current environment.
210
205
 
211
- You can include one or more domains to associate with the organization, but you should [verify the ownership](/user-management/domain-verification) of every domain before setting its state to `verified`.
206
+ You can include one or more domains to associate with the organization, but you should [verify the ownership](/authkit/domain-verification) of every domain before setting its state to `verified`.
212
207
 
213
208
  <CodeBlock referenceId="create_organization">
214
209
  <CodeBlockTab title="Request" file="create-organization-request" />
@@ -29,7 +29,7 @@ originalPath: >-
29
29
 
30
30
  ## Get an Organization by External ID
31
31
 
32
- Get the details of an existing organization by an [external identifier](/user-management/metadata/external-identifiers).
32
+ Get the details of an existing organization by an [external identifier](/authkit/metadata/external-identifiers).
33
33
 
34
34
  <CodeBlock referenceId="get_organization_by_external_id">
35
35
  <CodeBlockTab
@@ -7,13 +7,13 @@ descriptions:
7
7
  name: >-
8
8
  A descriptive name for the Organization. This field does not need to be
9
9
  unique.
10
- domains: 'List of [Organization Domains](/reference/organization-domain).'
10
+ domains: 'List of [Organization Domains](/reference/domain-verification).'
11
11
  stripe_customer_id: |
12
12
  The Stripe customer ID associated with this organization.
13
13
  external_id: The external ID of the Organization.
14
14
  metadata: >-
15
- Object containing [metadata](/user-management/metadata) key/value pairs
16
- associated with the Organization.
15
+ Object containing [metadata](/authkit/metadata) key/value pairs associated
16
+ with the Organization.
17
17
  created_at: The timestamp when the Organization was last created.
18
18
  updated_at: The timestamp when the Organization was last updated.
19
19
  domain_data:
@@ -28,11 +28,11 @@ descriptions:
28
28
 
29
29
  to you that they own this domain. A [verified
30
30
 
31
- domain](/user-management/domain-verification) may belong to multiple
31
+ domain](/authkit/domain-verification) may belong to multiple
32
32
 
33
33
  organizations but only a single organization can include the domain in its
34
34
 
35
- [Domain Policy](/user-management/organization-policies/domain-policy),
35
+ [Domain Policy](/authkit/organization-policies/domain-policy),
36
36
 
37
37
  which has the potential to affect authentication policy across your
38
38
 
@@ -228,7 +228,7 @@ originalPath: .tmp-workos-clone/packages/docs/content/reference/organization/upd
228
228
 
229
229
  Updates an organization in the current environment.
230
230
 
231
- You can include one or more domains to associate with the organization, but you should [verify the ownership](/user-management/domain-verification) of every domain before setting its state to `verified`.
231
+ You can include one or more domains to associate with the organization, but you should [verify the ownership](/authkit/domain-verification) of every domain before setting its state to `verified`.
232
232
 
233
233
  <CodeBlock referenceId="update_organization">
234
234
  <CodeBlockTab title="Request" file="update-organization-request" />
@@ -16,7 +16,6 @@ descriptions:
16
16
  An object ID that defines your place in the list. When the ID is not
17
17
  present, you are at the end of the list.
18
18
 
19
-
20
19
  For example, if you make a list request and receive 100 objects, ending with
21
20
  `"obj_123"`, your subsequent call can include `before="obj_123"` to fetch a
22
21
  new batch of objects before `"obj_123"`.
@@ -24,7 +23,6 @@ descriptions:
24
23
  An object ID that defines your place in the list. When the ID is not
25
24
  present, you are at the end of the list.
26
25
 
27
-
28
26
  For example, if you make a list request and receive 100 objects, ending with
29
27
  `"obj_123"`, your subsequent call can include `after="obj_123"` to fetch a
30
28
  new batch of objects after `"obj_123"`.
@@ -229,7 +227,7 @@ reference:
229
227
  optional: true
230
228
  type: string
231
229
  description: (after)
232
- originalPath: .tmp-workos-clone/packages/docs/content/reference/pagination.mdx
230
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/pagination/index.mdx
233
231
  ---
234
232
 
235
233
  # Pagination
@@ -0,0 +1,174 @@
1
+ ---
2
+ descriptions:
3
+ pipes_access_token: The OAuth access token for the connected integration.
4
+ pipes_active: >-
5
+ Indicates whether the access token is valid and ready for use, or if
6
+ reauthorization is required.
7
+ pipes_expires_at: The ISO-8601 formatted timestamp indicating when the access token expires.
8
+ pipes_scopes: The scopes granted to the access token.
9
+ pipes_missing_scopes: >-
10
+ If the integration has requested scopes that aren't present on the access
11
+ token, they're listed here.
12
+ pipes_get_token:
13
+ slug: The identifier of the integration.
14
+ user_id: >-
15
+ A [User](/reference/authkit/user) identifier. The user must have an active
16
+ connection to the specified integration.
17
+ organization_id: >-
18
+ An [Organization](/reference/organization) identifier. Optional parameter
19
+ to scope the integration lookup to a specific organization.
20
+ access_token: >-
21
+ The [access token](/reference/pipes/access-token) object, present when
22
+ `active` is `true`.
23
+ error: >
24
+ - `"not_installed"`: The user does not have the integration installed.
25
+
26
+ - `"needs_reauthorization"`: The user needs to reauthorize the
27
+ integration.
28
+ reference:
29
+ curl:
30
+ - key: pipes_get_token
31
+ id: pipes_get_token
32
+ url: /reference/pipes/access-token/get
33
+ title: '/data-integrations/:slug/token'
34
+ type: POST
35
+ parameters:
36
+ - key: slug
37
+ type: string
38
+ description: (pipes_get_token.slug)
39
+ - key: user_id
40
+ type: string
41
+ description: (pipes_get_token.user_id)
42
+ - key: organization_id
43
+ type: string
44
+ description: (pipes_get_token.organization_id)
45
+ optional: true
46
+ returns:
47
+ - key: anonymous
48
+ type: object
49
+ unwrap: true
50
+ properties:
51
+ - key: active
52
+ type: boolean
53
+ description: (pipes_active)
54
+ - key: access_token
55
+ type: access_token
56
+ optional: true
57
+ description: (pipes_get_token.access_token)
58
+ - key: error
59
+ type: '"not_installed" | "needs_reauthorization"'
60
+ optional: true
61
+ description: (pipes_get_token.error)
62
+ js:
63
+ - key: pipesGetToken
64
+ id: pipes_get_token
65
+ url: /reference/pipes/access-token/get
66
+ title: pipes.getAccessToken()
67
+ parameters:
68
+ - key: options
69
+ type: object
70
+ unwrap: true
71
+ properties:
72
+ - key: provider
73
+ type: string
74
+ description: (pipes_get_token.slug)
75
+ - key: userId
76
+ type: string
77
+ description: (pipes_get_token.user_id)
78
+ - key: organizationId
79
+ type: string
80
+ optional: true
81
+ description: (pipes_get_token.organization_id)
82
+ returns:
83
+ - key: accessToken
84
+ type: object | null
85
+ description: >-
86
+ Includes the access token value itself, as well as metadata about
87
+ the token. It's null if the token is invalid; check the `reason`
88
+ property for more information.
89
+ properties:
90
+ - key: token
91
+ type: string
92
+ description: (pipes_access_token)
93
+ - key: expiresAt
94
+ type: Date | null
95
+ description: (pipes_expires_at)
96
+ - key: scopes
97
+ type: 'string[]'
98
+ description: (pipes_scopes)
99
+ - key: missingScopes
100
+ type: 'string[]'
101
+ description: (pipes_missing_scopes)
102
+ - key: error
103
+ type: '"not_installed" | "needs_reauthorization"'
104
+ optional: true
105
+ description: (pipes_get_token.error)
106
+ go:
107
+ - key: GetAccessToken
108
+ id: pipes_get_token
109
+ url: /reference/pipes/access-token/get
110
+ title: pipes.GetAccessToken()
111
+ parameters:
112
+ - key: ctx
113
+ type: context.Context
114
+ description: >-
115
+ The [Context](https://pkg.go.dev/context) type provides information
116
+ about the client making the request.
117
+ - key: opts
118
+ type: pipes.GetAccessTokenOpts
119
+ unwrap: true
120
+ properties:
121
+ - key: Provider
122
+ type: string
123
+ description: (pipes_get_token.slug)
124
+ - key: UserID
125
+ type: string
126
+ description: (pipes_get_token.user_id)
127
+ - key: OrganizationID
128
+ type: string
129
+ optional: true
130
+ description: (pipes_get_token.organization_id)
131
+ returns:
132
+ - key: accessToken
133
+ type: pipes.AccessToken
134
+ description: >-
135
+ Includes the access token value itself, as well as metadata about
136
+ the token. It's null if the token is invalid; check the `reason`
137
+ property for more information.
138
+ properties:
139
+ - key: AccessToken
140
+ type: string
141
+ description: (pipes_access_token)
142
+ - key: ExpiresAt
143
+ type: time.Time | null
144
+ description: (pipes_expires_at)
145
+ - key: Scopes
146
+ type: '[]string'
147
+ description: (pipes_scopes)
148
+ - key: MissingScopes
149
+ type: '[]string'
150
+ description: (pipes_missing_scopes)
151
+ - key: err
152
+ type: pipes.NotInstalled | pipes.NeedsReauthorization | error
153
+ description: >
154
+ Includes Pipes-specific errors:
155
+
156
+ - `pipes.NotInstalled`: The user does not have the integration
157
+ installed.
158
+
159
+ - `pipes.NeedsReauthorization`: The user needs to reauthorize the
160
+ integration.
161
+
162
+
163
+ Network and other transient errors may also be returned.
164
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/pipes/access-token/get.mdx
165
+ ---
166
+
167
+ ## Get an access token for a connected account
168
+
169
+ Fetches a valid OAuth access token for a user's connected account. WorkOS automatically handles token refresh, ensuring you always receive a valid, non-expired token.
170
+
171
+ <CodeBlock referenceId="pipes_get_token">
172
+ <CodeBlockTab title="Request" file="get-token-request" />
173
+ <CodeBlockTab title="Response" file="get-token-response" />
174
+ </CodeBlock>
@@ -0,0 +1,44 @@
1
+ ---
2
+ descriptions:
3
+ pipes_access_token_object:
4
+ object: Distinguishes the access token object.
5
+ access_token: The OAuth access token for the connected integration.
6
+ expires_at: The ISO-8601 formatted timestamp indicating when the access token expires.
7
+ scopes: The scopes granted to the access token.
8
+ missing_scopes: >-
9
+ If the integration has requested scopes that aren't present on the access
10
+ token, they're listed here.
11
+ reference:
12
+ curl:
13
+ - url: /reference/pipes/access-token
14
+ key: pipes_access_token_object
15
+ id: pipes_access_token_object
16
+ title: access_token
17
+ properties:
18
+ - key: object
19
+ type: '"access_token"'
20
+ description: (pipes_access_token_object.object)
21
+ - key: access_token
22
+ type: string
23
+ description: (pipes_access_token_object.access_token)
24
+ - key: expires_at
25
+ type: string | null
26
+ description: (pipes_access_token_object.expires_at)
27
+ - key: scopes
28
+ type: 'string[]'
29
+ description: (pipes_access_token_object.scopes)
30
+ - key: missing_scopes
31
+ type: 'string[]'
32
+ description: (pipes_access_token_object.missing_scopes)
33
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/pipes/access-token/index.mdx
34
+ ---
35
+
36
+ # Access Token
37
+
38
+ An access token allows you to make API calls to a connected third-party service on behalf of a user. WorkOS handles token refresh automatically, so you always receive a valid, non-expired token.
39
+
40
+ <CodeBlock
41
+ title="Access Token"
42
+ referenceId="pipes_access_token_object"
43
+ file="access-token"
44
+ />