@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,277 @@
1
+ [
2
+ {
3
+ "package": "workos-platform",
4
+ "version": "Support for changing email addresses",
5
+ "date": "2025-05-30",
6
+ "changes": [
7
+ "User's emails can now be changed via API or the dashboard."
8
+ ],
9
+ "source": "rss",
10
+ "url": "https://workos.com/changelog/support-for-changing-email-addresses",
11
+ "guid": "https://workos.com/changelog/support-for-changing-email-addresses"
12
+ },
13
+ {
14
+ "package": "workos-platform",
15
+ "version": "MCP Authorization with AuthKit",
16
+ "date": "2025-05-23",
17
+ "changes": [
18
+ "AuthKit can now be used for MCP server authorization."
19
+ ],
20
+ "source": "rss",
21
+ "url": "https://workos.com/changelog/mcp-authorization-with-authkit",
22
+ "guid": "https://workos.com/changelog/mcp-authorization-with-authkit"
23
+ },
24
+ {
25
+ "package": "workos-platform",
26
+ "version": "SAML Custom Attributes",
27
+ "date": "2025-05-20",
28
+ "changes": [
29
+ "Custom attributes now support mapping from SAML responses during SSO."
30
+ ],
31
+ "source": "rss",
32
+ "url": "https://workos.com/changelog/saml-custom-attributes",
33
+ "guid": "https://workos.com/changelog/saml-custom-attributes"
34
+ },
35
+ {
36
+ "package": "workos-platform",
37
+ "version": "Domain Verification Improvements",
38
+ "date": "2025-05-12",
39
+ "changes": [
40
+ "Admin Portal now alerts customers to verify domains before setting up a SSO connection."
41
+ ],
42
+ "source": "rss",
43
+ "url": "https://workos.com/changelog/domain-verification-improvements",
44
+ "guid": "https://workos.com/changelog/domain-verification-improvements"
45
+ },
46
+ {
47
+ "package": "workos-platform",
48
+ "version": "FGA Policy Helpers",
49
+ "date": "2025-05-09",
50
+ "changes": [
51
+ "New FGA policy helpers make it easier to write dynamic, context-aware policies."
52
+ ],
53
+ "source": "rss",
54
+ "url": "https://workos.com/changelog/fga-policy-helpers",
55
+ "guid": "https://workos.com/changelog/fga-policy-helpers"
56
+ },
57
+ {
58
+ "package": "workos-platform",
59
+ "version": "Use WorkOS to secure remote MCP Servers deployed to Cloudflare",
60
+ "date": "2025-04-30",
61
+ "changes": [
62
+ "Use your existing authentication provided by WorkOS to secure your remote MPC server running on Cloudflare"
63
+ ],
64
+ "source": "rss",
65
+ "url": "https://workos.com/changelog/use-workos-to-secure-remote-mcp-servers-deployed-to-cloudflare",
66
+ "guid": "https://workos.com/changelog/use-workos-to-secure-remote-mcp-servers-deployed-to-cloudflare"
67
+ },
68
+ {
69
+ "package": "workos-platform",
70
+ "version": "Simplified Login Initiation",
71
+ "date": "2025-04-30",
72
+ "changes": [
73
+ "Support logins that originate outside of your application, like from bookmarks, with less effort."
74
+ ],
75
+ "source": "rss",
76
+ "url": "https://workos.com/changelog/simplified-login-initiation",
77
+ "guid": "https://workos.com/changelog/simplified-login-initiation"
78
+ },
79
+ {
80
+ "package": "workos-platform",
81
+ "version": "WorkOS Guides",
82
+ "date": "2025-04-29",
83
+ "changes": [
84
+ "Introducing WorkOS Guides, your new go-to hub for mastering authentication, authorization, user provisioning, security, and more."
85
+ ],
86
+ "source": "rss",
87
+ "url": "https://workos.com/changelog/workos-guides",
88
+ "guid": "https://workos.com/changelog/workos-guides"
89
+ },
90
+ {
91
+ "package": "workos-platform",
92
+ "version": "Copy docs as Markdown for use with LLMs",
93
+ "date": "2025-04-28",
94
+ "changes": [
95
+ "Add context to your LLM prompts with ease using the new “Copy as Markdown” feature in the WorkOS product documentation."
96
+ ],
97
+ "source": "rss",
98
+ "url": "https://workos.com/changelog/copy-docs-as-markdown-for-use-with-llms",
99
+ "guid": "https://workos.com/changelog/copy-docs-as-markdown-for-use-with-llms"
100
+ },
101
+ {
102
+ "package": "workos-platform",
103
+ "version": "SSO Role Assignment in Admin Portal",
104
+ "date": "2025-04-17",
105
+ "changes": [
106
+ "IT admins can now map roles to identity provider groups during Single Sign-On setup in the Admin Portal."
107
+ ],
108
+ "source": "rss",
109
+ "url": "https://workos.com/changelog/sso-role-assignment",
110
+ "guid": "https://workos.com/changelog/sso-role-assignment"
111
+ },
112
+ {
113
+ "package": "workos-platform",
114
+ "version": "Schema-Based Policies in FGA",
115
+ "date": "2025-04-09",
116
+ "changes": [
117
+ "Define and use policies in your authorization schema with WorkOS Fine-Grained Authorization (FGA)"
118
+ ],
119
+ "source": "rss",
120
+ "url": "https://workos.com/changelog/schema-based-policies-in-fga",
121
+ "guid": "https://workos.com/changelog/schema-based-policies-in-fga"
122
+ },
123
+ {
124
+ "package": "workos-platform",
125
+ "version": "Using WorkOS with on-prem customers",
126
+ "date": "2025-04-04",
127
+ "changes": [
128
+ "Learn how to use WorkOS with on-prem customers"
129
+ ],
130
+ "source": "rss",
131
+ "url": "https://workos.com/changelog/using-workos-with-on-prem-customers",
132
+ "guid": "https://workos.com/changelog/using-workos-with-on-prem-customers"
133
+ },
134
+ {
135
+ "package": "workos-platform",
136
+ "version": "Password History",
137
+ "date": "2025-03-25",
138
+ "changes": [
139
+ "Developers can enable password history to reject up to 10 previously used passwords for a user."
140
+ ],
141
+ "source": "rss",
142
+ "url": "https://workos.com/changelog/password-history",
143
+ "guid": "https://workos.com/changelog/password-history"
144
+ },
145
+ {
146
+ "package": "workos-platform",
147
+ "version": "Widgets - User Profile and Organization Switcher",
148
+ "date": "2025-03-21",
149
+ "changes": [
150
+ "New widgets are available for a complete user profile experience and organization switching."
151
+ ],
152
+ "source": "rss",
153
+ "url": "https://workos.com/changelog/widgets-user-profile-and-organization-switcher",
154
+ "guid": "https://workos.com/changelog/widgets-user-profile-and-organization-switcher"
155
+ },
156
+ {
157
+ "package": "workos-platform",
158
+ "version": "New enterprise login integrations in AuthKit",
159
+ "date": "2025-03-20",
160
+ "changes": [
161
+ "WorkOS now supports eight new built-in login providers for AuthKit."
162
+ ],
163
+ "source": "rss",
164
+ "url": "https://workos.com/changelog/authkit-login-integrations",
165
+ "guid": "https://workos.com/changelog/authkit-login-integrations"
166
+ },
167
+ {
168
+ "package": "workos-platform",
169
+ "version": "Custom Metadata, External ID, and JWT Templates",
170
+ "date": "2025-03-19",
171
+ "changes": [
172
+ "Customize your AuthKit integration with custom metadata, external id, and JWT templates."
173
+ ],
174
+ "source": "rss",
175
+ "url": "https://workos.com/changelog/custom-metadata-external-id-and-jwt-templates",
176
+ "guid": "https://workos.com/changelog/custom-metadata-external-id-and-jwt-templates"
177
+ },
178
+ {
179
+ "package": "workos-platform",
180
+ "version": "WorkOS Vault",
181
+ "date": "2025-03-18",
182
+ "changes": [
183
+ "Simplify encryption and secrets management for modern web applications with WorkOS Vault."
184
+ ],
185
+ "source": "rss",
186
+ "url": "https://workos.com/changelog/vault",
187
+ "guid": "https://workos.com/changelog/vault"
188
+ },
189
+ {
190
+ "package": "workos-platform",
191
+ "version": "WorkOS Connect",
192
+ "date": "2025-03-17",
193
+ "changes": [
194
+ "Allow customers, partners, and vendors to seamlessly connect to your application with WorkOS Connect."
195
+ ],
196
+ "source": "rss",
197
+ "url": "https://workos.com/changelog/workos-connect",
198
+ "guid": "https://workos.com/changelog/workos-connect"
199
+ },
200
+ {
201
+ "package": "workos-platform",
202
+ "version": "WorkOS Dashboard Notifications",
203
+ "date": "2025-02-28",
204
+ "changes": [
205
+ "The WorkOS Dashboard now includes a new notifications page."
206
+ ],
207
+ "source": "rss",
208
+ "url": "https://workos.com/changelog/workos-dashboard-notifications",
209
+ "guid": "https://workos.com/changelog/workos-dashboard-notifications"
210
+ },
211
+ {
212
+ "package": "workos-platform",
213
+ "version": "SSO Connection Issue Notifications to IT Admins",
214
+ "date": "2025-02-28",
215
+ "changes": [
216
+ "Organizations with IT Admin emails configured will now be notified directly when there are issues with their SSO Connection."
217
+ ],
218
+ "source": "rss",
219
+ "url": "https://workos.com/changelog/sso-connection-issue-notifications-to-it-admins",
220
+ "guid": "https://workos.com/changelog/sso-connection-issue-notifications-to-it-admins"
221
+ },
222
+ {
223
+ "package": "workos-platform",
224
+ "version": "AuthKit Starter Kit for Laravel Cloud",
225
+ "date": "2025-02-24",
226
+ "changes": [
227
+ "Laravel Cloud supports AuthKit via a pre-built integration"
228
+ ],
229
+ "source": "rss",
230
+ "url": "https://workos.com/changelog/authkit-starter-kit-for-laravel-cloud",
231
+ "guid": "https://workos.com/changelog/authkit-starter-kit-for-laravel-cloud"
232
+ },
233
+ {
234
+ "package": "workos-platform",
235
+ "version": "Impersonation Support for Frontend Sessions",
236
+ "date": "2025-02-24",
237
+ "changes": [
238
+ "Authkit customers using frontend sessions can now leverage user impersonation."
239
+ ],
240
+ "source": "rss",
241
+ "url": "https://workos.com/changelog/impersonation-support-for-frontend-sessions",
242
+ "guid": "https://workos.com/changelog/impersonation-support-for-frontend-sessions"
243
+ },
244
+ {
245
+ "package": "workos-platform",
246
+ "version": "FGA Playground",
247
+ "date": "2025-02-04",
248
+ "changes": [
249
+ "Develop, test and share fine-grained authorization schemas with the FGA Playground."
250
+ ],
251
+ "source": "rss",
252
+ "url": "https://workos.com/changelog/fga-playground",
253
+ "guid": "https://workos.com/changelog/fga-playground"
254
+ },
255
+ {
256
+ "package": "workos-platform",
257
+ "version": "authkit-nextjs v1.0.0",
258
+ "date": "2025-01-24",
259
+ "changes": [
260
+ "The AuthKit Next.js SDK is now available as a v1.0"
261
+ ],
262
+ "source": "rss",
263
+ "url": "https://workos.com/changelog/authkit-nextjs-v1-0-0",
264
+ "guid": "https://workos.com/changelog/authkit-nextjs-v1-0-0"
265
+ },
266
+ {
267
+ "package": "workos-platform",
268
+ "version": "Custom Logout URIs",
269
+ "date": "2025-01-22",
270
+ "changes": [
271
+ "WorkOS now supports the addition of multiple logout URIs."
272
+ ],
273
+ "source": "rss",
274
+ "url": "https://workos.com/changelog/custom-logout-uris",
275
+ "guid": "https://workos.com/changelog/custom-logout-uris"
276
+ }
277
+ ]
@@ -0,0 +1,16 @@
1
+ ---
2
+ title: Admin Portal
3
+ links:
4
+ - title: Getting Started
5
+ links:
6
+ - title: Quick Start
7
+ url: /admin-portal
8
+ - title: Example Apps
9
+ url: /admin-portal/example-apps
10
+ - title: Going Live
11
+ links:
12
+ - title: Custom Branding
13
+ url: /admin-portal/custom-branding
14
+ originalPath: .tmp-workos-clone/packages/docs/content/admin-portal/_navigation.mdx
15
+ ---
16
+
@@ -0,0 +1,111 @@
1
+ ---
2
+ title: Custom Branding
3
+ description: Use your own logo and colors in the Admin Portal.
4
+ originalPath: .tmp-workos-clone/packages/docs/content/admin-portal/custom-branding.mdx
5
+ ---
6
+
7
+ ## Introduction
8
+
9
+ You can customize the look and feel of the Admin Portal from the WorkOS Dashboard. Go to [Branding settings](https://dashboard.workos.com/branding) where you can:
10
+
11
+ - Upload your logos
12
+ - Set your brand color
13
+ - View your custom domains
14
+
15
+ Custom branding can be tested for free in the staging environment. You need the [WorkOS Enterprise plan](https://workos.com/pricing) to enable custom branding in the production environment
16
+
17
+ ![A screenshot showing the WorkOS Dashboard branding settings page.](https://images.workoscdn.com/images/fc67ec10-44e1-467c-a094-32ed3ff5bd92.png?auto=format&fit=clip&q=80)
18
+
19
+ ## Logos and icons
20
+
21
+ You can upload custom branding assets which will be used in the Admin Portal as well as emails.
22
+
23
+ ### Logo
24
+
25
+ Image with your company's logo and wordmark.
26
+
27
+ - **Usage:** Shown in the top left corner of the Admin Portal.
28
+ - **Requirements:** At least 160x160 px (JPG, PNG, or SVG. 100 KB max size)
29
+
30
+ ![A screenshot showing the WorkOS Admin Portal and highlighting the custom logo.](https://images.workoscdn.com/images/ca579b3c-6a50-41aa-ad3e-62b32740b6c8.png?auto=format&fit=clip&q=50)
31
+
32
+ ### Logo icon
33
+
34
+ A smaller, square version of the logo. This is often simply the logomark.
35
+
36
+ <style>{`
37
+ .tight-bullets p {
38
+ margin-bottom: var(--space-2);
39
+ }
40
+ .tight-bullets .rt-Box:has(.rt-Box) {
41
+ margin-bottom: var(--space-2);
42
+ }
43
+ `}</style>
44
+
45
+ <div class="tight-bullets">
46
+
47
+ - **Usage:**
48
+
49
+ - Displayed in Admin Portal emails
50
+ - Available for IT admins to
51
+ download from the Admin Portal for configuring IdP-initiated SSO in Okta,
52
+ Entra ID and Google Workspace.
53
+
54
+ - **Requirements:** At least 160x160 px with a
55
+ 1:1 aspect ratio (JPG, PNG, or SVG. 100 KB max size)
56
+
57
+ </div>
58
+
59
+ ![A screenshot showing an email from WorkOS and highlighting the custom logo icon.](https://images.workoscdn.com/images/df8b54e6-a3fc-431b-8086-a01fb03388c7.png?auto=format&fit=clip&q=50)
60
+ ![A screenshot showing the WorkOS Admin Portal and highlighting the custom logo icon download.](https://images.workoscdn.com/images/d07c701e-a051-4444-ae66-fc35eecb6791.png?auto=format&fit=clip&q=50)
61
+
62
+ ### Favicon
63
+
64
+ A small icon that serves as branding for your website.
65
+
66
+ - **Usage:** Displayed in the address bar of the Admin Portal website.
67
+ - **Requirements:** At least 32x32 px with a 1:1 aspect ratio (JPG, PNG, GIF, SVG, WebP, AVIF, or ICO. 100 KB max size)
68
+
69
+ ![A screenshot showing the WorkOS Admin Portal and highlighting the custom favicon.](https://images.workoscdn.com/images/15dd6370-961d-4d8b-97b1-6bfc3ef80143.png?auto=format&fit=clip&q=50)
70
+
71
+ ### Brand color
72
+
73
+ Hex value used as the background color for buttons in the Admin Portal and emails.
74
+
75
+ ![A screenshot showing the WorkOS Admin Portal and highlighting the custom button color.](https://images.workoscdn.com/images/080c0c45-08ee-44c4-b153-7b419174fc5e.png?auto=format&fit=clip&q=50)
76
+
77
+ ![A screenshot showing an email from WorkOS and highlighting the custom button color.](https://images.workoscdn.com/images/6da61ac8-82f1-44e6-ab55-33d699841739.png?auto=format&fit=clip&q=50)
78
+
79
+ ## Custom domains
80
+
81
+ WorkOS allows you to customize the domain you send API calls to, the domain used by the Admin Portal, and the from address used in emails sent to your customer's IT admin.
82
+
83
+ ![A screenshot showing the WorkOS Dashboard branding settings page highlighting the custom domains section](https://images.workoscdn.com/images/b6afe130-219c-4e0e-8209-49b1a0fb6098.png?auto=format&fit=clip&q=80)
84
+
85
+ ### Auth link domain
86
+
87
+ Controls the domain you send API calls to and the domain used in URL’s that face your customer’s IT admin such as ACS URL and SP Entity ID.
88
+
89
+ ### Admin Portal domain
90
+
91
+ Controls the domain of Admin Portal setup links and Admin Portal sessions opened by your customer’s IT admin.
92
+
93
+ ### Email domain
94
+
95
+ Controls the from address for emails sent to your customer's IT admin.
96
+
97
+ To configure custom domains, please reach out to [customer support](mailto:support@workos.com) for assistance.
98
+
99
+ ## Team name
100
+
101
+ Your team name is visible in the Admin Portal and in the emails received by your customers’ organization admins. Learn how to change your team name in [team settings](/dashboard/manage-your-team).
102
+
103
+ ![A screenshot showing the WorkOS Admin Portal and highlighting the page title.](https://images.workoscdn.com/images/0fd29434-3a5a-43ed-a446-45aec90f75da.png?auto=format&fit=clip&q=50)
104
+
105
+ ![A screenshot showing an email by WorkOS and highlighting the sender name.](https://images.workoscdn.com/images/8d679e97-ceaa-4b94-bb75-290619c94085.png?auto=format&fit=clip&q=50)
106
+
107
+ ## Support email address
108
+
109
+ Add a support email in the Dashboard to streamline communication with your customers’ organization admins. This email will be included in the footer of messages sent to them and set as the reply-to address, making it easy for admins to reach out with any questions. Learn how to update the support email in [team settings](/dashboard/manage-your-team).
110
+
111
+ ![A screenshot showing an email with a custom support email address](https://images.workoscdn.com/images/8eb036ab-5fd0-44fe-81f3-6a69a8c38530.png?auto=format&fit=clip&q=50)
@@ -0,0 +1,46 @@
1
+ ---
2
+ title: Example Apps
3
+ description: "View sample Admin\_Portal\_apps for\_each\_SDK."
4
+ originalPath: .tmp-workos-clone/packages/docs/content/admin-portal/example-apps.mdx
5
+ ---
6
+
7
+ You can view minimal example apps that demonstrate how to use the WorkOS SDKs to power the Admin Portal:
8
+
9
+ <ExampleApps.Root>
10
+ <ExampleApps.Card
11
+ href="https://github.com/workos/node-example-applications/tree/main/node-admin-portal-example"
12
+ title="Node.js Admin Portal app"
13
+ />
14
+ <ExampleApps.Card
15
+ href="https://github.com/workos/typescript-example-applications/tree/main/typescript-admin-portal-example"
16
+ title="TypeScript Admin Portal app"
17
+ />
18
+ <ExampleApps.Card
19
+ href="https://github.com/workos/ruby-example-applications/tree/main/ruby-admin-portal-example"
20
+ title="Ruby Admin Portal app"
21
+ />
22
+ <ExampleApps.Card
23
+ href="https://github.com/workos/python-flask-example-applications/tree/main/python-flask-admin-portal-example"
24
+ title="Python Flask Admin Portal app"
25
+ />
26
+ <ExampleApps.Card
27
+ href="https://github.com/workos/python-django-example-applications/tree/main/python-django-admin-portal-example"
28
+ title="Python Django Admin Portal app"
29
+ />
30
+ <ExampleApps.Card
31
+ href="https://github.com/workos/go-example-applications/tree/main/go-admin-portal-example"
32
+ title="Go Admin Portal app"
33
+ />
34
+ <ExampleApps.Card
35
+ href="https://github.com/workos/java-example-applications/tree/main/java-admin-portal-example"
36
+ title="Java Admin Portal app"
37
+ />
38
+ <ExampleApps.Card
39
+ href="https://github.com/workos/php-example-applications/tree/main/php-admin-portal-example"
40
+ title="PHP Admin Portal app"
41
+ />
42
+ <ExampleApps.Card
43
+ href="https://github.com/workos/dotnet-example-applications/tree/main/dotnet-admin-portal-example"
44
+ title=".NET Admin Portal app"
45
+ />
46
+ </ExampleApps.Root>