@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,527 @@
1
+ ---
2
+ title: API Reference
3
+ links:
4
+ - title: Overview
5
+ url: /reference
6
+ - title: Client libraries
7
+ url: /reference/client-libraries
8
+ - title: Testing
9
+ url: /reference/testing
10
+ - title: API Keys
11
+ url: /reference/api-keys
12
+ - title: Errors
13
+ url: /reference/errors
14
+ - title: Pagination
15
+ url: /reference/pagination
16
+ - title: Idempotency
17
+ url: /reference/idempotency
18
+ - title: Rate limits
19
+ url: /reference/rate-limits
20
+ - title: Events
21
+ links:
22
+ - title: Overview
23
+ url: /reference/events
24
+ - title: List events
25
+ url: /reference/events/list
26
+ - title: Organizations
27
+ links:
28
+ - title: Organization
29
+ url: /reference/organization
30
+ links:
31
+ - title: Get an Organization
32
+ url: /reference/organization/get
33
+ - title: Get an Organization by External ID
34
+ url: /reference/organization/get-by-external-id
35
+ - title: List Organizations
36
+ url: /reference/organization/list
37
+ - title: Create an Organization
38
+ url: /reference/organization/create
39
+ - title: Update an Organization
40
+ url: /reference/organization/update
41
+ - title: Delete an Organization
42
+ url: /reference/organization/delete
43
+ - title: Organization Domain
44
+ url: /reference/organization-domain
45
+ - title: Roles
46
+ links:
47
+ - title: Role
48
+ url: /reference/roles
49
+ links:
50
+ - title: List roles for an Organization
51
+ url: /reference/roles/list-for-organization
52
+ - title: User Management
53
+ links:
54
+ - title: Overview
55
+ url: /reference/user-management
56
+ - title: User
57
+ url: /reference/user-management/user
58
+ links:
59
+ - title: Get a user
60
+ url: /reference/user-management/user/get
61
+ - title: Get a user by external ID
62
+ url: /reference/user-management/user/get-by-external-id
63
+ - title: List users
64
+ url: /reference/user-management/user/list
65
+ - title: Create a user
66
+ url: /reference/user-management/user/create
67
+ - title: Update a user
68
+ url: /reference/user-management/user/update
69
+ - title: Delete a user
70
+ url: /reference/user-management/user/delete
71
+ - title: Identity
72
+ url: /reference/user-management/identity
73
+ links:
74
+ - title: List identities
75
+ url: /reference/user-management/identity/list
76
+ - title: Authentication
77
+ url: /reference/user-management/authentication
78
+ links:
79
+ - title: Get authorization URL
80
+ url: /reference/user-management/authentication/get-authorization-url
81
+ links:
82
+ - title: Redirect URI
83
+ url: >-
84
+ /reference/user-management/authentication/get-authorization-url/redirect-uri
85
+ - title: PKCE
86
+ url: >-
87
+ /reference/user-management/authentication/get-authorization-url/pkce
88
+ - title: Error codes
89
+ url: >-
90
+ /reference/user-management/authentication/get-authorization-url/error-codes
91
+ - title: 'AuthKit, OAuth, SSO'
92
+ url: /reference/user-management/authentication/code
93
+ - title: Password
94
+ url: /reference/user-management/authentication/password
95
+ - title: Magic Auth
96
+ url: /reference/user-management/authentication/magic-auth
97
+ - title: Refresh token
98
+ url: /reference/user-management/authentication/refresh-token
99
+ - title: Email verification code
100
+ url: /reference/user-management/authentication/email-verification
101
+ - title: TOTP code
102
+ url: /reference/user-management/authentication/totp
103
+ - title: Organization selection
104
+ url: /reference/user-management/authentication/organization-selection
105
+ - title: Session cookie
106
+ url: /reference/user-management/authentication/session-cookie
107
+ - title: Refresh and seal session data
108
+ url: >-
109
+ /reference/user-management/authentication/refresh-and-seal-session-data
110
+ - title: Session tokens
111
+ url: /reference/user-management/session-tokens
112
+ links:
113
+ - title: JWKS
114
+ url: /reference/user-management/session-tokens/jwks
115
+ - title: Access token
116
+ url: /reference/user-management/session-tokens/access-token
117
+ - title: Refresh token
118
+ url: /reference/user-management/session-tokens/refresh-token
119
+ - title: Session helpers
120
+ url: /reference/user-management/session-helpers
121
+ links:
122
+ - title: Load sealed session
123
+ url: /reference/user-management/session-helpers/load-sealed-session
124
+ - title: Authenticate
125
+ url: /reference/user-management/session-helpers/authenticate
126
+ - title: Refresh
127
+ url: /reference/user-management/session-helpers/refresh
128
+ - title: Get log out URL
129
+ url: /reference/user-management/session-helpers/get-logout-url
130
+ - title: Authentication errors
131
+ url: /reference/user-management/authentication-errors
132
+ links:
133
+ - title: Email verification
134
+ url: >-
135
+ /reference/user-management/authentication-errors/email-verification-required-error
136
+ - title: MFA enrollment
137
+ url: >-
138
+ /reference/user-management/authentication-errors/mfa-enrollment-error
139
+ - title: MFA challenge
140
+ url: >-
141
+ /reference/user-management/authentication-errors/mfa-challenge-error
142
+ - title: Organization selection
143
+ url: >-
144
+ /reference/user-management/authentication-errors/organization-selection-error
145
+ - title: SSO required
146
+ url: >-
147
+ /reference/user-management/authentication-errors/sso-required-error
148
+ - title: Organization authentication required
149
+ url: >-
150
+ /reference/user-management/authentication-errors/organization-authentication-required-error
151
+ - title: Magic Auth
152
+ url: /reference/user-management/magic-auth
153
+ links:
154
+ - title: Get a Magic Auth code
155
+ url: /reference/user-management/magic-auth/get
156
+ - title: Create a Magic Auth code
157
+ url: /reference/user-management/magic-auth/create
158
+ - title: Multi-Factor Auth
159
+ url: /reference/user-management/mfa
160
+ links:
161
+ - title: Authentication factor
162
+ url: /reference/user-management/mfa/authentication-factor
163
+ - title: Authentication challenge
164
+ url: /reference/user-management/mfa/authentication-challenge
165
+ - title: Enroll an auth factor
166
+ url: /reference/user-management/mfa/enroll-auth-factor
167
+ - title: List auth factors
168
+ url: /reference/user-management/mfa/list-auth-factors
169
+ - title: Email verification
170
+ url: /reference/user-management/email-verification
171
+ links:
172
+ - title: Get an email verification code
173
+ url: /reference/user-management/email-verification/get
174
+ - title: Password reset
175
+ url: /reference/user-management/password-reset
176
+ links:
177
+ - title: Get a password reset token
178
+ url: /reference/user-management/password-reset/get
179
+ - title: Create a password reset token
180
+ url: /reference/user-management/password-reset/create
181
+ - title: Reset password
182
+ url: /reference/user-management/password-reset/reset-password
183
+ - title: Organization membership
184
+ url: /reference/user-management/organization-membership
185
+ links:
186
+ - title: Get membership
187
+ url: /reference/user-management/organization-membership/get
188
+ - title: List memberships
189
+ url: /reference/user-management/organization-membership/list
190
+ - title: Create membership
191
+ url: /reference/user-management/organization-membership/create
192
+ - title: Update membership
193
+ url: /reference/user-management/organization-membership/update
194
+ - title: Delete membership
195
+ url: /reference/user-management/organization-membership/delete
196
+ - title: Deactivate membership
197
+ url: /reference/user-management/organization-membership/deactivate
198
+ - title: Reactivate membership
199
+ url: /reference/user-management/organization-membership/reactivate
200
+ - title: Invitation
201
+ url: /reference/user-management/invitation
202
+ links:
203
+ - title: Get an invitation
204
+ url: /reference/user-management/invitation/get
205
+ - title: Find an invitation by token
206
+ url: /reference/user-management/invitation/find-by-token
207
+ - title: List invitations
208
+ url: /reference/user-management/invitation/list
209
+ - title: Send an invitation
210
+ url: /reference/user-management/invitation/send
211
+ - title: Accept an invitation
212
+ url: /reference/user-management/invitation/accept
213
+ - title: Revoke an invitation
214
+ url: /reference/user-management/invitation/revoke
215
+ - title: Logout
216
+ url: /reference/user-management/logout
217
+ links:
218
+ - title: Get logout URL
219
+ url: /reference/user-management/logout/get-logout-url
220
+ - title: Get logout URL from session cookie
221
+ url: >-
222
+ /reference/user-management/logout/get-logout-url-from-session-cookie
223
+ - title: Single Sign-On
224
+ links:
225
+ - title: Overview
226
+ url: /reference/sso
227
+ - title: Get authorization URL
228
+ url: /reference/sso/get-authorization-url
229
+ links:
230
+ - title: Redirect URI
231
+ url: /reference/sso/get-authorization-url/redirect-uri
232
+ - title: Error codes
233
+ url: /reference/sso/get-authorization-url/error-codes
234
+ - title: Profile
235
+ url: /reference/sso/profile
236
+ links:
237
+ - title: Get a Profile and Token
238
+ url: /reference/sso/profile/get-profile-and-token
239
+ - title: Get a User Profile
240
+ url: /reference/sso/profile/get-user-profile
241
+ - title: Connection
242
+ url: /reference/sso/connection
243
+ links:
244
+ - title: Get a Connection
245
+ url: /reference/sso/connection/get
246
+ - title: List Connections
247
+ url: /reference/sso/connection/list
248
+ - title: Delete a Connection
249
+ url: /reference/sso/connection/delete
250
+ - title: Logout
251
+ url: /reference/sso/logout
252
+ featureFlag: single-logout-docs
253
+ links:
254
+ - title: Logout Authorize
255
+ url: /reference/sso/logout/authorize
256
+ - title: Logout Redirect
257
+ url: /reference/sso/logout/redirect
258
+ - title: Directory Sync
259
+ links:
260
+ - title: Overview
261
+ url: /reference/directory-sync
262
+ - title: Directory
263
+ url: /reference/directory-sync/directory
264
+ links:
265
+ - title: Get a Directory
266
+ url: /reference/directory-sync/directory/get
267
+ - title: List Directories
268
+ url: /reference/directory-sync/directory/list
269
+ - title: Delete a Directory
270
+ url: /reference/directory-sync/directory/delete
271
+ - title: Directory User
272
+ url: /reference/directory-sync/directory-user
273
+ links:
274
+ - title: Get a Directory User
275
+ url: /reference/directory-sync/directory-user/get
276
+ - title: List Directory Users
277
+ url: /reference/directory-sync/directory-user/list
278
+ - title: Directory Group
279
+ url: /reference/directory-sync/directory-group
280
+ links:
281
+ - title: Get a Directory Group
282
+ url: /reference/directory-sync/directory-group/get
283
+ - title: List Directory Groups
284
+ url: /reference/directory-sync/directory-group/list
285
+ - title: Admin Portal
286
+ links:
287
+ - title: Overview
288
+ url: /reference/admin-portal
289
+ - title: Portal Link
290
+ url: /reference/admin-portal/portal-link
291
+ - title: Generate a Portal Link
292
+ url: /reference/admin-portal/portal-link/generate
293
+ - title: Provider Icons
294
+ url: /reference/admin-portal/provider-icons
295
+ - title: Audit Logs
296
+ links:
297
+ - title: Overview
298
+ url: /reference/audit-logs
299
+ - title: Create Event
300
+ url: /reference/audit-logs/create-event
301
+ - title: Audit Log Schema
302
+ url: /reference/audit-logs/audit-log-schema
303
+ - title: Create Schema
304
+ url: /reference/audit-logs/create-schema
305
+ - title: List Schemas
306
+ url: /reference/audit-logs/list-schemas
307
+ - title: List Actions
308
+ url: /reference/audit-logs/list-actions
309
+ - title: Audit Log Export
310
+ url: /reference/audit-logs/audit-log-export
311
+ - title: Create Export
312
+ url: /reference/audit-logs/create-export
313
+ - title: Get Export
314
+ url: /reference/audit-logs/get-export
315
+ - title: Get Retention
316
+ url: /reference/audit-logs/get-retention
317
+ - title: Set Retention
318
+ url: /reference/audit-logs/set-retention
319
+ - title: Domain Verification
320
+ links:
321
+ - title: Organization Domain
322
+ url: /reference/domain-verification
323
+ links:
324
+ - title: Get
325
+ url: /reference/domain-verification/get
326
+ - title: Create
327
+ url: /reference/domain-verification/create
328
+ - title: Verify
329
+ url: /reference/domain-verification/verify
330
+ - title: Multi-Factor Auth
331
+ links:
332
+ - title: Authentication Factor
333
+ url: /reference/mfa/authentication-factor
334
+ - title: Authentication Challenge
335
+ url: /reference/mfa/authentication-challenge
336
+ - title: Enroll Factor
337
+ url: /reference/mfa/enroll-factor
338
+ - title: Challenge Factor
339
+ url: /reference/mfa/challenge-factor
340
+ - title: Verify Challenge
341
+ url: /reference/mfa/verify-challenge
342
+ - title: Get Authentication Factor
343
+ url: /reference/mfa/get-factor
344
+ - title: Delete Authentication Factor
345
+ url: /reference/mfa/delete-factor
346
+ - title: Fine-Grained Authorization
347
+ links:
348
+ - title: Overview
349
+ url: /reference/fga
350
+ - title: Resource Type
351
+ url: /reference/fga/resource-type
352
+ links:
353
+ - title: Get a resource type
354
+ url: /reference/fga/resource-type/get
355
+ - title: List resource types
356
+ url: /reference/fga/resource-type/list
357
+ - title: Create a resource type
358
+ url: /reference/fga/resource-type/create
359
+ - title: Update a resource type
360
+ url: /reference/fga/resource-type/update
361
+ - title: Delete a resource type
362
+ url: /reference/fga/resource-type/delete
363
+ - title: Apply resource types
364
+ url: /reference/fga/resource-type/apply
365
+ - title: Warrant
366
+ url: /reference/fga/warrant
367
+ links:
368
+ - title: List warrants
369
+ url: /reference/fga/warrant/list
370
+ - title: Create a warrant
371
+ url: /reference/fga/warrant/create
372
+ - title: Delete a warrant
373
+ url: /reference/fga/warrant/delete
374
+ - title: Batch write warrants
375
+ url: /reference/fga/warrant/batch-write
376
+ - title: Resource
377
+ url: /reference/fga/resource
378
+ links:
379
+ - title: Get a resource
380
+ url: /reference/fga/resource/get
381
+ - title: List resources
382
+ url: /reference/fga/resource/list
383
+ - title: Create a resource
384
+ url: /reference/fga/resource/create
385
+ - title: Update a resource
386
+ url: /reference/fga/resource/update
387
+ - title: Delete a resource
388
+ url: /reference/fga/resource/delete
389
+ - title: Batch write resources
390
+ url: /reference/fga/resource/batch-write
391
+ - title: Policy
392
+ url: /reference/fga/policy
393
+ links:
394
+ - title: Get a policy
395
+ url: /reference/fga/policy/get
396
+ - title: List policies
397
+ url: /reference/fga/policy/list
398
+ - title: Create a policy
399
+ url: /reference/fga/policy/create
400
+ - title: Update a policy
401
+ url: /reference/fga/policy/update
402
+ - title: Delete a policy
403
+ url: /reference/fga/policy/delete
404
+ - title: Check
405
+ url: /reference/fga/check
406
+ - title: Batch Check
407
+ url: /reference/fga/batch-check
408
+ - title: Query
409
+ url: /reference/fga/query
410
+ - title: Schema
411
+ url: /reference/fga/schema
412
+ links:
413
+ - title: Get a schema
414
+ url: /reference/fga/schema/get
415
+ - title: Apply schema
416
+ url: /reference/fga/schema/apply
417
+ - title: Widgets
418
+ links:
419
+ - title: Overview
420
+ url: /reference/widgets
421
+ - title: Get Token
422
+ url: /reference/widgets/get-token
423
+ - title: Vault
424
+ links:
425
+ - title: Overview
426
+ url: /reference/vault
427
+ - title: Encrypted Object
428
+ url: /reference/vault/object
429
+ links:
430
+ - title: Create an object
431
+ url: /reference/vault/object/create
432
+ - title: Get an object
433
+ url: /reference/vault/object/get
434
+ - title: Update an object
435
+ url: /reference/vault/object/update
436
+ - title: Retrieve metadata
437
+ url: /reference/vault/object/metadata
438
+ - title: List objects
439
+ url: /reference/vault/object/list
440
+ - title: Delete an object
441
+ url: /reference/vault/object/delete
442
+ - title: Object Versions
443
+ url: /reference/vault/object/version
444
+ links:
445
+ - title: List object versions
446
+ url: /reference/vault/object/versions
447
+ - title: Encryption Key Management
448
+ url: /reference/vault/key
449
+ links:
450
+ - title: Create a data key
451
+ url: /reference/vault/key/create-data-key
452
+ - title: Decrypt a data key
453
+ url: /reference/vault/key/decrypt-data-key
454
+ - title: Encrypt data
455
+ url: /reference/vault/key/encrypt-data
456
+ - title: Decrypt data
457
+ url: /reference/vault/key/decrypt-data
458
+ - title: WorkOS Connect
459
+ links:
460
+ - title: Overview
461
+ url: /reference/workos-connect
462
+ - title: Authorize
463
+ url: /reference/workos-connect/authorize
464
+ - title: Token
465
+ url: /reference/workos-connect/token
466
+ links:
467
+ - title: Authorization code grant
468
+ url: /reference/workos-connect/token/authorization-code-grant
469
+ links:
470
+ - title: Access token
471
+ url: >-
472
+ /reference/workos-connect/token/authorization-code-grant/access-token
473
+ - title: ID token
474
+ url: >-
475
+ /reference/workos-connect/token/authorization-code-grant/id-token
476
+ - title: Refresh token grant
477
+ url: /reference/workos-connect/token/refresh-token-grant
478
+ - title: Client credentials grant
479
+ url: /reference/workos-connect/token/client-credentials-grant
480
+ links:
481
+ - title: Access token
482
+ url: >-
483
+ /reference/workos-connect/token/client-credentials-grant/access-token
484
+ - title: Token introspection
485
+ url: /reference/workos-connect/introspection
486
+ - title: User information
487
+ url: /reference/workos-connect/userinfo
488
+ - title: Metadata
489
+ url: /reference/workos-connect/metadata
490
+ links:
491
+ - title: OpenID Configuration
492
+ url: /reference/workos-connect/metadata/openid-configuration
493
+ - title: OAuth Authorization Server
494
+ url: /reference/workos-connect/metadata/oauth-authorization-server
495
+ - title: Radar
496
+ links:
497
+ - title: Overview
498
+ url: /reference/radar
499
+ - title: Attempts
500
+ url: /reference/radar/attempts
501
+ links:
502
+ - title: Create attempt
503
+ url: /reference/radar/attempts/create
504
+ - title: Update attempt
505
+ url: /reference/radar/attempts/update
506
+ - title: Lists
507
+ url: /reference/radar/lists
508
+ links:
509
+ - title: Add entry
510
+ url: /reference/radar/lists/update
511
+ - title: Remove entry
512
+ url: /reference/radar/lists/delete
513
+ - title: Deprecated APIs
514
+ excludeFromSearch: true
515
+ links:
516
+ - title: Magic Link
517
+ url: /reference/magic-link
518
+ links:
519
+ - title: Passwordless Session
520
+ url: /reference/magic-link/passwordless-session
521
+ - title: Create Passwordless Session
522
+ url: /reference/magic-link/passwordless-session/create
523
+ - title: Email a Magic Link
524
+ url: /reference/magic-link/passwordless-session/send-email
525
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/_navigation.mdx
526
+ ---
527
+
@@ -0,0 +1,6 @@
1
+ ---
2
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/admin-portal/index.mdx
3
+ ---
4
+ # Admin Portal
5
+
6
+ The Admin Portal is a standalone application where your users can configure and manage WorkOS resources such as [Connections](/reference/sso/connection) and [Directories](/reference/directory-sync/directory) that are scoped to their [Organization](/reference/organization).