@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,281 @@
1
+ ---
2
+ descriptions:
3
+ directories_search: Searchable text to match against Directory names.
4
+ directories_organization_id: Filter Directories by their associated organization.
5
+ directory_list: 'Array of [Directories](/reference/directory-sync) ordered by creation time.'
6
+ reference:
7
+ curl:
8
+ - key: listDirectories
9
+ id: list_directories
10
+ url: /reference/directory-sync/directory/list
11
+ title: /directories
12
+ type: GET
13
+ parameters:
14
+ - key: search
15
+ optional: true
16
+ type: string
17
+ description: (directories_search)
18
+ - key: organization_id
19
+ optional: true
20
+ type: string
21
+ description: (directories_organization_id)
22
+ - (limit)
23
+ - (before)
24
+ - (after)
25
+ - (order)
26
+ returns:
27
+ - key: anonymous
28
+ type: object
29
+ unwrap: true
30
+ properties:
31
+ - key: data
32
+ type: array
33
+ description: (directory_list)
34
+ - key: list_metadata
35
+ type: object
36
+ properties:
37
+ - (after)
38
+ - (before)
39
+ dotnet:
40
+ - key: ListDirectories
41
+ id: list_directories
42
+ url: /reference/directory-sync/directory/list
43
+ title: directorySyncService.ListDirectories()
44
+ parameters:
45
+ - key: options
46
+ type: ListDirectoriesOptions
47
+ expanded: true
48
+ properties:
49
+ - key: Search
50
+ optional: true
51
+ type: string
52
+ description: (directories_search)
53
+ - key: OrganizationId
54
+ optional: true
55
+ type: string
56
+ description: (directories_organization_id)
57
+ - (Limit)
58
+ - (Before)
59
+ - (After)
60
+ - (Order)
61
+ - (cancellationToken)
62
+ returns:
63
+ - key: Task<WorkOSList<Directory>>
64
+ expanded: true
65
+ properties:
66
+ - key: Data
67
+ type: List<Directory>
68
+ description: (directory_list)
69
+ - key: ListMetadata
70
+ type: ListMetadata
71
+ properties:
72
+ - (Before)
73
+ - (After)
74
+ ruby:
75
+ - key: list_directories
76
+ id: list_directories
77
+ url: /reference/directory-sync/directory/list
78
+ title: DirectorySync.list_directories()
79
+ parameters:
80
+ - key: search
81
+ optional: true
82
+ type: String
83
+ description: (directories_search)
84
+ - key: organization_id
85
+ optional: true
86
+ type: String
87
+ description: (directories_organization_id)
88
+ - (limit)
89
+ - (before)
90
+ - (after)
91
+ - (order)
92
+ returns:
93
+ - key: anonymous
94
+ type: Struct
95
+ unwrap: true
96
+ properties:
97
+ - key: data
98
+ type: 'Array[Directory]'
99
+ description: (directory_list)
100
+ - key: list_metadata
101
+ type: Hash
102
+ properties:
103
+ - (after)
104
+ - (before)
105
+ python:
106
+ - key: list_directories
107
+ id: list_directories
108
+ url: /reference/directory-sync/directory/list
109
+ title: directory_sync.list_directories()
110
+ parameters:
111
+ - key: search
112
+ optional: true
113
+ type: str
114
+ description: (directories_search)
115
+ - key: organization
116
+ optional: true
117
+ type: str
118
+ description: (directories_organization_id)
119
+ - (limit)
120
+ - (before)
121
+ - (after)
122
+ - (order)
123
+ returns:
124
+ - key: anonymous
125
+ type: WorkOSListResource
126
+ unwrap: true
127
+ properties:
128
+ - key: data
129
+ type: 'list[Directory]'
130
+ description: (directory_list)
131
+ - key: list_metadata
132
+ type: ListMetadata
133
+ properties:
134
+ - (after)
135
+ - (before)
136
+ js:
137
+ - key: listDirectories
138
+ id: list_directories
139
+ url: /reference/directory-sync/directory/list
140
+ title: directorySync.listDirectories()
141
+ parameters:
142
+ - key: options
143
+ type: object
144
+ unwrap: true
145
+ properties:
146
+ - key: organizationId
147
+ optional: true
148
+ type: string
149
+ description: (directories_organization_id)
150
+ - key: search
151
+ optional: true
152
+ type: string
153
+ description: (directories_search)
154
+ - (limit)
155
+ - (before)
156
+ - (after)
157
+ - (order)
158
+ returns:
159
+ - key: anonymous
160
+ type: object
161
+ unwrap: true
162
+ properties:
163
+ - key: data
164
+ type: 'Directory[]'
165
+ description: (directory_list)
166
+ - key: listMetadata
167
+ type: object
168
+ properties:
169
+ - (before)
170
+ - (after)
171
+ go:
172
+ - key: ListDirectories
173
+ id: list_directories
174
+ url: /reference/directory-sync/directory/list
175
+ title: directorysync.ListDirectories()
176
+ parameters:
177
+ - (ctx)
178
+ - key: opts
179
+ type: directorysync.ListDirectoriesOpts
180
+ expanded: true
181
+ properties:
182
+ - key: Search
183
+ optional: true
184
+ type: string
185
+ description: (directories_search)
186
+ - key: OrganizationID
187
+ optional: true
188
+ type: string
189
+ description: (directories_organization_id)
190
+ - (Limit)
191
+ - (Before)
192
+ - (After)
193
+ - (Order)
194
+ returns:
195
+ - key: list
196
+ type: directorysync.ListDirectoriesResponse
197
+ expanded: true
198
+ properties:
199
+ - key: Data
200
+ type: '[]directorysync.Directory'
201
+ description: (directory_list)
202
+ - key: ListMetadata
203
+ type: common.ListMetadata
204
+ properties:
205
+ - (Before)
206
+ - (After)
207
+ - (err)
208
+ php:
209
+ - key: listDirectories
210
+ id: list_directories
211
+ url: /reference/directory-sync/directory/list
212
+ title: $ds->listDirectories()
213
+ parameters:
214
+ - key: search
215
+ optional: true
216
+ type: string
217
+ description: (directories_search)
218
+ - key: organizationId
219
+ optional: true
220
+ type: string
221
+ description: (directories_organization_id)
222
+ - (limit)
223
+ - (before)
224
+ - (after)
225
+ - (order)
226
+ returns:
227
+ - key: anonymous
228
+ type: array
229
+ unwrap: true
230
+ properties:
231
+ - (before)
232
+ - (after)
233
+ - key: data
234
+ type: 'Directory[]'
235
+ description: (directory_list)
236
+ java:
237
+ - key: listDirectories
238
+ id: list_directories
239
+ url: /reference/directory-sync/directory/list
240
+ title: directorySync.listDirectories()
241
+ parameters:
242
+ - key: options
243
+ type: ListDirectoriesOptions
244
+ expanded: true
245
+ properties:
246
+ - key: organization
247
+ optional: true
248
+ type: String
249
+ description: (directories_organization_id)
250
+ - (after)
251
+ - (before)
252
+ - (limit)
253
+ - (order)
254
+ - key: builder()
255
+ type: ListDirectoriesOptionsBuilder
256
+ description: (java.builder)
257
+ returns:
258
+ - key: directoryList
259
+ type: DirectoryList
260
+ expanded: true
261
+ properties:
262
+ - key: data
263
+ type: List<Directory>
264
+ description: (directory_list)
265
+ - key: listMetadata
266
+ type: ListMetadata
267
+ properties:
268
+ - (after)
269
+ - (before)
270
+ originalPath: >-
271
+ .tmp-workos-clone/packages/docs/content/reference/directory-sync/directory/list.mdx
272
+ ---
273
+
274
+ ## List Directories
275
+
276
+ Get a list of all of your existing directories matching the criteria specified.
277
+
278
+ <CodeBlock referenceId="list_directories">
279
+ <CodeBlockTab title="Request" file="list-directories-request" />
280
+ <CodeBlockTab title="Response" file="list-directories-response" />
281
+ </CodeBlock>
@@ -0,0 +1,105 @@
1
+ ---
2
+ reference:
3
+ curl:
4
+ - key: get_directory_group
5
+ id: get_directory_group
6
+ url: /reference/directory-sync/directory-group/get
7
+ title: '/directory_groups/:id'
8
+ type: GET
9
+ parameters:
10
+ - (directory_group.id)
11
+ returns:
12
+ - (directory_group)
13
+ dotnet:
14
+ - key: GetGroup
15
+ id: get_directory_group
16
+ url: /reference/directory-sync/directory-group/get
17
+ title: directorySyncService.GetGroup()
18
+ parameters:
19
+ - key: id
20
+ type: string
21
+ description: (directory_group.id)
22
+ - (cancellationToken)
23
+ returns:
24
+ - key: Task<Group>
25
+ description: (directory_group.self)
26
+ ruby:
27
+ - key: get_group
28
+ id: get_directory_group
29
+ url: /reference/directory-sync/directory-group/get
30
+ title: DirectorySync.get_group()
31
+ parameters:
32
+ - (DirectoryGroup.id)
33
+ returns:
34
+ - (DirectoryGroup)
35
+ python:
36
+ - key: get_group
37
+ id: get_directory_group
38
+ url: /reference/directory-sync/directory-group/get
39
+ title: directory_sync.get_group()
40
+ parameters:
41
+ - key: group_id
42
+ type: str
43
+ description: (directory_group.id)
44
+ returns:
45
+ - (DirectoryGroup)
46
+ js:
47
+ - key: getGroup
48
+ id: get_directory_group
49
+ url: /reference/directory-sync/directory-group/get
50
+ title: directorySync.getGroup()
51
+ parameters:
52
+ - (DirectoryGroup.id)
53
+ returns:
54
+ - (DirectoryGroup)
55
+ go:
56
+ - key: GetGroup
57
+ id: get_directory_group
58
+ url: /reference/directory-sync/directory-group/get
59
+ title: directorysync.GetGroup()
60
+ parameters:
61
+ - (ctx)
62
+ - key: opts
63
+ type: directorysync.GetGroupOpts
64
+ expanded: true
65
+ properties:
66
+ - key: Group
67
+ type: string
68
+ description: (directory_group.id)
69
+ returns:
70
+ - key: group
71
+ type: directorysync.Group
72
+ description: (directory_group.self)
73
+ - (err)
74
+ php:
75
+ - key: getGroup
76
+ id: get_directory_group
77
+ url: /reference/directory-sync/directory-group/get
78
+ title: $ds->getGroup()
79
+ parameters:
80
+ - key: directoryGroup
81
+ type: string
82
+ description: (directory_group.id)
83
+ returns:
84
+ - (DirectoryGroup)
85
+ java:
86
+ - key: getDirectoryGroup
87
+ id: get_directory_group
88
+ url: /reference/directory-sync/directory-group/get
89
+ title: directorySync.getDirectoryGroup()
90
+ parameters:
91
+ - (Group.id)
92
+ returns:
93
+ - (Group)
94
+ originalPath: >-
95
+ .tmp-workos-clone/packages/docs/content/reference/directory-sync/directory-group/get.mdx
96
+ ---
97
+
98
+ ## Get a Directory Group
99
+
100
+ Get the details of an existing Directory Group.
101
+
102
+ <CodeBlock referenceId="get_directory_group">
103
+ <CodeBlockTab title="Request" file="get-directory-group-request" />
104
+ <CodeBlockTab title="Response" file="get-directory-group-response" />
105
+ </CodeBlock>
@@ -0,0 +1,277 @@
1
+ ---
2
+ descriptions:
3
+ directory_group:
4
+ self: 'The [Directory Group](/reference/directory-sync/directory-group) object.'
5
+ object: Distinguishes the Directory Group object.
6
+ id: Unique identifier for the Directory Group.
7
+ idp: >
8
+ Unique identifier for the group, assigned by the Directory Provider.
9
+ Different Directory Providers use different ID formats.
10
+ directory_id: The identifier of the Directory the Directory Group belongs to.
11
+ organization_id: The identifier for the Organization in which the Directory resides.
12
+ name: The name of the Directory Group.
13
+ created_at: The timestamp when the Directory Group was created.
14
+ updated_at: The timestamp when the Directory Group was last updated.
15
+ raw_attributes: >-
16
+ This field is deprecated. An object containing the data returned from the
17
+ Directory Provider.
18
+ reference:
19
+ curl:
20
+ - url: /reference/directory-sync/directory-group
21
+ key: directory_group
22
+ id: directory_group
23
+ title: directory_group
24
+ properties:
25
+ - key: id
26
+ type: string
27
+ description: (directory_group.id)
28
+ - key: idp_id
29
+ type: string
30
+ description: (directory_group.idp)
31
+ - key: directory_id
32
+ type: string
33
+ description: (directory_group.directory_id)
34
+ - key: organization_id
35
+ optional: true
36
+ type: string
37
+ description: (directory_group.organization_id)
38
+ - key: name
39
+ type: string
40
+ description: (directory_group.name)
41
+ - key: created_at
42
+ type: string
43
+ description: (directory_group.created_at)
44
+ - key: updated_at
45
+ type: string
46
+ description: (directory_group.updated_at)
47
+ - key: 'raw_attributes [Deprecated]'
48
+ type: object
49
+ description: (directory_group.raw_attributes)
50
+ dotnet:
51
+ - url: /reference/directory-sync/directory-group
52
+ key: Group
53
+ id: directory_group
54
+ title: class Group
55
+ properties:
56
+ - key: Object
57
+ type: '"directory_group"'
58
+ description: (directory_group.object)
59
+ - key: Id
60
+ type: string
61
+ description: (directory_group.id)
62
+ - key: IdpId
63
+ type: string
64
+ description: (directory_group.idp)
65
+ - key: DirectoryId
66
+ type: string
67
+ description: (directory_group.directory_id)
68
+ - key: OrganizationId
69
+ optional: true
70
+ type: string
71
+ description: (directory_group.organization_id)
72
+ - key: Name
73
+ type: string
74
+ description: (directory_group.name)
75
+ - key: CreatedAt
76
+ type: string
77
+ description: (directory_group.created_at)
78
+ - key: UpdatedAt
79
+ type: string
80
+ description: (directory_group.updated_at)
81
+ ruby:
82
+ - url: /reference/directory-sync/directory-group
83
+ key: DirectoryGroup
84
+ id: directory_group
85
+ title: class DirectoryGroup
86
+ properties:
87
+ - key: id
88
+ type: String
89
+ description: (directory_group.id)
90
+ - key: idp_id
91
+ type: String
92
+ description: (directory_group.idp)
93
+ - key: directory_id
94
+ type: String
95
+ description: (directory_group.directory_id)
96
+ - key: organization_id
97
+ optional: true
98
+ type: String
99
+ description: (directory_group.organization_id)
100
+ - key: name
101
+ type: String
102
+ description: (directory_group.name)
103
+ - key: created_at
104
+ type: String
105
+ description: (directory_group.created_at)
106
+ - key: updated_at
107
+ type: String
108
+ description: (directory_group.updated_at)
109
+ - key: 'raw_attributes [Deprecated]'
110
+ type: Hash
111
+ description: (directory_group.raw_attributes)
112
+ python:
113
+ - url: /reference/directory-sync/directory-group
114
+ key: DirectoryGroup
115
+ id: directory_group
116
+ title: DirectoryGroup
117
+ properties:
118
+ - key: id
119
+ type: str
120
+ description: (directory_group.id)
121
+ - key: idp_id
122
+ type: str
123
+ description: (directory_group.idp)
124
+ - key: directory_id
125
+ type: str
126
+ description: (directory_group.directory_id)
127
+ - key: name
128
+ type: str
129
+ description: (directory_group.name)
130
+ - key: created_at
131
+ type: str
132
+ description: (directory_group.created_at)
133
+ - key: updated_at
134
+ type: str
135
+ description: (directory_group.updated_at)
136
+ - key: 'raw_attributes [Deprecated]'
137
+ type: dict
138
+ js:
139
+ - url: /reference/directory-sync/directory-group
140
+ key: DirectoryGroup
141
+ id: directory_group
142
+ title: interface DirectoryGroup
143
+ properties:
144
+ - key: id
145
+ type: string
146
+ description: (directory_group.id)
147
+ - key: idpId
148
+ type: string
149
+ description: (directory_group.idp)
150
+ - key: directoryId
151
+ type: string
152
+ description: (directory_group.directory_id)
153
+ - key: organizationId
154
+ optional: true
155
+ type: string
156
+ description: (directory_group.organization_id)
157
+ - key: name
158
+ type: string
159
+ description: (directory_group.name)
160
+ - key: createdAt
161
+ type: string
162
+ description: (directory_group.created_at)
163
+ - key: updatedAt
164
+ type: string
165
+ description: (directory_group.updated_at)
166
+ - key: rawAttributes
167
+ type: object
168
+ description: (directory_group.raw_attributes)
169
+ go:
170
+ - url: /reference/directory-sync/directory-group
171
+ key: Group
172
+ id: directory_group
173
+ title: directorysync.Group
174
+ properties:
175
+ - key: ID
176
+ type: string
177
+ description: (directory_group.id)
178
+ - key: IdpID
179
+ type: string
180
+ description: (directory_group.idp)
181
+ - key: DirectoryID
182
+ type: string
183
+ description: (directory_group.directory_id)
184
+ - key: OrganizationID
185
+ optional: true
186
+ type: string
187
+ description: (directory_group.organization_id)
188
+ - key: Name
189
+ type: string
190
+ description: (directory_group.name)
191
+ - key: CreatedAt
192
+ type: string
193
+ description: (directory_group.created_at)
194
+ - key: UpdatedAt
195
+ type: string
196
+ description: (directory_group.updated_at)
197
+ - key: 'RawAttributes [Deprecated]'
198
+ type: json.RawMessage
199
+ description: (directory_group.raw_attributes)
200
+ php:
201
+ - url: /reference/directory-sync/directory-group
202
+ key: DirectoryGroup
203
+ id: directory_group
204
+ title: WorkOS\Resource\DirectoryGroup
205
+ properties:
206
+ - key: id
207
+ type: string
208
+ description: (directory_group.id)
209
+ - key: idpId
210
+ type: string
211
+ description: (directory_group.idp)
212
+ - key: directoryId
213
+ type: string
214
+ description: (directory_group.directory_id)
215
+ - key: organizationId
216
+ optional: true
217
+ type: string
218
+ description: (directory_group.organization_id)
219
+ - key: name
220
+ type: string
221
+ description: (directory_group.name)
222
+ - key: createdAt
223
+ type: string
224
+ description: (directory_group.created_at)
225
+ - key: updatedAt
226
+ type: string
227
+ description: (directory_group.updated_at)
228
+ - key: 'rawAttributes [Deprecated]'
229
+ type: array
230
+ description: (directory_group.raw_attributes)
231
+ java:
232
+ - url: /reference/directory-sync/directory-group
233
+ key: Group
234
+ id: directory_group
235
+ title: class Group
236
+ properties:
237
+ - key: obj
238
+ type: '"directory_group"'
239
+ description: (directory_group.object)
240
+ - key: directoryId
241
+ type: String
242
+ description: (directory_group.directory_id)
243
+ - key: organizationId
244
+ optional: true
245
+ type: String
246
+ description: (directory_group.organization_id)
247
+ - key: id
248
+ type: String
249
+ description: (directory_group.id)
250
+ - key: idpId
251
+ type: String
252
+ description: (directory_group.idp)
253
+ - key: name
254
+ type: String
255
+ description: (directory_group.name)
256
+ - key: createdAt
257
+ type: String
258
+ description: (directory_group.created_at)
259
+ - key: updatedAt
260
+ type: String
261
+ description: (directory_group.updated_at)
262
+ - key: 'rawAttributes [Deprecated]'
263
+ type: 'Map<String, Any>'
264
+ description: (directory_group.raw_attributes)
265
+ originalPath: >-
266
+ .tmp-workos-clone/packages/docs/content/reference/directory-sync/directory-group/index.mdx
267
+ ---
268
+
269
+ ## Directory Group
270
+
271
+ A directory group represents an organizational unit of users in a directory provider.
272
+
273
+ <CodeBlock
274
+ title="Example Directory Group"
275
+ file="directory-group"
276
+ referenceId="directory_group"
277
+ />