@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,7 +2,7 @@
|
|
|
2
2
|
title: Magic Auth
|
|
3
3
|
description: Maximize user experience and security with passwordless authentication.
|
|
4
4
|
showNextPage: true
|
|
5
|
-
originalPath: .tmp-workos-clone/packages/docs/content/
|
|
5
|
+
originalPath: .tmp-workos-clone/packages/docs/content/authkit/magic-auth.mdx
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
## Introduction
|
|
@@ -11,9 +11,7 @@ Magic Auth is a passwordless authentication method that allows users to sign in
|
|
|
11
11
|
|
|
12
12
|
## Getting started
|
|
13
13
|
|
|
14
|
-
AuthKit will make the necessary API calls to issue one-time-use codes via email and provide input verification and authentication automatically. If desired, you can [send these emails yourself](/
|
|
15
|
-
|
|
16
|
-
> **Important:** Emails will not be sent from the **production** environment until you have configured a domain. See the [Custom Domains](/custom-domains/email) guide for more information on how to configure this.
|
|
14
|
+
AuthKit will make the necessary API calls to issue one-time-use codes via email and provide input verification and authentication automatically. If desired, you can [send these emails yourself](/authkit/custom-emails).
|
|
17
15
|
|
|
18
16
|
### Enabling Magic Auth
|
|
19
17
|
|
|
@@ -31,6 +29,6 @@ One-time-use codes expire after **10 minutes**.
|
|
|
31
29
|
|
|
32
30
|
## Integrating via the API
|
|
33
31
|
|
|
34
|
-
If you’d prefer to build and manage your own authentication UI, you can do so via the
|
|
32
|
+
If you’d prefer to build and manage your own authentication UI, you can do so via the AuthKit [Magic Auth API](/reference/authkit/magic-auth).
|
|
35
33
|
|
|
36
34
|
Examples of building custom UI are also [available on GitHub](https://github.com/workos/authkit).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: Model Context Protocol
|
|
3
3
|
description: How to use AuthKit as the authorization server for your MCP server.
|
|
4
4
|
showNextPage: true
|
|
5
|
-
originalPath: .tmp-workos-clone/packages/docs/content/
|
|
5
|
+
originalPath: .tmp-workos-clone/packages/docs/content/authkit/mcp.mdx
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
## Introduction
|
|
@@ -11,7 +11,7 @@ originalPath: .tmp-workos-clone/packages/docs/content/user-management/mcp.mdx
|
|
|
11
11
|
|
|
12
12
|
This guide is intended for application developers implementing an MCP _server_ that requires authentication. WorkOS and AuthKit can provide a secure way to manage access to your MCP server with minimal effort.
|
|
13
13
|
|
|
14
|
-
>
|
|
14
|
+
> If you have feedback or questions about MCP, we'd love to hear from you! Reach out to [WorkOS support](mailto:support@workos.com?subject=MCP%20Authentication%20with%20AuthKit) or via your team's WorkOS Slack channel.
|
|
15
15
|
|
|
16
16
|
## Authorization
|
|
17
17
|
|
|
@@ -20,7 +20,7 @@ The MCP specification builds on industry-standard protocols like [OAuth 2.0](htt
|
|
|
20
20
|
- **Resource Server** – This is your MCP server, which you may choose to build using the [official Model Context Protocol SDKs](https://github.com/modelcontextprotocol).
|
|
21
21
|
- **Authorization Server** – This is AuthKit, which is a spec-compatible OAuth authorization server. While the spec allows the authorization and resource server to be the same, it can be architecturally simpler to delegate to an existing authorization server like AuthKit.
|
|
22
22
|
|
|
23
|
-
Support for MCP authorization is built on top of [WorkOS Connect](/
|
|
23
|
+
Support for MCP authorization is built on top of [WorkOS Connect](/authkit/connect/oauth), which provides all of the necessary OAuth API endpoints MCP clients will use to authenticate. You can view your AuthKit metadata by making a request to its `/.well-known/oauth-authorization-server` endpoint:
|
|
24
24
|
|
|
25
25
|
```bash
|
|
26
26
|
curl https://authkit_domain/.well-known/oauth-authorization-server | jq
|
|
@@ -50,17 +50,19 @@ AuthKit handles the authentication flow so your MCP server only needs to impleme
|
|
|
50
50
|
1. Verifying access tokens issued by AuthKit for your MCP server.
|
|
51
51
|
1. Direct clients to AuthKit using standardized metadata endpoints.
|
|
52
52
|
|
|
53
|
-
### Enabling
|
|
53
|
+
### Enabling Client ID Metadata Document (CIMD)
|
|
54
54
|
|
|
55
|
-
The MCP protocol
|
|
55
|
+
MCP clients often have no prior relationship with your MCP server. The MCP protocol specifies that authorization servers (AuthKit) should support [Client ID Metadata Document](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-client-id-metadata-document-00) (CIMD) to allow MCP clients to identify themselves.
|
|
56
56
|
|
|
57
|
-
|
|
57
|
+
Client ID Metadata Document is off by default, but you should enable it in the WorkOS Dashboard under _Connect_ → _Configuration_.
|
|
58
58
|
|
|
59
|
-
|
|
59
|
+
Client ID Metadata Document was added to the MCP specification in November 2025. You can enable the previous approach, [Dynamic Client Registration](https://datatracker.ietf.org/doc/html/rfc7591) (DCR), in the WorkOS Dashboard for backwards compatibility with MCP clients that don't yet support Client ID Metadata Document.
|
|
60
|
+
|
|
61
|
+

|
|
60
62
|
|
|
61
63
|
### Token Verification
|
|
62
64
|
|
|
63
|
-
Your app needs to gate access to the MCP endpoints by verifying access tokens issued by AuthKit for your MCP server. This process is very similar to [the way any Connect JWT is verified](/
|
|
65
|
+
Your app needs to gate access to the MCP endpoints by verifying access tokens issued by AuthKit for your MCP server. This process is very similar to [the way any Connect JWT is verified](/authkit/connect/oauth/verifying-tokens), with one important addition:
|
|
64
66
|
|
|
65
67
|
```js
|
|
66
68
|
import { jwtVerify, createRemoteJWKSet } from 'jose';
|
|
@@ -120,7 +122,7 @@ MCP clients that support metadata discovery will automatically fetch this metada
|
|
|
120
122
|
|
|
121
123
|

|
|
122
124
|
|
|
123
|
-
Behind the scenes, AuthKit implements the necessary authorization
|
|
125
|
+
Behind the scenes, AuthKit implements the necessary authorization and token endpoints so that your application doesn't need to. You can read more in the [latest version of the MCP authorization spec](https://github.com/modelcontextprotocol/modelcontextprotocol/blob/901ac03e1c72827acb8017f80eeb14e38ad8ba42/docs/specification/draft/basic/authorization.mdx) but most apps can consider them implementation details of AuthKit as the authorization server.
|
|
124
126
|
|
|
125
127
|
Upon successful authentication the client will receive credentials and can start making requests to your application's MCP endpoints.
|
|
126
128
|
|
|
@@ -144,3 +146,38 @@ app.get('/.well-known/oauth-authorization-server', async (req, res) => {
|
|
|
144
146
|
```
|
|
145
147
|
|
|
146
148
|
Clients will use AuthKit as the authorization server and the rest of the flow will be identical.
|
|
149
|
+
|
|
150
|
+
## Standalone MCP OAuth
|
|
151
|
+
|
|
152
|
+
If you already have an existing authentication system in your application, you can use [Standalone Connect](/authkit/connect/standalone) to integrate AuthKit's OAuth capabilities with your MCP server while preserving your current authentication stack.
|
|
153
|
+
|
|
154
|
+
Standalone Connect is particularly useful for MCP scenarios where you:
|
|
155
|
+
|
|
156
|
+
- Want to add MCP support to an application with existing user authentication.
|
|
157
|
+
- Need to maintain consistency with your current login experience and user management.
|
|
158
|
+
- Require custom authentication logic.
|
|
159
|
+
|
|
160
|
+
### How it works
|
|
161
|
+
|
|
162
|
+
With Standalone Connect for MCP, the authentication flow works differently from the standard AuthKit integration described above:
|
|
163
|
+
|
|
164
|
+
1. **MCP clients** initiate the OAuth flow for your MCP server with AuthKit as your authorization server.
|
|
165
|
+
2. **AuthKit redirects** users to your application's Login URI instead of showing AuthKit's login page.
|
|
166
|
+
3. **Your application** authenticates users using your existing authentication system.
|
|
167
|
+
4. **Your application** calls [AuthKit's completion API](/reference/workos-connect/standalone/complete) to complete the OAuth flow.
|
|
168
|
+
5. **AuthKit** handles the OAuth consent, token issuance, and returns control to the MCP client.
|
|
169
|
+
|
|
170
|
+
This approach allows you to maintain full control over the user authentication experience while leveraging AuthKit's OAuth infrastructure for MCP client authorization.
|
|
171
|
+
|
|
172
|
+
### Implementation considerations
|
|
173
|
+
|
|
174
|
+
When using Standalone Connect with MCP:
|
|
175
|
+
|
|
176
|
+
- You'll still need to enable [Client ID Metadata Document](#enabling-client-id-metadata-document-cimd) to support MCP clients that register themselves.
|
|
177
|
+
- [Token verification](#token-verification) works identically—your MCP server validates tokens using the same JWT verification process.
|
|
178
|
+
- The [metadata endpoints](#metadata) remain the same, ensuring MCP clients can discover and interact with your server.
|
|
179
|
+
- Your Login URI must be configured in the WorkOS Dashboard and handle the `external_auth_id` parameter from AuthKit.
|
|
180
|
+
|
|
181
|
+
The key difference is in the authentication step: instead of users signing in through AuthKit's interface, they authenticate with your existing system, and AuthKit handles only the OAuth authorization and token issuance portions of the flow.
|
|
182
|
+
|
|
183
|
+
For detailed implementation steps and code examples, see the [Standalone Connect documentation](/authkit/connect/standalone).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: Metadata and External IDs
|
|
3
3
|
description: Store additional information about users and organizations.
|
|
4
4
|
showNextPage: true
|
|
5
|
-
originalPath: .tmp-workos-clone/packages/docs/content/
|
|
5
|
+
originalPath: .tmp-workos-clone/packages/docs/content/authkit/metadata.mdx
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
## Introduction
|
|
@@ -24,28 +24,28 @@ External identifiers must be unique within your environment and are limited to 6
|
|
|
24
24
|
You can add up to 10 key-value pairs to an organization or user within these data limits:
|
|
25
25
|
|
|
26
26
|
- **Key**: Up to 40 characters long. ASCII only.
|
|
27
|
-
- **Value**: Up to
|
|
27
|
+
- **Value**: Up to 600 characters long. ASCII only.
|
|
28
28
|
|
|
29
29
|
If your integration requires more than 10 key-value pairs, consider storing the additional data in your own external database and use an external identifier to associate the data with an organization or user.
|
|
30
30
|
|
|
31
31
|
> Never store sensitive information in metadata such as passwords, API keys, or other private information.
|
|
32
32
|
|
|
33
|
-
Metadata is returned in the response body for backend API operations that return organization or user objects, but not in the response body of the [User Authentication](/reference/
|
|
33
|
+
Metadata is returned in the response body for backend API operations that return organization or user objects, but not in the response body of the [User Authentication](/reference/authkit/authentication) operations. If you want to publicly expose metadata properties from users or organizations in your access tokens, you can use JWT templates to customize claims in your application's access tokens.
|
|
34
34
|
|
|
35
35
|
## Set an external identifier
|
|
36
36
|
|
|
37
|
-
To set an external identifier for an organization or user, include the `external_id` property in the request body of the [Create an organization](/reference/organization/create) or [Create a user](/reference/
|
|
37
|
+
To set an external identifier for an organization or user, include the `external_id` property in the request body of the [Create an organization](/reference/organization/create) or [Create a user](/reference/authkit/user/create) endpoints.
|
|
38
38
|
|
|
39
39
|
<CodeBlock referenceId="set_external_id">
|
|
40
40
|
<CodeBlockTab title="Request" file="set-external-id" />
|
|
41
41
|
<CodeBlockTab title="Response" file="set-external-id-response" />
|
|
42
42
|
</CodeBlock>
|
|
43
43
|
|
|
44
|
-
To update an external identifier, include the `external_id` property in the request body of the [Update an organization](/reference/organization/update) or [Update a user](/reference/
|
|
44
|
+
To update an external identifier, include the `external_id` property in the request body of the [Update an organization](/reference/organization/update) or [Update a user](/reference/authkit/user/update) endpoints.
|
|
45
45
|
|
|
46
46
|
## Query by external identifier
|
|
47
47
|
|
|
48
|
-
To query an organization or user by their external identifier, use the [Get organization by external identifier](/reference/organization/get-by-external-id) or [Get user by external identifier](/reference/
|
|
48
|
+
To query an organization or user by their external identifier, use the [Get organization by external identifier](/reference/organization/get-by-external-id) or [Get user by external identifier](/reference/authkit/user/get-by-external-id) endpoints.
|
|
49
49
|
|
|
50
50
|
## Add and update metadata
|
|
51
51
|
|
|
@@ -55,8 +55,8 @@ Metadata can be included in the request body of the following endpoints:
|
|
|
55
55
|
|
|
56
56
|
- [Create an organization](/reference/organization/create)
|
|
57
57
|
- [Update an organization](/reference/organization/update)
|
|
58
|
-
- [Create a user](/reference/
|
|
59
|
-
- [Update a user](/reference/
|
|
58
|
+
- [Create a user](/reference/authkit/user/create)
|
|
59
|
+
- [Update a user](/reference/authkit/user/update)
|
|
60
60
|
|
|
61
61
|
To add a metadata attribute to an entity, include the key and value pair in the `metadata` object of the request body.
|
|
62
62
|
|
|
@@ -98,7 +98,7 @@ To delete all metadata attributes, set the `metadata` property an empty object.
|
|
|
98
98
|
|
|
99
99
|
## Exposing metadata in JWTs
|
|
100
100
|
|
|
101
|
-
Custom metadata and external identifiers can be exposed as claims in JWTs using [JWT Templates](/
|
|
101
|
+
Custom metadata and external identifiers can be exposed as claims in JWTs using [JWT Templates](/authkit/jwt-templates).
|
|
102
102
|
|
|
103
103
|
<CodeBlock>
|
|
104
104
|
<CodeBlockTab
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: Multi-Factor Authentication
|
|
3
3
|
description: Add an additional layer of security to your application.
|
|
4
4
|
showNextPage: true
|
|
5
|
-
originalPath: .tmp-workos-clone/packages/docs/content/
|
|
5
|
+
originalPath: .tmp-workos-clone/packages/docs/content/authkit/mfa.mdx
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
## Introduction
|
|
@@ -27,6 +27,6 @@ MFA can be enabled in the _Authentication_ section of the [WorkOS Dashboard](htt
|
|
|
27
27
|
|
|
28
28
|
## Integrating via the API
|
|
29
29
|
|
|
30
|
-
If you’d prefer to build and manage your own authentication UI, you can do so via the
|
|
30
|
+
If you’d prefer to build and manage your own authentication UI, you can do so via the AuthKit [Multi-Factor API](/reference/authkit/mfa).
|
|
31
31
|
|
|
32
32
|
Examples of building custom UI are also [available on GitHub](https://github.com/workos/authkit).
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: Migrating to
|
|
2
|
+
title: Migrating to AuthKit
|
|
3
3
|
description: Guidance on moving your existing users to WorkOS.
|
|
4
4
|
showNextPage: true
|
|
5
|
-
originalPath: .tmp-workos-clone/packages/docs/content/
|
|
5
|
+
originalPath: .tmp-workos-clone/packages/docs/content/authkit/migrations.mdx
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
## Introduction
|
|
9
9
|
|
|
10
|
-
WorkOS provides a [range of guides](/migrate) to help you migrate your existing integration to
|
|
10
|
+
WorkOS provides a [range of guides](/migrate) to help you migrate your existing integration to AuthKit.
|
|
11
11
|
|
|
12
12
|
## Migrate from another service
|
|
13
13
|
|
|
@@ -17,4 +17,4 @@ These guides will walk you through the process of moving your users and organiza
|
|
|
17
17
|
|
|
18
18
|
## Migrating an existing WorkOS integration
|
|
19
19
|
|
|
20
|
-
If you already have an integration with WorkOS (for example, using the [standalone API](/sso) to provide SSO to your customers), you can migrate to
|
|
20
|
+
If you already have an integration with WorkOS (for example, using the [standalone API](/sso) to provide SSO to your customers), you can migrate to AuthKit and take advantage of all of the features it provides by following [this guide](/migrate/standalone-sso).
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: Modeling Your App
|
|
3
3
|
description: Learn how to architect your WorkOS integration
|
|
4
4
|
showNextPage: true
|
|
5
|
-
originalPath: .tmp-workos-clone/packages/docs/content/
|
|
5
|
+
originalPath: .tmp-workos-clone/packages/docs/content/authkit/modeling-your-app.mdx
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
## Introduction
|
|
@@ -29,11 +29,11 @@ There are three main ways to add WorkOS authentication to your application:
|
|
|
29
29
|
|
|
30
30
|
### AuthKit
|
|
31
31
|
|
|
32
|
-
A [hosted login solution](/
|
|
32
|
+
A [hosted login solution](/authkit) that provides a customizable UI and supports a wide range of authentication methods.
|
|
33
33
|
|
|
34
34
|
### Custom AuthKit UI
|
|
35
35
|
|
|
36
|
-
If you prefer to craft your own UI in your own stack,
|
|
36
|
+
If you prefer to craft your own UI in your own stack, you can use the [AuthKit APIs](/reference/authkit) directly.
|
|
37
37
|
|
|
38
38
|
### Standalone Single Sign-On (SSO)
|
|
39
39
|
|
|
@@ -45,7 +45,7 @@ In the majority of cases we recommend using the hosted AuthKit solution.
|
|
|
45
45
|
|
|
46
46
|
On successful completion, AuthKit will return an authentication code to your application via your specified redirect URI, this is exchanged for the user object and used to create a session.
|
|
47
47
|
|
|
48
|
-
See the [Quick Start guide](/
|
|
48
|
+
See the [Quick Start guide](/authkit) for more information on how to implement this.
|
|
49
49
|
|
|
50
50
|
## Authentication methods
|
|
51
51
|
|
|
@@ -69,7 +69,7 @@ A similar technique is Magic Link, where the user can log in by clicking a link
|
|
|
69
69
|
|
|
70
70
|
The favored authentication method by enterprise sized companies, SSO allows an organization's users to sign in with a single ID to related, yet independent software systems.
|
|
71
71
|
|
|
72
|
-
The
|
|
72
|
+
The AuthKit APIs make the above easy to implement using your own UI, or you can use AuthKit's Hosted UI for a fully hosted experience.
|
|
73
73
|
|
|
74
74
|
## Single-tenant and multi-tenant models
|
|
75
75
|
|
|
@@ -89,7 +89,7 @@ Multi-tenant refers to a software architecture where a single instance of the so
|
|
|
89
89
|
|
|
90
90
|
Each tenant's data is isolated and remains invisible to other tenants because the software is designed to securely handle this data across all tenants.
|
|
91
91
|
|
|
92
|
-
In the context of WorkOS, a multi-tenant application could be accomplished by the use of [Organizations](/reference/organization) and [Organization Memberships](/reference/
|
|
92
|
+
In the context of WorkOS, a multi-tenant application could be accomplished by the use of [Organizations](/reference/organization) and [Organization Memberships](/reference/authkit/organization-membership) to ensure that end-users only have access to the data they are authorized to.
|
|
93
93
|
|
|
94
94
|
By default WorkOS comes with two environments: staging and production. The former is for development and testing, the latter for live traffic. For single-tenant applications, new environments can be added to your WorkOS account to accommodate each of your users. For more information or to request new environments, please reach out to [support](mailto:support@workos.com).
|
|
95
95
|
|
|
@@ -121,7 +121,7 @@ This model starts to become incredibly powerful as we can now capture more compl
|
|
|
121
121
|
|
|
122
122
|
### Domain verification and domain policies
|
|
123
123
|
|
|
124
|
-
[Domain verification](/
|
|
124
|
+
[Domain verification](/authkit/domain-verification) is the process of proving ownership of a specific domain, typically handled by a company’s IT department. Once a domain is verified, all existing and future users with email addresses matching the domain are, by default, managed by the organization's [domain policy](/authkit/organization-policies/domain-policy). This allows the organization to control authentication and membership behavior for these users, such as requiring these users to authenticate via SSO.
|
|
125
125
|
|
|
126
126
|
Users signing in with SSO with a verified email domain are automatically considered verified and do not need to complete the email verification process.
|
|
127
127
|
|
|
@@ -139,11 +139,11 @@ With the Admin Portal, the process of configuring your customer’s SSO integrat
|
|
|
139
139
|
|
|
140
140
|
As with B2C models, user data on the WorkOS side can be used as the source of truth, but the far more common scenario is to store user information in your own database which links to the WorkOS user.
|
|
141
141
|
|
|
142
|
-
The
|
|
142
|
+
The AuthKit and SSO products can be used independently, with the latter acting as authentication middleware which intentionally does not handle user database management for your application. If you're unsure which is best for your business, it's recommended to stick with AuthKit as it gives you the aforementioned flexibility to add and/or remove features as your needs grow.
|
|
143
143
|
|
|
144
144
|
## Example scenarios
|
|
145
145
|
|
|
146
|
-
As your application grows you may find yourself needing to add additional features to support customer needs.
|
|
146
|
+
As your application grows you may find yourself needing to add additional features to support customer needs. AuthKit is designed with this is mind. As you move upmarket and take on larger and larger customers, you can easily adopt and extend your feature set within an established architecture. The following scenarios explain some common use cases with specific feature sets.
|
|
147
147
|
|
|
148
|
-
- [SSO with contractors](/
|
|
149
|
-
- [Invite-only Signup](/
|
|
148
|
+
- [SSO with contractors](/authkit/sso-with-contractors) – Enforcing Organization SSO with external guest members.
|
|
149
|
+
- [Invite-only Signup](/authkit/invite-only-signup) – An invite only application that allows existing users to invite new members.
|
|
@@ -2,8 +2,7 @@
|
|
|
2
2
|
title: Organization Authentication Policies
|
|
3
3
|
description: Customize available authentication methods for each organization.
|
|
4
4
|
showNextPage: true
|
|
5
|
-
originalPath:
|
|
6
|
-
.tmp-workos-clone/packages/docs/content/user-management/organization-policies.mdx
|
|
5
|
+
originalPath: .tmp-workos-clone/packages/docs/content/authkit/organization-policies.mdx
|
|
7
6
|
---
|
|
8
7
|
|
|
9
8
|
## Introduction
|
|
@@ -12,9 +11,9 @@ Some organizations may prefer to limit their users to specific authentication me
|
|
|
12
11
|
|
|
13
12
|
## Domain policy
|
|
14
13
|
|
|
15
|
-
A domain policy allows an organization to control authentication and membership behavior of users whose email domain matches one of the organization’s [verified domains](/
|
|
14
|
+
A domain policy allows an organization to control authentication and membership behavior of users whose email domain matches one of the organization’s [verified domains](/authkit/domain-verification). Domain policies are enforced for _all_ users with email domains included in the policy, regardless of their membership status within the organization or the organization selected during sign-in.
|
|
16
15
|
|
|
17
|
-
Additionally, users provisioned through a [directory](/
|
|
16
|
+
Additionally, users provisioned through a [directory](/authkit/directory-provisioning) with an email domain included in the organization's domain policy will be automatically added as active members of the organization without needing an invitation.
|
|
18
17
|
|
|
19
18
|

|
|
20
19
|
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: AuthKit
|
|
3
|
+
description: >-
|
|
4
|
+
Easy to use authentication APIs designed to provide a flexible, secure, and
|
|
5
|
+
fast integration.
|
|
6
|
+
showNextPage: true
|
|
7
|
+
originalPath: .tmp-workos-clone/packages/docs/content/authkit/overview.mdx
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Introduction
|
|
11
|
+
|
|
12
|
+
WorkOS AuthKit is a user management platform that provides a set of user authentication and organization security features that securely power your application. Features are designed to be flexible, while offering a fast integration to handle all of the user management complexity that comes with advanced business and customer needs.
|
|
13
|
+
|
|
14
|
+
## Authentication
|
|
15
|
+
|
|
16
|
+
AuthKit supports many authentication methods out of the box. They are designed to grow with your app, from the simplest use case all the way to complex Enterprise [SSO](/authkit/sso) for your largest customers, these include:
|
|
17
|
+
|
|
18
|
+
- [Single Sign-On](/authkit/sso)
|
|
19
|
+
- [Email & Password](/authkit/email-password)
|
|
20
|
+
- [Social Login](/authkit/social-login)
|
|
21
|
+
- [Multi-Factor Auth](/authkit/mfa)
|
|
22
|
+
- [Magic Auth](/authkit/magic-auth)
|
|
23
|
+
|
|
24
|
+
These features are available via [AuthKit](/authkit), or through the public [API](/reference/authkit). AuthKit provides an easy to integrate, pre-built authentication flow, while integrating against the API allows you to implement your own UI and Sign In flow.
|
|
25
|
+
|
|
26
|
+
## Fast integration
|
|
27
|
+
|
|
28
|
+
The fastest way to integrate AuthKit features is with the [Hosted UI](/authkit/hosted-ui).
|
|
29
|
+
|
|
30
|
+

|
|
31
|
+
|
|
32
|
+
AuthKit abstracts away many of the UX and WorkOS API calling concerns automatically, allowing you to focus on building your application. See the [Quick Start](/authkit) guide for more information on how to get started.
|
|
33
|
+
|
|
34
|
+
## Security
|
|
35
|
+
|
|
36
|
+
Adopting AuthKit in your app provides a wealth of security benefits.
|
|
37
|
+
|
|
38
|
+
- Best-in-class [email verification](/authkit/email-verification), enabled by default.
|
|
39
|
+
- Safe [identity linking](/authkit/identity-linking) and merging of duplicate accounts. This protects against spoofing and reduces the user support burden.
|
|
40
|
+
- Identity Provider (IdP) differences are normalized, so that you get consistency across user profiles. This reduces the likelihood of security issues related to differing semantics across providers.
|
|
41
|
+
- Automatic bot detection and blocking, to protect against brute force attacks.
|
|
42
|
+
- [Multi-Factor Authentication (MFA)](/authkit/mfa) available per environment to further enhance your app’s security posture.
|
|
43
|
+
|
|
44
|
+
## Getting started
|
|
45
|
+
|
|
46
|
+
Start integrating AuthKit into your app today, check out the [Quick Start](/authkit) guide to get started with AuthKit or review the [API Reference](/reference/authkit) material.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: Passkeys
|
|
3
3
|
description: Configuring passkey authentication and enrollment.
|
|
4
4
|
showNextPage: true
|
|
5
|
-
originalPath: .tmp-workos-clone/packages/docs/content/
|
|
5
|
+
originalPath: .tmp-workos-clone/packages/docs/content/authkit/passkeys.mdx
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
## Introduction
|
|
@@ -31,7 +31,7 @@ If users skip passkey enrollment they will be reminded every two weeks, and addi
|
|
|
31
31
|
|
|
32
32
|
### Multi-factor auth
|
|
33
33
|
|
|
34
|
-
If [MFA](/
|
|
34
|
+
If [MFA](/authkit/mfa) is also enabled and required, users who sign in with a passkey will not be prompted for a separate TOTP code. AuthKit treats passkeys as both a first and second factor by requiring user verification when a passkey is presented.
|
|
35
35
|
|
|
36
36
|
User verification in the context of a passkey means the passkey must be combined with another "authorization gesture", like the scanning of a fingerprint, or entering a separate PIN.
|
|
37
37
|
|
|
@@ -39,4 +39,4 @@ User verification in the context of a passkey means the passkey must be combined
|
|
|
39
39
|
|
|
40
40
|
## Integrating via the API
|
|
41
41
|
|
|
42
|
-
Passkey authentication is currently only available
|
|
42
|
+
Passkey authentication is currently only available with the hosted UI in AuthKit.
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Pipes
|
|
3
|
+
description: >-
|
|
4
|
+
Enable your customers to connect their third-party accounts to your
|
|
5
|
+
application.
|
|
6
|
+
showNextPage: true
|
|
7
|
+
originalPath: .tmp-workos-clone/packages/docs/content/authkit/pipes.mdx
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Introduction
|
|
11
|
+
|
|
12
|
+
Pipes allows your users to securely connect their third-party accounts to your
|
|
13
|
+
application. With Pipes, you can easily integrate with popular services like
|
|
14
|
+
GitHub, Slack, Google, Salesforce, and many more without managing OAuth flows,
|
|
15
|
+
token refresh logic, or credential storage.
|
|
16
|
+
|
|
17
|
+
## Configuring providers
|
|
18
|
+
|
|
19
|
+
To make an provider available to your users, you will need to configure it in
|
|
20
|
+
the WorkOS Dashboard.
|
|
21
|
+
|
|
22
|
+
Visit the _Pipes_ section of the WorkOS Dashboard to get started. Click _Connect
|
|
23
|
+
provider_ then choose the provider from the list. If you don’t see the provider
|
|
24
|
+
you need, please reach out to [our team](mailto:support@workos.com).
|
|
25
|
+
|
|
26
|
+

|
|
27
|
+
|
|
28
|
+
### Shared Credentials
|
|
29
|
+
|
|
30
|
+
For the fastest setup, you can use WorkOS-managed shared credentials in sandbox
|
|
31
|
+
environments. This allows users to connect immediately without requiring you to
|
|
32
|
+
create OAuth applications with each provider.
|
|
33
|
+
|
|
34
|
+
1. Specify the required **scopes** for your application.
|
|
35
|
+
2. Provide an optional **description**. This will be used in the widget to inform users
|
|
36
|
+
on how your application will use their data from the provider.
|
|
37
|
+
|
|
38
|
+
### Custom Credentials
|
|
39
|
+
|
|
40
|
+
For production applications, configure the provider with your own OAuth credentials:
|
|
41
|
+
|
|
42
|
+
1. **Create an OAuth application** within the provider's dashboard.
|
|
43
|
+
1. You can find instructions on setting up the provider in the documentation section of the setup modal.
|
|
44
|
+
1. Use the provided **redirect URI** when configuring the provider.
|
|
45
|
+
1. Set the **client ID and secret** from the provider.
|
|
46
|
+
1. Specify the required **scopes** for your application.
|
|
47
|
+
1. You may need to set these scopes in the provider configuration as well.
|
|
48
|
+
1. Provide an optional **description**. This will be used in the widget to inform users
|
|
49
|
+
on how your application will use their data from the provider.
|
|
50
|
+
|
|
51
|
+
Commonly used scopes are provided in-line, but you should consult each provider's documentation for the full list of available scopes.
|
|
52
|
+
|
|
53
|
+
## Provider management in your application
|
|
54
|
+
|
|
55
|
+
The [Pipes Widget](/widgets/pipes) provides a pre-built UI for users to connect
|
|
56
|
+
and manage their connected accounts. The widget shows the user which
|
|
57
|
+
providers are available, and lets them easily initiate the authorization
|
|
58
|
+
flow. It communicates with the WorkOS API and stores the connection information
|
|
59
|
+
for the user. If there's ever a problem with the user’s access token, the widget
|
|
60
|
+
will let them know they need to reauthorize.
|
|
61
|
+
|
|
62
|
+

|
|
63
|
+
|
|
64
|
+
> The description in the widget is set in the provider's configuration in the WorkOS Dashboard.
|
|
65
|
+
|
|
66
|
+
## Fetching access tokens
|
|
67
|
+
|
|
68
|
+
Once a user has connected a provider, you can [fetch access tokens](/reference/pipes) from your
|
|
69
|
+
backend to make API calls to the connected service on their behalf. Pipes takes
|
|
70
|
+
care of refreshing the token if needed, so you’ll always have a fresh token. If
|
|
71
|
+
there’s a problem with the token, the endpoint will return information about the issue so you can
|
|
72
|
+
direct the user to the correct it. This may require sending the user to re-authorize directly
|
|
73
|
+
or via the page with the Pipes widget.
|
|
74
|
+
|
|
75
|
+
<CodeBlock file="pipes-fetch-token" />
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: Radar
|
|
3
3
|
description: 'Protecting against bots, fraud and abuse.'
|
|
4
4
|
showNextPage: true
|
|
5
|
-
originalPath: .tmp-workos-clone/packages/docs/content/
|
|
5
|
+
originalPath: .tmp-workos-clone/packages/docs/content/authkit/radar.mdx
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
## Introduction
|
|
@@ -17,8 +17,9 @@ It's also a signal for suspicious behavior, such as when a device is used for mu
|
|
|
17
17
|
|
|
18
18
|
## Getting Started
|
|
19
19
|
|
|
20
|
-
Radar
|
|
21
|
-
|
|
20
|
+
Radar works with AuthKit without additional integration effort.
|
|
21
|
+
You can enable Radar directly from the WorkOS dashboard.
|
|
22
|
+
If you are interested in using Radar but are not an AuthKit customer, please reach out to [our team](mailto:support@workos.com), or for current customers, drop a note in your shared Slack channel.
|
|
22
23
|
|
|
23
24
|
## Dashboard
|
|
24
25
|
|
|
@@ -57,6 +58,10 @@ The user is then prompted to enter that code to continue authentication.
|
|
|
57
58
|
Challenging suspicious authentication attempts with an OTP is effective in stopping bots that are capable of solving CAPTCHAs,
|
|
58
59
|
as well as malicious users who have stolen credentials but don't have access to the user's email account.
|
|
59
60
|
|
|
61
|
+
> Radar supports SMS challenges for sign ups in preview.
|
|
62
|
+
> Reach out to support via [email](mailto:support@workos.com) or Slack if you are interested in using SMS challenges.
|
|
63
|
+
> Additional fees may apply.
|
|
64
|
+
|
|
60
65
|
**Notifying** on an attempt will send an informational email to users and/or admins when Radar detects a suspicious behavior.
|
|
61
66
|
This is helpful to proactively make individuals aware that an attack might be taking place, or their account was compromised.
|
|
62
67
|
|
|
@@ -92,6 +97,15 @@ Radar will detect if these attempts happen over a short period where it's not po
|
|
|
92
97
|
|
|
93
98
|

|
|
94
99
|
|
|
100
|
+
### Repeat sign up
|
|
101
|
+
|
|
102
|
+
Block or challenge repeat sign up attempts from the same email. By default, AuthKit fully deletes users.
|
|
103
|
+
|
|
104
|
+
If your application allows for account deletion and has a free-trial, then users may be able to delete their account and sign up again to get a new free-trial.
|
|
105
|
+
This protection restricts an email to a max of three uses before denying further sign ups.
|
|
106
|
+
|
|
107
|
+

|
|
108
|
+
|
|
95
109
|
### Stale accounts
|
|
96
110
|
|
|
97
111
|
Get notified when an account that has been dormant without use becomes active
|
|
@@ -112,7 +126,28 @@ If it hasn’t, both the user and an administrator can be notified by email.
|
|
|
112
126
|
|
|
113
127
|

|
|
114
128
|
|
|
115
|
-
|
|
129
|
+
## Managed lists
|
|
130
|
+
|
|
131
|
+
### Disposable email domains
|
|
132
|
+
|
|
133
|
+
Radar maintains a constantly updated list of email domains known to provide disposable email services.
|
|
134
|
+
Disposable email services may be used to bypass free account or free trial limits in your application.
|
|
135
|
+
|
|
136
|
+
You can choose to block or log registrations that match an email domain in this list.
|
|
137
|
+
Logging is useful to verify no adverse impact will occur before blocking all the domains.
|
|
138
|
+
|
|
139
|
+

|
|
140
|
+
|
|
141
|
+
### U.S. Sanctioned countries
|
|
142
|
+
|
|
143
|
+
Block users from countries under US Sanctions from signing up or logging into your application. Contact [support](mailto:support@workos.com) to get the current list of countries.
|
|
144
|
+
|
|
145
|
+
> If you need to block a different set of countries, please reach out to support via [email](mailto:support@workos.com) or slack to configure regional blocks.
|
|
146
|
+
> Radar supports any region in the [ISO 3166-1 specification](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
|
|
147
|
+
|
|
148
|
+

|
|
149
|
+
|
|
150
|
+
## Custom restrictions
|
|
116
151
|
|
|
117
152
|
Specific user identifiers can be configured to always allow or deny an authentication attempt.
|
|
118
153
|
Examples of using a custom restrictions:
|