@workos/mcp-docs-server 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (455) hide show
  1. package/.docs/organized/changelogs/workos-platform.json +277 -0
  2. package/.docs/organized/docs/admin-portal/_navigation.mdx +16 -0
  3. package/.docs/organized/docs/admin-portal/custom-branding.mdx +111 -0
  4. package/.docs/organized/docs/admin-portal/example-apps.mdx +46 -0
  5. package/.docs/organized/docs/admin-portal/index.mdx +240 -0
  6. package/.docs/organized/docs/audit-logs/_navigation.mdx +22 -0
  7. package/.docs/organized/docs/audit-logs/admin-portal.mdx +20 -0
  8. package/.docs/organized/docs/audit-logs/editing-events.mdx +27 -0
  9. package/.docs/organized/docs/audit-logs/exporting-events.mdx +29 -0
  10. package/.docs/organized/docs/audit-logs/index.mdx +110 -0
  11. package/.docs/organized/docs/audit-logs/log-streams.mdx +56 -0
  12. package/.docs/organized/docs/audit-logs/metadata-schema.mdx +21 -0
  13. package/.docs/organized/docs/custom-domains/_navigation.mdx +16 -0
  14. package/.docs/organized/docs/custom-domains/admin-portal.mdx +38 -0
  15. package/.docs/organized/docs/custom-domains/auth-api.mdx +59 -0
  16. package/.docs/organized/docs/custom-domains/authkit.mdx +36 -0
  17. package/.docs/organized/docs/custom-domains/email.mdx +41 -0
  18. package/.docs/organized/docs/custom-domains/index.mdx +19 -0
  19. package/.docs/organized/docs/dashboard.mdx +244 -0
  20. package/.docs/organized/docs/demo/_navigation.mdx +26 -0
  21. package/.docs/organized/docs/demo/accordion.mdx +34 -0
  22. package/.docs/organized/docs/demo/checklist.mdx +33 -0
  23. package/.docs/organized/docs/demo/code-block.mdx +185 -0
  24. package/.docs/organized/docs/demo/definition-list.mdx +35 -0
  25. package/.docs/organized/docs/demo/index.mdx +7 -0
  26. package/.docs/organized/docs/demo/punctuation.mdx +37 -0
  27. package/.docs/organized/docs/demo/replacements.mdx +26 -0
  28. package/.docs/organized/docs/demo/table.mdx +26 -0
  29. package/.docs/organized/docs/demo/tabs.mdx +17 -0
  30. package/.docs/organized/docs/directory-sync/_navigation.mdx +28 -0
  31. package/.docs/organized/docs/directory-sync/attributes.mdx +209 -0
  32. package/.docs/organized/docs/directory-sync/example-apps.mdx +46 -0
  33. package/.docs/organized/docs/directory-sync/handle-inactive-users.mdx +52 -0
  34. package/.docs/organized/docs/directory-sync/identity-provider-role-assignment.mdx +134 -0
  35. package/.docs/organized/docs/directory-sync/index.mdx +107 -0
  36. package/.docs/organized/docs/directory-sync/quick-start.mdx +129 -0
  37. package/.docs/organized/docs/directory-sync/understanding-events.mdx +209 -0
  38. package/.docs/organized/docs/domain-verification/_navigation.mdx +10 -0
  39. package/.docs/organized/docs/domain-verification/api.mdx +60 -0
  40. package/.docs/organized/docs/domain-verification/index.mdx +67 -0
  41. package/.docs/organized/docs/email.mdx +109 -0
  42. package/.docs/organized/docs/events/_navigation.mdx +22 -0
  43. package/.docs/organized/docs/events/data-syncing/data-reconciliation.mdx +56 -0
  44. package/.docs/organized/docs/events/data-syncing/events-api.mdx +114 -0
  45. package/.docs/organized/docs/events/data-syncing/index.mdx +66 -0
  46. package/.docs/organized/docs/events/data-syncing/webhooks.mdx +173 -0
  47. package/.docs/organized/docs/events/index.mdx +783 -0
  48. package/.docs/organized/docs/events/observability/datadog.mdx +76 -0
  49. package/.docs/organized/docs/fga/_navigation.mdx +64 -0
  50. package/.docs/organized/docs/fga/identity-provider-sessions.mdx +68 -0
  51. package/.docs/organized/docs/fga/index.mdx +60 -0
  52. package/.docs/organized/docs/fga/local-development.mdx +155 -0
  53. package/.docs/organized/docs/fga/modeling/abac.mdx +107 -0
  54. package/.docs/organized/docs/fga/modeling/blocklist.mdx +84 -0
  55. package/.docs/organized/docs/fga/modeling/conditional-roles.mdx +99 -0
  56. package/.docs/organized/docs/fga/modeling/custom-roles.mdx +90 -0
  57. package/.docs/organized/docs/fga/modeling/entitlements.mdx +127 -0
  58. package/.docs/organized/docs/fga/modeling/managed-service-provider.mdx +131 -0
  59. package/.docs/organized/docs/fga/modeling/org-roles-and-permissions.mdx +95 -0
  60. package/.docs/organized/docs/fga/modeling/policy-context.mdx +231 -0
  61. package/.docs/organized/docs/fga/modeling/public-access.mdx +61 -0
  62. package/.docs/organized/docs/fga/modeling/shareable-content.mdx +106 -0
  63. package/.docs/organized/docs/fga/modeling/superusers.mdx +74 -0
  64. package/.docs/organized/docs/fga/modeling/user-groups.mdx +92 -0
  65. package/.docs/organized/docs/fga/operations-usage.mdx +104 -0
  66. package/.docs/organized/docs/fga/playground.mdx +12 -0
  67. package/.docs/organized/docs/fga/policies.mdx +462 -0
  68. package/.docs/organized/docs/fga/query-language.mdx +112 -0
  69. package/.docs/organized/docs/fga/quick-start.mdx +174 -0
  70. package/.docs/organized/docs/fga/resources.mdx +92 -0
  71. package/.docs/organized/docs/fga/schema-management.mdx +224 -0
  72. package/.docs/organized/docs/fga/schema.mdx +388 -0
  73. package/.docs/organized/docs/fga/warrant-tokens.mdx +44 -0
  74. package/.docs/organized/docs/fga/warrants.mdx +92 -0
  75. package/.docs/organized/docs/glossary.mdx +184 -0
  76. package/.docs/organized/docs/integrations/_navigation.mdx +6 -0
  77. package/.docs/organized/docs/integrations/access-people-hr.mdx +87 -0
  78. package/.docs/organized/docs/integrations/adp-oidc.mdx +103 -0
  79. package/.docs/organized/docs/integrations/apple.mdx +169 -0
  80. package/.docs/organized/docs/integrations/auth0-directory-sync.mdx +78 -0
  81. package/.docs/organized/docs/integrations/auth0-enterprise-connection.mdx +92 -0
  82. package/.docs/organized/docs/integrations/auth0-saml.mdx +81 -0
  83. package/.docs/organized/docs/integrations/aws-cognito.mdx +81 -0
  84. package/.docs/organized/docs/integrations/bamboohr.mdx +90 -0
  85. package/.docs/organized/docs/integrations/breathe-hr.mdx +89 -0
  86. package/.docs/organized/docs/integrations/bubble.mdx +129 -0
  87. package/.docs/organized/docs/integrations/cas-saml.mdx +65 -0
  88. package/.docs/organized/docs/integrations/cezanne.mdx +74 -0
  89. package/.docs/organized/docs/integrations/classlink-saml.mdx +100 -0
  90. package/.docs/organized/docs/integrations/cloudflare-saml.mdx +164 -0
  91. package/.docs/organized/docs/integrations/cyberark-saml.mdx +138 -0
  92. package/.docs/organized/docs/integrations/cyberark-scim.mdx +100 -0
  93. package/.docs/organized/docs/integrations/duo-saml.mdx +127 -0
  94. package/.docs/organized/docs/integrations/entra-id-saml.mdx +156 -0
  95. package/.docs/organized/docs/integrations/entra-id-scim.mdx +218 -0
  96. package/.docs/organized/docs/integrations/firebase.mdx +98 -0
  97. package/.docs/organized/docs/integrations/fourth.mdx +66 -0
  98. package/.docs/organized/docs/integrations/github-oauth.mdx +85 -0
  99. package/.docs/organized/docs/integrations/gitlab-oauth.mdx +81 -0
  100. package/.docs/organized/docs/integrations/google-directory-sync.mdx +86 -0
  101. package/.docs/organized/docs/integrations/google-oauth.mdx +173 -0
  102. package/.docs/organized/docs/integrations/google-saml.mdx +135 -0
  103. package/.docs/organized/docs/integrations/hibob.mdx +98 -0
  104. package/.docs/organized/docs/integrations/jumpcloud-saml.mdx +96 -0
  105. package/.docs/organized/docs/integrations/jumpcloud-scim.mdx +106 -0
  106. package/.docs/organized/docs/integrations/keycloak-saml.mdx +128 -0
  107. package/.docs/organized/docs/integrations/lastpass-saml.mdx +134 -0
  108. package/.docs/organized/docs/integrations/linkedin-oauth.mdx +77 -0
  109. package/.docs/organized/docs/integrations/login-gov-oidc.mdx +103 -0
  110. package/.docs/organized/docs/integrations/microsoft-ad-fs-saml.mdx +96 -0
  111. package/.docs/organized/docs/integrations/microsoft-oauth.mdx +101 -0
  112. package/.docs/organized/docs/integrations/miniorange-saml.mdx +124 -0
  113. package/.docs/organized/docs/integrations/net-iq-saml.mdx +75 -0
  114. package/.docs/organized/docs/integrations/next-auth.mdx +257 -0
  115. package/.docs/organized/docs/integrations/oidc.mdx +64 -0
  116. package/.docs/organized/docs/integrations/okta-saml.mdx +144 -0
  117. package/.docs/organized/docs/integrations/okta-scim.mdx +210 -0
  118. package/.docs/organized/docs/integrations/onelogin-saml.mdx +131 -0
  119. package/.docs/organized/docs/integrations/onelogin-scim.mdx +150 -0
  120. package/.docs/organized/docs/integrations/oracle-saml.mdx +76 -0
  121. package/.docs/organized/docs/integrations/pingfederate-saml.mdx +103 -0
  122. package/.docs/organized/docs/integrations/pingfederate-scim.mdx +150 -0
  123. package/.docs/organized/docs/integrations/pingone-saml.mdx +86 -0
  124. package/.docs/organized/docs/integrations/react-native-expo.mdx +93 -0
  125. package/.docs/organized/docs/integrations/rippling-saml.mdx +174 -0
  126. package/.docs/organized/docs/integrations/rippling-scim.mdx +148 -0
  127. package/.docs/organized/docs/integrations/salesforce-saml.mdx +143 -0
  128. package/.docs/organized/docs/integrations/saml.mdx +64 -0
  129. package/.docs/organized/docs/integrations/scim.mdx +64 -0
  130. package/.docs/organized/docs/integrations/sftp.mdx +150 -0
  131. package/.docs/organized/docs/integrations/shibboleth-generic-saml.mdx +84 -0
  132. package/.docs/organized/docs/integrations/shibboleth-unsolicited-saml.mdx +84 -0
  133. package/.docs/organized/docs/integrations/simple-saml-php.mdx +78 -0
  134. package/.docs/organized/docs/integrations/slack-oauth.mdx +102 -0
  135. package/.docs/organized/docs/integrations/supabase.mdx +68 -0
  136. package/.docs/organized/docs/integrations/vmware-saml.mdx +100 -0
  137. package/.docs/organized/docs/integrations/workday.mdx +156 -0
  138. package/.docs/organized/docs/integrations/xero-oauth.mdx +83 -0
  139. package/.docs/organized/docs/magic-link/_navigation.mdx +16 -0
  140. package/.docs/organized/docs/magic-link/example-apps.mdx +46 -0
  141. package/.docs/organized/docs/magic-link/index.mdx +199 -0
  142. package/.docs/organized/docs/magic-link/launch-checklist.mdx +27 -0
  143. package/.docs/organized/docs/mfa/_navigation.mdx +18 -0
  144. package/.docs/organized/docs/mfa/example-apps.mdx +46 -0
  145. package/.docs/organized/docs/mfa/index.mdx +140 -0
  146. package/.docs/organized/docs/mfa/ux/enrollment.mdx +74 -0
  147. package/.docs/organized/docs/mfa/ux/sign-in.mdx +30 -0
  148. package/.docs/organized/docs/migrate/_navigation.mdx +6 -0
  149. package/.docs/organized/docs/migrate/auth0.mdx +98 -0
  150. package/.docs/organized/docs/migrate/aws-cognito.mdx +115 -0
  151. package/.docs/organized/docs/migrate/clerk.mdx +106 -0
  152. package/.docs/organized/docs/migrate/firebase.mdx +80 -0
  153. package/.docs/organized/docs/migrate/other-services.mdx +179 -0
  154. package/.docs/organized/docs/migrate/standalone-sso.mdx +105 -0
  155. package/.docs/organized/docs/on-prem-deployment.mdx +119 -0
  156. package/.docs/organized/docs/postman.mdx +90 -0
  157. package/.docs/organized/docs/reference/_navigation.mdx +527 -0
  158. package/.docs/organized/docs/reference/admin-portal/index.mdx +6 -0
  159. package/.docs/organized/docs/reference/admin-portal/portal-link/generate.mdx +268 -0
  160. package/.docs/organized/docs/reference/admin-portal/portal-link/index.mdx +15 -0
  161. package/.docs/organized/docs/reference/admin-portal/provider-icons/index.mdx +52 -0
  162. package/.docs/organized/docs/reference/api-keys.mdx +22 -0
  163. package/.docs/organized/docs/reference/audit-logs/audit-log-export.mdx +239 -0
  164. package/.docs/organized/docs/reference/audit-logs/audit-log-schema.mdx +69 -0
  165. package/.docs/organized/docs/reference/audit-logs/create-event.mdx +673 -0
  166. package/.docs/organized/docs/reference/audit-logs/create-export.mdx +308 -0
  167. package/.docs/organized/docs/reference/audit-logs/create-schema.mdx +95 -0
  168. package/.docs/organized/docs/reference/audit-logs/get-export.mdx +117 -0
  169. package/.docs/organized/docs/reference/audit-logs/get-retention.mdx +34 -0
  170. package/.docs/organized/docs/reference/audit-logs/index.mdx +6 -0
  171. package/.docs/organized/docs/reference/audit-logs/list-actions.mdx +40 -0
  172. package/.docs/organized/docs/reference/audit-logs/list-schemas.mdx +40 -0
  173. package/.docs/organized/docs/reference/audit-logs/set-retention.mdx +39 -0
  174. package/.docs/organized/docs/reference/client-libraries.mdx +19 -0
  175. package/.docs/organized/docs/reference/directory-sync/directory/delete.mdx +90 -0
  176. package/.docs/organized/docs/reference/directory-sync/directory/get.mdx +105 -0
  177. package/.docs/organized/docs/reference/directory-sync/directory/index.mdx +385 -0
  178. package/.docs/organized/docs/reference/directory-sync/directory/list.mdx +281 -0
  179. package/.docs/organized/docs/reference/directory-sync/directory-group/get.mdx +105 -0
  180. package/.docs/organized/docs/reference/directory-sync/directory-group/index.mdx +277 -0
  181. package/.docs/organized/docs/reference/directory-sync/directory-group/list.mdx +295 -0
  182. package/.docs/organized/docs/reference/directory-sync/directory-user/get.mdx +112 -0
  183. package/.docs/organized/docs/reference/directory-sync/directory-user/index.mdx +470 -0
  184. package/.docs/organized/docs/reference/directory-sync/directory-user/list.mdx +304 -0
  185. package/.docs/organized/docs/reference/directory-sync/index.mdx +10 -0
  186. package/.docs/organized/docs/reference/domain-verification/create.mdx +38 -0
  187. package/.docs/organized/docs/reference/domain-verification/get.mdx +32 -0
  188. package/.docs/organized/docs/reference/domain-verification/index.mdx +84 -0
  189. package/.docs/organized/docs/reference/domain-verification/verify.mdx +36 -0
  190. package/.docs/organized/docs/reference/errors.mdx +30 -0
  191. package/.docs/organized/docs/reference/events/index.mdx +9 -0
  192. package/.docs/organized/docs/reference/events/list.mdx +246 -0
  193. package/.docs/organized/docs/reference/fga/batch-check.mdx +277 -0
  194. package/.docs/organized/docs/reference/fga/check.mdx +563 -0
  195. package/.docs/organized/docs/reference/fga/index.mdx +6 -0
  196. package/.docs/organized/docs/reference/fga/policy/create.mdx +27 -0
  197. package/.docs/organized/docs/reference/fga/policy/delete.mdx +18 -0
  198. package/.docs/organized/docs/reference/fga/policy/get.mdx +23 -0
  199. package/.docs/organized/docs/reference/fga/policy/index.mdx +52 -0
  200. package/.docs/organized/docs/reference/fga/policy/list.mdx +41 -0
  201. package/.docs/organized/docs/reference/fga/policy/update.mdx +26 -0
  202. package/.docs/organized/docs/reference/fga/query.mdx +375 -0
  203. package/.docs/organized/docs/reference/fga/resource/batch-write.mdx +175 -0
  204. package/.docs/organized/docs/reference/fga/resource/create.mdx +130 -0
  205. package/.docs/organized/docs/reference/fga/resource/delete.mdx +86 -0
  206. package/.docs/organized/docs/reference/fga/resource/get.mdx +88 -0
  207. package/.docs/organized/docs/reference/fga/resource/index.mdx +98 -0
  208. package/.docs/organized/docs/reference/fga/resource/list.mdx +188 -0
  209. package/.docs/organized/docs/reference/fga/resource/update.mdx +115 -0
  210. package/.docs/organized/docs/reference/fga/resource-type/apply.mdx +35 -0
  211. package/.docs/organized/docs/reference/fga/resource-type/create.mdx +24 -0
  212. package/.docs/organized/docs/reference/fga/resource-type/delete.mdx +22 -0
  213. package/.docs/organized/docs/reference/fga/resource-type/get.mdx +23 -0
  214. package/.docs/organized/docs/reference/fga/resource-type/index.mdx +68 -0
  215. package/.docs/organized/docs/reference/fga/resource-type/list.mdx +36 -0
  216. package/.docs/organized/docs/reference/fga/resource-type/update.mdx +23 -0
  217. package/.docs/organized/docs/reference/fga/schema/apply.mdx +42 -0
  218. package/.docs/organized/docs/reference/fga/schema/get.mdx +24 -0
  219. package/.docs/organized/docs/reference/fga/schema/index.mdx +39 -0
  220. package/.docs/organized/docs/reference/fga/warrant/batch-write.mdx +226 -0
  221. package/.docs/organized/docs/reference/fga/warrant/create.mdx +215 -0
  222. package/.docs/organized/docs/reference/fga/warrant/delete.mdx +212 -0
  223. package/.docs/organized/docs/reference/fga/warrant/index.mdx +186 -0
  224. package/.docs/organized/docs/reference/fga/warrant/list.mdx +282 -0
  225. package/.docs/organized/docs/reference/idempotency.mdx +21 -0
  226. package/.docs/organized/docs/reference/index.mdx +194 -0
  227. package/.docs/organized/docs/reference/magic-link/index.mdx +8 -0
  228. package/.docs/organized/docs/reference/magic-link/passwordless-session/create.mdx +268 -0
  229. package/.docs/organized/docs/reference/magic-link/passwordless-session/index.mdx +203 -0
  230. package/.docs/organized/docs/reference/magic-link/passwordless-session/send-email.mdx +158 -0
  231. package/.docs/organized/docs/reference/mfa/authentication-challenge.mdx +217 -0
  232. package/.docs/organized/docs/reference/mfa/authentication-factor.mdx +381 -0
  233. package/.docs/organized/docs/reference/mfa/challenge-factor.mdx +170 -0
  234. package/.docs/organized/docs/reference/mfa/delete-factor.mdx +93 -0
  235. package/.docs/organized/docs/reference/mfa/enroll-factor.mdx +241 -0
  236. package/.docs/organized/docs/reference/mfa/get-factor.mdx +108 -0
  237. package/.docs/organized/docs/reference/mfa/index.mdx +8 -0
  238. package/.docs/organized/docs/reference/mfa/verify-challenge.mdx +228 -0
  239. package/.docs/organized/docs/reference/organization/create.mdx +216 -0
  240. package/.docs/organized/docs/reference/organization/delete.mdx +89 -0
  241. package/.docs/organized/docs/reference/organization/get-by-external-id.mdx +40 -0
  242. package/.docs/organized/docs/reference/organization/get.mdx +104 -0
  243. package/.docs/organized/docs/reference/organization/index.mdx +274 -0
  244. package/.docs/organized/docs/reference/organization/list.mdx +258 -0
  245. package/.docs/organized/docs/reference/organization/update.mdx +236 -0
  246. package/.docs/organized/docs/reference/organization-domain.mdx +189 -0
  247. package/.docs/organized/docs/reference/pagination.mdx +244 -0
  248. package/.docs/organized/docs/reference/radar/attempts/create.mdx +115 -0
  249. package/.docs/organized/docs/reference/radar/attempts/index.mdx +7 -0
  250. package/.docs/organized/docs/reference/radar/attempts/update.mdx +34 -0
  251. package/.docs/organized/docs/reference/radar/index.mdx +8 -0
  252. package/.docs/organized/docs/reference/radar/lists/delete.mdx +36 -0
  253. package/.docs/organized/docs/reference/radar/lists/index.mdx +7 -0
  254. package/.docs/organized/docs/reference/radar/lists/update.mdx +36 -0
  255. package/.docs/organized/docs/reference/rate-limits.mdx +50 -0
  256. package/.docs/organized/docs/reference/roles/index.mdx +268 -0
  257. package/.docs/organized/docs/reference/roles/list-for-organization.mdx +152 -0
  258. package/.docs/organized/docs/reference/sso/connection/delete.mdx +89 -0
  259. package/.docs/organized/docs/reference/sso/connection/get.mdx +104 -0
  260. package/.docs/organized/docs/reference/sso/connection/index.mdx +388 -0
  261. package/.docs/organized/docs/reference/sso/connection/list.mdx +320 -0
  262. package/.docs/organized/docs/reference/sso/get-authorization-url/error-codes.mdx +28 -0
  263. package/.docs/organized/docs/reference/sso/get-authorization-url/index.mdx +434 -0
  264. package/.docs/organized/docs/reference/sso/get-authorization-url/redirect-uri.mdx +21 -0
  265. package/.docs/organized/docs/reference/sso/index.mdx +8 -0
  266. package/.docs/organized/docs/reference/sso/logout/authorize.mdx +47 -0
  267. package/.docs/organized/docs/reference/sso/logout/index.mdx +14 -0
  268. package/.docs/organized/docs/reference/sso/logout/redirect.mdx +32 -0
  269. package/.docs/organized/docs/reference/sso/profile/get-profile-and-token.mdx +229 -0
  270. package/.docs/organized/docs/reference/sso/profile/get-user-profile.mdx +127 -0
  271. package/.docs/organized/docs/reference/sso/profile/index.mdx +364 -0
  272. package/.docs/organized/docs/reference/testing.mdx +8 -0
  273. package/.docs/organized/docs/reference/user-management/access-token/index.mdx +13 -0
  274. package/.docs/organized/docs/reference/user-management/authentication/code.mdx +448 -0
  275. package/.docs/organized/docs/reference/user-management/authentication/email-verification.mdx +359 -0
  276. package/.docs/organized/docs/reference/user-management/authentication/get-authorization-url/error-codes.mdx +25 -0
  277. package/.docs/organized/docs/reference/user-management/authentication/get-authorization-url/index.mdx +425 -0
  278. package/.docs/organized/docs/reference/user-management/authentication/get-authorization-url/pkce.mdx +9 -0
  279. package/.docs/organized/docs/reference/user-management/authentication/get-authorization-url/redirect-uri.mdx +23 -0
  280. package/.docs/organized/docs/reference/user-management/authentication/index.mdx +66 -0
  281. package/.docs/organized/docs/reference/user-management/authentication/magic-auth.mdx +353 -0
  282. package/.docs/organized/docs/reference/user-management/authentication/organization-selection.mdx +349 -0
  283. package/.docs/organized/docs/reference/user-management/authentication/password.mdx +350 -0
  284. package/.docs/organized/docs/reference/user-management/authentication/refresh-and-seal-session-data.mdx +57 -0
  285. package/.docs/organized/docs/reference/user-management/authentication/refresh-token.mdx +381 -0
  286. package/.docs/organized/docs/reference/user-management/authentication/session-cookie.mdx +79 -0
  287. package/.docs/organized/docs/reference/user-management/authentication/totp.mdx +369 -0
  288. package/.docs/organized/docs/reference/user-management/authentication-errors/email-verification-required-error.mdx +42 -0
  289. package/.docs/organized/docs/reference/user-management/authentication-errors/index.mdx +20 -0
  290. package/.docs/organized/docs/reference/user-management/authentication-errors/mfa-challenge-error.mdx +44 -0
  291. package/.docs/organized/docs/reference/user-management/authentication-errors/mfa-enrollment-error.mdx +37 -0
  292. package/.docs/organized/docs/reference/user-management/authentication-errors/organization-authentication-required-error.mdx +68 -0
  293. package/.docs/organized/docs/reference/user-management/authentication-errors/organization-selection-error.mdx +44 -0
  294. package/.docs/organized/docs/reference/user-management/authentication-errors/sso-required-error.mdx +51 -0
  295. package/.docs/organized/docs/reference/user-management/email-verification/get.mdx +88 -0
  296. package/.docs/organized/docs/reference/user-management/email-verification/index.mdx +227 -0
  297. package/.docs/organized/docs/reference/user-management/identity/index.mdx +74 -0
  298. package/.docs/organized/docs/reference/user-management/identity/list.mdx +52 -0
  299. package/.docs/organized/docs/reference/user-management/index.mdx +13 -0
  300. package/.docs/organized/docs/reference/user-management/invitation/accept.mdx +39 -0
  301. package/.docs/organized/docs/reference/user-management/invitation/find-by-token.mdx +87 -0
  302. package/.docs/organized/docs/reference/user-management/invitation/get.mdx +87 -0
  303. package/.docs/organized/docs/reference/user-management/invitation/index.mdx +374 -0
  304. package/.docs/organized/docs/reference/user-management/invitation/list.mdx +247 -0
  305. package/.docs/organized/docs/reference/user-management/invitation/revoke.mdx +90 -0
  306. package/.docs/organized/docs/reference/user-management/invitation/send.mdx +230 -0
  307. package/.docs/organized/docs/reference/user-management/logout/get-logout-url-from-session-cookie.mdx +52 -0
  308. package/.docs/organized/docs/reference/user-management/logout/get-logout-url.mdx +147 -0
  309. package/.docs/organized/docs/reference/user-management/logout/index.mdx +26 -0
  310. package/.docs/organized/docs/reference/user-management/magic-auth/create.mdx +148 -0
  311. package/.docs/organized/docs/reference/user-management/magic-auth/get.mdx +88 -0
  312. package/.docs/organized/docs/reference/user-management/magic-auth/index.mdx +225 -0
  313. package/.docs/organized/docs/reference/user-management/mfa/authentication-challenge.mdx +194 -0
  314. package/.docs/organized/docs/reference/user-management/mfa/authentication-factor.mdx +324 -0
  315. package/.docs/organized/docs/reference/user-management/mfa/enroll-auth-factor.mdx +296 -0
  316. package/.docs/organized/docs/reference/user-management/mfa/index.mdx +5 -0
  317. package/.docs/organized/docs/reference/user-management/mfa/list-auth-factors.mdx +194 -0
  318. package/.docs/organized/docs/reference/user-management/organization-membership/create.mdx +155 -0
  319. package/.docs/organized/docs/reference/user-management/organization-membership/deactivate.mdx +106 -0
  320. package/.docs/organized/docs/reference/user-management/organization-membership/delete.mdx +76 -0
  321. package/.docs/organized/docs/reference/user-management/organization-membership/get.mdx +95 -0
  322. package/.docs/organized/docs/reference/user-management/organization-membership/index.mdx +265 -0
  323. package/.docs/organized/docs/reference/user-management/organization-membership/list.mdx +291 -0
  324. package/.docs/organized/docs/reference/user-management/organization-membership/reactivate.mdx +106 -0
  325. package/.docs/organized/docs/reference/user-management/organization-membership/update.mdx +119 -0
  326. package/.docs/organized/docs/reference/user-management/password-reset/create.mdx +108 -0
  327. package/.docs/organized/docs/reference/user-management/password-reset/get.mdx +88 -0
  328. package/.docs/organized/docs/reference/user-management/password-reset/index.mdx +227 -0
  329. package/.docs/organized/docs/reference/user-management/password-reset/reset-password.mdx +144 -0
  330. package/.docs/organized/docs/reference/user-management/session-helpers/authenticate.mdx +176 -0
  331. package/.docs/organized/docs/reference/user-management/session-helpers/get-logout-url.mdx +42 -0
  332. package/.docs/organized/docs/reference/user-management/session-helpers/index.mdx +14 -0
  333. package/.docs/organized/docs/reference/user-management/session-helpers/load-sealed-session.mdx +105 -0
  334. package/.docs/organized/docs/reference/user-management/session-helpers/refresh.mdx +213 -0
  335. package/.docs/organized/docs/reference/user-management/session-tokens/access-token.mdx +90 -0
  336. package/.docs/organized/docs/reference/user-management/session-tokens/index.mdx +5 -0
  337. package/.docs/organized/docs/reference/user-management/session-tokens/jwks.mdx +110 -0
  338. package/.docs/organized/docs/reference/user-management/session-tokens/refresh-token.mdx +8 -0
  339. package/.docs/organized/docs/reference/user-management/user/create.mdx +327 -0
  340. package/.docs/organized/docs/reference/user-management/user/delete.mdx +76 -0
  341. package/.docs/organized/docs/reference/user-management/user/get-by-external-id.mdx +39 -0
  342. package/.docs/organized/docs/reference/user-management/user/get.mdx +103 -0
  343. package/.docs/organized/docs/reference/user-management/user/index.mdx +322 -0
  344. package/.docs/organized/docs/reference/user-management/user/list.mdx +260 -0
  345. package/.docs/organized/docs/reference/user-management/user/update.mdx +344 -0
  346. package/.docs/organized/docs/reference/vault/index.mdx +6 -0
  347. package/.docs/organized/docs/reference/vault/key/create-data-key.mdx +106 -0
  348. package/.docs/organized/docs/reference/vault/key/decrypt-data-key.mdx +84 -0
  349. package/.docs/organized/docs/reference/vault/key/decrypt-data.mdx +52 -0
  350. package/.docs/organized/docs/reference/vault/key/encrypt-data.mdx +58 -0
  351. package/.docs/organized/docs/reference/vault/key/index.mdx +25 -0
  352. package/.docs/organized/docs/reference/vault/object/create.mdx +62 -0
  353. package/.docs/organized/docs/reference/vault/object/delete.mdx +75 -0
  354. package/.docs/organized/docs/reference/vault/object/get.mdx +50 -0
  355. package/.docs/organized/docs/reference/vault/object/index.mdx +174 -0
  356. package/.docs/organized/docs/reference/vault/object/list.mdx +105 -0
  357. package/.docs/organized/docs/reference/vault/object/metadata.mdx +52 -0
  358. package/.docs/organized/docs/reference/vault/object/update.mdx +67 -0
  359. package/.docs/organized/docs/reference/vault/object/version.mdx +87 -0
  360. package/.docs/organized/docs/reference/vault/object/versions.mdx +83 -0
  361. package/.docs/organized/docs/reference/widgets/get-token.mdx +185 -0
  362. package/.docs/organized/docs/reference/widgets/index.mdx +6 -0
  363. package/.docs/organized/docs/reference/workos-connect/authorize/index.mdx +75 -0
  364. package/.docs/organized/docs/reference/workos-connect/index.mdx +33 -0
  365. package/.docs/organized/docs/reference/workos-connect/introspection/index.mdx +122 -0
  366. package/.docs/organized/docs/reference/workos-connect/metadata/index.mdx +25 -0
  367. package/.docs/organized/docs/reference/workos-connect/metadata/oauth-authorization-server/index.mdx +99 -0
  368. package/.docs/organized/docs/reference/workos-connect/metadata/openid-configuration/index.mdx +70 -0
  369. package/.docs/organized/docs/reference/workos-connect/token/authorization-code-grant/access-token.mdx +53 -0
  370. package/.docs/organized/docs/reference/workos-connect/token/authorization-code-grant/id-token.mdx +60 -0
  371. package/.docs/organized/docs/reference/workos-connect/token/authorization-code-grant/index.mdx +69 -0
  372. package/.docs/organized/docs/reference/workos-connect/token/client-credentials-grant/access-token.mdx +46 -0
  373. package/.docs/organized/docs/reference/workos-connect/token/client-credentials-grant/index.mdx +56 -0
  374. package/.docs/organized/docs/reference/workos-connect/token/index.mdx +39 -0
  375. package/.docs/organized/docs/reference/workos-connect/token/refresh-token-grant.mdx +69 -0
  376. package/.docs/organized/docs/reference/workos-connect/userinfo/index.mdx +46 -0
  377. package/.docs/organized/docs/sdks/dotnet.mdx +6 -0
  378. package/.docs/organized/docs/sdks/elixir.mdx +6 -0
  379. package/.docs/organized/docs/sdks/go.mdx +6 -0
  380. package/.docs/organized/docs/sdks/java.mdx +9 -0
  381. package/.docs/organized/docs/sdks/laravel.mdx +6 -0
  382. package/.docs/organized/docs/sdks/node.mdx +9 -0
  383. package/.docs/organized/docs/sdks/php.mdx +6 -0
  384. package/.docs/organized/docs/sdks/python.mdx +6 -0
  385. package/.docs/organized/docs/sdks/ruby.mdx +9 -0
  386. package/.docs/organized/docs/sso/_navigation.mdx +44 -0
  387. package/.docs/organized/docs/sso/_sequence-diagrams/saml-protocol-security-considerations.md +59 -0
  388. package/.docs/organized/docs/sso/attributes.mdx +110 -0
  389. package/.docs/organized/docs/sso/domains.mdx +111 -0
  390. package/.docs/organized/docs/sso/example-apps.mdx +46 -0
  391. package/.docs/organized/docs/sso/identity-provider-role-assignment.mdx +113 -0
  392. package/.docs/organized/docs/sso/index.mdx +295 -0
  393. package/.docs/organized/docs/sso/it-team-faq.mdx +35 -0
  394. package/.docs/organized/docs/sso/jit-provisioning.mdx +101 -0
  395. package/.docs/organized/docs/sso/launch-checklist.mdx +71 -0
  396. package/.docs/organized/docs/sso/login-flows.mdx +101 -0
  397. package/.docs/organized/docs/sso/redirect-uris.mdx +44 -0
  398. package/.docs/organized/docs/sso/saml-security.mdx +122 -0
  399. package/.docs/organized/docs/sso/signing-certificates.mdx +121 -0
  400. package/.docs/organized/docs/sso/single-logout.mdx +45 -0
  401. package/.docs/organized/docs/sso/test-sso.mdx +73 -0
  402. package/.docs/organized/docs/sso/ux/sign-in.mdx +44 -0
  403. package/.docs/organized/docs/user-management/_navigation.mdx +87 -0
  404. package/.docs/organized/docs/user-management/actions.mdx +169 -0
  405. package/.docs/organized/docs/user-management/authkit.mdx +69 -0
  406. package/.docs/organized/docs/user-management/branding.mdx +143 -0
  407. package/.docs/organized/docs/user-management/connect.mdx +110 -0
  408. package/.docs/organized/docs/user-management/custom-emails.mdx +164 -0
  409. package/.docs/organized/docs/user-management/directory-provisioning.mdx +78 -0
  410. package/.docs/organized/docs/user-management/domain-verification.mdx +28 -0
  411. package/.docs/organized/docs/user-management/email-password.mdx +42 -0
  412. package/.docs/organized/docs/user-management/email-verification.mdx +29 -0
  413. package/.docs/organized/docs/user-management/entitlements.mdx +46 -0
  414. package/.docs/organized/docs/user-management/example-apps.mdx +39 -0
  415. package/.docs/organized/docs/user-management/identity-linking.mdx +52 -0
  416. package/.docs/organized/docs/user-management/impersonation.mdx +82 -0
  417. package/.docs/organized/docs/user-management/index.mdx +525 -0
  418. package/.docs/organized/docs/user-management/invitations.mdx +60 -0
  419. package/.docs/organized/docs/user-management/invite-only-signup.mdx +72 -0
  420. package/.docs/organized/docs/user-management/jit-provisioning.mdx +36 -0
  421. package/.docs/organized/docs/user-management/jwt-templates.mdx +278 -0
  422. package/.docs/organized/docs/user-management/magic-auth.mdx +36 -0
  423. package/.docs/organized/docs/user-management/mcp.mdx +146 -0
  424. package/.docs/organized/docs/user-management/metadata.mdx +119 -0
  425. package/.docs/organized/docs/user-management/mfa.mdx +32 -0
  426. package/.docs/organized/docs/user-management/migrations.mdx +20 -0
  427. package/.docs/organized/docs/user-management/modeling-your-app.mdx +149 -0
  428. package/.docs/organized/docs/user-management/organization-policies.mdx +33 -0
  429. package/.docs/organized/docs/user-management/overview.mdx +46 -0
  430. package/.docs/organized/docs/user-management/passkeys.mdx +42 -0
  431. package/.docs/organized/docs/user-management/radar.mdx +127 -0
  432. package/.docs/organized/docs/user-management/roles-and-permissions.mdx +155 -0
  433. package/.docs/organized/docs/user-management/sessions.mdx +101 -0
  434. package/.docs/organized/docs/user-management/social-login.mdx +34 -0
  435. package/.docs/organized/docs/user-management/sso-with-contractors.mdx +85 -0
  436. package/.docs/organized/docs/user-management/sso.mdx +96 -0
  437. package/.docs/organized/docs/user-management/users-organizations.mdx +91 -0
  438. package/.docs/organized/docs/user-management/widgets.mdx +190 -0
  439. package/.docs/organized/docs/vault/_navigation.mdx +14 -0
  440. package/.docs/organized/docs/vault/index.mdx +38 -0
  441. package/.docs/organized/docs/vault/key-context.mdx +32 -0
  442. package/.docs/organized/docs/vault/quick-start.mdx +82 -0
  443. package/README.md +252 -0
  444. package/dist/chunk-64GKEK6G.js +48 -0
  445. package/dist/chunk-64GKEK6G.js.map +1 -0
  446. package/dist/get-tools.d.ts +23 -0
  447. package/dist/get-tools.js +8 -0
  448. package/dist/get-tools.js.map +1 -0
  449. package/dist/index.d.ts +1 -0
  450. package/dist/index.js +552 -0
  451. package/dist/index.js.map +1 -0
  452. package/dist/prepare.d.ts +2 -0
  453. package/dist/prepare.js +269 -0
  454. package/dist/prepare.js.map +1 -0
  455. package/package.json +49 -0
