@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,130 @@
1
+ ---
2
+ descriptions:
3
+ create_resource:
4
+ resource_id: >-
5
+ Unique string ID of the resource. If one is not provided, one will be
6
+ automatically generated upon creation.
7
+ reference:
8
+ curl:
9
+ - key: create_resource
10
+ id: create_resource
11
+ url: /reference/fga/resources/create
12
+ title: /fga/v1/resources
13
+ type: POST
14
+ parameters:
15
+ - key: resource_type
16
+ type: string
17
+ description: (resource.resource_type)
18
+ - key: resource_id
19
+ type: string
20
+ optional: true
21
+ description: (create_resource.resource_id)
22
+ - key: meta
23
+ type: object
24
+ optional: true
25
+ description: (resource.meta)
26
+ returns:
27
+ - (resource)
28
+ js:
29
+ - key: createResource
30
+ id: create_resource
31
+ url: /reference/fga/resources/create
32
+ title: fga.createResource()
33
+ parameters:
34
+ - key: options
35
+ type: object
36
+ unwrap: true
37
+ properties:
38
+ - key: resourceType
39
+ type: string
40
+ description: (resource.resource_type)
41
+ - key: resourceId
42
+ type: string
43
+ optional: true
44
+ description: (create_resource.resource_id)
45
+ - key: meta
46
+ type: object
47
+ optional: true
48
+ description: (resource.meta)
49
+ returns:
50
+ - (Resource)
51
+ go:
52
+ - key: CreateResource
53
+ id: create_resource
54
+ url: /reference/fga/resources/create
55
+ title: fga.CreateResource()
56
+ parameters:
57
+ - (ctx)
58
+ - key: opts
59
+ type: fga.CreateResourceOpts
60
+ unwrap: true
61
+ properties:
62
+ - key: ResourceType
63
+ type: string
64
+ description: (resource.resource_type)
65
+ - key: ResourceId
66
+ type: string
67
+ optional: true
68
+ description: (create_resource.resource_id)
69
+ - key: Meta
70
+ type: object
71
+ optional: true
72
+ description: (resource.meta)
73
+ returns:
74
+ - key: resource
75
+ type: fga.Resource
76
+ description: (resource.self)
77
+ - (err)
78
+ java:
79
+ - key: createResource
80
+ id: create_resource
81
+ url: /reference/fga/resources/create
82
+ title: fga.createResource()
83
+ parameters:
84
+ - key: options
85
+ type: CreateResourceOptions
86
+ unwrap: true
87
+ properties:
88
+ - key: resourceType
89
+ type: String
90
+ description: (resource.resource_type)
91
+ - key: resourceId
92
+ type: String
93
+ optional: true
94
+ description: (create_resource.resource_id)
95
+ - key: meta
96
+ type: 'Map<String, String>'
97
+ optional: true
98
+ description: (resource.meta)
99
+ returns:
100
+ - (Resource)
101
+ python:
102
+ - key: create_resource
103
+ id: create_resource
104
+ url: /reference/fga/resources/create
105
+ title: fga.create_resource()
106
+ parameters:
107
+ - key: resource_type
108
+ type: str
109
+ description: (resource.resource_type)
110
+ - key: resource_id
111
+ type: str
112
+ optional: true
113
+ description: (create_resource.resource_id)
114
+ - key: meta
115
+ type: dict
116
+ optional: true
117
+ description: (resource.meta)
118
+ returns:
119
+ - (Resource)
120
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource/create.mdx
121
+ ---
122
+
123
+ ## Create a resource
124
+
125
+ Create a new resource in the current environment.
126
+
127
+ <CodeBlock referenceId="create_resource">
128
+ <CodeBlockTab title="Request" file="create-resource-request" />
129
+ <CodeBlockTab title="Response" file="create-resource-response" />
130
+ </CodeBlock>
@@ -0,0 +1,86 @@
1
+ ---
2
+ reference:
3
+ curl:
4
+ - key: delete_resource
5
+ id: delete_resource
6
+ url: /reference/fga/resources/delete
7
+ title: '/fga/v1/resources/:resource_type/:resource_id'
8
+ type: DELETE
9
+ parameters:
10
+ - (resource.resource_type)
11
+ - (resource.resource_id)
12
+ js:
13
+ - key: deleteResource
14
+ id: delete_resource
15
+ url: /reference/fga/resources/delete
16
+ title: fga.deleteResource()
17
+ type: DELETE
18
+ parameters:
19
+ - key: options
20
+ type: object
21
+ unwrap: true
22
+ properties:
23
+ - key: resourceType
24
+ type: string
25
+ description: (resource.resource_type)
26
+ - key: resourceId
27
+ type: string
28
+ description: (resource.resource_id)
29
+ go:
30
+ - key: DeleteResource
31
+ id: delete_resource
32
+ url: /reference/fga/resources/delete
33
+ title: fga.DeleteResource()
34
+ type: DELETE
35
+ parameters:
36
+ - (ctx)
37
+ - key: opts
38
+ type: fga.DeleteResourceOpts
39
+ unwrap: true
40
+ properties:
41
+ - key: ResourceType
42
+ type: string
43
+ description: (resource.resource_type)
44
+ - key: ResourceId
45
+ type: string
46
+ description: (resource.resource_id)
47
+ java:
48
+ - key: deleteResource
49
+ id: delete_resource
50
+ url: /reference/fga/resources/delete
51
+ title: fga.deleteResource()
52
+ type: DELETE
53
+ parameters:
54
+ - key: resourceType
55
+ type: String
56
+ description: (resource.resource_type)
57
+ - key: resourceId
58
+ type: String
59
+ description: (resource.resource_id)
60
+ python:
61
+ - key: delete_resource
62
+ id: delete_resource
63
+ url: /reference/fga/resources/delete
64
+ title: fga.delete_resource()
65
+ type: DELETE
66
+ parameters:
67
+ - key: resource_type
68
+ type: str
69
+ description: (resource.resource_type)
70
+ - key: resource_id
71
+ type: str
72
+ description: (resource.resource_id)
73
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource/delete.mdx
74
+ ---
75
+
76
+ ## Delete a resource
77
+
78
+ Deletes a resource in the current environment.
79
+
80
+ > Deleting a resource will also delete all warrants where the resource is the `resource` or `subject` of the warrant.
81
+
82
+ <CodeBlock
83
+ title="Request"
84
+ referenceId="delete_resource"
85
+ file="delete-resource"
86
+ />
@@ -0,0 +1,88 @@
1
+ ---
2
+ reference:
3
+ curl:
4
+ - key: get_resource
5
+ id: get_resource
6
+ url: /reference/fga/resources/get
7
+ title: '/fga/v1/resources/:resource_type/:resource_id'
8
+ type: GET
9
+ parameters:
10
+ - (resource.resource_type)
11
+ - (resource.resource_id)
12
+ returns:
13
+ - (resource)
14
+ js:
15
+ - key: getResource
16
+ id: get_resource
17
+ url: /reference/fga/resources/get
18
+ title: fga.getResource()
19
+ type: GET
20
+ parameters:
21
+ - key: options
22
+ type: object
23
+ unwrap: true
24
+ properties:
25
+ - (Resource.resourceType)
26
+ - (Resource.resourceId)
27
+ returns:
28
+ - (Resource)
29
+ go:
30
+ - key: GetResource
31
+ id: get_resource
32
+ url: /reference/fga/resources/get
33
+ title: fga.GetResource()
34
+ type: GET
35
+ parameters:
36
+ - (ctx)
37
+ - key: opts
38
+ type: fga.GetResourceOpts
39
+ unwrap: true
40
+ properties:
41
+ - key: ResourceType
42
+ type: string
43
+ description: (resource.resource_type)
44
+ - key: ResourceId
45
+ type: string
46
+ description: (resource.resource_id)
47
+ returns:
48
+ - key: resource
49
+ type: fga.Resource
50
+ description: (resource.self)
51
+ - (err)
52
+ java:
53
+ - key: getResource
54
+ id: get_resource
55
+ url: /reference/fga/resources/get
56
+ title: fga.getResource()
57
+ type: GET
58
+ parameters:
59
+ - (Resource.resourceType)
60
+ - (Resource.resourceId)
61
+ returns:
62
+ - (Resource)
63
+ python:
64
+ - key: get_resource
65
+ id: get_resource
66
+ url: /reference/fga/resources/get
67
+ title: fga.get_resource()
68
+ type: GET
69
+ parameters:
70
+ - key: resource_type
71
+ type: str
72
+ description: (resource.resource_type)
73
+ - key: resource_id
74
+ type: str
75
+ description: (resource.resource_id)
76
+ returns:
77
+ - (Resource)
78
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource/get.mdx
79
+ ---
80
+
81
+ ## Get a resource
82
+
83
+ Get an existing resource.
84
+
85
+ <CodeBlock referenceId="get_resource">
86
+ <CodeBlockTab title="Request" file="get-resource-request" />
87
+ <CodeBlockTab title="Response" file="get-resource-response" />
88
+ </CodeBlock>
@@ -0,0 +1,98 @@
1
+ ---
2
+ descriptions:
3
+ resource:
4
+ self: 'The FGA [Resource](/reference/fga/resource).'
5
+ resource_type: The type of the resource.
6
+ resource_id: Unique string ID of the resource.
7
+ meta: A JSON resource containing additional information about this resource.
8
+ reference:
9
+ curl:
10
+ - url: /reference/fga/resource
11
+ key: resource
12
+ id: resource
13
+ title: resource
14
+ properties:
15
+ - key: resource_type
16
+ type: string
17
+ description: (resource.resource_type)
18
+ - key: resource_id
19
+ type: string
20
+ description: (resource.resource_id)
21
+ - key: meta
22
+ type: object
23
+ optional: true
24
+ description: (resource.meta)
25
+ js:
26
+ - url: /reference/fga/resource
27
+ key: Resource
28
+ id: resource
29
+ title: interface BaseWarrantResource
30
+ properties:
31
+ - key: resourceType
32
+ type: string
33
+ description: (resource.resource_type)
34
+ - key: resourceId
35
+ type: string
36
+ description: (resource.resource_id)
37
+ - key: meta
38
+ type: object
39
+ optional: true
40
+ description: (resource.meta)
41
+ go:
42
+ - url: /reference/fga/resource
43
+ key: Resource
44
+ id: resource
45
+ title: fga.Resource
46
+ properties:
47
+ - key: ResourceType
48
+ type: string
49
+ description: (resource.resource_type)
50
+ - key: ResourceId
51
+ type: string
52
+ description: (resource.resource_id)
53
+ - key: Meta
54
+ type: object
55
+ optional: true
56
+ description: (resource.meta)
57
+ java:
58
+ - url: /reference/fga/resource
59
+ key: Resource
60
+ id: resource
61
+ title: class Resource
62
+ properties:
63
+ - key: resourceType
64
+ type: String
65
+ description: (resource.resource_type)
66
+ - key: resourceId
67
+ type: String
68
+ description: (resource.resource_id)
69
+ - key: meta
70
+ type: 'Map<String, String>'
71
+ optional: true
72
+ description: (resource.meta)
73
+ python:
74
+ - url: /reference/fga/resource
75
+ key: Resource
76
+ id: resource
77
+ title: AuthorizationResource
78
+ properties:
79
+ - key: resource_type
80
+ type: str
81
+ description: (resource.resource_type)
82
+ - key: resource_id
83
+ type: str
84
+ description: (resource.resource_id)
85
+ - key: meta
86
+ type: dict
87
+ optional: true
88
+ description: (resource.meta)
89
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource/index.mdx
90
+ ---
91
+
92
+ ---
93
+
94
+ # Resource
95
+
96
+ Represents a resource in your application.
97
+
98
+ <CodeBlock title="Resource" referenceId="resource" file="resource" />
@@ -0,0 +1,188 @@
1
+ ---
2
+ descriptions:
3
+ list_resources:
4
+ data: 'Array of [Resources](/reference/fga/resource).'
5
+ resource_type: Only return resources with an `resource_type` matching this value.
6
+ search: >-
7
+ Only returns resources where `resource_type` and/or `resource_id` contain
8
+ the search term.
9
+ reference:
10
+ curl:
11
+ - key: list_resources
12
+ id: list_resources
13
+ url: /reference/fga/resource/list
14
+ title: /fga/v1/resources
15
+ type: GET
16
+ parameters:
17
+ - key: resource_type
18
+ type: string
19
+ optional: true
20
+ description: (list_resources.resource_type)
21
+ - key: search
22
+ type: string
23
+ optional: true
24
+ description: (list_resources.search)
25
+ - (limit)
26
+ - (before)
27
+ - (after)
28
+ - (order)
29
+ returns:
30
+ - key: data
31
+ type: array
32
+ description: (list_resources.data)
33
+ - key: list_metadata
34
+ type: object
35
+ properties:
36
+ - (before)
37
+ - (after)
38
+ js:
39
+ - key: listResources
40
+ id: list_resources
41
+ url: /reference/resources/list
42
+ title: fga.listResources()
43
+ type: GET
44
+ parameters:
45
+ - key: options
46
+ type: object
47
+ unwrap: true
48
+ optional: true
49
+ properties:
50
+ - key: resourceType
51
+ type: string
52
+ optional: true
53
+ description: (list_resources.resource_type)
54
+ - key: search
55
+ type: string
56
+ optional: true
57
+ description: (list_resources.search)
58
+ - (limit)
59
+ - (before)
60
+ - (after)
61
+ - (order)
62
+ returns:
63
+ - key: anonymous
64
+ type: object
65
+ unwrap: true
66
+ properties:
67
+ - key: data
68
+ type: 'Resource[]'
69
+ description: (list_resources.data)
70
+ - key: listMetadata
71
+ type: object
72
+ properties:
73
+ - (before)
74
+ - (after)
75
+ go:
76
+ - key: ListResources
77
+ id: list_resources
78
+ url: /reference/resources/list
79
+ title: fga.ListResources()
80
+ type: GET
81
+ parameters:
82
+ - (ctx)
83
+ - key: opts
84
+ type: fga.ListResourcesOpts
85
+ unwrap: true
86
+ properties:
87
+ - key: ResourceType
88
+ optional: true
89
+ type: string
90
+ description: (list_resources.resource_type)
91
+ - key: Search
92
+ optional: true
93
+ type: string
94
+ description: (list_resources.search)
95
+ - (Limit)
96
+ - (Before)
97
+ - (After)
98
+ - (Order)
99
+ returns:
100
+ - key: resources
101
+ type: ListResourcesResponse
102
+ unwrap: true
103
+ properties:
104
+ - key: Data
105
+ type: 'User[]'
106
+ description: (list_resources.data)
107
+ - key: ListMetadata
108
+ type: ListMetadata
109
+ properties:
110
+ - (Before)
111
+ - (After)
112
+ - (err)
113
+ java:
114
+ - key: listResources
115
+ id: list_resources
116
+ url: /reference/resources/list
117
+ title: fga.listResources()
118
+ type: GET
119
+ parameters:
120
+ - key: options
121
+ type: ListResourcesOptions
122
+ optional: true
123
+ unwrap: true
124
+ properties:
125
+ - key: resourceType
126
+ type: String
127
+ optional: true
128
+ description: (list_resources.resource_type)
129
+ - key: search
130
+ type: String
131
+ optional: true
132
+ description: (list_resources.search)
133
+ - (limit)
134
+ - (before)
135
+ - (after)
136
+ - (order)
137
+ returns:
138
+ - key: anonymous
139
+ type: Resources
140
+ unwrap: true
141
+ properties:
142
+ - key: data
143
+ type: 'Array[Resource]'
144
+ description: (list_resources.data)
145
+ - key: listMetadata
146
+ type: ListMetadata
147
+ properties:
148
+ - (before)
149
+ - (after)
150
+ python:
151
+ - key: list_resources
152
+ id: list_resources
153
+ url: /reference/resources/list
154
+ title: fga.list_resources()
155
+ type: GET
156
+ parameters:
157
+ - key: resource_type
158
+ type: str
159
+ optional: true
160
+ description: (list_resources.resource_type)
161
+ - key: search
162
+ type: str
163
+ optional: true
164
+ description: (list_resources.search)
165
+ - (limit)
166
+ - (before)
167
+ - (after)
168
+ - (order)
169
+ returns:
170
+ - key: data
171
+ type: 'List[AuthorizationResource]'
172
+ description: (list_resources.data)
173
+ - key: list_metadata
174
+ type: dict
175
+ properties:
176
+ - (before)
177
+ - (after)
178
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource/list.mdx
179
+ ---
180
+
181
+ ## List resources
182
+
183
+ Get a list of all your existing resources matching the criteria specified.
184
+
185
+ <CodeBlock referenceId="list_resources">
186
+ <CodeBlockTab title="Request" file="list-resources-request" />
187
+ <CodeBlockTab title="Response" file="list-resources-response" />
188
+ </CodeBlock>
@@ -0,0 +1,115 @@
1
+ ---
2
+ reference:
3
+ curl:
4
+ - key: update_resource
5
+ id: update_resource
6
+ url: /reference/fga/resources/update
7
+ title: '/fga/v1/resources/:resource_type/:resource_id'
8
+ type: PUT
9
+ parameters:
10
+ - (resource.resource_type)
11
+ - (resource.resource_id)
12
+ - (resource.meta)
13
+ returns:
14
+ - (resource)
15
+ js:
16
+ - key: updateResource
17
+ id: update_resource
18
+ url: /reference/fga/resources/update
19
+ title: fga.updateResource()
20
+ type: PUT
21
+ parameters:
22
+ - key: options
23
+ type: object
24
+ unwrap: true
25
+ properties:
26
+ - key: resource
27
+ type: object
28
+ properties:
29
+ - key: resourceType
30
+ type: string
31
+ description: (resource.resource_type)
32
+ - key: resourceId
33
+ type: string
34
+ description: (resource.resource_id)
35
+ - key: meta
36
+ type: string
37
+ description: (resource.meta)
38
+ returns:
39
+ - (Resource)
40
+ go:
41
+ - key: UpdateResource
42
+ id: update_resource
43
+ url: /reference/fga/resources/update
44
+ title: fga.UpdateResource()
45
+ type: PUT
46
+ parameters:
47
+ - (ctx)
48
+ - key: opts
49
+ type: fga.UpdateResourceOpts
50
+ unwrap: true
51
+ properties:
52
+ - key: ResourceType
53
+ type: string
54
+ description: (resource.resource_type)
55
+ - key: ResourceId
56
+ type: string
57
+ description: (resource.resource_id)
58
+ - key: Meta
59
+ type: string
60
+ description: (resource.meta)
61
+ returns:
62
+ - key: resource
63
+ type: fga.Resource
64
+ description: (resource.self)
65
+ - (err)
66
+ java:
67
+ - key: updateResource
68
+ id: update_resource
69
+ url: /reference/fga/resources/update
70
+ title: fga.updateResource()
71
+ type: PUT
72
+ parameters:
73
+ - key: resourceType
74
+ type: String
75
+ description: (resource.resource_type)
76
+ - key: resourceId
77
+ type: String
78
+ description: (resource.resource_id)
79
+ - key: options
80
+ type: UpdateResourceOptions
81
+ properties:
82
+ - key: meta
83
+ type: String
84
+ description: (resource.meta)
85
+ returns:
86
+ - (Resource)
87
+ python:
88
+ - key: update_resource
89
+ id: update_resource
90
+ url: /reference/fga/resources/update
91
+ title: fga.update_resource()
92
+ type: PUT
93
+ parameters:
94
+ - key: resource_type
95
+ type: string
96
+ description: (resource.resource_type)
97
+ - key: resource_id
98
+ type: string
99
+ description: (resource.resource_id)
100
+ - key: meta
101
+ type: dict
102
+ description: (resource.meta)
103
+ returns:
104
+ - (Resource)
105
+ originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource/update.mdx
106
+ ---
107
+
108
+ ## Update a resource
109
+
110
+ Update the meta of an existing resource in the current environment.
111
+
112
+ <CodeBlock referenceId="update_resource">
113
+ <CodeBlockTab title="Request" file="update-resource-request" />
114
+ <CodeBlockTab title="Response" file="update-resource-response" />
115
+ </CodeBlock>