@workos/mcp-docs-server 0.1.0 → 0.2.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.
- package/.docs/organized/changelogs/workos-platform.json +125 -125
- package/.docs/organized/docs/admin-portal/custom-branding.mdx +2 -4
- package/.docs/organized/docs/admin-portal/example-apps.mdx +11 -11
- package/.docs/organized/docs/admin-portal/index.mdx +39 -33
- package/.docs/organized/docs/audit-logs/admin-portal.mdx +1 -1
- package/.docs/organized/docs/audit-logs/editing-events.mdx +1 -1
- package/.docs/organized/docs/audit-logs/exporting-events.mdx +1 -1
- package/.docs/organized/docs/audit-logs/index.mdx +17 -2
- package/.docs/organized/docs/audit-logs/log-streams.mdx +325 -1
- package/.docs/organized/docs/audit-logs/metadata-schema.mdx +1 -1
- package/.docs/organized/docs/authkit/_navigation.mdx +108 -0
- package/.docs/organized/docs/{user-management → authkit}/actions.mdx +3 -4
- package/.docs/organized/docs/authkit/add-ons/google-analytics.mdx +79 -0
- package/.docs/organized/docs/authkit/add-ons/segment.mdx +77 -0
- package/.docs/organized/docs/authkit/add-ons/stripe.mdx +103 -0
- package/.docs/organized/docs/authkit/api-keys.mdx +99 -0
- package/.docs/organized/docs/{user-management → authkit}/branding.mdx +220 -2
- package/.docs/organized/docs/authkit/cli-auth.mdx +76 -0
- package/.docs/organized/docs/authkit/cli-installer.mdx +157 -0
- package/.docs/organized/docs/authkit/connect/m2m.mdx +65 -0
- package/.docs/organized/docs/authkit/connect/oauth.mdx +88 -0
- package/.docs/organized/docs/authkit/connect/standalone.mdx +179 -0
- package/.docs/organized/docs/authkit/connect.mdx +65 -0
- package/.docs/organized/docs/authkit/custom-email-providers.mdx +141 -0
- package/.docs/organized/docs/{user-management → authkit}/custom-emails.mdx +15 -15
- package/.docs/organized/docs/authkit/directory-provisioning.mdx +89 -0
- package/.docs/organized/docs/{user-management → authkit}/domain-verification.mdx +5 -6
- package/.docs/organized/docs/{user-management → authkit}/email-password.mdx +2 -2
- package/.docs/organized/docs/authkit/email-verification.mdx +31 -0
- package/.docs/organized/docs/{user-management → authkit}/example-apps.mdx +3 -3
- package/.docs/organized/docs/authkit/hosted-ui.mdx +165 -0
- package/.docs/organized/docs/{user-management → authkit}/identity-linking.mdx +9 -9
- package/.docs/organized/docs/{user-management → authkit}/impersonation.mdx +8 -8
- package/.docs/organized/docs/{user-management → authkit}/index.mdx +141 -74
- package/.docs/organized/docs/{user-management → authkit}/invitations.mdx +4 -4
- package/.docs/organized/docs/{user-management → authkit}/invite-only-signup.mdx +3 -3
- package/.docs/organized/docs/authkit/jit-provisioning.mdx +42 -0
- package/.docs/organized/docs/{user-management → authkit}/jwt-templates.mdx +37 -3
- package/.docs/organized/docs/authkit/landing.mdx +22 -0
- package/.docs/organized/docs/{user-management → authkit}/magic-auth.mdx +3 -5
- package/.docs/organized/docs/{user-management → authkit}/mcp.mdx +46 -9
- package/.docs/organized/docs/{user-management → authkit}/metadata.mdx +9 -9
- package/.docs/organized/docs/{user-management → authkit}/mfa.mdx +2 -2
- package/.docs/organized/docs/{user-management → authkit}/migrations.mdx +4 -4
- package/.docs/organized/docs/{user-management → authkit}/modeling-your-app.mdx +11 -11
- package/.docs/organized/docs/{user-management → authkit}/organization-policies.mdx +3 -4
- package/.docs/organized/docs/authkit/overview.mdx +46 -0
- package/.docs/organized/docs/{user-management → authkit}/passkeys.mdx +3 -3
- package/.docs/organized/docs/authkit/pipes.mdx +75 -0
- package/.docs/organized/docs/{user-management → authkit}/radar.mdx +39 -4
- package/.docs/organized/docs/authkit/roles-and-permissions.mdx +208 -0
- package/.docs/organized/docs/{user-management → authkit}/sessions.mdx +32 -20
- package/.docs/organized/docs/{user-management → authkit}/social-login.mdx +16 -2
- package/.docs/organized/docs/{user-management → authkit}/sso-with-contractors.mdx +3 -4
- package/.docs/organized/docs/{user-management → authkit}/sso.mdx +2 -2
- package/.docs/organized/docs/authkit/users-organizations.mdx +107 -0
- package/.docs/organized/docs/custom-domains/admin-portal.mdx +0 -2
- package/.docs/organized/docs/custom-domains/authkit.mdx +0 -2
- package/.docs/organized/docs/custom-domains/email.mdx +2 -2
- package/.docs/organized/docs/deprecations/_navigation.mdx +8 -0
- package/.docs/organized/docs/deprecations/raw-attributes.mdx +136 -0
- package/.docs/organized/docs/directory-sync/attributes.mdx +50 -31
- package/.docs/organized/docs/directory-sync/example-apps.mdx +11 -11
- package/.docs/organized/docs/directory-sync/identity-provider-role-assignment.mdx +23 -26
- package/.docs/organized/docs/directory-sync/index.mdx +4 -2
- package/.docs/organized/docs/directory-sync/quick-start.mdx +3 -3
- package/.docs/organized/docs/directory-sync/understanding-events.mdx +2 -2
- package/.docs/organized/docs/domain-verification/api.mdx +8 -8
- package/.docs/organized/docs/domain-verification/index.mdx +3 -3
- package/.docs/organized/docs/email.mdx +49 -5
- package/.docs/organized/docs/events/data-syncing/events-api.mdx +3 -3
- package/.docs/organized/docs/events/data-syncing/index.mdx +2 -3
- package/.docs/organized/docs/events/data-syncing/webhooks.mdx +4 -4
- package/.docs/organized/docs/events/index.mdx +419 -33
- package/.docs/organized/docs/feature-flags/_navigation.mdx +10 -0
- package/.docs/organized/docs/feature-flags/index.mdx +80 -0
- package/.docs/organized/docs/feature-flags/slack-notifications.mdx +58 -0
- package/.docs/organized/docs/fga/_navigation.mdx +34 -54
- package/.docs/organized/docs/fga/access-checks.mdx +109 -0
- package/.docs/organized/docs/fga/assignments.mdx +124 -0
- package/.docs/organized/docs/fga/authkit-integration.mdx +92 -0
- package/.docs/organized/docs/fga/high-cardinality-entities.mdx +172 -0
- package/.docs/organized/docs/fga/idp-role-assignment.mdx +66 -0
- package/.docs/organized/docs/fga/index.mdx +94 -29
- package/.docs/organized/docs/fga/migration-openfga.mdx +306 -0
- package/.docs/organized/docs/fga/migration-oso.mdx +372 -0
- package/.docs/organized/docs/fga/migration-spicedb.mdx +364 -0
- package/.docs/organized/docs/fga/quick-start.mdx +283 -98
- package/.docs/organized/docs/fga/resource-discovery.mdx +78 -0
- package/.docs/organized/docs/fga/resource-types.mdx +165 -0
- package/.docs/organized/docs/fga/resources.mdx +179 -59
- package/.docs/organized/docs/fga/roles-and-permissions.mdx +122 -0
- package/.docs/organized/docs/fga/standalone-integration.mdx +176 -0
- package/.docs/organized/docs/glossary.mdx +7 -3
- package/.docs/organized/docs/integrations/access-people-hr.mdx +1 -1
- package/.docs/organized/docs/integrations/adp-oidc.mdx +1 -1
- package/.docs/organized/docs/integrations/apple.mdx +112 -69
- package/.docs/organized/docs/integrations/auth0-directory-sync.mdx +3 -1
- package/.docs/organized/docs/integrations/auth0-enterprise-connection.mdx +3 -1
- package/.docs/organized/docs/integrations/auth0-saml.mdx +3 -1
- package/.docs/organized/docs/integrations/bamboohr.mdx +4 -4
- package/.docs/organized/docs/integrations/breathe-hr.mdx +1 -1
- package/.docs/organized/docs/integrations/bubble.mdx +1 -1
- package/.docs/organized/docs/integrations/cas-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/classlink-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/clever-oidc.mdx +94 -0
- package/.docs/organized/docs/integrations/cloudflare-saml.mdx +35 -2
- package/.docs/organized/docs/integrations/cyberark-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/cyberark-scim.mdx +1 -1
- package/.docs/organized/docs/integrations/duo-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/entra-id-oidc.mdx +198 -0
- package/.docs/organized/docs/integrations/entra-id-saml.mdx +3 -3
- package/.docs/organized/docs/integrations/entra-id-scim.mdx +5 -1
- package/.docs/organized/docs/integrations/fourth.mdx +2 -2
- package/.docs/organized/docs/integrations/github-oauth.mdx +80 -33
- package/.docs/organized/docs/integrations/gitlab-oauth.mdx +86 -31
- package/.docs/organized/docs/integrations/google-directory-sync.mdx +5 -1
- package/.docs/organized/docs/integrations/google-oauth.mdx +87 -70
- package/.docs/organized/docs/integrations/google-oidc.mdx +142 -0
- package/.docs/organized/docs/integrations/google-saml.mdx +3 -3
- package/.docs/organized/docs/integrations/hibob.mdx +17 -4
- package/.docs/organized/docs/integrations/intuit-oauth.mdx +128 -0
- package/.docs/organized/docs/integrations/jumpcloud-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/jumpcloud-scim.mdx +5 -1
- package/.docs/organized/docs/integrations/keycloak-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/lastpass-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/linkedin-oauth.mdx +69 -30
- package/.docs/organized/docs/integrations/microsoft-ad-fs-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/microsoft-oauth.mdx +95 -38
- package/.docs/organized/docs/integrations/miniorange-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/net-iq-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/next-auth.mdx +1 -1
- package/.docs/organized/docs/integrations/oidc.mdx +37 -24
- package/.docs/organized/docs/integrations/okta-oidc.mdx +149 -0
- package/.docs/organized/docs/integrations/okta-saml.mdx +3 -3
- package/.docs/organized/docs/integrations/okta-scim.mdx +6 -2
- package/.docs/organized/docs/integrations/onelogin-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/onelogin-scim.mdx +1 -1
- package/.docs/organized/docs/integrations/oracle-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/pingfederate-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/pingfederate-scim.mdx +1 -1
- package/.docs/organized/docs/integrations/pingone-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/rippling-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/rippling-scim.mdx +1 -1
- package/.docs/organized/docs/integrations/sailpoint-scim.mdx +77 -0
- package/.docs/organized/docs/integrations/salesforce-oauth.mdx +116 -0
- package/.docs/organized/docs/integrations/salesforce-saml.mdx +4 -4
- package/.docs/organized/docs/integrations/saml.mdx +43 -23
- package/.docs/organized/docs/integrations/scim.mdx +36 -24
- package/.docs/organized/docs/integrations/sftp.mdx +59 -36
- package/.docs/organized/docs/integrations/shibboleth-generic-saml.mdx +1 -1
- package/.docs/organized/docs/integrations/shibboleth-unsolicited-saml.mdx +1 -1
- package/.docs/organized/docs/integrations/simple-saml-php.mdx +2 -2
- package/.docs/organized/docs/integrations/slack-oauth.mdx +53 -49
- package/.docs/organized/docs/integrations/supabase-authkit.mdx +46 -0
- package/.docs/organized/docs/integrations/{supabase.mdx → supabase-sso.mdx} +6 -4
- package/.docs/organized/docs/integrations/vercel-oauth.mdx +120 -0
- package/.docs/organized/docs/integrations/vmware-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/workday.mdx +1 -1
- package/.docs/organized/docs/integrations/xero-oauth.mdx +77 -32
- package/.docs/organized/docs/magic-link/example-apps.mdx +11 -11
- package/.docs/organized/docs/magic-link/index.mdx +2 -0
- package/.docs/organized/docs/mfa/example-apps.mdx +2 -2
- package/.docs/organized/docs/mfa/index.mdx +2 -2
- package/.docs/organized/docs/mfa/ux/enrollment.mdx +1 -1
- package/.docs/organized/docs/mfa/ux/sign-in.mdx +1 -1
- package/.docs/organized/docs/migrate/_navigation.mdx +21 -1
- package/.docs/organized/docs/migrate/auth0.mdx +5 -5
- package/.docs/organized/docs/migrate/aws-cognito.mdx +5 -5
- package/.docs/organized/docs/migrate/better-auth.mdx +282 -0
- package/.docs/organized/docs/migrate/clerk.mdx +9 -11
- package/.docs/organized/docs/migrate/descope.mdx +290 -0
- package/.docs/organized/docs/migrate/firebase.mdx +4 -4
- package/.docs/organized/docs/migrate/other-services.mdx +25 -6
- package/.docs/organized/docs/migrate/standalone-sso.mdx +14 -14
- package/.docs/organized/docs/migrate/stytch.mdx +363 -0
- package/.docs/organized/docs/migrate/supabase.mdx +255 -0
- package/.docs/organized/docs/on-prem-deployment.mdx +1 -1
- package/.docs/organized/docs/pipes/_navigation.mdx +12 -0
- package/.docs/organized/docs/pipes/index.mdx +75 -0
- package/.docs/organized/docs/pipes/providers.mdx +9 -0
- package/.docs/organized/docs/rbac/_navigation.mdx +16 -0
- package/.docs/organized/docs/rbac/configuration.mdx +80 -0
- package/.docs/organized/docs/rbac/idp-role-assignment.mdx +79 -0
- package/.docs/organized/docs/rbac/index.mdx +24 -0
- package/.docs/organized/docs/rbac/integration.mdx +59 -0
- package/.docs/organized/docs/rbac/organization-roles.mdx +38 -0
- package/.docs/organized/docs/rbac/quick-start.mdx +52 -0
- package/.docs/organized/docs/reference/_navigation.mdx +437 -284
- package/.docs/organized/docs/reference/admin-portal/portal-link/index.mdx +1 -1
- package/.docs/organized/docs/reference/admin-portal/provider-icons/index.mdx +3 -3
- package/.docs/organized/docs/reference/{api-keys.mdx → api-authentication/index.mdx} +3 -3
- package/.docs/organized/docs/reference/audit-logs/configuration/index.mdx +97 -0
- package/.docs/organized/docs/reference/audit-logs/{create-event.mdx → event/create.mdx} +12 -2
- package/.docs/organized/docs/reference/audit-logs/event/index.mdx +92 -0
- package/.docs/organized/docs/reference/audit-logs/{create-export.mdx → export/create.mdx} +1 -1
- package/.docs/organized/docs/reference/audit-logs/{get-export.mdx → export/get.mdx} +1 -1
- package/.docs/organized/docs/reference/audit-logs/{audit-log-export.mdx → export/index.mdx} +11 -12
- package/.docs/organized/docs/reference/audit-logs/{get-retention.mdx → retention/get.mdx} +1 -1
- package/.docs/organized/docs/reference/audit-logs/retention/index.mdx +25 -0
- package/.docs/organized/docs/reference/audit-logs/{set-retention.mdx → retention/set.mdx} +1 -1
- package/.docs/organized/docs/reference/audit-logs/{create-schema.mdx → schema/create.mdx} +1 -1
- package/.docs/organized/docs/reference/audit-logs/{audit-log-schema.mdx → schema/index.mdx} +5 -6
- package/.docs/organized/docs/reference/audit-logs/{list-actions.mdx → schema/list-actions.mdx} +2 -1
- package/.docs/organized/docs/reference/audit-logs/{list-schemas.mdx → schema/list.mdx} +1 -1
- package/.docs/organized/docs/reference/authkit/api-keys/create-for-organization.mdx +40 -0
- package/.docs/organized/docs/reference/authkit/api-keys/delete.mdx +23 -0
- package/.docs/organized/docs/reference/authkit/api-keys/index.mdx +275 -0
- package/.docs/organized/docs/reference/authkit/api-keys/list-for-organization.mdx +41 -0
- package/.docs/organized/docs/reference/authkit/api-keys/validate.mdx +77 -0
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/code.mdx +138 -18
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/email-verification.mdx +10 -10
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/get-authorization-url/error-codes.mdx +3 -3
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/get-authorization-url/index.mdx +64 -17
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/get-authorization-url/pkce.mdx +2 -2
- package/.docs/organized/docs/reference/authkit/authentication/get-authorization-url/redirect-uri.mdx +47 -0
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/index.mdx +19 -11
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/magic-auth.mdx +9 -9
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/organization-selection.mdx +9 -9
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/password.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/refresh-and-seal-session-data.mdx +3 -3
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/refresh-token.mdx +17 -17
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/session-cookie.mdx +7 -3
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/totp.mdx +10 -10
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/email-verification-required-error.mdx +3 -3
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/index.mdx +1 -3
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/mfa-challenge-error.mdx +3 -3
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/mfa-enrollment-error.mdx +3 -3
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/organization-authentication-required-error.mdx +3 -3
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/organization-selection-error.mdx +3 -4
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/sso-required-error.mdx +3 -3
- package/.docs/organized/docs/reference/authkit/cli-auth/device-authorization.mdx +61 -0
- package/.docs/organized/docs/reference/authkit/cli-auth/device-code.mdx +57 -0
- package/.docs/organized/docs/reference/authkit/cli-auth/error-codes.mdx +31 -0
- package/.docs/organized/docs/reference/authkit/cli-auth/index.mdx +22 -0
- package/.docs/organized/docs/reference/{user-management → authkit}/email-verification/get.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/email-verification/index.mdx +9 -11
- package/.docs/organized/docs/reference/{user-management → authkit}/identity/index.mdx +6 -9
- package/.docs/organized/docs/reference/{user-management → authkit}/identity/list.mdx +5 -6
- package/.docs/organized/docs/reference/authkit/index.mdx +13 -0
- package/.docs/organized/docs/reference/{user-management → authkit}/invitation/accept.mdx +5 -5
- package/.docs/organized/docs/reference/{user-management → authkit}/invitation/find-by-token.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/invitation/get.mdx +8 -9
- package/.docs/organized/docs/reference/{user-management → authkit}/invitation/index.mdx +10 -15
- package/.docs/organized/docs/reference/{user-management → authkit}/invitation/list.mdx +10 -11
- package/.docs/organized/docs/reference/authkit/invitation/resend.mdx +109 -0
- package/.docs/organized/docs/reference/{user-management → authkit}/invitation/revoke.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/invitation/send.mdx +23 -13
- package/.docs/organized/docs/reference/{user-management → authkit}/logout/get-logout-url-from-session-cookie.mdx +2 -2
- package/.docs/organized/docs/reference/{user-management → authkit}/logout/get-logout-url.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/logout/index.mdx +4 -5
- package/.docs/organized/docs/reference/{user-management → authkit}/magic-auth/create.mdx +10 -10
- package/.docs/organized/docs/reference/{user-management → authkit}/magic-auth/get.mdx +9 -10
- package/.docs/organized/docs/reference/{user-management → authkit}/magic-auth/index.mdx +10 -15
- package/.docs/organized/docs/reference/{user-management → authkit}/mfa/authentication-challenge.mdx +9 -10
- package/.docs/organized/docs/reference/{user-management → authkit}/mfa/authentication-factor.mdx +11 -11
- package/.docs/organized/docs/reference/{user-management → authkit}/mfa/enroll-auth-factor.mdx +19 -15
- package/.docs/organized/docs/reference/authkit/mfa/index.mdx +11 -0
- package/.docs/organized/docs/reference/{user-management → authkit}/mfa/list-auth-factors.mdx +9 -9
- package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/create.mdx +27 -10
- package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/deactivate.mdx +10 -10
- package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/delete.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/get.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/index.mdx +107 -14
- package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/list.mdx +10 -10
- package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/reactivate.mdx +11 -11
- package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/update.mdx +25 -9
- package/.docs/organized/docs/reference/{user-management → authkit}/password-reset/create.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/password-reset/get.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/password-reset/index.mdx +10 -12
- package/.docs/organized/docs/reference/{user-management → authkit}/password-reset/reset-password.mdx +8 -8
- package/.docs/organized/docs/reference/authkit/session/index.mdx +128 -0
- package/.docs/organized/docs/reference/authkit/session/list.mdx +110 -0
- package/.docs/organized/docs/reference/authkit/session/revoke.mdx +73 -0
- package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/authenticate.mdx +22 -6
- package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/get-logout-url.mdx +5 -5
- package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/index.mdx +2 -2
- package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/load-sealed-session.mdx +4 -4
- package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/refresh.mdx +18 -6
- package/.docs/organized/docs/reference/{user-management → authkit}/session-tokens/access-token.mdx +16 -8
- package/.docs/organized/docs/reference/authkit/session-tokens/index.mdx +5 -0
- package/.docs/organized/docs/reference/{user-management → authkit}/session-tokens/jwks.mdx +8 -8
- package/.docs/organized/docs/reference/authkit/session-tokens/refresh-token.mdx +8 -0
- package/.docs/organized/docs/reference/{user-management → authkit}/user/create.mdx +36 -17
- package/.docs/organized/docs/reference/{user-management → authkit}/user/delete.mdx +8 -9
- package/.docs/organized/docs/reference/{user-management → authkit}/user/get-by-external-id.mdx +16 -4
- package/.docs/organized/docs/reference/{user-management → authkit}/user/get.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/user/index.mdx +25 -15
- package/.docs/organized/docs/reference/{user-management → authkit}/user/list.mdx +9 -12
- package/.docs/organized/docs/reference/{user-management → authkit}/user/update.mdx +43 -20
- package/.docs/organized/docs/reference/{client-libraries.mdx → client-libraries/index.mdx} +2 -2
- package/.docs/organized/docs/reference/directory-sync/directory/index.mdx +1 -1
- package/.docs/organized/docs/reference/directory-sync/directory-group/index.mdx +1 -24
- package/.docs/organized/docs/reference/directory-sync/directory-user/index.mdx +1 -29
- package/.docs/organized/docs/reference/directory-sync/directory-user/list.mdx +1 -1
- package/.docs/organized/docs/reference/directory-sync/index.mdx +1 -1
- package/.docs/organized/docs/reference/domain-verification/create.mdx +35 -0
- package/.docs/organized/docs/reference/domain-verification/delete.mdx +55 -0
- package/.docs/organized/docs/reference/domain-verification/get.mdx +29 -0
- package/.docs/organized/docs/reference/domain-verification/index.mdx +57 -1
- package/.docs/organized/docs/reference/domain-verification/verify.mdx +29 -0
- package/.docs/organized/docs/reference/{errors.mdx → errors/index.mdx} +1 -1
- package/.docs/organized/docs/reference/events/list.mdx +5 -4
- package/.docs/organized/docs/reference/feature-flags/flag/disable.mdx +33 -0
- package/.docs/organized/docs/reference/feature-flags/flag/enable.mdx +33 -0
- package/.docs/organized/docs/reference/feature-flags/flag/get.mdx +32 -0
- package/.docs/organized/docs/reference/feature-flags/flag/index.mdx +116 -0
- package/.docs/organized/docs/reference/feature-flags/flag/list.mdx +67 -0
- package/.docs/organized/docs/reference/feature-flags/index.mdx +123 -0
- package/.docs/organized/docs/reference/feature-flags/targeting/add.mdx +43 -0
- package/.docs/organized/docs/reference/feature-flags/targeting/index.mdx +23 -0
- package/.docs/organized/docs/reference/feature-flags/targeting/list-for-organization.mdx +132 -0
- package/.docs/organized/docs/reference/feature-flags/targeting/list-for-user.mdx +94 -0
- package/.docs/organized/docs/reference/feature-flags/targeting/remove.mdx +43 -0
- package/.docs/organized/docs/reference/fga/access-check/check.mdx +102 -0
- package/.docs/organized/docs/reference/fga/access-check/index.mdx +6 -0
- package/.docs/organized/docs/reference/fga/access-check/list-memberships-by-external-id.mdx +143 -0
- package/.docs/organized/docs/reference/fga/access-check/list-memberships.mdx +127 -0
- package/.docs/organized/docs/reference/fga/access-check/list-resources.mdx +152 -0
- package/.docs/organized/docs/reference/fga/index.mdx +14 -2
- package/.docs/organized/docs/reference/fga/resource/create.mdx +74 -88
- package/.docs/organized/docs/reference/fga/resource/delete-by-external-id.mdx +78 -0
- package/.docs/organized/docs/reference/fga/resource/delete.mdx +38 -62
- package/.docs/organized/docs/reference/fga/resource/get-by-external-id.mdx +60 -0
- package/.docs/organized/docs/reference/fga/resource/get.mdx +15 -63
- package/.docs/organized/docs/reference/fga/resource/index.mdx +74 -73
- package/.docs/organized/docs/reference/fga/resource/list.mdx +90 -131
- package/.docs/organized/docs/reference/fga/resource/update-by-external-id.mdx +81 -0
- package/.docs/organized/docs/reference/fga/resource/update.mdx +29 -85
- package/.docs/organized/docs/reference/fga/role-assignment/create.mdx +89 -0
- package/.docs/organized/docs/reference/fga/role-assignment/delete-by-id.mdx +59 -0
- package/.docs/organized/docs/reference/fga/role-assignment/delete.mdx +90 -0
- package/.docs/organized/docs/reference/fga/role-assignment/index.mdx +106 -0
- package/.docs/organized/docs/reference/fga/role-assignment/list.mdx +86 -0
- package/.docs/organized/docs/reference/index.mdx +21 -12
- package/.docs/organized/docs/reference/magic-link/passwordless-session/index.mdx +1 -1
- package/.docs/organized/docs/reference/mfa/{challenge-factor.mdx → challenge/create.mdx} +1 -1
- package/.docs/organized/docs/reference/mfa/{authentication-challenge.mdx → challenge/index.mdx} +11 -14
- package/.docs/organized/docs/reference/mfa/{verify-challenge.mdx → challenge/verify.mdx} +10 -12
- package/.docs/organized/docs/reference/mfa/{delete-factor.mdx → factor/delete.mdx} +1 -1
- package/.docs/organized/docs/reference/mfa/{enroll-factor.mdx → factor/enroll.mdx} +1 -1
- package/.docs/organized/docs/reference/mfa/{get-factor.mdx → factor/get.mdx} +1 -1
- package/.docs/organized/docs/reference/mfa/{authentication-factor.mdx → factor/index.mdx} +11 -12
- package/.docs/organized/docs/reference/organization/create.mdx +1 -6
- package/.docs/organized/docs/reference/organization/get-by-external-id.mdx +1 -1
- package/.docs/organized/docs/reference/organization/index.mdx +5 -5
- package/.docs/organized/docs/reference/organization/update.mdx +1 -1
- package/.docs/organized/docs/reference/{pagination.mdx → pagination/index.mdx} +1 -3
- package/.docs/organized/docs/reference/pipes/access-token/get.mdx +174 -0
- package/.docs/organized/docs/reference/pipes/access-token/index.mdx +44 -0
- package/.docs/organized/docs/reference/pipes/connected-account/delete.mdx +42 -0
- package/.docs/organized/docs/reference/pipes/connected-account/get-authorize-url.mdx +49 -0
- package/.docs/organized/docs/reference/pipes/connected-account/get.mdx +42 -0
- package/.docs/organized/docs/reference/pipes/connected-account/index.mdx +69 -0
- package/.docs/organized/docs/reference/pipes/index.mdx +8 -0
- package/.docs/organized/docs/reference/pipes/provider/index.mdx +70 -0
- package/.docs/organized/docs/reference/pipes/provider/list.mdx +47 -0
- package/.docs/organized/docs/reference/radar/attempts/index.mdx +1 -1
- package/.docs/organized/docs/reference/radar/lists/index.mdx +1 -1
- package/.docs/organized/docs/reference/rate-limits/index.mdx +56 -0
- package/.docs/organized/docs/reference/roles/index.mdx +12 -262
- package/.docs/organized/docs/reference/roles/organization-role/add-permission.mdx +75 -0
- package/.docs/organized/docs/reference/roles/organization-role/create.mdx +95 -0
- package/.docs/organized/docs/reference/roles/organization-role/delete.mdx +47 -0
- package/.docs/organized/docs/reference/roles/organization-role/get.mdx +55 -0
- package/.docs/organized/docs/reference/roles/organization-role/index.mdx +148 -0
- package/.docs/organized/docs/reference/roles/organization-role/list.mdx +68 -0
- package/.docs/organized/docs/reference/roles/organization-role/remove-permission.mdx +68 -0
- package/.docs/organized/docs/reference/roles/organization-role/set-permissions.mdx +79 -0
- package/.docs/organized/docs/reference/roles/organization-role/update.mdx +85 -0
- package/.docs/organized/docs/reference/roles/permission/create.mdx +101 -0
- package/.docs/organized/docs/reference/roles/permission/delete.mdx +38 -0
- package/.docs/organized/docs/reference/roles/permission/get.mdx +45 -0
- package/.docs/organized/docs/reference/roles/permission/index.mdx +128 -0
- package/.docs/organized/docs/reference/roles/permission/list.mdx +91 -0
- package/.docs/organized/docs/reference/roles/permission/update.mdx +80 -0
- package/.docs/organized/docs/reference/roles/role/add-permission.mdx +63 -0
- package/.docs/organized/docs/reference/roles/role/create.mdx +103 -0
- package/.docs/organized/docs/reference/roles/role/get.mdx +52 -0
- package/.docs/organized/docs/reference/roles/role/index.mdx +135 -0
- package/.docs/organized/docs/reference/roles/role/list.mdx +56 -0
- package/.docs/organized/docs/reference/roles/role/set-permissions.mdx +67 -0
- package/.docs/organized/docs/reference/roles/role/update.mdx +78 -0
- package/.docs/organized/docs/reference/sso/connection/index.mdx +2 -2
- package/.docs/organized/docs/reference/sso/get-authorization-url/error-codes.mdx +5 -3
- package/.docs/organized/docs/reference/sso/get-authorization-url/index.mdx +24 -2
- package/.docs/organized/docs/reference/sso/get-authorization-url/redirect-uri.mdx +25 -1
- package/.docs/organized/docs/reference/sso/index.mdx +1 -1
- package/.docs/organized/docs/reference/sso/logout/authorize.mdx +0 -1
- package/.docs/organized/docs/reference/sso/logout/index.mdx +1 -2
- package/.docs/organized/docs/reference/sso/logout/redirect.mdx +0 -1
- package/.docs/organized/docs/reference/sso/profile/get-profile-and-token.mdx +13 -1
- package/.docs/organized/docs/reference/sso/profile/index.mdx +25 -24
- package/.docs/organized/docs/reference/{testing.mdx → testing/index.mdx} +1 -1
- package/.docs/organized/docs/reference/vault/key/create-data-key.mdx +29 -0
- package/.docs/organized/docs/reference/vault/key/decrypt-data-key.mdx +20 -0
- package/.docs/organized/docs/reference/vault/key/decrypt-data.mdx +24 -0
- package/.docs/organized/docs/reference/vault/key/encrypt-data.mdx +20 -0
- package/.docs/organized/docs/reference/vault/object/create.mdx +17 -0
- package/.docs/organized/docs/reference/vault/object/delete.mdx +12 -0
- package/.docs/organized/docs/reference/vault/object/get-by-name.mdx +61 -0
- package/.docs/organized/docs/reference/vault/object/get.mdx +11 -0
- package/.docs/organized/docs/reference/vault/object/index.mdx +50 -4
- package/.docs/organized/docs/reference/vault/object/list.mdx +40 -1
- package/.docs/organized/docs/reference/vault/object/update.mdx +18 -0
- package/.docs/organized/docs/reference/vault/object/version.mdx +15 -2
- package/.docs/organized/docs/reference/vault/object/versions.mdx +13 -0
- package/.docs/organized/docs/reference/widgets/get-token.mdx +8 -5
- package/.docs/organized/docs/reference/workos-connect/applications/client-secrets/create.mdx +55 -0
- package/.docs/organized/docs/reference/workos-connect/applications/client-secrets/delete.mdx +28 -0
- package/.docs/organized/docs/reference/workos-connect/applications/client-secrets/index.mdx +60 -0
- package/.docs/organized/docs/reference/workos-connect/applications/client-secrets/list.mdx +52 -0
- package/.docs/organized/docs/reference/workos-connect/applications/create.mdx +79 -0
- package/.docs/organized/docs/reference/workos-connect/applications/delete.mdx +28 -0
- package/.docs/organized/docs/reference/workos-connect/applications/get.mdx +59 -0
- package/.docs/organized/docs/reference/workos-connect/applications/index.mdx +40 -0
- package/.docs/organized/docs/reference/workos-connect/applications/list.mdx +49 -0
- package/.docs/organized/docs/reference/workos-connect/applications/m2m.mdx +52 -0
- package/.docs/organized/docs/reference/workos-connect/applications/oauth.mdx +85 -0
- package/.docs/organized/docs/reference/workos-connect/applications/update.mdx +59 -0
- package/.docs/organized/docs/reference/workos-connect/authorize/index.mdx +29 -1
- package/.docs/organized/docs/reference/workos-connect/cli-auth/authorize-device/index.mdx +81 -0
- package/.docs/organized/docs/reference/workos-connect/cli-auth/device-code-grant.mdx +74 -0
- package/.docs/organized/docs/reference/workos-connect/cli-auth/index.mdx +23 -0
- package/.docs/organized/docs/reference/workos-connect/index.mdx +1 -1
- package/.docs/organized/docs/reference/workos-connect/introspection/index.mdx +8 -3
- package/.docs/organized/docs/reference/workos-connect/metadata/index.mdx +1 -1
- package/.docs/organized/docs/reference/workos-connect/metadata/oauth-authorization-server/index.mdx +1 -1
- package/.docs/organized/docs/reference/workos-connect/standalone/complete.mdx +68 -0
- package/.docs/organized/docs/reference/workos-connect/standalone/index.mdx +9 -0
- package/.docs/organized/docs/reference/workos-connect/standalone/user-consent-options.mdx +41 -0
- package/.docs/organized/docs/reference/workos-connect/token/authorization-code-grant/access-token.mdx +6 -0
- package/.docs/organized/docs/reference/workos-connect/token/authorization-code-grant/id-token.mdx +1 -1
- package/.docs/organized/docs/reference/workos-connect/token/{authorization-code-grant/index.mdx → authorization-code-grant.mdx} +23 -2
- package/.docs/organized/docs/reference/workos-connect/token/client-credentials-grant/access-token.mdx +1 -1
- package/.docs/organized/docs/reference/workos-connect/token/{client-credentials-grant/index.mdx → client-credentials-grant.mdx} +2 -2
- package/.docs/organized/docs/reference/workos-connect/token/index.mdx +5 -4
- package/.docs/organized/docs/reference/workos-connect/token/refresh-token-grant.mdx +1 -1
- package/.docs/organized/docs/reference/workos-connect/userinfo/index.mdx +2 -2
- package/.docs/organized/docs/sdks/authkit-js.mdx +14 -0
- package/.docs/organized/docs/sdks/authkit-nextjs.mdx +14 -0
- package/.docs/organized/docs/sdks/authkit-react-router.mdx +14 -0
- package/.docs/organized/docs/sdks/authkit-react.mdx +14 -0
- package/.docs/organized/docs/sdks/authkit-remix.mdx +14 -0
- package/.docs/organized/docs/sdks/authkit-tanstack-start.mdx +14 -0
- package/.docs/organized/docs/sso/_navigation.mdx +8 -2
- package/.docs/organized/docs/sso/attributes.mdx +15 -3
- package/.docs/organized/docs/sso/domains.mdx +8 -6
- package/.docs/organized/docs/sso/example-apps.mdx +2 -2
- package/.docs/organized/docs/sso/identity-provider-role-assignment.mdx +30 -30
- package/.docs/organized/docs/sso/index.mdx +7 -6
- package/.docs/organized/docs/sso/it-team-faq.mdx +1 -1
- package/.docs/organized/docs/sso/jit-provisioning.mdx +2 -3
- package/.docs/organized/docs/sso/launch-checklist.mdx +2 -2
- package/.docs/organized/docs/sso/login-flows.mdx +3 -3
- package/.docs/organized/docs/sso/redirect-uris.mdx +22 -11
- package/.docs/organized/docs/sso/saml-security.mdx +1 -1
- package/.docs/organized/docs/sso/sign-in-consent.mdx +59 -0
- package/.docs/organized/docs/sso/signing-certificates.mdx +7 -7
- package/.docs/organized/docs/sso/single-logout.mdx +0 -1
- package/.docs/organized/docs/sso/ux/sessions.mdx +99 -0
- package/.docs/organized/docs/sso/ux/sign-in.mdx +1 -1
- package/.docs/organized/docs/vault/_navigation.mdx +2 -0
- package/.docs/organized/docs/vault/byok.mdx +140 -0
- package/.docs/organized/docs/vault/index.mdx +1 -1
- package/.docs/organized/docs/widgets/_navigation.mdx +48 -0
- package/.docs/organized/docs/widgets/admin-portal-domain-verification.mdx +24 -0
- package/.docs/organized/docs/widgets/admin-portal-sso-connection.mdx +20 -0
- package/.docs/organized/docs/widgets/api-keys.mdx +28 -0
- package/.docs/organized/docs/widgets/audit-log-streaming.mdx +25 -0
- package/.docs/organized/docs/widgets/directory-sync.mdx +23 -0
- package/.docs/organized/docs/widgets/index.mdx +12 -0
- package/.docs/organized/docs/widgets/localization.mdx +111 -0
- package/.docs/organized/docs/widgets/organization-switcher.mdx +47 -0
- package/.docs/organized/docs/widgets/pipes.mdx +27 -0
- package/.docs/organized/docs/widgets/quick-start.mdx +38 -0
- package/.docs/organized/docs/widgets/styling/css-customization.mdx +100 -0
- package/.docs/organized/docs/widgets/styling/index.mdx +29 -0
- package/.docs/organized/docs/widgets/styling/theme-customization.mdx +51 -0
- package/.docs/organized/docs/widgets/tokens.mdx +17 -0
- package/.docs/organized/docs/widgets/user-management.mdx +28 -0
- package/.docs/organized/docs/widgets/user-profile.mdx +30 -0
- package/.docs/organized/docs/widgets/user-security.mdx +31 -0
- package/.docs/organized/docs/widgets/user-sessions.mdx +26 -0
- package/LICENSE +21 -0
- package/README.md +14 -1
- package/dist/prepare.js +1 -1
- package/dist/prepare.js.map +1 -1
- package/package.json +2 -1
- package/.docs/organized/docs/dashboard.mdx +0 -244
- package/.docs/organized/docs/demo/_navigation.mdx +0 -26
- package/.docs/organized/docs/demo/accordion.mdx +0 -34
- package/.docs/organized/docs/demo/checklist.mdx +0 -33
- package/.docs/organized/docs/demo/code-block.mdx +0 -185
- package/.docs/organized/docs/demo/definition-list.mdx +0 -35
- package/.docs/organized/docs/demo/index.mdx +0 -7
- package/.docs/organized/docs/demo/punctuation.mdx +0 -37
- package/.docs/organized/docs/demo/replacements.mdx +0 -26
- package/.docs/organized/docs/demo/table.mdx +0 -26
- package/.docs/organized/docs/demo/tabs.mdx +0 -17
- package/.docs/organized/docs/fga/identity-provider-sessions.mdx +0 -68
- package/.docs/organized/docs/fga/local-development.mdx +0 -155
- package/.docs/organized/docs/fga/modeling/abac.mdx +0 -107
- package/.docs/organized/docs/fga/modeling/blocklist.mdx +0 -84
- package/.docs/organized/docs/fga/modeling/conditional-roles.mdx +0 -99
- package/.docs/organized/docs/fga/modeling/custom-roles.mdx +0 -90
- package/.docs/organized/docs/fga/modeling/entitlements.mdx +0 -127
- package/.docs/organized/docs/fga/modeling/managed-service-provider.mdx +0 -131
- package/.docs/organized/docs/fga/modeling/org-roles-and-permissions.mdx +0 -95
- package/.docs/organized/docs/fga/modeling/policy-context.mdx +0 -231
- package/.docs/organized/docs/fga/modeling/public-access.mdx +0 -61
- package/.docs/organized/docs/fga/modeling/shareable-content.mdx +0 -106
- package/.docs/organized/docs/fga/modeling/superusers.mdx +0 -74
- package/.docs/organized/docs/fga/modeling/user-groups.mdx +0 -92
- package/.docs/organized/docs/fga/operations-usage.mdx +0 -104
- package/.docs/organized/docs/fga/playground.mdx +0 -12
- package/.docs/organized/docs/fga/policies.mdx +0 -462
- package/.docs/organized/docs/fga/query-language.mdx +0 -112
- package/.docs/organized/docs/fga/schema-management.mdx +0 -224
- package/.docs/organized/docs/fga/schema.mdx +0 -388
- package/.docs/organized/docs/fga/warrant-tokens.mdx +0 -44
- package/.docs/organized/docs/fga/warrants.mdx +0 -92
- package/.docs/organized/docs/reference/fga/batch-check.mdx +0 -277
- package/.docs/organized/docs/reference/fga/check.mdx +0 -563
- package/.docs/organized/docs/reference/fga/policy/create.mdx +0 -27
- package/.docs/organized/docs/reference/fga/policy/delete.mdx +0 -18
- package/.docs/organized/docs/reference/fga/policy/get.mdx +0 -23
- package/.docs/organized/docs/reference/fga/policy/index.mdx +0 -52
- package/.docs/organized/docs/reference/fga/policy/list.mdx +0 -41
- package/.docs/organized/docs/reference/fga/policy/update.mdx +0 -26
- package/.docs/organized/docs/reference/fga/query.mdx +0 -375
- package/.docs/organized/docs/reference/fga/resource/batch-write.mdx +0 -175
- package/.docs/organized/docs/reference/fga/resource-type/apply.mdx +0 -35
- package/.docs/organized/docs/reference/fga/resource-type/create.mdx +0 -24
- package/.docs/organized/docs/reference/fga/resource-type/delete.mdx +0 -22
- package/.docs/organized/docs/reference/fga/resource-type/get.mdx +0 -23
- package/.docs/organized/docs/reference/fga/resource-type/index.mdx +0 -68
- package/.docs/organized/docs/reference/fga/resource-type/list.mdx +0 -36
- package/.docs/organized/docs/reference/fga/resource-type/update.mdx +0 -23
- package/.docs/organized/docs/reference/fga/schema/apply.mdx +0 -42
- package/.docs/organized/docs/reference/fga/schema/get.mdx +0 -24
- package/.docs/organized/docs/reference/fga/schema/index.mdx +0 -39
- package/.docs/organized/docs/reference/fga/warrant/batch-write.mdx +0 -226
- package/.docs/organized/docs/reference/fga/warrant/create.mdx +0 -215
- package/.docs/organized/docs/reference/fga/warrant/delete.mdx +0 -212
- package/.docs/organized/docs/reference/fga/warrant/index.mdx +0 -186
- package/.docs/organized/docs/reference/fga/warrant/list.mdx +0 -282
- package/.docs/organized/docs/reference/idempotency.mdx +0 -21
- package/.docs/organized/docs/reference/organization-domain.mdx +0 -189
- package/.docs/organized/docs/reference/rate-limits.mdx +0 -50
- package/.docs/organized/docs/reference/roles/list-for-organization.mdx +0 -152
- package/.docs/organized/docs/reference/user-management/access-token/index.mdx +0 -13
- package/.docs/organized/docs/reference/user-management/authentication/get-authorization-url/redirect-uri.mdx +0 -23
- package/.docs/organized/docs/reference/user-management/index.mdx +0 -13
- package/.docs/organized/docs/reference/user-management/mfa/index.mdx +0 -5
- package/.docs/organized/docs/reference/user-management/session-tokens/index.mdx +0 -5
- package/.docs/organized/docs/reference/user-management/session-tokens/refresh-token.mdx +0 -8
- package/.docs/organized/docs/user-management/_navigation.mdx +0 -87
- package/.docs/organized/docs/user-management/authkit.mdx +0 -69
- package/.docs/organized/docs/user-management/connect.mdx +0 -110
- package/.docs/organized/docs/user-management/directory-provisioning.mdx +0 -78
- package/.docs/organized/docs/user-management/email-verification.mdx +0 -29
- package/.docs/organized/docs/user-management/entitlements.mdx +0 -46
- package/.docs/organized/docs/user-management/jit-provisioning.mdx +0 -36
- package/.docs/organized/docs/user-management/overview.mdx +0 -46
- package/.docs/organized/docs/user-management/roles-and-permissions.mdx +0 -155
- package/.docs/organized/docs/user-management/users-organizations.mdx +0 -91
- package/.docs/organized/docs/user-management/widgets.mdx +0 -190
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
reference:
|
|
3
|
-
curl:
|
|
4
|
-
- key: get_resource_type
|
|
5
|
-
id: get_resource_type
|
|
6
|
-
url: /reference/fga/resource-types/get
|
|
7
|
-
title: '/fga/v1/resource-types/:type'
|
|
8
|
-
type: GET
|
|
9
|
-
parameters:
|
|
10
|
-
- (resource_type.type)
|
|
11
|
-
returns:
|
|
12
|
-
- (resource_type)
|
|
13
|
-
originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource-type/get.mdx
|
|
14
|
-
---
|
|
15
|
-
|
|
16
|
-
## Get a resource type
|
|
17
|
-
|
|
18
|
-
Get the definition of an existing resource type.
|
|
19
|
-
|
|
20
|
-
<CodeBlock referenceId="get_resource_type">
|
|
21
|
-
<CodeBlockTab title="Request" file="get-resource-type-request" />
|
|
22
|
-
<CodeBlockTab title="Response" file="get-resource-type-response" />
|
|
23
|
-
</CodeBlock>
|
|
@@ -1,68 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
descriptions:
|
|
3
|
-
resource_type:
|
|
4
|
-
type: Unique string ID of the resource type.
|
|
5
|
-
relations:
|
|
6
|
-
allowed_types: List of resource types that can have this relationship.
|
|
7
|
-
inherit_if: >-
|
|
8
|
-
Relation that must be inherited from the parent resource type for this
|
|
9
|
-
relationship to be inherited. Can also be any_of, all_of, or none_of for
|
|
10
|
-
logical combinations of relations.
|
|
11
|
-
of_type: >-
|
|
12
|
-
Resource type that this relationship is inherited from.Use this field to
|
|
13
|
-
define resource inheritance rules.
|
|
14
|
-
with_relation: >-
|
|
15
|
-
Relation that must exist on the parent resource type for this
|
|
16
|
-
relationship to be inherited. Use this field to define resource
|
|
17
|
-
inheritance rules.
|
|
18
|
-
rules: >-
|
|
19
|
-
Rules that define how the relationship is inherited from other resource
|
|
20
|
-
types. Rules are recursively defined with the same type as relations.
|
|
21
|
-
policy: The policy name that this relationship is inherited from.
|
|
22
|
-
relation: Name of relationship that resources can have on resources of this type.
|
|
23
|
-
reference:
|
|
24
|
-
curl:
|
|
25
|
-
- url: /reference/fga/resource-type
|
|
26
|
-
key: resource_type
|
|
27
|
-
id: resource_type
|
|
28
|
-
title: resource_type
|
|
29
|
-
properties:
|
|
30
|
-
- key: type
|
|
31
|
-
type: string
|
|
32
|
-
description: (resource_type.type)
|
|
33
|
-
- key: relations
|
|
34
|
-
type: object
|
|
35
|
-
unwrap: true
|
|
36
|
-
properties:
|
|
37
|
-
- key: allowed_types
|
|
38
|
-
type: array
|
|
39
|
-
description: (resource_type.relations.allowed_types)
|
|
40
|
-
- key: inherit_if
|
|
41
|
-
type: string
|
|
42
|
-
description: (resource_type.relations.inherit_if)
|
|
43
|
-
- key: of_type
|
|
44
|
-
type: string
|
|
45
|
-
description: (resource_type.relations.of_type)
|
|
46
|
-
- key: with_relation
|
|
47
|
-
type: string
|
|
48
|
-
description: (resource_type.relations.with_relation)
|
|
49
|
-
- key: rules
|
|
50
|
-
type: array
|
|
51
|
-
description: (resource_type.relations.rules)
|
|
52
|
-
- key: policy
|
|
53
|
-
type: string
|
|
54
|
-
description: (resource_type.relations.policy)
|
|
55
|
-
originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource-type/index.mdx
|
|
56
|
-
---
|
|
57
|
-
|
|
58
|
-
---
|
|
59
|
-
|
|
60
|
-
# Resource Type
|
|
61
|
-
|
|
62
|
-
Represents a type of resource and its possible relationships in your application. See [Resource Types](/fga/schema/schema-syntax/resource-types) to learn more about relation rules. See [JSON Syntax](/fga/schema/schema-syntax) for more examples.
|
|
63
|
-
|
|
64
|
-
<CodeBlock
|
|
65
|
-
title="Resource Type"
|
|
66
|
-
referenceId="resource_type"
|
|
67
|
-
file="resource_type"
|
|
68
|
-
/>
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
descriptions:
|
|
3
|
-
list_resource_types:
|
|
4
|
-
data: 'Array of [Resource Types](/reference/fga/resource-type).'
|
|
5
|
-
reference:
|
|
6
|
-
curl:
|
|
7
|
-
- key: list_resource_types
|
|
8
|
-
id: list_resource_types
|
|
9
|
-
url: /reference/resource-types/list
|
|
10
|
-
title: /fga/v1/resource-types
|
|
11
|
-
type: GET
|
|
12
|
-
parameters:
|
|
13
|
-
- (limit)
|
|
14
|
-
- (before)
|
|
15
|
-
- (after)
|
|
16
|
-
- (order)
|
|
17
|
-
returns:
|
|
18
|
-
- key: data
|
|
19
|
-
type: array
|
|
20
|
-
description: (list_resource_types.data)
|
|
21
|
-
- key: list_metadata
|
|
22
|
-
type: object
|
|
23
|
-
properties:
|
|
24
|
-
- (before)
|
|
25
|
-
- (after)
|
|
26
|
-
originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource-type/list.mdx
|
|
27
|
-
---
|
|
28
|
-
|
|
29
|
-
## List resource types
|
|
30
|
-
|
|
31
|
-
Get a list of all your existing resource types matching the criteria specified.
|
|
32
|
-
|
|
33
|
-
<CodeBlock referenceId="list_resource_types">
|
|
34
|
-
<CodeBlockTab title="Request" file="list-resource-types-request" />
|
|
35
|
-
<CodeBlockTab title="Response" file="list-resource-types-response" />
|
|
36
|
-
</CodeBlock>
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
reference:
|
|
3
|
-
curl:
|
|
4
|
-
- key: update_resource_type
|
|
5
|
-
id: update_resource_type
|
|
6
|
-
url: '/reference/fga/resource-types/:type'
|
|
7
|
-
title: /fga/v1/resource-types
|
|
8
|
-
type: PUT
|
|
9
|
-
parameters:
|
|
10
|
-
- (resource_type.relations)
|
|
11
|
-
returns:
|
|
12
|
-
- (resource_type)
|
|
13
|
-
originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource-type/update.mdx
|
|
14
|
-
---
|
|
15
|
-
|
|
16
|
-
## Update a resource type
|
|
17
|
-
|
|
18
|
-
Update properties of a resource type.
|
|
19
|
-
|
|
20
|
-
<CodeBlock referenceId="update_resource_type">
|
|
21
|
-
<CodeBlockTab title="Request" file="update-resource-type-request" />
|
|
22
|
-
<CodeBlockTab title="Response" file="update-resource-type-response" />
|
|
23
|
-
</CodeBlock>
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
reference:
|
|
3
|
-
curl:
|
|
4
|
-
- key: apply_schema
|
|
5
|
-
id: apply_schema
|
|
6
|
-
url: /reference/fga/schema/apply
|
|
7
|
-
title: /fga/v1/schema
|
|
8
|
-
type: POST
|
|
9
|
-
parameters:
|
|
10
|
-
- key: resource_types
|
|
11
|
-
type: array
|
|
12
|
-
expanded: true
|
|
13
|
-
properties:
|
|
14
|
-
- (resource_type.type)
|
|
15
|
-
- (resource_type.relations)
|
|
16
|
-
- key: policies
|
|
17
|
-
type: object
|
|
18
|
-
expanded: true
|
|
19
|
-
properties:
|
|
20
|
-
- (policy.name)
|
|
21
|
-
- (policy.description)
|
|
22
|
-
- (policy.language)
|
|
23
|
-
- (policy.parameters)
|
|
24
|
-
- (policy.expression)
|
|
25
|
-
returns:
|
|
26
|
-
- key: schema
|
|
27
|
-
url: /reference/fga/schema
|
|
28
|
-
id: fga_schema
|
|
29
|
-
title: schema
|
|
30
|
-
originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/schema/apply.mdx
|
|
31
|
-
---
|
|
32
|
-
|
|
33
|
-
## Apply schema
|
|
34
|
-
|
|
35
|
-
Sets resource types and policies in the current environment.
|
|
36
|
-
|
|
37
|
-
> This endpoint performs a batch operation which will override your entire schema for the environment. Any existing resource types and policies not included in the request will be deleted.
|
|
38
|
-
|
|
39
|
-
<CodeBlock referenceId="apply_schema">
|
|
40
|
-
<CodeBlockTab title="Request" file="apply-schema-request" />
|
|
41
|
-
<CodeBlockTab title="Response" file="apply-schema-response" />
|
|
42
|
-
</CodeBlock>
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
reference:
|
|
3
|
-
curl:
|
|
4
|
-
- key: get_schema
|
|
5
|
-
id: get_schema
|
|
6
|
-
url: /reference/fga/schema/get
|
|
7
|
-
title: /fga/v1/schema
|
|
8
|
-
type: GET
|
|
9
|
-
returns:
|
|
10
|
-
- key: schema
|
|
11
|
-
url: /reference/fga/schema
|
|
12
|
-
id: fga_schema
|
|
13
|
-
title: schema
|
|
14
|
-
originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/schema/get.mdx
|
|
15
|
-
---
|
|
16
|
-
|
|
17
|
-
## Get a schema
|
|
18
|
-
|
|
19
|
-
Get the authorization model for your current environment.
|
|
20
|
-
|
|
21
|
-
<CodeBlock referenceId="get_schema">
|
|
22
|
-
<CodeBlockTab title="Request" file="get-schema-request" />
|
|
23
|
-
<CodeBlockTab title="Response" file="get-schema-response" />
|
|
24
|
-
</CodeBlock>
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
descriptions:
|
|
3
|
-
schema:
|
|
4
|
-
self: 'The FGA [Schema](/reference/fga/schema).'
|
|
5
|
-
reference:
|
|
6
|
-
curl:
|
|
7
|
-
- key: schema
|
|
8
|
-
url: /reference/fga/schema
|
|
9
|
-
id: fga_schema
|
|
10
|
-
title: schema
|
|
11
|
-
properties:
|
|
12
|
-
- key: version
|
|
13
|
-
type: string
|
|
14
|
-
description: The version of the transpiler used to convert to schema language.
|
|
15
|
-
- key: resource_types
|
|
16
|
-
type: array
|
|
17
|
-
description: 'Array of [Resource Types](/reference/fga/resource-type).'
|
|
18
|
-
unwrap: true
|
|
19
|
-
properties:
|
|
20
|
-
- (resource_type.type)
|
|
21
|
-
- (resource_type.relations)
|
|
22
|
-
- key: policies
|
|
23
|
-
type: object
|
|
24
|
-
description: 'Array of [Policies](/reference/fga/policy).'
|
|
25
|
-
unwrap: true
|
|
26
|
-
properties:
|
|
27
|
-
- (policy.name)
|
|
28
|
-
- (policy.description)
|
|
29
|
-
- (policy.language)
|
|
30
|
-
- (policy.parameters)
|
|
31
|
-
- (policy.expression)
|
|
32
|
-
originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/schema/index.mdx
|
|
33
|
-
---
|
|
34
|
-
|
|
35
|
-
# Schema
|
|
36
|
-
|
|
37
|
-
Represents the authorization model in your FGA environment. Includes resource type definitions and policies that define how authorization checks are processed.
|
|
38
|
-
|
|
39
|
-
<CodeBlock title="Schema" referenceId="schema" file="schema" />
|
|
@@ -1,226 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
reference:
|
|
3
|
-
curl:
|
|
4
|
-
- key: batch_write_warrants
|
|
5
|
-
id: batch_write_warrants
|
|
6
|
-
url: /reference/fga/warrants/batch-write
|
|
7
|
-
title: /fga/v1/warrants
|
|
8
|
-
type: POST
|
|
9
|
-
parameters:
|
|
10
|
-
- key: warrants
|
|
11
|
-
type: array
|
|
12
|
-
expanded: true
|
|
13
|
-
properties:
|
|
14
|
-
- key: op
|
|
15
|
-
type: '"create" | "delete"'
|
|
16
|
-
optional: true
|
|
17
|
-
description: (write_warrant.op)
|
|
18
|
-
- (warrant.resource_type)
|
|
19
|
-
- (warrant.resource_id)
|
|
20
|
-
- (warrant.relation)
|
|
21
|
-
- (warrant.subject)
|
|
22
|
-
- (warrant.policy)
|
|
23
|
-
returns:
|
|
24
|
-
- key: warrant_token
|
|
25
|
-
type: string
|
|
26
|
-
description: (warrant.warrant_token)
|
|
27
|
-
js:
|
|
28
|
-
- key: batchWriteWarrants
|
|
29
|
-
id: batch_write_warrants
|
|
30
|
-
url: /reference/fga/warrants/batch-write
|
|
31
|
-
title: fga.batchWriteWarrants()
|
|
32
|
-
parameters:
|
|
33
|
-
- key: warrants
|
|
34
|
-
type: array
|
|
35
|
-
expanded: true
|
|
36
|
-
properties:
|
|
37
|
-
- key: op
|
|
38
|
-
type: '"create" | "delete"'
|
|
39
|
-
optional: true
|
|
40
|
-
description: (write_warrant.op)
|
|
41
|
-
- key: resourceType
|
|
42
|
-
type: string
|
|
43
|
-
description: (warrant.resource_type)
|
|
44
|
-
- key: resourceId
|
|
45
|
-
type: string
|
|
46
|
-
description: (warrant.resource_id)
|
|
47
|
-
- key: relation
|
|
48
|
-
type: string
|
|
49
|
-
description: (warrant.relation)
|
|
50
|
-
- key: subject
|
|
51
|
-
type: object
|
|
52
|
-
unwrap: true
|
|
53
|
-
properties:
|
|
54
|
-
- key: resourceType
|
|
55
|
-
type: string
|
|
56
|
-
- key: resourceId
|
|
57
|
-
type: string
|
|
58
|
-
- key: relation
|
|
59
|
-
type: string
|
|
60
|
-
optional: true
|
|
61
|
-
- key: policy
|
|
62
|
-
type: string
|
|
63
|
-
optional: true
|
|
64
|
-
description: (warrant.policy)
|
|
65
|
-
returns:
|
|
66
|
-
- key: anonymous
|
|
67
|
-
type: object
|
|
68
|
-
unwrap: true
|
|
69
|
-
properties:
|
|
70
|
-
- key: warrantToken
|
|
71
|
-
type: string
|
|
72
|
-
description: (warrant.warrant_token)
|
|
73
|
-
go:
|
|
74
|
-
- key: BatchWriteWarrants
|
|
75
|
-
id: batch_write_warrants
|
|
76
|
-
url: /reference/fga/warrants/batch-write
|
|
77
|
-
title: fga.BatchWriteWarrants()
|
|
78
|
-
parameters:
|
|
79
|
-
- (ctx)
|
|
80
|
-
- key: opts
|
|
81
|
-
type: array
|
|
82
|
-
expanded: true
|
|
83
|
-
properties:
|
|
84
|
-
- key: opts
|
|
85
|
-
type: fga.WriteWarrantOpts
|
|
86
|
-
unwrap: true
|
|
87
|
-
properties:
|
|
88
|
-
- key: Op
|
|
89
|
-
type: '"create" | "delete"'
|
|
90
|
-
optional: true
|
|
91
|
-
description: (write_warrant.op)
|
|
92
|
-
- key: ResourceType
|
|
93
|
-
type: string
|
|
94
|
-
description: (warrant.resource_type)
|
|
95
|
-
- key: ResourceId
|
|
96
|
-
type: string
|
|
97
|
-
description: (warrant.resource_id)
|
|
98
|
-
- key: Relation
|
|
99
|
-
type: string
|
|
100
|
-
description: (warrant.relation)
|
|
101
|
-
- key: Subject
|
|
102
|
-
type: fga.Subject
|
|
103
|
-
unwrap: true
|
|
104
|
-
properties:
|
|
105
|
-
- key: ResourceType
|
|
106
|
-
type: string
|
|
107
|
-
- key: ResourceId
|
|
108
|
-
type: string
|
|
109
|
-
- key: Relation
|
|
110
|
-
type: string
|
|
111
|
-
optional: true
|
|
112
|
-
- key: Policy
|
|
113
|
-
type: string
|
|
114
|
-
optional: true
|
|
115
|
-
description: (warrant.policy)
|
|
116
|
-
returns:
|
|
117
|
-
- key: response
|
|
118
|
-
type: fga.WriteWarrantResponse
|
|
119
|
-
unwrap: true
|
|
120
|
-
properties:
|
|
121
|
-
- key: WarrantToken
|
|
122
|
-
type: string
|
|
123
|
-
description: (warrant.warrant_token)
|
|
124
|
-
java:
|
|
125
|
-
- key: batchWriteWarrants
|
|
126
|
-
id: batch_write_warrants
|
|
127
|
-
url: /reference/fga/warrants/batch-write
|
|
128
|
-
title: fga.batchWriteWarrants()
|
|
129
|
-
parameters:
|
|
130
|
-
- key: options
|
|
131
|
-
type: List<WriteWarrantOptions>
|
|
132
|
-
expanded: true
|
|
133
|
-
properties:
|
|
134
|
-
- key: op
|
|
135
|
-
type: '"create" | "delete"'
|
|
136
|
-
optional: true
|
|
137
|
-
description: (write_warrant.op)
|
|
138
|
-
- key: resourceType
|
|
139
|
-
type: String
|
|
140
|
-
description: (warrant.resource_type)
|
|
141
|
-
- key: resourceId
|
|
142
|
-
type: String
|
|
143
|
-
description: (warrant.resource_id)
|
|
144
|
-
- key: relation
|
|
145
|
-
type: String
|
|
146
|
-
description: (warrant.relation)
|
|
147
|
-
- key: subject
|
|
148
|
-
type: Subject
|
|
149
|
-
unwrap: true
|
|
150
|
-
properties:
|
|
151
|
-
- key: resourceType
|
|
152
|
-
type: String
|
|
153
|
-
- key: resourceId
|
|
154
|
-
type: String
|
|
155
|
-
- key: relation
|
|
156
|
-
type: String
|
|
157
|
-
optional: true
|
|
158
|
-
- key: policy
|
|
159
|
-
type: String
|
|
160
|
-
optional: true
|
|
161
|
-
description: (warrant.policy)
|
|
162
|
-
returns:
|
|
163
|
-
- key: response
|
|
164
|
-
type: WriteWarrantResponse
|
|
165
|
-
unwrap: true
|
|
166
|
-
properties:
|
|
167
|
-
- key: warrantToken
|
|
168
|
-
type: String
|
|
169
|
-
description: (warrant.warrant_token)
|
|
170
|
-
python:
|
|
171
|
-
- key: batch_write_warrants
|
|
172
|
-
id: batch_write_warrants
|
|
173
|
-
url: /reference/fga/warrants/batch-write
|
|
174
|
-
title: fga.batch_write_warrants()
|
|
175
|
-
parameters:
|
|
176
|
-
- key: warrants
|
|
177
|
-
type: 'List[WriteWarrantOptions]'
|
|
178
|
-
expanded: true
|
|
179
|
-
properties:
|
|
180
|
-
- key: op
|
|
181
|
-
type: '"create" | "delete"'
|
|
182
|
-
optional: true
|
|
183
|
-
description: (write_warrant.op)
|
|
184
|
-
- key: resource_type
|
|
185
|
-
type: str
|
|
186
|
-
description: (warrant.resource_type)
|
|
187
|
-
- key: resource_id
|
|
188
|
-
type: str
|
|
189
|
-
description: (warrant.resource_id)
|
|
190
|
-
- key: relation
|
|
191
|
-
type: str
|
|
192
|
-
description: (warrant.relation)
|
|
193
|
-
- key: subject
|
|
194
|
-
type: Subject
|
|
195
|
-
unwrap: true
|
|
196
|
-
properties:
|
|
197
|
-
- key: resource_type
|
|
198
|
-
type: str
|
|
199
|
-
- key: resource_id
|
|
200
|
-
type: str
|
|
201
|
-
- key: relation
|
|
202
|
-
type: str
|
|
203
|
-
optional: true
|
|
204
|
-
- key: policy
|
|
205
|
-
type: str
|
|
206
|
-
optional: true
|
|
207
|
-
description: (warrant.policy)
|
|
208
|
-
returns:
|
|
209
|
-
- key: response
|
|
210
|
-
type: fga.WriteWarrantResponse
|
|
211
|
-
unwrap: true
|
|
212
|
-
properties:
|
|
213
|
-
- key: warrant_token
|
|
214
|
-
type: str
|
|
215
|
-
description: (warrant.warrant_token)
|
|
216
|
-
originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/warrant/batch-write.mdx
|
|
217
|
-
---
|
|
218
|
-
|
|
219
|
-
## Batch Write Warrants
|
|
220
|
-
|
|
221
|
-
Executes a batch of warrant writes in the current environment.
|
|
222
|
-
|
|
223
|
-
<CodeBlock referenceId="batch_write_warrants">
|
|
224
|
-
<CodeBlockTab title="Request" file="batch-write-warrants-request" />
|
|
225
|
-
<CodeBlockTab title="Response" file="batch-write-warrants-response" />
|
|
226
|
-
</CodeBlock>
|
|
@@ -1,215 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
descriptions:
|
|
3
|
-
write_warrant:
|
|
4
|
-
op: >-
|
|
5
|
-
Operation to perform for the given warrant (`create`/`delete`). Defaults
|
|
6
|
-
to `create` if not provided.
|
|
7
|
-
reference:
|
|
8
|
-
curl:
|
|
9
|
-
- key: create_warrant
|
|
10
|
-
id: create_warrant
|
|
11
|
-
url: /reference/fga/warrants/create
|
|
12
|
-
title: /fga/v1/warrants
|
|
13
|
-
type: POST
|
|
14
|
-
parameters:
|
|
15
|
-
- key: op
|
|
16
|
-
type: '"create"'
|
|
17
|
-
optional: true
|
|
18
|
-
description: (write_warrant.op)
|
|
19
|
-
- (warrant.resource_type)
|
|
20
|
-
- (warrant.resource_id)
|
|
21
|
-
- (warrant.relation)
|
|
22
|
-
- (warrant.subject)
|
|
23
|
-
- (warrant.policy)
|
|
24
|
-
returns:
|
|
25
|
-
- key: anonymous
|
|
26
|
-
type: object
|
|
27
|
-
unwrap: true
|
|
28
|
-
properties:
|
|
29
|
-
- key: warrant_token
|
|
30
|
-
type: string
|
|
31
|
-
description: (warrant.warrant_token)
|
|
32
|
-
js:
|
|
33
|
-
- key: createWarrant
|
|
34
|
-
id: create_warrant
|
|
35
|
-
url: /reference/fga/warrants/create
|
|
36
|
-
title: fga.writeWarrant()
|
|
37
|
-
parameters:
|
|
38
|
-
- key: options
|
|
39
|
-
type: object
|
|
40
|
-
unwrap: true
|
|
41
|
-
properties:
|
|
42
|
-
- key: op
|
|
43
|
-
type: '"create"'
|
|
44
|
-
optional: true
|
|
45
|
-
description: (write_warrant.op)
|
|
46
|
-
- key: resourceType
|
|
47
|
-
type: string
|
|
48
|
-
description: (warrant.resource_type)
|
|
49
|
-
- key: resourceId
|
|
50
|
-
type: string
|
|
51
|
-
description: (warrant.resource_id)
|
|
52
|
-
- key: relation
|
|
53
|
-
type: string
|
|
54
|
-
description: (warrant.relation)
|
|
55
|
-
- key: subject
|
|
56
|
-
type: object
|
|
57
|
-
unwrap: true
|
|
58
|
-
properties:
|
|
59
|
-
- key: resourceType
|
|
60
|
-
type: string
|
|
61
|
-
- key: resourceId
|
|
62
|
-
type: string
|
|
63
|
-
- key: relation
|
|
64
|
-
type: string
|
|
65
|
-
optional: true
|
|
66
|
-
- key: policy
|
|
67
|
-
type: string
|
|
68
|
-
optional: true
|
|
69
|
-
description: (warrant.policy)
|
|
70
|
-
returns:
|
|
71
|
-
- key: anonymous
|
|
72
|
-
type: object
|
|
73
|
-
unwrap: true
|
|
74
|
-
properties:
|
|
75
|
-
- key: warrantToken
|
|
76
|
-
type: string
|
|
77
|
-
description: (warrant.warrant_token)
|
|
78
|
-
go:
|
|
79
|
-
- key: CreateWarrant
|
|
80
|
-
id: create_warrant
|
|
81
|
-
url: /reference/fga/warrants/create
|
|
82
|
-
title: fga.WriteWarrant()
|
|
83
|
-
parameters:
|
|
84
|
-
- (ctx)
|
|
85
|
-
- key: opts
|
|
86
|
-
type: fga.WriteWarrantOpts
|
|
87
|
-
expanded: true
|
|
88
|
-
properties:
|
|
89
|
-
- key: Op
|
|
90
|
-
type: '"create"'
|
|
91
|
-
optional: true
|
|
92
|
-
description: (write_warrant.op)
|
|
93
|
-
- key: ResourceType
|
|
94
|
-
type: string
|
|
95
|
-
description: (warrant.resource_type)
|
|
96
|
-
- key: ResourceId
|
|
97
|
-
type: string
|
|
98
|
-
description: (warrant.resource_id)
|
|
99
|
-
- key: Relation
|
|
100
|
-
type: string
|
|
101
|
-
description: (warrant.relation)
|
|
102
|
-
- key: Subject
|
|
103
|
-
type: fga.Subject
|
|
104
|
-
unwrap: true
|
|
105
|
-
properties:
|
|
106
|
-
- key: ResourceType
|
|
107
|
-
type: string
|
|
108
|
-
- key: ResourceId
|
|
109
|
-
type: string
|
|
110
|
-
- key: Relation
|
|
111
|
-
type: string
|
|
112
|
-
optional: true
|
|
113
|
-
- key: Policy
|
|
114
|
-
type: string
|
|
115
|
-
optional: true
|
|
116
|
-
description: (warrant.policy)
|
|
117
|
-
returns:
|
|
118
|
-
- key: response
|
|
119
|
-
type: fga.WriteWarrantResponse
|
|
120
|
-
unwrap: true
|
|
121
|
-
properties:
|
|
122
|
-
- key: WarrantToken
|
|
123
|
-
type: string
|
|
124
|
-
description: (warrant.warrant_token)
|
|
125
|
-
java:
|
|
126
|
-
- key: createWarrant
|
|
127
|
-
id: create_warrant
|
|
128
|
-
url: /reference/fga/warrants/create
|
|
129
|
-
title: fga.WriteWarrant()
|
|
130
|
-
parameters:
|
|
131
|
-
- key: options
|
|
132
|
-
type: CreateWarrantOptions
|
|
133
|
-
expanded: true
|
|
134
|
-
properties:
|
|
135
|
-
- key: resourceType
|
|
136
|
-
type: String
|
|
137
|
-
description: (warrant.resource_type)
|
|
138
|
-
- key: resourceId
|
|
139
|
-
type: String
|
|
140
|
-
description: (warrant.resource_id)
|
|
141
|
-
- key: relation
|
|
142
|
-
type: String
|
|
143
|
-
description: (warrant.relation)
|
|
144
|
-
- key: subject
|
|
145
|
-
type: Subject
|
|
146
|
-
unwrap: true
|
|
147
|
-
properties:
|
|
148
|
-
- key: resourceType
|
|
149
|
-
type: String
|
|
150
|
-
- key: resourceId
|
|
151
|
-
type: String
|
|
152
|
-
- key: relation
|
|
153
|
-
type: String
|
|
154
|
-
optional: true
|
|
155
|
-
- key: policy
|
|
156
|
-
type: String
|
|
157
|
-
optional: true
|
|
158
|
-
description: (warrant.policy)
|
|
159
|
-
returns:
|
|
160
|
-
- key: response
|
|
161
|
-
type: WriteWarrantResponse
|
|
162
|
-
unwrap: true
|
|
163
|
-
properties:
|
|
164
|
-
- key: warrantToken
|
|
165
|
-
type: String
|
|
166
|
-
description: (warrant.warrant_token)
|
|
167
|
-
python:
|
|
168
|
-
- key: create_warrant
|
|
169
|
-
id: create_warrant
|
|
170
|
-
url: /reference/fga/warrants/create
|
|
171
|
-
title: fga.write_warrant()
|
|
172
|
-
parameters:
|
|
173
|
-
- key: op
|
|
174
|
-
type: '"create"'
|
|
175
|
-
optional: true
|
|
176
|
-
description: (write_warrant.op)
|
|
177
|
-
- key: subject_type
|
|
178
|
-
type: str
|
|
179
|
-
- key: subject_id
|
|
180
|
-
type: str
|
|
181
|
-
- key: subject_relation
|
|
182
|
-
type: str
|
|
183
|
-
optional: true
|
|
184
|
-
- key: relation
|
|
185
|
-
type: str
|
|
186
|
-
description: (warrant.relation)
|
|
187
|
-
- key: resource_type
|
|
188
|
-
type: str
|
|
189
|
-
description: (warrant.resource_type)
|
|
190
|
-
- key: resource_id
|
|
191
|
-
type: str
|
|
192
|
-
description: (warrant.resource_id)
|
|
193
|
-
- key: policy
|
|
194
|
-
type: str
|
|
195
|
-
optional: true
|
|
196
|
-
description: (warrant.policy)
|
|
197
|
-
returns:
|
|
198
|
-
- key: response
|
|
199
|
-
type: WriteWarrantResponse
|
|
200
|
-
unwrap: true
|
|
201
|
-
properties:
|
|
202
|
-
- key: warrant_token
|
|
203
|
-
type: str
|
|
204
|
-
description: (warrant.warrant_token)
|
|
205
|
-
originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/warrant/create.mdx
|
|
206
|
-
---
|
|
207
|
-
|
|
208
|
-
## Create a warrant
|
|
209
|
-
|
|
210
|
-
Creates a new warrant in the current environment.
|
|
211
|
-
|
|
212
|
-
<CodeBlock referenceId="create_warrant">
|
|
213
|
-
<CodeBlockTab title="Request" file="create-warrant-request" />
|
|
214
|
-
<CodeBlockTab title="Response" file="create-warrant-response" />
|
|
215
|
-
</CodeBlock>
|