@@ -0,0 +1,70 @@
1
+ ---
2
+ descriptions:
3
+ workos_connect_openid_configuration:
4
+ id_token_signing_alg_values_supported: >
5
+ A list of the algorithms supported for signing ID tokens. Currently this
6
+ is always `["RS256"]`.
7
+ jwks_uri: >
8
+ The URL of the JSON Web Key Set (JWKS) endpoint that contains the public
9
+ keys used to validate tokens.
10
+ subject_types_supported: >
11
+ A list of the subject identifier types supported. Currently this is always
12
+ `["public"]`.
13
+ userinfo_endpoint: >
14
+ The URL of the userinfo endpoint that can be used to get information about
15
+ the user specified in an access token.
16
+ reference:
17
+ curl:
18
+ - url: /reference/workos-connect/openid-configuration
19
+ key: workos_connect_openid_configuration
20
+ id: workos_connect_openid_configuration
21
+ title: /.well-known/openid-configuration
22
+ type: GET
23
+ returns:
24
+ - key: anonymous
25
+ type: object
26
+ unwrap: true
27
+ properties:
28
+ - key: issuer
29
+ type: string
30
+ description: (workos_connect_well_known_metadata.issuer)
31
+ - key: authorization_endpoint
32
+ type: string
33
+ description: (workos_connect_well_known_metadata.authorization_endpoint)
34
+ - key: grant_types_supported
35
+ type: array
36
+ description: (workos_connect_well_known_metadata.grant_types_supported)
37
+ - key: id_token_signing_alg_values_supported
38
+ type: array
39
+ description: >-
40
+ (workos_connect_openid_configuration.id_token_signing_alg_values_supported)
41
+ - key: introspection_endpoint
42
+ type: string
43
+ description: (workos_connect_well_known_metadata.introspection_endpoint)
44
+ - key: jwks_uri
45
+ type: string
46
+ description: (workos_connect_openid_configuration.jwks_uri)
47
+ - key: response_types_supported
48
+ type: array
49
+ description: (workos_connect_well_known_metadata.response_types_supported)
50
+ - key: subject_types_supported
51
+ type: array
52
+ description: (workos_connect_openid_configuration.subject_types_supported)
53
+ - key: token_endpoint
54
+ type: string
55
+ description: (workos_connect_well_known_metadata.token_endpoint)
56
+ - key: userinfo_endpoint
57
+ type: string
58
+ description: (workos_connect_openid_configuration.userinfo_endpoint)
59
+ originalPath: >-
60
+ .tmp-workos-clone/packages/docs/content/reference/workos-connect/metadata/openid-configuration/index.mdx
61
+ ---
62
+
63
+ ### OpenID configuration
64
+
65
+ This discovery endpoint provides the standard configuration for OpenID clients to interact with WorkOS Connect.
66
+
67
+ <CodeBlock referenceId="workos_connect_openid_configuration">
68
+ <CodeBlockTab title="Request" file="openid-configuration-request" />
69
+ <CodeBlockTab title="Response" file="openid-configuration-response" />
70
+ </CodeBlock>
@@ -0,0 +1,53 @@
1
+ ---
2
+ reference:
3
+ json:
4
+ - url: /reference/workos-connect/token/authorization-code-grant/access-token
5
+ key: workos_connect_token_authorization_code_grant_access_token
6
+ id: workos_connect_token_authorization_code_grant_access_token
7
+ title: Access token JWT
8
+ properties:
9
+ - key: iss
10
+ type: string
11
+ description: >
12
+ The issuer of the JWT, your AuthKit domain
13
+ (`https://authkit_domain`).
14
+ - key: aud
15
+ type: string
16
+ description: >
17
+ The client ID of the environment that issued the token (in other
18
+ words, your app).
19
+ - key: sub
20
+ type: string
21
+ description: (user.id)
22
+ - key: sid
23
+ type: string
24
+ description: >
25
+ The session identifier for the token, which for a WorkOS Connect
26
+ OAuth Application is the identifier of the consent granted by the
27
+ user.
28
+ - key: jti
29
+ type: string
30
+ description: A unique identifier for this access token.
31
+ - key: exp
32
+ type: DateTime
33
+ description: >-
34
+ The token should not be trusted after this time. The timestamp is
35
+ the number of seconds since epoch.
36
+ - key: iat
37
+ type: DateTime
38
+ description: >-
39
+ The token was issued at this time. The timestamp is the number of
40
+ seconds since epoch.
41
+ originalPath: >-
42
+ .tmp-workos-clone/packages/docs/content/reference/workos-connect/token/authorization-code-grant/access-token.mdx
43
+ ---
44
+
45
+ #### Access token
46
+
47
+ The access token for WorkOS Connect OAuth Applications contains the following claims.
48
+
49
+ <CodeBlock
50
+ file="token-authorization-code-access-token"
51
+ referenceId="workos_connect_token_authorization_code_grant_access_token"
52
+ title="Decoded access token"
53
+ />
@@ -0,0 +1,60 @@
1
+ ---
2
+ reference:
3
+ json:
4
+ - url: /reference/workos-connect/token/authorization-code-grant/id-token
5
+ key: workos_connect_token_authorization_code_grant_id_token
6
+ id: workos_connect_token_authorization_code_grant_id_token
7
+ title: ID token JWT
8
+ properties:
9
+ - key: iss
10
+ type: string
11
+ description: (workos_connect_id_token.iss)
12
+ - key: aud
13
+ type: string
14
+ description: (workos_connect_id_token.aud)
15
+ - key: sub
16
+ type: string
17
+ description: (user.id)
18
+ - key: name
19
+ type: string
20
+ optional: true
21
+ description: (workos_connect_id_token.name)
22
+ - key: given_name
23
+ type: string
24
+ optional: true
25
+ description: (workos_connect_id_token.given_name)
26
+ - key: family_name
27
+ type: string
28
+ optional: true
29
+ description: (workos_connect_id_token.family_name)
30
+ - key: email
31
+ type: string
32
+ optional: true
33
+ description: (workos_connect_id_token.email)
34
+ - key: email_verified
35
+ type: boolean
36
+ optional: true
37
+ description: (workos_connect_id_token.email_verified)
38
+ - key: exp
39
+ type: DateTime
40
+ description: >-
41
+ The token should not be trusted after this time. The timestamp is
42
+ the number of seconds since epoch.
43
+ - key: iat
44
+ type: DateTime
45
+ description: >-
46
+ The token was issued at this time. The timestamp is the number of
47
+ seconds since epoch.
48
+ originalPath: >-
49
+ .tmp-workos-clone/packages/docs/content/reference/workos-connect/token/authorization-code-grant/id-token.mdx
50
+ ---
51
+
52
+ #### ID token
53
+
54
+ The ID token, when requested with the `openid` scope, contains information about the user’s identity, like name and email address.
55
+
56
+ <CodeBlock
57
+ file="token-authorization-code-id-token"
58
+ referenceId="workos_connect_token_authorization_code_grant_id_token"
59
+ title="Decoded ID token"
60
+ />
@@ -0,0 +1,69 @@
1
+ ---
2
+ descriptions:
3
+ workos_connect_token_authorization_code_grant:
4
+ grant_type: Always `"authorization_code"` for this flow.
5
+ code: >
6
+ The authorization code received from authenticating the user, provided
7
+ when the user is redirected back to the client.
8
+ redirect_uri: >
9
+ The URL to redirect the user to after they have logged in. This must be
10
+ the same redirect URI used in the initial `/oauth2/authorize` request.
11
+ reference:
12
+ curl:
13
+ - url: /reference/workos-connect/token/authorization-code-grant
14
+ key: workos_connect_token_authorization_code_grant
15
+ id: workos_connect_token_authorization_code_grant
16
+ title: /oauth2/token
17
+ type: POST
18
+ parameters:
19
+ - key: client_id
20
+ type: string
21
+ description: (workos_connect_token_request.client_id)
22
+ - key: client_secret
23
+ type: string
24
+ description: (workos_connect_token_request.client_secret)
25
+ - key: grant_type
26
+ type: '"authorization_code"'
27
+ description: (workos_connect_token_authorization_code_grant.grant_type)
28
+ - key: code
29
+ type: string
30
+ description: (workos_connect_token_authorization_code_grant.code)
31
+ - key: redirect_uri
32
+ type: string
33
+ description: (workos_connect_token_authorization_code_grant.code)
34
+ returns:
35
+ - key: anonymous
36
+ type: object
37
+ unwrap: true
38
+ properties:
39
+ - key: access_token
40
+ type: string
41
+ description: (workos_connect_token_response.access_token)
42
+ - key: expires_in
43
+ type: integer
44
+ description: (workos_connect_token_response.expires_in)
45
+ - key: id_token
46
+ type: string
47
+ description: (workos_connect_token_response.id_token)
48
+ - key: refresh_token
49
+ type: string
50
+ optional: true
51
+ description: (workos_connect_token_response.refresh_token)
52
+ - key: token_type
53
+ type: '"bearer"'
54
+ description: (workos_connect_token_response.token_type)
55
+ originalPath: >-
56
+ .tmp-workos-clone/packages/docs/content/reference/workos-connect/token/authorization-code-grant/index.mdx
57
+ ---
58
+
59
+ ### Authorization code grant
60
+
61
+ Used by WorkOS Connect OAuth Applications to exchange an authorization code for access tokens, ID tokens, and refresh tokens.
62
+
63
+ <CodeBlock referenceId="workos_connect_token_authorization_code_grant">
64
+ <CodeBlockTab title="Request" file="token-authorization-code-grant-request" />
65
+ <CodeBlockTab
66
+ title="Response"
67
+ file="token-authorization-code-grant-response"
68
+ />
69
+ </CodeBlock>
@@ -0,0 +1,46 @@
1
+ ---
2
+ reference:
3
+ json:
4
+ - url: /reference/workos-connect/token/client-credentials-grant/access-token
5
+ key: workos_connect_token_client_credentials_grant_access_token
6
+ id: workos_connect_token_client_credentials_grant_access_token
7
+ title: Access token JWT
8
+ properties:
9
+ - key: iss
10
+ type: string
11
+ description: |
12
+ The issuer of the JWT, your AuthKit domain.
13
+ - key: sub
14
+ type: string
15
+ description: |
16
+ The WorkOS Connect Application’s client ID.
17
+ - key: org_id
18
+ type: string
19
+ optional: true
20
+ description: (organization.id)
21
+ - key: jti
22
+ type: string
23
+ description: A unique identifier for this access token.
24
+ - key: exp
25
+ type: DateTime
26
+ description: >-
27
+ The token should not be trusted after this time. The timestamp is
28
+ the number of seconds since epoch.
29
+ - key: iat
30
+ type: DateTime
31
+ description: >-
32
+ The token was issued at this time. The timestamp is the number of
33
+ seconds since epoch.
34
+ originalPath: >-
35
+ .tmp-workos-clone/packages/docs/content/reference/workos-connect/token/client-credentials-grant/access-token.mdx
36
+ ---
37
+
38
+ #### Access token
39
+
40
+ The access token for WorkOS Connect M2M Applications contains the following claims.
41
+
42
+ <CodeBlock
43
+ file="token-client-credentials-access-token"
44
+ referenceId="workos_connect_token_client_credentials_grant_access_token"
45
+ title="Decoded access token"
46
+ />
@@ -0,0 +1,56 @@
1
+ ---
2
+ descriptions:
3
+ workos_connect_token_client_credentials_grant:
4
+ grant_type: Always `"client_credentials"` for this flow.
5
+ scope: |
6
+ A space-separated set of scopes to use for the access token.
7
+ reference:
8
+ curl:
9
+ - url: /reference/workos-connect/token/client-credentials-grant
10
+ key: workos_connect_token_client_credentials_grant
11
+ id: workos_connect_token_client_credentials_grant
12
+ title: /oauth2/token
13
+ type: POST
14
+ parameters:
15
+ - key: client_id
16
+ type: string
17
+ description: (workos_connect_token_request.client_id)
18
+ - key: client_secret
19
+ type: string
20
+ description: (workos_connect_token_request.client_secret)
21
+ - key: grant_type
22
+ type: '"client_credentials"'
23
+ description: (workos_connect_token_client_credentials_grant.grant_type)
24
+ - key: scope
25
+ type: string
26
+ optional: true
27
+ description: (workos_connect_token_client_credentials_grant.scope)
28
+ returns:
29
+ - key: anonymous
30
+ type: object
31
+ unwrap: true
32
+ properties:
33
+ - key: access_token
34
+ type: string
35
+ description: (workos_connect_token_response.access_token)
36
+ - key: expires_in
37
+ type: integer
38
+ description: (workos_connect_token_response.expires_in)
39
+ - key: token_type
40
+ type: '"bearer"'
41
+ description: (workos_connect_token_response.token_type)
42
+ originalPath: >-
43
+ .tmp-workos-clone/packages/docs/content/reference/workos-connect/token/client-credentials-grant/index.mdx
44
+ ---
45
+
46
+ ### Client credentials grant
47
+
48
+ Used by WorkOS Connect M2M Applications to exchange the app’s credentials for access tokens.
49
+
50
+ <CodeBlock referenceId="workos_connect_token_client_credentials_grant">
51
+ <CodeBlockTab title="Request" file="token-client-credentials-grant-request" />
52
+ <CodeBlockTab
53
+ title="Response"
54
+ file="token-client-credentials-grant-response"
55
+ />
56
+ </CodeBlock>
@@ -0,0 +1,39 @@
1
+ ---
2
+ descriptions:
3
+ workos_connect_token_request:
4
+ client_id: |
5
+ The client ID of the WorkOS Connect Application.
6
+ client_secret: |
7
+ A secret key associated with the WorkOS Connect Application.
8
+ workos_connect_token_response:
9
+ access_token: |
10
+ A JWT that can be used to authorize requests.
11
+ expires_in: |
12
+ The number of seconds until the access token expires.
13
+ id_token: |
14
+ A JWT that contains information about the user.
15
+ refresh_token: >
16
+ An opaque token that can be exchanged for new access, ID, and refresh
17
+ tokens.
18
+ token_type: >
19
+ How to use the access token to authorize requests. Currently, this is
20
+ always `"bearer"`, which means it should be included in the
21
+ `Authorization` header of requests, e.g. `Authorization: Bearer <access
22
+ token>`.
23
+ originalPath: >-
24
+ .tmp-workos-clone/packages/docs/content/reference/workos-connect/token/index.mdx
25
+ ---
26
+
27
+ ## Token
28
+
29
+ This endpoint is called by WorkOS Connect Applications to get access tokens, ID tokens, and refresh tokens, depending on the `grant_type` provided when requested.
30
+
31
+ This endpoint is authenticated by provided the WorkOS Application’s client ID and client secret in the body of the request.
32
+
33
+ There are three grant types available:
34
+
35
+ - [Authorization code](/reference/workos-connect/token/authorization-code-grant)
36
+ - [Refresh token](/reference/workos-connect/token/refresh-token-grant)
37
+ - [Client credentials](/reference/workos-connect/token/client-credentials-grant)
38
+
39
+ Each is describe in greater detail below.
@@ -0,0 +1,69 @@
1
+ ---
2
+ descriptions:
3
+ workos_connect_token_refresh_token_grant:
4
+ grant_type: Always `"refresh_token"` for this flow.
5
+ refresh_token: |
6
+ The refresh token received from a previous token request.
7
+ scope: >
8
+ A space-separated set of scopes to use for the tokens to be issued by this
9
+ request. Must be a subset of the scopes initially specified in the
10
+ `/oauth2/authorize` request.
11
+ reference:
12
+ curl:
13
+ - url: /reference/workos-connect/token/refresh-token-grant
14
+ key: workos_connect_token_refresh_token_grant
15
+ id: workos_connect_token_refresh_token_grant
16
+ title: /oauth2/token
17
+ type: POST
18
+ parameters:
19
+ - key: client_id
20
+ type: string
21
+ description: (workos_connect_token_request.client_id)
22
+ - key: client_secret
23
+ type: string
24
+ description: (workos_connect_token_request.client_secret)
25
+ - key: grant_type
26
+ type: '"refresh_token"'
27
+ description: (workos_connect_token_refresh_token_grant.grant_type)
28
+ - key: refresh_token
29
+ type: string
30
+ description: (workos_connect_token_refresh_token_grant.refresh_token)
31
+ - key: scope
32
+ type: string
33
+ optional: true
34
+ description: (workos_connect_token_refresh_token_grant.scope)
35
+ returns:
36
+ - key: anonymous
37
+ type: object
38
+ unwrap: true
39
+ properties:
40
+ - key: access_token
41
+ type: string
42
+ description: (workos_connect_token_response.access_token)
43
+ - key: expires_in
44
+ type: integer
45
+ description: (workos_connect_token_response.expires_in)
46
+ - key: id_token
47
+ type: string
48
+ description: (workos_connect_token_response.id_token)
49
+ - key: refresh_token
50
+ type: string
51
+ optional: true
52
+ description: (workos_connect_token_response.refresh_token)
53
+ - key: token_type
54
+ type: '"bearer"'
55
+ description: (workos_connect_token_response.token_type)
56
+ originalPath: >-
57
+ .tmp-workos-clone/packages/docs/content/reference/workos-connect/token/refresh-token-grant.mdx
58
+ ---
59
+
60
+ ### Refresh token grant
61
+
62
+ Used by WorkOS Connect OAuth Applications to exchange a refresh token for new access tokens and/or ID tokens. The refresh token is provided when the initial `oauth2/authorize` request is made with the `offline_access` scope.
63
+
64
+ The [access token](reference/workos-connect/token/authorization-code-grant/access-token) and [ID tokens](reference/workos-connect/token/authorization-code-grant/id-token) issued here are the same as those issued for the initial `authorization_code` grant.
65
+
66
+ <CodeBlock referenceId="workos_connect_token_refresh_token_grant">
67
+ <CodeBlockTab title="Request" file="token-refresh-token-grant-request" />
68
+ <CodeBlockTab title="Response" file="token-refresh-token-grant-response" />
69
+ </CodeBlock>
@@ -0,0 +1,46 @@
1
+ ---
2
+ reference:
3
+ curl:
4
+ - url: /reference/workos-connect/userinfo
5
+ key: workos_connect_userinfo
6
+ id: workos_connect_userinfo
7
+ title: /oauth2/userinfo
8
+ type: POST
9
+ returns:
10
+ - key: sub
11
+ type: string
12
+ description: (user.id)
13
+ - key: name
14
+ type: string
15
+ optional: true
16
+ description: (workos_connect_id_token.name)
17
+ - key: given_name
18
+ type: string
19
+ optional: true
20
+ description: (workos_connect_id_token.given_name)
21
+ - key: family_name
22
+ type: string
23
+ optional: true
24
+ description: (workos_connect_id_token.family_name)
25
+ - key: email
26
+ type: string
27
+ optional: true
28
+ description: (workos_connect_id_token.email)
29
+ - key: email_verified
30
+ type: boolean
31
+ optional: true
32
+ description: (workos_connect_id_token.email_verified)
33
+ originalPath: >-
34
+ .tmp-workos-clone/packages/docs/content/reference/workos-connect/userinfo/index.mdx
35
+ ---
36
+
37
+ ## User information
38
+
39
+ Provides information about the [User](/reference/user-management/user) referenced by the access token’s `sub` claim. Which claims are returned depends on the scopes originally granted when the access token was issued.
40
+
41
+ This endpoint is authenticated by providing the previously acquired access token in the `Authorization` header.
42
+
43
+ <CodeBlock referenceId="workos_connect_userinfo">
44
+ <CodeBlockTab title="Request" file="workos-connect-userinfo-request" />
45
+ <CodeBlockTab title="Response" file="workos-connect-userinfo-response" />
46
+ </CodeBlock>
@@ -0,0 +1,6 @@
1
+ ---
2
+ originalPath: .tmp-workos-clone/packages/docs/content/sdks/dotnet.mdx
3
+ ---
4
+ ## Installation
5
+
6
+ <CodeBlock title="Command Line" file="install-dotnet-sdk" />
@@ -0,0 +1,6 @@
1
+ ---
2
+ originalPath: .tmp-workos-clone/packages/docs/content/sdks/elixir.mdx
3
+ ---
4
+ ## Installation
5
+
6
+ <CodeBlock title="mix.exs" file="install-elixir-sdk" />
@@ -0,0 +1,6 @@
1
+ ---
2
+ originalPath: .tmp-workos-clone/packages/docs/content/sdks/go.mdx
3
+ ---
4
+ ## Installation
5
+
6
+ <CodeBlock title="Command Line" file="install-go-sdk" />
@@ -0,0 +1,9 @@
1
+ ---
2
+ originalPath: .tmp-workos-clone/packages/docs/content/sdks/java.mdx
3
+ ---
4
+ ## Installation
5
+
6
+ <CodeBlock title="Install the WorkOS SDK">
7
+ <CodeBlockTab language="java" file="install-sdk-maven" title="Maven" />
8
+ <CodeBlockTab language="java" file="install-sdk-gradle" title="Gradle" />
9
+ </CodeBlock>
@@ -0,0 +1,6 @@
1
+ ---
2
+ originalPath: .tmp-workos-clone/packages/docs/content/sdks/laravel.mdx
3
+ ---
4
+ ## Installation
5
+
6
+ <CodeBlock title="Command Line" file="install-laravel-sdk" />
@@ -0,0 +1,9 @@
1
+ ---
2
+ originalPath: .tmp-workos-clone/packages/docs/content/sdks/node.mdx
3
+ ---
4
+ ## Installation
5
+
6
+ <CodeBlock>
7
+ <CodeBlockTab language="js" file="install-sdk-npm" title="npm" />
8
+ <CodeBlockTab language="js" file="install-sdk-yarn" title="yarn" />
9
+ </CodeBlock>
@@ -0,0 +1,6 @@
1
+ ---
2
+ originalPath: .tmp-workos-clone/packages/docs/content/sdks/php.mdx
3
+ ---
4
+ ## Installation
5
+
6
+ <CodeBlock title="Command Line" file="install-php-sdk" />
@@ -0,0 +1,6 @@
1
+ ---
2
+ originalPath: .tmp-workos-clone/packages/docs/content/sdks/python.mdx
3
+ ---
4
+ ## Installation
5
+
6
+ <CodeBlock title="Command Line" file="install-python-sdk" />
@@ -0,0 +1,9 @@
1
+ ---
2
+ originalPath: .tmp-workos-clone/packages/docs/content/sdks/ruby.mdx
3
+ ---
4
+ ## Installation
5
+
6
+ <CodeBlock title="Install the WorkOS SDK">
7
+ <CodeBlockTab language="ruby" file="install-sdk-terminal" title="Terminal" />
8
+ <CodeBlockTab language="ruby" file="install-sdk-bundler" title="Bundler" />
9
+ </CodeBlock>
@@ -0,0 +1,44 @@
1
+ ---
2
+ title: Single Sign-On
3
+ links:
4
+ - title: Getting Started
5
+ links:
6
+ - title: Quick Start
7
+ url: /sso
8
+ - title: Test SSO
9
+ url: /sso/test-sso
10
+ - title: Example Apps
11
+ url: /sso/example-apps
12
+ - title: User Experience
13
+ links:
14
+ - title: Sign-In
15
+ url: /sso/ux/sign-in
16
+ - title: Going Live
17
+ links:
18
+ - title: Login Flows
19
+ url: /sso/login-flows
20
+ - title: Redirect URIs
21
+ url: /sso/redirect-uris
22
+ - title: Domains
23
+ url: /sso/domains
24
+ - title: Signing Certificates
25
+ url: /sso/signing-certificates
26
+ - title: JIT Provisioning
27
+ url: /sso/jit-provisioning
28
+ - title: Profile Attributes
29
+ url: /sso/attributes
30
+ - title: Launch Checklist
31
+ url: /sso/launch-checklist
32
+ - title: FAQ for IT teams
33
+ url: /sso/it-team-faq
34
+ - title: SAML Security
35
+ url: /sso/saml-security
36
+ - title: On-prem Deployment
37
+ url: /on-prem-deployment
38
+ - title: Mapping Roles
39
+ links:
40
+ - title: IdP Role Assignment
41
+ url: /sso/identity-provider-role-assignment
42
+ originalPath: .tmp-workos-clone/packages/docs/content/sso/_navigation.mdx
43
+ ---
44
+