@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
|
@@ -2,259 +2,261 @@
|
|
|
2
2
|
title: API Reference
|
|
3
3
|
links:
|
|
4
4
|
- title: Overview
|
|
5
|
-
url: /reference
|
|
6
|
-
- title: Client libraries
|
|
7
|
-
url: /reference/client-libraries
|
|
8
|
-
- title: Testing
|
|
9
|
-
url: /reference/testing
|
|
10
|
-
- title: API Keys
|
|
11
|
-
url: /reference/api-keys
|
|
12
|
-
- title: Errors
|
|
13
|
-
url: /reference/errors
|
|
14
|
-
- title: Pagination
|
|
15
|
-
url: /reference/pagination
|
|
16
|
-
- title: Idempotency
|
|
17
|
-
url: /reference/idempotency
|
|
18
|
-
- title: Rate limits
|
|
19
|
-
url: /reference/rate-limits
|
|
20
|
-
- title: Events
|
|
21
5
|
links:
|
|
22
|
-
- title:
|
|
23
|
-
url: /reference
|
|
24
|
-
- title:
|
|
25
|
-
url: /reference/
|
|
26
|
-
|
|
6
|
+
- title: Getting started
|
|
7
|
+
url: /reference
|
|
8
|
+
- title: Client libraries
|
|
9
|
+
url: /reference/client-libraries
|
|
10
|
+
- title: Testing
|
|
11
|
+
url: /reference/testing
|
|
12
|
+
- title: API authentication
|
|
13
|
+
url: /reference/api-authentication
|
|
14
|
+
- title: Errors
|
|
15
|
+
url: /reference/errors
|
|
16
|
+
- title: Pagination
|
|
17
|
+
url: /reference/pagination
|
|
18
|
+
- title: Rate limits
|
|
19
|
+
url: /reference/rate-limits
|
|
20
|
+
- title: Admin Portal
|
|
27
21
|
links:
|
|
28
|
-
- title:
|
|
29
|
-
url: /reference/
|
|
22
|
+
- title: Overview
|
|
23
|
+
url: /reference/admin-portal
|
|
24
|
+
- title: Portal Link
|
|
25
|
+
url: /reference/admin-portal/portal-link
|
|
30
26
|
links:
|
|
31
|
-
- title:
|
|
32
|
-
url: /reference/
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
url: /reference/organization/list
|
|
37
|
-
- title: Create an Organization
|
|
38
|
-
url: /reference/organization/create
|
|
39
|
-
- title: Update an Organization
|
|
40
|
-
url: /reference/organization/update
|
|
41
|
-
- title: Delete an Organization
|
|
42
|
-
url: /reference/organization/delete
|
|
43
|
-
- title: Organization Domain
|
|
44
|
-
url: /reference/organization-domain
|
|
45
|
-
- title: Roles
|
|
27
|
+
- title: Generate a Portal Link
|
|
28
|
+
url: /reference/admin-portal/portal-link/generate
|
|
29
|
+
- title: Provider Icons
|
|
30
|
+
url: /reference/admin-portal/provider-icons
|
|
31
|
+
- title: Audit Logs
|
|
46
32
|
links:
|
|
47
|
-
- title:
|
|
48
|
-
url: /reference/
|
|
33
|
+
- title: Overview
|
|
34
|
+
url: /reference/audit-logs
|
|
35
|
+
- title: Event
|
|
36
|
+
url: /reference/audit-logs/event
|
|
49
37
|
links:
|
|
50
|
-
- title:
|
|
51
|
-
url: /reference/
|
|
52
|
-
|
|
38
|
+
- title: Create Event
|
|
39
|
+
url: /reference/audit-logs/event/create
|
|
40
|
+
- title: Schema
|
|
41
|
+
url: /reference/audit-logs/schema
|
|
42
|
+
links:
|
|
43
|
+
- title: Create Schema
|
|
44
|
+
url: /reference/audit-logs/schema/create
|
|
45
|
+
- title: List Schemas
|
|
46
|
+
url: /reference/audit-logs/schema/list
|
|
47
|
+
- title: List Actions
|
|
48
|
+
url: /reference/audit-logs/schema/list-actions
|
|
49
|
+
- title: Export
|
|
50
|
+
url: /reference/audit-logs/export
|
|
51
|
+
links:
|
|
52
|
+
- title: Create Export
|
|
53
|
+
url: /reference/audit-logs/export/create
|
|
54
|
+
- title: Get Export
|
|
55
|
+
url: /reference/audit-logs/export/get
|
|
56
|
+
- title: Retention
|
|
57
|
+
url: /reference/audit-logs/retention
|
|
58
|
+
links:
|
|
59
|
+
- title: Get Retention
|
|
60
|
+
url: /reference/audit-logs/retention/get
|
|
61
|
+
- title: Set Retention
|
|
62
|
+
url: /reference/audit-logs/retention/set
|
|
63
|
+
- title: Configuration
|
|
64
|
+
url: /reference/audit-logs/configuration
|
|
65
|
+
- title: AuthKit
|
|
53
66
|
links:
|
|
54
67
|
- title: Overview
|
|
55
|
-
url: /reference/
|
|
68
|
+
url: /reference/authkit
|
|
56
69
|
- title: User
|
|
57
|
-
url: /reference/
|
|
70
|
+
url: /reference/authkit/user
|
|
58
71
|
links:
|
|
59
72
|
- title: Get a user
|
|
60
|
-
url: /reference/
|
|
73
|
+
url: /reference/authkit/user/get
|
|
61
74
|
- title: Get a user by external ID
|
|
62
|
-
url: /reference/
|
|
75
|
+
url: /reference/authkit/user/get-by-external-id
|
|
63
76
|
- title: List users
|
|
64
|
-
url: /reference/
|
|
77
|
+
url: /reference/authkit/user/list
|
|
65
78
|
- title: Create a user
|
|
66
|
-
url: /reference/
|
|
79
|
+
url: /reference/authkit/user/create
|
|
67
80
|
- title: Update a user
|
|
68
|
-
url: /reference/
|
|
81
|
+
url: /reference/authkit/user/update
|
|
69
82
|
- title: Delete a user
|
|
70
|
-
url: /reference/
|
|
83
|
+
url: /reference/authkit/user/delete
|
|
71
84
|
- title: Identity
|
|
72
|
-
url: /reference/
|
|
85
|
+
url: /reference/authkit/identity
|
|
73
86
|
links:
|
|
74
87
|
- title: List identities
|
|
75
|
-
url: /reference/
|
|
88
|
+
url: /reference/authkit/identity/list
|
|
76
89
|
- title: Authentication
|
|
77
|
-
url: /reference/
|
|
90
|
+
url: /reference/authkit/authentication
|
|
78
91
|
links:
|
|
79
92
|
- title: Get authorization URL
|
|
80
|
-
url: /reference/
|
|
93
|
+
url: /reference/authkit/authentication/get-authorization-url
|
|
81
94
|
links:
|
|
82
95
|
- title: Redirect URI
|
|
83
96
|
url: >-
|
|
84
|
-
/reference/
|
|
97
|
+
/reference/authkit/authentication/get-authorization-url/redirect-uri
|
|
85
98
|
- title: PKCE
|
|
86
|
-
url:
|
|
87
|
-
/reference/user-management/authentication/get-authorization-url/pkce
|
|
99
|
+
url: /reference/authkit/authentication/get-authorization-url/pkce
|
|
88
100
|
- title: Error codes
|
|
89
101
|
url: >-
|
|
90
|
-
/reference/
|
|
102
|
+
/reference/authkit/authentication/get-authorization-url/error-codes
|
|
91
103
|
- title: 'AuthKit, OAuth, SSO'
|
|
92
|
-
url: /reference/
|
|
104
|
+
url: /reference/authkit/authentication/code
|
|
93
105
|
- title: Password
|
|
94
|
-
url: /reference/
|
|
106
|
+
url: /reference/authkit/authentication/password
|
|
95
107
|
- title: Magic Auth
|
|
96
|
-
url: /reference/
|
|
108
|
+
url: /reference/authkit/authentication/magic-auth
|
|
97
109
|
- title: Refresh token
|
|
98
|
-
url: /reference/
|
|
110
|
+
url: /reference/authkit/authentication/refresh-token
|
|
99
111
|
- title: Email verification code
|
|
100
|
-
url: /reference/
|
|
112
|
+
url: /reference/authkit/authentication/email-verification
|
|
101
113
|
- title: TOTP code
|
|
102
|
-
url: /reference/
|
|
114
|
+
url: /reference/authkit/authentication/totp
|
|
103
115
|
- title: Organization selection
|
|
104
|
-
url: /reference/
|
|
116
|
+
url: /reference/authkit/authentication/organization-selection
|
|
105
117
|
- title: Session cookie
|
|
106
|
-
url: /reference/
|
|
118
|
+
url: /reference/authkit/authentication/session-cookie
|
|
107
119
|
- title: Refresh and seal session data
|
|
108
|
-
url:
|
|
109
|
-
/reference/user-management/authentication/refresh-and-seal-session-data
|
|
120
|
+
url: /reference/authkit/authentication/refresh-and-seal-session-data
|
|
110
121
|
- title: Session tokens
|
|
111
|
-
url: /reference/
|
|
122
|
+
url: /reference/authkit/session-tokens
|
|
112
123
|
links:
|
|
113
124
|
- title: JWKS
|
|
114
|
-
url: /reference/
|
|
125
|
+
url: /reference/authkit/session-tokens/jwks
|
|
115
126
|
- title: Access token
|
|
116
|
-
url: /reference/
|
|
127
|
+
url: /reference/authkit/session-tokens/access-token
|
|
117
128
|
- title: Refresh token
|
|
118
|
-
url: /reference/
|
|
129
|
+
url: /reference/authkit/session-tokens/refresh-token
|
|
130
|
+
- title: Session
|
|
131
|
+
url: /reference/authkit/session
|
|
132
|
+
links:
|
|
133
|
+
- title: List sessions
|
|
134
|
+
url: /reference/authkit/session/list
|
|
135
|
+
- title: Revoke session
|
|
136
|
+
url: /reference/authkit/session/revoke
|
|
119
137
|
- title: Session helpers
|
|
120
|
-
url: /reference/
|
|
138
|
+
url: /reference/authkit/session-helpers
|
|
121
139
|
links:
|
|
122
140
|
- title: Load sealed session
|
|
123
|
-
url: /reference/
|
|
141
|
+
url: /reference/authkit/session-helpers/load-sealed-session
|
|
124
142
|
- title: Authenticate
|
|
125
|
-
url: /reference/
|
|
143
|
+
url: /reference/authkit/session-helpers/authenticate
|
|
126
144
|
- title: Refresh
|
|
127
|
-
url: /reference/
|
|
145
|
+
url: /reference/authkit/session-helpers/refresh
|
|
128
146
|
- title: Get log out URL
|
|
129
|
-
url: /reference/
|
|
147
|
+
url: /reference/authkit/session-helpers/get-logout-url
|
|
130
148
|
- title: Authentication errors
|
|
131
|
-
url: /reference/
|
|
149
|
+
url: /reference/authkit/authentication-errors
|
|
132
150
|
links:
|
|
133
151
|
- title: Email verification
|
|
134
152
|
url: >-
|
|
135
|
-
/reference/
|
|
153
|
+
/reference/authkit/authentication-errors/email-verification-required-error
|
|
136
154
|
- title: MFA enrollment
|
|
137
|
-
url:
|
|
138
|
-
/reference/user-management/authentication-errors/mfa-enrollment-error
|
|
155
|
+
url: /reference/authkit/authentication-errors/mfa-enrollment-error
|
|
139
156
|
- title: MFA challenge
|
|
140
|
-
url:
|
|
141
|
-
/reference/user-management/authentication-errors/mfa-challenge-error
|
|
157
|
+
url: /reference/authkit/authentication-errors/mfa-challenge-error
|
|
142
158
|
- title: Organization selection
|
|
143
159
|
url: >-
|
|
144
|
-
/reference/
|
|
160
|
+
/reference/authkit/authentication-errors/organization-selection-error
|
|
145
161
|
- title: SSO required
|
|
146
|
-
url:
|
|
147
|
-
/reference/user-management/authentication-errors/sso-required-error
|
|
162
|
+
url: /reference/authkit/authentication-errors/sso-required-error
|
|
148
163
|
- title: Organization authentication required
|
|
149
164
|
url: >-
|
|
150
|
-
/reference/
|
|
165
|
+
/reference/authkit/authentication-errors/organization-authentication-required-error
|
|
151
166
|
- title: Magic Auth
|
|
152
|
-
url: /reference/
|
|
167
|
+
url: /reference/authkit/magic-auth
|
|
153
168
|
links:
|
|
154
|
-
- title: Get
|
|
155
|
-
url: /reference/
|
|
169
|
+
- title: Get Magic Auth code details
|
|
170
|
+
url: /reference/authkit/magic-auth/get
|
|
156
171
|
- title: Create a Magic Auth code
|
|
157
|
-
url: /reference/
|
|
172
|
+
url: /reference/authkit/magic-auth/create
|
|
158
173
|
- title: Multi-Factor Auth
|
|
159
|
-
url: /reference/
|
|
174
|
+
url: /reference/authkit/mfa
|
|
160
175
|
links:
|
|
161
176
|
- title: Authentication factor
|
|
162
|
-
url: /reference/
|
|
177
|
+
url: /reference/authkit/mfa/authentication-factor
|
|
163
178
|
- title: Authentication challenge
|
|
164
|
-
url: /reference/
|
|
179
|
+
url: /reference/authkit/mfa/authentication-challenge
|
|
165
180
|
- title: Enroll an auth factor
|
|
166
|
-
url: /reference/
|
|
181
|
+
url: /reference/authkit/mfa/enroll-auth-factor
|
|
167
182
|
- title: List auth factors
|
|
168
|
-
url: /reference/
|
|
183
|
+
url: /reference/authkit/mfa/list-auth-factors
|
|
169
184
|
- title: Email verification
|
|
170
|
-
url: /reference/
|
|
185
|
+
url: /reference/authkit/email-verification
|
|
171
186
|
links:
|
|
172
187
|
- title: Get an email verification code
|
|
173
|
-
url: /reference/
|
|
188
|
+
url: /reference/authkit/email-verification/get
|
|
174
189
|
- title: Password reset
|
|
175
|
-
url: /reference/
|
|
190
|
+
url: /reference/authkit/password-reset
|
|
176
191
|
links:
|
|
177
192
|
- title: Get a password reset token
|
|
178
|
-
url: /reference/
|
|
193
|
+
url: /reference/authkit/password-reset/get
|
|
179
194
|
- title: Create a password reset token
|
|
180
|
-
url: /reference/
|
|
195
|
+
url: /reference/authkit/password-reset/create
|
|
181
196
|
- title: Reset password
|
|
182
|
-
url: /reference/
|
|
197
|
+
url: /reference/authkit/password-reset/reset-password
|
|
183
198
|
- title: Organization membership
|
|
184
|
-
url: /reference/
|
|
199
|
+
url: /reference/authkit/organization-membership
|
|
185
200
|
links:
|
|
186
201
|
- title: Get membership
|
|
187
|
-
url: /reference/
|
|
202
|
+
url: /reference/authkit/organization-membership/get
|
|
188
203
|
- title: List memberships
|
|
189
|
-
url: /reference/
|
|
204
|
+
url: /reference/authkit/organization-membership/list
|
|
190
205
|
- title: Create membership
|
|
191
|
-
url: /reference/
|
|
206
|
+
url: /reference/authkit/organization-membership/create
|
|
192
207
|
- title: Update membership
|
|
193
|
-
url: /reference/
|
|
208
|
+
url: /reference/authkit/organization-membership/update
|
|
194
209
|
- title: Delete membership
|
|
195
|
-
url: /reference/
|
|
210
|
+
url: /reference/authkit/organization-membership/delete
|
|
196
211
|
- title: Deactivate membership
|
|
197
|
-
url: /reference/
|
|
212
|
+
url: /reference/authkit/organization-membership/deactivate
|
|
198
213
|
- title: Reactivate membership
|
|
199
|
-
url: /reference/
|
|
214
|
+
url: /reference/authkit/organization-membership/reactivate
|
|
200
215
|
- title: Invitation
|
|
201
|
-
url: /reference/
|
|
216
|
+
url: /reference/authkit/invitation
|
|
202
217
|
links:
|
|
203
218
|
- title: Get an invitation
|
|
204
|
-
url: /reference/
|
|
219
|
+
url: /reference/authkit/invitation/get
|
|
205
220
|
- title: Find an invitation by token
|
|
206
|
-
url: /reference/
|
|
221
|
+
url: /reference/authkit/invitation/find-by-token
|
|
207
222
|
- title: List invitations
|
|
208
|
-
url: /reference/
|
|
223
|
+
url: /reference/authkit/invitation/list
|
|
209
224
|
- title: Send an invitation
|
|
210
|
-
url: /reference/
|
|
225
|
+
url: /reference/authkit/invitation/send
|
|
226
|
+
- title: Resend an invitation
|
|
227
|
+
url: /reference/authkit/invitation/resend
|
|
211
228
|
- title: Accept an invitation
|
|
212
|
-
url: /reference/
|
|
229
|
+
url: /reference/authkit/invitation/accept
|
|
213
230
|
- title: Revoke an invitation
|
|
214
|
-
url: /reference/
|
|
231
|
+
url: /reference/authkit/invitation/revoke
|
|
215
232
|
- title: Logout
|
|
216
|
-
url: /reference/
|
|
233
|
+
url: /reference/authkit/logout
|
|
217
234
|
links:
|
|
218
235
|
- title: Get logout URL
|
|
219
|
-
url: /reference/
|
|
236
|
+
url: /reference/authkit/logout/get-logout-url
|
|
220
237
|
- title: Get logout URL from session cookie
|
|
221
|
-
url:
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
- title:
|
|
238
|
-
url: /reference/
|
|
239
|
-
- title:
|
|
240
|
-
url: /reference/
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
links:
|
|
244
|
-
- title: Get a Connection
|
|
245
|
-
url: /reference/sso/connection/get
|
|
246
|
-
- title: List Connections
|
|
247
|
-
url: /reference/sso/connection/list
|
|
248
|
-
- title: Delete a Connection
|
|
249
|
-
url: /reference/sso/connection/delete
|
|
250
|
-
- title: Logout
|
|
251
|
-
url: /reference/sso/logout
|
|
252
|
-
featureFlag: single-logout-docs
|
|
253
|
-
links:
|
|
254
|
-
- title: Logout Authorize
|
|
255
|
-
url: /reference/sso/logout/authorize
|
|
256
|
-
- title: Logout Redirect
|
|
257
|
-
url: /reference/sso/logout/redirect
|
|
238
|
+
url: /reference/authkit/logout/get-logout-url-from-session-cookie
|
|
239
|
+
- title: CLI Auth
|
|
240
|
+
url: /reference/authkit/cli-auth
|
|
241
|
+
links:
|
|
242
|
+
- title: Get device authorization URL
|
|
243
|
+
url: /reference/authkit/cli-auth/device-authorization
|
|
244
|
+
- title: Device code
|
|
245
|
+
url: /reference/authkit/cli-auth/device-code
|
|
246
|
+
links:
|
|
247
|
+
- title: Error codes
|
|
248
|
+
url: /reference/authkit/cli-auth/device-code/error-codes
|
|
249
|
+
- title: API Keys
|
|
250
|
+
url: /reference/authkit/api-keys
|
|
251
|
+
links:
|
|
252
|
+
- title: List organization API keys
|
|
253
|
+
url: /reference/authkit/api-keys/list-for-organization
|
|
254
|
+
- title: Create organization API key
|
|
255
|
+
url: /reference/authkit/api-keys/create-for-organization
|
|
256
|
+
- title: Delete API key
|
|
257
|
+
url: /reference/authkit/api-keys/delete
|
|
258
|
+
- title: Validate API key
|
|
259
|
+
url: /reference/authkit/api-keys/validate
|
|
258
260
|
- title: Directory Sync
|
|
259
261
|
links:
|
|
260
262
|
- title: Overview
|
|
@@ -282,40 +284,6 @@ links:
|
|
|
282
284
|
url: /reference/directory-sync/directory-group/get
|
|
283
285
|
- title: List Directory Groups
|
|
284
286
|
url: /reference/directory-sync/directory-group/list
|
|
285
|
-
- title: Admin Portal
|
|
286
|
-
links:
|
|
287
|
-
- title: Overview
|
|
288
|
-
url: /reference/admin-portal
|
|
289
|
-
- title: Portal Link
|
|
290
|
-
url: /reference/admin-portal/portal-link
|
|
291
|
-
- title: Generate a Portal Link
|
|
292
|
-
url: /reference/admin-portal/portal-link/generate
|
|
293
|
-
- title: Provider Icons
|
|
294
|
-
url: /reference/admin-portal/provider-icons
|
|
295
|
-
- title: Audit Logs
|
|
296
|
-
links:
|
|
297
|
-
- title: Overview
|
|
298
|
-
url: /reference/audit-logs
|
|
299
|
-
- title: Create Event
|
|
300
|
-
url: /reference/audit-logs/create-event
|
|
301
|
-
- title: Audit Log Schema
|
|
302
|
-
url: /reference/audit-logs/audit-log-schema
|
|
303
|
-
- title: Create Schema
|
|
304
|
-
url: /reference/audit-logs/create-schema
|
|
305
|
-
- title: List Schemas
|
|
306
|
-
url: /reference/audit-logs/list-schemas
|
|
307
|
-
- title: List Actions
|
|
308
|
-
url: /reference/audit-logs/list-actions
|
|
309
|
-
- title: Audit Log Export
|
|
310
|
-
url: /reference/audit-logs/audit-log-export
|
|
311
|
-
- title: Create Export
|
|
312
|
-
url: /reference/audit-logs/create-export
|
|
313
|
-
- title: Get Export
|
|
314
|
-
url: /reference/audit-logs/get-export
|
|
315
|
-
- title: Get Retention
|
|
316
|
-
url: /reference/audit-logs/get-retention
|
|
317
|
-
- title: Set Retention
|
|
318
|
-
url: /reference/audit-logs/set-retention
|
|
319
287
|
- title: Domain Verification
|
|
320
288
|
links:
|
|
321
289
|
- title: Organization Domain
|
|
@@ -327,99 +295,253 @@ links:
|
|
|
327
295
|
url: /reference/domain-verification/create
|
|
328
296
|
- title: Verify
|
|
329
297
|
url: /reference/domain-verification/verify
|
|
298
|
+
- title: Delete
|
|
299
|
+
url: /reference/domain-verification/delete
|
|
300
|
+
- title: Events
|
|
301
|
+
links:
|
|
302
|
+
- title: Event
|
|
303
|
+
url: /reference/events
|
|
304
|
+
links:
|
|
305
|
+
- title: List events
|
|
306
|
+
url: /reference/events/list
|
|
307
|
+
- title: Feature Flags
|
|
308
|
+
links:
|
|
309
|
+
- title: Overview
|
|
310
|
+
url: /reference/feature-flags
|
|
311
|
+
- title: Flag
|
|
312
|
+
url: /reference/feature-flags/flag
|
|
313
|
+
links:
|
|
314
|
+
- title: Get a feature flag
|
|
315
|
+
url: /reference/feature-flags/flag/get
|
|
316
|
+
- title: List feature flags
|
|
317
|
+
url: /reference/feature-flags/flag/list
|
|
318
|
+
- title: Enable flag
|
|
319
|
+
url: /reference/feature-flags/flag/enable
|
|
320
|
+
- title: Disable flag
|
|
321
|
+
url: /reference/feature-flags/flag/disable
|
|
322
|
+
- title: Targeting
|
|
323
|
+
url: /reference/feature-flags/targeting
|
|
324
|
+
links:
|
|
325
|
+
- title: List flags for an organization
|
|
326
|
+
url: /reference/feature-flags/targeting/list-for-organization
|
|
327
|
+
- title: List flags for a user
|
|
328
|
+
url: /reference/feature-flags/targeting/list-for-user
|
|
329
|
+
- title: Add flag target
|
|
330
|
+
url: /reference/feature-flags/targeting/add
|
|
331
|
+
- title: Remove flag target
|
|
332
|
+
url: /reference/feature-flags/targeting/remove
|
|
330
333
|
- title: Multi-Factor Auth
|
|
331
334
|
links:
|
|
332
|
-
- title:
|
|
333
|
-
url: /reference/mfa
|
|
334
|
-
- title:
|
|
335
|
-
url: /reference/mfa/
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
335
|
+
- title: Overview
|
|
336
|
+
url: /reference/mfa
|
|
337
|
+
- title: Factor
|
|
338
|
+
url: /reference/mfa/factor
|
|
339
|
+
links:
|
|
340
|
+
- title: Enroll Factor
|
|
341
|
+
url: /reference/mfa/factor/enroll
|
|
342
|
+
- title: Get Factor
|
|
343
|
+
url: /reference/mfa/factor/get
|
|
344
|
+
- title: Delete Factor
|
|
345
|
+
url: /reference/mfa/factor/delete
|
|
346
|
+
- title: Challenge
|
|
347
|
+
url: /reference/mfa/challenge
|
|
348
|
+
links:
|
|
349
|
+
- title: Create Challenge
|
|
350
|
+
url: /reference/mfa/challenge/create
|
|
351
|
+
- title: Verify Challenge
|
|
352
|
+
url: /reference/mfa/challenge/verify
|
|
353
|
+
- title: Organizations
|
|
354
|
+
links:
|
|
355
|
+
- title: Organization
|
|
356
|
+
url: /reference/organization
|
|
357
|
+
links:
|
|
358
|
+
- title: Get an Organization
|
|
359
|
+
url: /reference/organization/get
|
|
360
|
+
- title: Get an Organization by External ID
|
|
361
|
+
url: /reference/organization/get-by-external-id
|
|
362
|
+
- title: List Organizations
|
|
363
|
+
url: /reference/organization/list
|
|
364
|
+
- title: Create an Organization
|
|
365
|
+
url: /reference/organization/create
|
|
366
|
+
- title: Update an Organization
|
|
367
|
+
url: /reference/organization/update
|
|
368
|
+
- title: Delete an Organization
|
|
369
|
+
url: /reference/organization/delete
|
|
370
|
+
- title: Pipes
|
|
371
|
+
links:
|
|
372
|
+
- title: Overview
|
|
373
|
+
url: /reference/pipes
|
|
374
|
+
- title: Provider
|
|
375
|
+
url: /reference/pipes/provider
|
|
376
|
+
links:
|
|
377
|
+
- title: List providers
|
|
378
|
+
url: /reference/pipes/provider/list
|
|
379
|
+
- title: Connected Account
|
|
380
|
+
url: /reference/pipes/connected-account
|
|
381
|
+
links:
|
|
382
|
+
- title: Get authorization URL
|
|
383
|
+
url: /reference/pipes/connected-account/get-authorize-url
|
|
384
|
+
- title: Get a connected account
|
|
385
|
+
url: /reference/pipes/connected-account/get
|
|
386
|
+
- title: Delete a connected account
|
|
387
|
+
url: /reference/pipes/connected-account/delete
|
|
388
|
+
- title: Access Token
|
|
389
|
+
url: /reference/pipes/access-token
|
|
390
|
+
links:
|
|
391
|
+
- title: Get an access token
|
|
392
|
+
url: /reference/pipes/access-token/get
|
|
393
|
+
- title: Radar
|
|
394
|
+
links:
|
|
395
|
+
- title: Overview
|
|
396
|
+
url: /reference/radar
|
|
397
|
+
- title: Attempts
|
|
398
|
+
url: /reference/radar/attempts
|
|
399
|
+
links:
|
|
400
|
+
- title: Create attempt
|
|
401
|
+
url: /reference/radar/attempts/create
|
|
402
|
+
- title: Update attempt
|
|
403
|
+
url: /reference/radar/attempts/update
|
|
404
|
+
- title: Lists
|
|
405
|
+
url: /reference/radar/lists
|
|
406
|
+
links:
|
|
407
|
+
- title: Add entry
|
|
408
|
+
url: /reference/radar/lists/update
|
|
409
|
+
- title: Remove entry
|
|
410
|
+
url: /reference/radar/lists/delete
|
|
411
|
+
- title: Roles
|
|
412
|
+
featureFlag: rbac-api-docs
|
|
413
|
+
links:
|
|
414
|
+
- title: Overview
|
|
415
|
+
url: /reference/roles
|
|
416
|
+
- title: Environment Role
|
|
417
|
+
url: /reference/roles/role
|
|
418
|
+
links:
|
|
419
|
+
- title: List roles
|
|
420
|
+
url: /reference/roles/role/list
|
|
421
|
+
- title: Create a role
|
|
422
|
+
url: /reference/roles/role/create
|
|
423
|
+
- title: Get a role
|
|
424
|
+
url: /reference/roles/role/get
|
|
425
|
+
- title: Update a role
|
|
426
|
+
url: /reference/roles/role/update
|
|
427
|
+
- title: Set permissions
|
|
428
|
+
url: /reference/roles/role/set-permissions
|
|
429
|
+
- title: Add a permission
|
|
430
|
+
url: /reference/roles/role/add-permission
|
|
431
|
+
- title: Organization Role
|
|
432
|
+
url: /reference/roles/organization-role
|
|
433
|
+
links:
|
|
434
|
+
- title: List roles
|
|
435
|
+
url: /reference/roles/organization-role/list
|
|
436
|
+
- title: Create a role
|
|
437
|
+
url: /reference/roles/organization-role/create
|
|
438
|
+
- title: Get a role
|
|
439
|
+
url: /reference/roles/organization-role/get
|
|
440
|
+
- title: Update a role
|
|
441
|
+
url: /reference/roles/organization-role/update
|
|
442
|
+
- title: Delete a role
|
|
443
|
+
url: /reference/roles/organization-role/delete
|
|
444
|
+
- title: Set permissions
|
|
445
|
+
url: /reference/roles/organization-role/set-permissions
|
|
446
|
+
- title: Add a permission
|
|
447
|
+
url: /reference/roles/organization-role/add-permission
|
|
448
|
+
- title: Remove a permission
|
|
449
|
+
url: /reference/roles/organization-role/remove-permission
|
|
450
|
+
- title: Permissions
|
|
451
|
+
featureFlag: rbac-api-docs
|
|
452
|
+
links:
|
|
453
|
+
- title: Permission
|
|
454
|
+
url: /reference/roles/permission
|
|
455
|
+
links:
|
|
456
|
+
- title: List permissions
|
|
457
|
+
url: /reference/roles/permission/list
|
|
458
|
+
- title: Create a permission
|
|
459
|
+
url: /reference/roles/permission/create
|
|
460
|
+
- title: Get a permission
|
|
461
|
+
url: /reference/roles/permission/get
|
|
462
|
+
- title: Update a permission
|
|
463
|
+
url: /reference/roles/permission/update
|
|
464
|
+
- title: Delete a permission
|
|
465
|
+
url: /reference/roles/permission/delete
|
|
466
|
+
- title: FGA
|
|
347
467
|
links:
|
|
348
468
|
- title: Overview
|
|
349
469
|
url: /reference/fga
|
|
350
|
-
- title: Resource Type
|
|
351
|
-
url: /reference/fga/resource-type
|
|
352
|
-
links:
|
|
353
|
-
- title: Get a resource type
|
|
354
|
-
url: /reference/fga/resource-type/get
|
|
355
|
-
- title: List resource types
|
|
356
|
-
url: /reference/fga/resource-type/list
|
|
357
|
-
- title: Create a resource type
|
|
358
|
-
url: /reference/fga/resource-type/create
|
|
359
|
-
- title: Update a resource type
|
|
360
|
-
url: /reference/fga/resource-type/update
|
|
361
|
-
- title: Delete a resource type
|
|
362
|
-
url: /reference/fga/resource-type/delete
|
|
363
|
-
- title: Apply resource types
|
|
364
|
-
url: /reference/fga/resource-type/apply
|
|
365
|
-
- title: Warrant
|
|
366
|
-
url: /reference/fga/warrant
|
|
367
|
-
links:
|
|
368
|
-
- title: List warrants
|
|
369
|
-
url: /reference/fga/warrant/list
|
|
370
|
-
- title: Create a warrant
|
|
371
|
-
url: /reference/fga/warrant/create
|
|
372
|
-
- title: Delete a warrant
|
|
373
|
-
url: /reference/fga/warrant/delete
|
|
374
|
-
- title: Batch write warrants
|
|
375
|
-
url: /reference/fga/warrant/batch-write
|
|
376
470
|
- title: Resource
|
|
377
471
|
url: /reference/fga/resource
|
|
378
472
|
links:
|
|
379
|
-
- title: Get a resource
|
|
380
|
-
url: /reference/fga/resource/get
|
|
381
473
|
- title: List resources
|
|
382
474
|
url: /reference/fga/resource/list
|
|
383
475
|
- title: Create a resource
|
|
384
476
|
url: /reference/fga/resource/create
|
|
477
|
+
- title: Get a resource
|
|
478
|
+
url: /reference/fga/resource/get
|
|
479
|
+
- title: Get a resource by external ID
|
|
480
|
+
url: /reference/fga/resource/get-by-external-id
|
|
385
481
|
- title: Update a resource
|
|
386
482
|
url: /reference/fga/resource/update
|
|
483
|
+
- title: Update a resource by external ID
|
|
484
|
+
url: /reference/fga/resource/update-by-external-id
|
|
387
485
|
- title: Delete a resource
|
|
388
486
|
url: /reference/fga/resource/delete
|
|
389
|
-
- title:
|
|
390
|
-
url: /reference/fga/resource/
|
|
391
|
-
- title:
|
|
392
|
-
url: /reference/fga/
|
|
393
|
-
links:
|
|
394
|
-
- title:
|
|
395
|
-
url: /reference/fga/
|
|
396
|
-
- title:
|
|
397
|
-
url: /reference/fga/
|
|
398
|
-
- title:
|
|
399
|
-
url: /reference/fga/
|
|
400
|
-
- title:
|
|
401
|
-
url: /reference/fga/
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
url: /reference/fga/schema/get
|
|
415
|
-
- title: Apply schema
|
|
416
|
-
url: /reference/fga/schema/apply
|
|
417
|
-
- title: Widgets
|
|
487
|
+
- title: Delete a resource by external ID
|
|
488
|
+
url: /reference/fga/resource/delete-by-external-id
|
|
489
|
+
- title: Role Assignment
|
|
490
|
+
url: /reference/fga/role-assignment
|
|
491
|
+
links:
|
|
492
|
+
- title: List role assignments
|
|
493
|
+
url: /reference/fga/role-assignment/list
|
|
494
|
+
- title: Assign a role
|
|
495
|
+
url: /reference/fga/role-assignment/create
|
|
496
|
+
- title: Remove a role assignment
|
|
497
|
+
url: /reference/fga/role-assignment/delete
|
|
498
|
+
- title: Remove a role assignment by ID
|
|
499
|
+
url: /reference/fga/role-assignment/delete-by-id
|
|
500
|
+
- title: Access Checks
|
|
501
|
+
url: /reference/fga/access-check
|
|
502
|
+
links:
|
|
503
|
+
- title: Check authorization
|
|
504
|
+
url: /reference/fga/access-check/check
|
|
505
|
+
- title: List resources for membership
|
|
506
|
+
url: /reference/fga/access-check/list-resources
|
|
507
|
+
- title: List memberships for resource
|
|
508
|
+
url: /reference/fga/access-check/list-memberships
|
|
509
|
+
- title: List memberships by external ID
|
|
510
|
+
url: /reference/fga/access-check/list-memberships-by-external-id
|
|
511
|
+
- title: Single Sign-On
|
|
418
512
|
links:
|
|
419
513
|
- title: Overview
|
|
420
|
-
url: /reference/
|
|
421
|
-
- title: Get
|
|
422
|
-
url: /reference/
|
|
514
|
+
url: /reference/sso
|
|
515
|
+
- title: Get authorization URL
|
|
516
|
+
url: /reference/sso/get-authorization-url
|
|
517
|
+
links:
|
|
518
|
+
- title: Redirect URI
|
|
519
|
+
url: /reference/sso/get-authorization-url/redirect-uri
|
|
520
|
+
- title: Error codes
|
|
521
|
+
url: /reference/sso/get-authorization-url/error-codes
|
|
522
|
+
- title: Profile
|
|
523
|
+
url: /reference/sso/profile
|
|
524
|
+
links:
|
|
525
|
+
- title: Get a Profile and Token
|
|
526
|
+
url: /reference/sso/profile/get-profile-and-token
|
|
527
|
+
- title: Get a User Profile
|
|
528
|
+
url: /reference/sso/profile/get-user-profile
|
|
529
|
+
- title: Connection
|
|
530
|
+
url: /reference/sso/connection
|
|
531
|
+
links:
|
|
532
|
+
- title: Get a Connection
|
|
533
|
+
url: /reference/sso/connection/get
|
|
534
|
+
- title: List Connections
|
|
535
|
+
url: /reference/sso/connection/list
|
|
536
|
+
- title: Delete a Connection
|
|
537
|
+
url: /reference/sso/connection/delete
|
|
538
|
+
- title: Logout
|
|
539
|
+
url: /reference/sso/logout
|
|
540
|
+
links:
|
|
541
|
+
- title: Logout Authorize
|
|
542
|
+
url: /reference/sso/logout/authorize
|
|
543
|
+
- title: Logout Redirect
|
|
544
|
+
url: /reference/sso/logout/redirect
|
|
423
545
|
- title: Vault
|
|
424
546
|
links:
|
|
425
547
|
- title: Overview
|
|
@@ -431,6 +553,8 @@ links:
|
|
|
431
553
|
url: /reference/vault/object/create
|
|
432
554
|
- title: Get an object
|
|
433
555
|
url: /reference/vault/object/get
|
|
556
|
+
- title: Get an object by name
|
|
557
|
+
url: /reference/vault/object/get-by-name
|
|
434
558
|
- title: Update an object
|
|
435
559
|
url: /reference/vault/object/update
|
|
436
560
|
- title: Retrieve metadata
|
|
@@ -455,6 +579,13 @@ links:
|
|
|
455
579
|
url: /reference/vault/key/encrypt-data
|
|
456
580
|
- title: Decrypt data
|
|
457
581
|
url: /reference/vault/key/decrypt-data
|
|
582
|
+
- title: Widgets
|
|
583
|
+
links:
|
|
584
|
+
- title: Widget
|
|
585
|
+
url: /reference/widgets
|
|
586
|
+
links:
|
|
587
|
+
- title: Get Token
|
|
588
|
+
url: /reference/widgets/get-token
|
|
458
589
|
- title: WorkOS Connect
|
|
459
590
|
links:
|
|
460
591
|
- title: Overview
|
|
@@ -492,24 +623,46 @@ links:
|
|
|
492
623
|
url: /reference/workos-connect/metadata/openid-configuration
|
|
493
624
|
- title: OAuth Authorization Server
|
|
494
625
|
url: /reference/workos-connect/metadata/oauth-authorization-server
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
626
|
+
- title: CLI Auth
|
|
627
|
+
url: /reference/workos-connect/cli-auth
|
|
628
|
+
links:
|
|
629
|
+
- title: Authorize device
|
|
630
|
+
url: /reference/workos-connect/cli-auth/authorize-device
|
|
631
|
+
- title: Device code grant
|
|
632
|
+
url: /reference/workos-connect/cli-auth/device-code-grant
|
|
633
|
+
- title: Standalone
|
|
634
|
+
url: /reference/workos-connect/standalone
|
|
635
|
+
links:
|
|
636
|
+
- title: Complete
|
|
637
|
+
url: /reference/workos-connect/standalone/complete
|
|
638
|
+
- title: User Consent Options
|
|
639
|
+
url: /reference/workos-connect/standalone/user-consent-options
|
|
640
|
+
- title: Applications
|
|
641
|
+
url: /reference/workos-connect/applications
|
|
642
|
+
links:
|
|
643
|
+
- title: OAuth Applications
|
|
644
|
+
url: /reference/workos-connect/applications/oauth
|
|
645
|
+
- title: M2M Applications
|
|
646
|
+
url: /reference/workos-connect/applications/m2m
|
|
647
|
+
- title: Get a Connect Application
|
|
648
|
+
url: /reference/workos-connect/applications/get
|
|
649
|
+
- title: List Connect Applications
|
|
650
|
+
url: /reference/workos-connect/applications/list
|
|
651
|
+
- title: Create a Connect Application
|
|
652
|
+
url: /reference/workos-connect/applications/create
|
|
653
|
+
- title: Update a Connect Application
|
|
654
|
+
url: /reference/workos-connect/applications/update
|
|
655
|
+
- title: Delete a Connect Application
|
|
656
|
+
url: /reference/workos-connect/applications/delete
|
|
657
|
+
- title: Client Secrets
|
|
658
|
+
url: /reference/workos-connect/applications/client-secrets
|
|
659
|
+
links:
|
|
660
|
+
- title: List Client Secrets
|
|
661
|
+
url: /reference/workos-connect/applications/client-secrets/list
|
|
662
|
+
- title: Create a Client Secret
|
|
663
|
+
url: /reference/workos-connect/applications/client-secrets/create
|
|
664
|
+
- title: Delete a Client Secret
|
|
665
|
+
url: /reference/workos-connect/applications/client-secrets/delete
|
|
513
666
|
- title: Deprecated APIs
|
|
514
667
|
excludeFromSearch: true
|
|
515
668
|
links:
|