@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
|
@@ -6,7 +6,7 @@ reference:
|
|
|
6
6
|
curl:
|
|
7
7
|
- key: authenticate_email_verification
|
|
8
8
|
id: authenticate_email_verification
|
|
9
|
-
url: /reference/
|
|
9
|
+
url: /reference/authkit/authentication/email-verification
|
|
10
10
|
title: /user_management/authenticate
|
|
11
11
|
type: POST
|
|
12
12
|
parameters:
|
|
@@ -54,7 +54,7 @@ reference:
|
|
|
54
54
|
js:
|
|
55
55
|
- key: authenticateWithEmailVerification
|
|
56
56
|
id: authenticate_email_verification
|
|
57
|
-
url: /reference/
|
|
57
|
+
url: /reference/authkit/authentication/email-verification
|
|
58
58
|
title: userManagement.authenticateWithEmailVerification()
|
|
59
59
|
parameters:
|
|
60
60
|
- key: options
|
|
@@ -115,7 +115,7 @@ reference:
|
|
|
115
115
|
python:
|
|
116
116
|
- key: authenticate_with_email_verification
|
|
117
117
|
id: authenticate_email_verification
|
|
118
|
-
url: /reference/
|
|
118
|
+
url: /reference/authkit/authentication/email_verification
|
|
119
119
|
title: user_management.authenticate_with_email_verification()
|
|
120
120
|
parameters:
|
|
121
121
|
- key: code
|
|
@@ -155,7 +155,7 @@ reference:
|
|
|
155
155
|
go:
|
|
156
156
|
- key: AuthenticateWithEmailVerification
|
|
157
157
|
id: authenticate_email_verification
|
|
158
|
-
url: /reference/
|
|
158
|
+
url: /reference/authkit/authentication/email-verification
|
|
159
159
|
title: usermanagement.AuthenticateWithEmailVerification()
|
|
160
160
|
parameters:
|
|
161
161
|
- (ctx)
|
|
@@ -196,7 +196,7 @@ reference:
|
|
|
196
196
|
php:
|
|
197
197
|
- key: authenticateWithEmailVerification
|
|
198
198
|
id: authenticate_email_verification
|
|
199
|
-
url: /reference/
|
|
199
|
+
url: /reference/authkit/authentication/email-verification
|
|
200
200
|
title: $userManagement->authenticateWithEmailVerification()
|
|
201
201
|
parameters:
|
|
202
202
|
- key: options
|
|
@@ -235,7 +235,7 @@ reference:
|
|
|
235
235
|
ruby:
|
|
236
236
|
- key: authenticate_with_email_verification
|
|
237
237
|
id: authenticate_email_verification
|
|
238
|
-
url: /reference/
|
|
238
|
+
url: /reference/authkit/authentication/email-verification
|
|
239
239
|
title: UserManagement.authenticate_with_email_verification()
|
|
240
240
|
parameters:
|
|
241
241
|
- key: options
|
|
@@ -274,7 +274,7 @@ reference:
|
|
|
274
274
|
java:
|
|
275
275
|
- key: authenticateWithEmailVerification
|
|
276
276
|
id: authenticate_email_verification
|
|
277
|
-
url: /reference/
|
|
277
|
+
url: /reference/authkit/authentication/email-verification
|
|
278
278
|
title: userManagement.authenticateWithEmailVerification()
|
|
279
279
|
parameters:
|
|
280
280
|
- key: clientId
|
|
@@ -336,16 +336,16 @@ reference:
|
|
|
336
336
|
optional: true
|
|
337
337
|
description: (authentication.impersonator.reason)
|
|
338
338
|
originalPath: >-
|
|
339
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
339
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication/email-verification.mdx
|
|
340
340
|
---
|
|
341
341
|
|
|
342
342
|
## Authenticate with an email verification code
|
|
343
343
|
|
|
344
344
|
Authenticates a user with an unverified email and verifies their email address.
|
|
345
345
|
|
|
346
|
-
A user with an unverified email address won’t be able to authenticate right away. When they attempt to authenticate with their credentials, the API will return an [email verification required error](/reference/
|
|
346
|
+
A user with an unverified email address won’t be able to authenticate right away. When they attempt to authenticate with their credentials, the API will return an [email verification required error](/reference/authkit/authentication-errors/email-verification-required-error) that contains a pending authentication token.
|
|
347
347
|
|
|
348
|
-
If the [email setting](/
|
|
348
|
+
If the [email setting](/authkit/custom-emails) for email verification is enabled, WorkOS will automatically send a one-time email verification code to the user’s email address. If the email setting is not enabled, [retrieve the email verification code](/reference/authkit/email-verification/get) to send the email yourself. Use the pending authentication token from the error and the one-time code the user received to authenticate them and to complete the email verification process.
|
|
349
349
|
|
|
350
350
|
<CodeBlock referenceId="authenticate_email_verification">
|
|
351
351
|
<CodeBlockTab
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
originalPath: >-
|
|
3
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
3
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication/get-authorization-url/error-codes.mdx
|
|
4
4
|
---
|
|
5
5
|
### Error codes
|
|
6
6
|
|
|
@@ -14,7 +14,7 @@ Possible error codes and the corresponding descriptions are listed below.
|
|
|
14
14
|
|
|
15
15
|
| Error code | Description |
|
|
16
16
|
| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
17
|
-
| `access_denied` | The user denied an OAuth authorization request at the identity provider.
|
|
17
|
+
| `access_denied` | The identity provider denied user access to the client application or the user denied an OAuth authorization request at the identity provider. |
|
|
18
18
|
| `ambiguous_connection_selector` | A connection could not be uniquely identified using the provided connection selector (e.g., organization). This can occur when there are multiple SSO connections under the same organization. If you need multiple SSO connections for an organization, use the connection parameter to identify which connection to use for SSO. |
|
|
19
19
|
| `connection_invalid` | There is no connection for the provided ID. |
|
|
20
20
|
| `connection_strategy_invalid` | The provider has multiple strategies associated per environment. |
|
|
@@ -22,4 +22,4 @@ Possible error codes and the corresponding descriptions are listed below.
|
|
|
22
22
|
| `invalid_connection_selector` | A valid connection selector query parameter must be provided in order to correctly determine the proper connection to return an authorization URL for. Valid connection selectors are either `connection`, `organization`, or `provider`. |
|
|
23
23
|
| `organization_invalid` | There is no organization matching the provided ID. |
|
|
24
24
|
| `oauth_failed` | An OAuth authorization request failed for a user. |
|
|
25
|
-
| `server_error` | The SSO authentication failed for the user. More detailed errors and steps to resolve are available in the
|
|
25
|
+
| `server_error` | The SSO authentication failed for the user. More detailed errors and steps to resolve are available in the Sessions tab on the connection page in the WorkOS Dashboard. |
|
|
@@ -49,7 +49,7 @@ descriptions:
|
|
|
49
49
|
sign-in page for the user, if you know their username ahead of time.
|
|
50
50
|
|
|
51
51
|
|
|
52
|
-
Currently, this parameter is supported for OAuth,
|
|
52
|
+
Currently, this parameter is supported for OAuth, AuthKit, OpenID Connect,
|
|
53
53
|
Okta, and Entra ID connections.
|
|
54
54
|
domain_hint: >
|
|
55
55
|
Can be used to pre-fill the domain field when initiating authentication
|
|
@@ -65,9 +65,20 @@ descriptions:
|
|
|
65
65
|
|
|
66
66
|
This parameter is required when specifying a `code_challenge` for the PKCE
|
|
67
67
|
flow.
|
|
68
|
+
provider_scopes: >
|
|
69
|
+
A list of additional OAuth scopes to request from the OAuth provider.
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
This parameter can be used with Google OAuth, Microsoft OAuth, GitHub
|
|
73
|
+
OAuth, GitLab OAuth, and Xero OAuth.
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
Tokens from the OAuth provider will be included in the authentication
|
|
77
|
+
response if your OAuth connection for the provider is configured in the
|
|
78
|
+
WorkOS Dashboard to return OAuth tokens.
|
|
68
79
|
reference:
|
|
69
80
|
curl:
|
|
70
|
-
- url: /reference/
|
|
81
|
+
- url: /reference/authkit/authentication/get-authorization-url
|
|
71
82
|
key: user_management_get_authorization_url
|
|
72
83
|
id: user_management_get_authorization_url
|
|
73
84
|
title: /user_management/authorize
|
|
@@ -120,12 +131,16 @@ reference:
|
|
|
120
131
|
optional: true
|
|
121
132
|
type: '"sign-up" | "sign-in"'
|
|
122
133
|
description: (user_management_get_authorization_url.screen_hint)
|
|
134
|
+
- key: provider_scopes
|
|
135
|
+
optional: true
|
|
136
|
+
type: array
|
|
137
|
+
description: (user_management_get_authorization_url.provider_scopes)
|
|
123
138
|
returns:
|
|
124
139
|
- key: url
|
|
125
140
|
type: string
|
|
126
141
|
description: (user_management_get_authorization_url.url)
|
|
127
142
|
js:
|
|
128
|
-
- url: /reference/
|
|
143
|
+
- url: /reference/authkit/authentication/get-authorization-url
|
|
129
144
|
key: getAuthorizationUrl
|
|
130
145
|
patternBefore: userManagement.
|
|
131
146
|
id: user_management_get_authorization_url
|
|
@@ -179,12 +194,16 @@ reference:
|
|
|
179
194
|
optional: true
|
|
180
195
|
type: '"sign-up" | "sign-in"'
|
|
181
196
|
description: (user_management_get_authorization_url.screen_hint)
|
|
197
|
+
- key: providerScopes
|
|
198
|
+
optional: true
|
|
199
|
+
type: array
|
|
200
|
+
description: (user_management_get_authorization_url.provider_scopes)
|
|
182
201
|
returns:
|
|
183
202
|
- key: url
|
|
184
203
|
type: string
|
|
185
204
|
description: (user_management_get_authorization_url.url)
|
|
186
205
|
python:
|
|
187
|
-
- url: /reference/
|
|
206
|
+
- url: /reference/authkit/authentication/get-authorization-url
|
|
188
207
|
key: get_authorization_url
|
|
189
208
|
patternBefore: user_management.
|
|
190
209
|
id: user_management_get_authorization_url
|
|
@@ -217,12 +236,20 @@ reference:
|
|
|
217
236
|
optional: true
|
|
218
237
|
type: str
|
|
219
238
|
description: (user_management_get_authorization_url.domain_hint)
|
|
239
|
+
- key: screen_hint
|
|
240
|
+
optional: true
|
|
241
|
+
type: '"sign-up" | "sign-in"'
|
|
242
|
+
description: (user_management_get_authorization_url.screen_hint)
|
|
243
|
+
- key: provider_scopes
|
|
244
|
+
optional: true
|
|
245
|
+
type: 'Sequence[str]'
|
|
246
|
+
description: (user_management_get_authorization_url.provider_scopes)
|
|
220
247
|
returns:
|
|
221
248
|
- key: url
|
|
222
249
|
type: str
|
|
223
250
|
description: (user_management_get_authorization_url.url)
|
|
224
251
|
go:
|
|
225
|
-
- url: /reference/
|
|
252
|
+
- url: /reference/authkit/authentication/get-authorization-url
|
|
226
253
|
key: GetAuthorizationURL
|
|
227
254
|
patternBefore: usermanagement.
|
|
228
255
|
id: user_management_get_authorization_url
|
|
@@ -275,28 +302,32 @@ reference:
|
|
|
275
302
|
optional: true
|
|
276
303
|
type: ScreenHint
|
|
277
304
|
description: (user_management_get_authorization_url.screen_hint)
|
|
305
|
+
- key: ProviderScopes
|
|
306
|
+
optional: true
|
|
307
|
+
type: '[]string'
|
|
308
|
+
description: (user_management_get_authorization_url.provider_scopes)
|
|
278
309
|
returns:
|
|
279
310
|
- key: url
|
|
280
311
|
type: string
|
|
281
312
|
description: (user_management_get_authorization_url.url)
|
|
282
313
|
- (err)
|
|
283
314
|
php:
|
|
284
|
-
- url: /reference/
|
|
315
|
+
- url: /reference/authkit/authentication/get-authorization-url
|
|
285
316
|
key: getAuthorizationUrl
|
|
286
317
|
id: user_management_get_authorization_url
|
|
287
318
|
patternBefore: userManagement->
|
|
288
319
|
title: $userManagement->getAuthorizationUrl()
|
|
289
320
|
parameters:
|
|
290
321
|
- key: redirectUri
|
|
291
|
-
type:
|
|
322
|
+
type: string
|
|
292
323
|
description: (user_management_get_authorization_url.redirect_uri)
|
|
293
324
|
- key: connectionId
|
|
294
325
|
optional: true
|
|
295
|
-
type:
|
|
326
|
+
type: string
|
|
296
327
|
description: (user_management_get_authorization_url.connection_id)
|
|
297
328
|
- key: organizationId
|
|
298
329
|
optional: true
|
|
299
|
-
type:
|
|
330
|
+
type: string
|
|
300
331
|
description: (user_management_get_authorization_url.organization_id)
|
|
301
332
|
- key: provider
|
|
302
333
|
optional: true
|
|
@@ -306,22 +337,26 @@ reference:
|
|
|
306
337
|
description: (user_management_get_authorization_url.provider)
|
|
307
338
|
- key: state
|
|
308
339
|
optional: true
|
|
309
|
-
type:
|
|
340
|
+
type: string
|
|
310
341
|
description: (user_management_get_authorization_url.state)
|
|
311
342
|
- key: loginHint
|
|
312
343
|
optional: true
|
|
313
|
-
type:
|
|
344
|
+
type: string
|
|
314
345
|
description: (user_management_get_authorization_url.login_hint)
|
|
315
346
|
- key: domainHint
|
|
316
347
|
optional: true
|
|
317
|
-
type:
|
|
348
|
+
type: string
|
|
318
349
|
description: (user_management_get_authorization_url.domain_hint)
|
|
350
|
+
- key: providerScopes
|
|
351
|
+
optional: true
|
|
352
|
+
type: 'string[]'
|
|
353
|
+
description: (user_management_get_authorization_url.provider_scopes)
|
|
319
354
|
returns:
|
|
320
355
|
- key: url
|
|
321
356
|
type: string
|
|
322
357
|
description: (user_management_get_authorization_url.url)
|
|
323
358
|
ruby:
|
|
324
|
-
- url: /reference/
|
|
359
|
+
- url: /reference/authkit/authentication/get-authorization-url
|
|
325
360
|
key: authorization_url
|
|
326
361
|
id: user_management_get_authorization_url
|
|
327
362
|
title: UserManagement.authorization_url()
|
|
@@ -332,6 +367,10 @@ reference:
|
|
|
332
367
|
- key: client_id
|
|
333
368
|
type: String
|
|
334
369
|
description: (client_id)
|
|
370
|
+
- key: screen_hint
|
|
371
|
+
optional: true
|
|
372
|
+
type: '"sign-up" | "sign-in"'
|
|
373
|
+
description: (user_management_get_authorization_url.screen_hint)
|
|
335
374
|
- key: domain_hint
|
|
336
375
|
optional: true
|
|
337
376
|
type: String
|
|
@@ -358,12 +397,16 @@ reference:
|
|
|
358
397
|
optional: true
|
|
359
398
|
type: String
|
|
360
399
|
description: (user_management_get_authorization_url.state)
|
|
400
|
+
- key: provider_scopes
|
|
401
|
+
optional: true
|
|
402
|
+
type: 'Array[String]'
|
|
403
|
+
description: (user_management_get_authorization_url.provider_scopes)
|
|
361
404
|
returns:
|
|
362
405
|
- key: url
|
|
363
406
|
type: String
|
|
364
407
|
description: (user_management_get_authorization_url.url)
|
|
365
408
|
java:
|
|
366
|
-
- url: /reference/
|
|
409
|
+
- url: /reference/authkit/authentication/get-authorization-url
|
|
367
410
|
key: authorization_url
|
|
368
411
|
id: user_management_get_authorization_url
|
|
369
412
|
title: userManagement.getAuthorizationUrl()
|
|
@@ -407,13 +450,17 @@ reference:
|
|
|
407
450
|
optional: true
|
|
408
451
|
type: String
|
|
409
452
|
description: (user_management_get_authorization_url.state)
|
|
453
|
+
- key: providerScopes
|
|
454
|
+
optional: true
|
|
455
|
+
type: List<String>
|
|
456
|
+
description: (user_management_get_authorization_url.provider_scopes)
|
|
410
457
|
originalPath: >-
|
|
411
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
458
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication/get-authorization-url/index.mdx
|
|
412
459
|
---
|
|
413
460
|
|
|
414
|
-
|
|
461
|
+
# Get an authorization URL
|
|
415
462
|
|
|
416
|
-
Generates an OAuth 2.0 authorization URL to authenticate a user with AuthKit or
|
|
463
|
+
Generates an OAuth 2.0 authorization URL to authenticate a user with AuthKit or SSO.
|
|
417
464
|
|
|
418
465
|
<CodeBlock referenceId="user_management_get_authorization_url">
|
|
419
466
|
<CodeBlockTab title="Request" file="get-authorization-url-request" />
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
originalPath: >-
|
|
3
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
3
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication/get-authorization-url/pkce.mdx
|
|
4
4
|
---
|
|
5
5
|
### PKCE
|
|
6
6
|
|
|
7
7
|
The [Proof Key for Code Exchange](https://datatracker.ietf.org/doc/html/rfc7636) (PKCE) flow is an extension to the OAuth 2.0 Authorization Code flow. It enables public clients, like native apps or single-page apps, to perform the authorization code flow securely. If you are developing a client that makes API calls in public, you’ll need to use this flow.
|
|
8
8
|
|
|
9
|
-
In this flow, your client generates a code verifier which is a high-entropy cryptographic random string. A code challenge is derived by hashing the code verifier. Instead of using a client secret, provide the code challenge when [getting the authorization URL](/reference/
|
|
9
|
+
In this flow, your client generates a code verifier which is a high-entropy cryptographic random string. A code challenge is derived by hashing the code verifier. Instead of using a client secret, provide the code challenge when [getting the authorization URL](/reference/authkit/authentication/get-authorization-url) and the code verifier when [authenticating a User](/reference/authkit/authentication/code).
|
package/.docs/organized/docs/reference/authkit/authentication/get-authorization-url/redirect-uri.mdx
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
---
|
|
2
|
+
originalPath: >-
|
|
3
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication/get-authorization-url/redirect-uri.mdx
|
|
4
|
+
---
|
|
5
|
+
### Redirect URI
|
|
6
|
+
|
|
7
|
+
In the [OAuth 2.0](/glossary/oauth-2-0) protocol, a redirect URI is the location that the user is redirected to once they have successfully authenticated with their identity provider.
|
|
8
|
+
|
|
9
|
+
When redirecting the user, WorkOS will generate an authorization code and pass it to your redirect URI as a `code` query parameter, your app will use this code to [authenticate the user](/reference/authkit/authentication/code). Additionally, WorkOS can pass a `state` parameter back to your application that you may use to encode arbitrary information to restore your application state between the redirects.
|
|
10
|
+
|
|
11
|
+
```url title="Redirect URI with query parameters"
|
|
12
|
+
https://your-app.com/callback?code=01E2RJ4C05B52KKZ8FSRDAP23J&state=dj1kUXc0dzlXZ1hjUQ==
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
You can use `state` to encode parameters like originating URL and query parameters. This is useful in a flow where unauthenticated users are automatically redirected to a login page. After successful sign in, users will be routed to your redirect URI callback route. From there you can extract the originating URL from `state` and redirect the user to their intended destination.
|
|
16
|
+
|
|
17
|
+
You’ll need to configure the allowed redirect URIs for your application via the [Redirects](https://dashboard.workos.com/redirects) page in the dashboard. Without a valid redirect URI, your users will be unable to sign in. Make sure that the redirect URI you use as a parameter to get the authorization URL matches one of the redirect URIs you have configured in the dashboard.
|
|
18
|
+
|
|
19
|
+
Redirect URIs follow stricter requirements in production environments:
|
|
20
|
+
|
|
21
|
+
- `HTTPS` protocol is required in production environments
|
|
22
|
+
- `HTTP` and `localhost` are allowed in staging environments
|
|
23
|
+
- The sole exception is the use of `http://127.0.0.1` in production environments to support native clients.
|
|
24
|
+
|
|
25
|
+
#### Wildcards
|
|
26
|
+
|
|
27
|
+
WorkOS supports using wildcard characters (`*`) in Redirect URIs to handle dynamic subdomains or variable ports during development.
|
|
28
|
+
|
|
29
|
+
##### Subdomains
|
|
30
|
+
|
|
31
|
+
The `*` symbol can be used as a wildcard for subdomains; however, it must be used in accordance with the following rules:
|
|
32
|
+
|
|
33
|
+
- The protocol of the URL **must not** be `http:` in production environments.
|
|
34
|
+
- The wildcard **must** be located in the subdomain furthest from the root domain (e.g., `https://*.sub.example.com` will work, but `https://sub.*.example.com` will not).
|
|
35
|
+
- The URL **must not** contain more than one wildcard.
|
|
36
|
+
- A wildcard character **may** be prefixed and/or suffixed (e.g., `https://prefix-*-suffix.example.com`).
|
|
37
|
+
- A wildcard **will not** match across multiple subdomain levels (e.g., `https://*.example.com` will not match `https://sub1.sub2.example.com`).
|
|
38
|
+
- Wildcards cannot be used with [public suffix domains](https://publicsuffix.org) (e.g., `https://*.ngrok-free.app` will not work).
|
|
39
|
+
- The wildcard will match letters, digits, hyphens, and underscores.
|
|
40
|
+
- A URL with a wildcard cannot be set as the default redirect URI.
|
|
41
|
+
|
|
42
|
+
##### Ports
|
|
43
|
+
|
|
44
|
+
To support [RFC 8252](https://datatracker.ietf.org/doc/html/rfc8252#section-7.3) ("OAuth 2.0 for Native Apps") and local development, a wildcard may be used in place of the port number.
|
|
45
|
+
|
|
46
|
+
- This is strictly limited to `localhost` and loopback IP addresses (e.g., `127.0.0.1`).
|
|
47
|
+
- Example: `http://localhost:*/auth/callback` is valid.
|
|
@@ -22,7 +22,7 @@ descriptions:
|
|
|
22
22
|
|
|
23
23
|
of the `User-Agent` header.
|
|
24
24
|
invitation_token: >
|
|
25
|
-
The token of an [invitation](/reference/
|
|
25
|
+
The token of an [invitation](/reference/authkit/invitation). The
|
|
26
26
|
invitation should be in the pending state.
|
|
27
27
|
|
|
28
28
|
|
|
@@ -32,16 +32,16 @@ descriptions:
|
|
|
32
32
|
authenticate call automatically provisions their membership to the
|
|
33
33
|
organization.
|
|
34
34
|
organization_id: >
|
|
35
|
-
The [organization](/reference/organization) the user selected to
|
|
36
|
-
to.
|
|
35
|
+
The ID of the [organization](/reference/organization) the user selected to
|
|
36
|
+
sign in to.
|
|
37
37
|
|
|
38
38
|
|
|
39
|
-
If the user is a member of multiple organizations, this is the
|
|
39
|
+
If the user is a member of multiple organizations, this is the ID of the
|
|
40
40
|
organization the user
|
|
41
|
-
[selected](/reference/
|
|
42
|
-
|
|
43
|
-
organization, this is that organization. If the user is not a
|
|
44
|
-
any organizations, this is
|
|
41
|
+
[selected](/reference/authkit/authentication/organization-selection) as
|
|
42
|
+
part of the authentication flow. If the user is a member of only one
|
|
43
|
+
organization, this is the ID of that organization. If the user is not a
|
|
44
|
+
member of any organizations, this is omitted from the response.
|
|
45
45
|
pending_authentication_token: >-
|
|
46
46
|
The authentication token returned from a failed authentication attempt due
|
|
47
47
|
to the corresponding error.
|
|
@@ -55,10 +55,18 @@ descriptions:
|
|
|
55
55
|
sealed_session: >-
|
|
56
56
|
The sealed session data to be set as a cookie in the user's browser. Only
|
|
57
57
|
returned if the seal session parameter was true.
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
58
|
+
refresh_token_authentication:
|
|
59
|
+
organization_id: >
|
|
60
|
+
The ID of the [organization](/reference/organization) the user is signed
|
|
61
|
+
in to.
|
|
61
62
|
|
|
63
|
+
|
|
64
|
+
If the request specified a valid `organization_id`, this is that value.
|
|
65
|
+
Otherwise, this is the ID for the organization the session most recently
|
|
66
|
+
used. If the session never used an organization, it is omitted from the
|
|
67
|
+
response.
|
|
68
|
+
originalPath: >-
|
|
69
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication/index.mdx
|
|
62
70
|
---
|
|
63
71
|
|
|
64
72
|
# Authentication
|
package/.docs/organized/docs/reference/{user-management → authkit}/authentication/magic-auth.mdx
RENAMED
|
@@ -6,7 +6,7 @@ reference:
|
|
|
6
6
|
curl:
|
|
7
7
|
- key: magic-auth
|
|
8
8
|
id: authenticate_magic_auth_user
|
|
9
|
-
url: /reference/
|
|
9
|
+
url: /reference/authkit/authentication/magic-auth
|
|
10
10
|
title: /user_management/authenticate
|
|
11
11
|
type: POST
|
|
12
12
|
parameters:
|
|
@@ -56,7 +56,7 @@ reference:
|
|
|
56
56
|
js:
|
|
57
57
|
- key: authenticateWithMagicAuth
|
|
58
58
|
id: authenticate_magic_auth_user
|
|
59
|
-
url: /reference/
|
|
59
|
+
url: /reference/authkit/authentication/magic-auth
|
|
60
60
|
title: userManagement.authenticateWithMagicAuth()
|
|
61
61
|
parameters:
|
|
62
62
|
- key: options
|
|
@@ -119,7 +119,7 @@ reference:
|
|
|
119
119
|
python:
|
|
120
120
|
- key: authenticate_with_magic_auth
|
|
121
121
|
id: authenticate_magic_auth_user
|
|
122
|
-
url: /reference/
|
|
122
|
+
url: /reference/authkit/authentication/magic-auth
|
|
123
123
|
title: user_management.authenticate_with_magic_auth()
|
|
124
124
|
parameters:
|
|
125
125
|
- key: code
|
|
@@ -159,7 +159,7 @@ reference:
|
|
|
159
159
|
go:
|
|
160
160
|
- key: AuthenticateWithMagicAuth
|
|
161
161
|
id: authenticate_magic_auth_user
|
|
162
|
-
url: /reference/
|
|
162
|
+
url: /reference/authkit/authentication/magic-auth
|
|
163
163
|
title: usermanagement.AuthenticateWithMagicAuth()
|
|
164
164
|
parameters:
|
|
165
165
|
- (ctx)
|
|
@@ -200,7 +200,7 @@ reference:
|
|
|
200
200
|
php:
|
|
201
201
|
- key: authenticateWithMagicAuth
|
|
202
202
|
id: authenticate_magic_auth_user
|
|
203
|
-
url: /reference/
|
|
203
|
+
url: /reference/authkit/authentication/magic-auth
|
|
204
204
|
title: $userManagement->authenticateWithMagicAuth()
|
|
205
205
|
parameters:
|
|
206
206
|
- key: options
|
|
@@ -239,7 +239,7 @@ reference:
|
|
|
239
239
|
ruby:
|
|
240
240
|
- key: authenticate_with_magic_auth
|
|
241
241
|
id: authenticate_magic_auth_user
|
|
242
|
-
url: /reference/
|
|
242
|
+
url: /reference/authkit/authentication/magic-auth
|
|
243
243
|
title: UserManagement.authenticate_with_magic_auth()
|
|
244
244
|
parameters:
|
|
245
245
|
- key: options
|
|
@@ -278,7 +278,7 @@ reference:
|
|
|
278
278
|
java:
|
|
279
279
|
- key: authenticateWithMagicAuth
|
|
280
280
|
id: authenticate_magic_auth_user
|
|
281
|
-
url: /reference/
|
|
281
|
+
url: /reference/authkit/authentication/magic-auth
|
|
282
282
|
title: userManagement.authenticateWithMagicAuth()
|
|
283
283
|
parameters:
|
|
284
284
|
- key: clientId
|
|
@@ -340,12 +340,12 @@ reference:
|
|
|
340
340
|
optional: true
|
|
341
341
|
description: (authentication.impersonator.reason)
|
|
342
342
|
originalPath: >-
|
|
343
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
343
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication/magic-auth.mdx
|
|
344
344
|
---
|
|
345
345
|
|
|
346
346
|
## Authenticate with Magic Auth
|
|
347
347
|
|
|
348
|
-
Authenticates a user by verifying the [Magic Auth code](/reference/
|
|
348
|
+
Authenticates a user by verifying the [Magic Auth code](/reference/authkit/magic-auth) sent to the user’s email.
|
|
349
349
|
|
|
350
350
|
<CodeBlock referenceId="authenticate_magic_auth_user">
|
|
351
351
|
<CodeBlockTab title="Request" file="authenticate-magic-auth-user-request" />
|
|
@@ -8,7 +8,7 @@ reference:
|
|
|
8
8
|
curl:
|
|
9
9
|
- key: authenticate_organization_selection
|
|
10
10
|
id: authenticate_organization_selection
|
|
11
|
-
url: /reference/
|
|
11
|
+
url: /reference/authkit/authentication/organization-selection
|
|
12
12
|
title: /user_management/authenticate
|
|
13
13
|
type: POST
|
|
14
14
|
parameters:
|
|
@@ -56,7 +56,7 @@ reference:
|
|
|
56
56
|
js:
|
|
57
57
|
- key: authenticateWithOrganizationSelection
|
|
58
58
|
id: authenticate_organization_selection
|
|
59
|
-
url: /reference/
|
|
59
|
+
url: /reference/authkit/authentication/organization-selection
|
|
60
60
|
title: userManagement.authenticateWithOrganizationSelection()
|
|
61
61
|
parameters:
|
|
62
62
|
- key: clientId
|
|
@@ -113,7 +113,7 @@ reference:
|
|
|
113
113
|
python:
|
|
114
114
|
- key: authenticate_with_organization_selection
|
|
115
115
|
id: authenticate_organization_selection
|
|
116
|
-
url: /reference/
|
|
116
|
+
url: /reference/authkit/authentication/organization-selection
|
|
117
117
|
title: user_management.authenticate_with_organization_selection()
|
|
118
118
|
parameters:
|
|
119
119
|
- key: organization_id
|
|
@@ -153,7 +153,7 @@ reference:
|
|
|
153
153
|
go:
|
|
154
154
|
- key: AuthenticateWithOrganizationSelection
|
|
155
155
|
id: authenticate_organization_selection
|
|
156
|
-
url: /reference/
|
|
156
|
+
url: /reference/authkit/authentication/organization-selection
|
|
157
157
|
title: usermanagement.AuthenticateWithOrganizationSelection()
|
|
158
158
|
parameters:
|
|
159
159
|
- (ctx)
|
|
@@ -194,7 +194,7 @@ reference:
|
|
|
194
194
|
php:
|
|
195
195
|
- key: authenticateWithOrganizationSelection
|
|
196
196
|
id: authenticate_organization_selection
|
|
197
|
-
url: /reference/
|
|
197
|
+
url: /reference/authkit/authentication/organization-selection
|
|
198
198
|
title: $userManagement->authenticateWithOrganizationSelection()
|
|
199
199
|
parameters:
|
|
200
200
|
- key: clientId
|
|
@@ -229,7 +229,7 @@ reference:
|
|
|
229
229
|
ruby:
|
|
230
230
|
- key: authenticate_with_organization_selection
|
|
231
231
|
id: authenticate_organization_selection
|
|
232
|
-
url: /reference/
|
|
232
|
+
url: /reference/authkit/authentication/organization-selection
|
|
233
233
|
title: UserManagement.authenticate_with_organization_selection()
|
|
234
234
|
parameters:
|
|
235
235
|
- key: client_id
|
|
@@ -264,7 +264,7 @@ reference:
|
|
|
264
264
|
java:
|
|
265
265
|
- key: authenticateWithOrganizationSelection
|
|
266
266
|
id: authenticate_organization_selection
|
|
267
|
-
url: /reference/
|
|
267
|
+
url: /reference/authkit/authentication/organization-selection
|
|
268
268
|
title: userManagement.authenticateWithOrganizationSelection()
|
|
269
269
|
parameters:
|
|
270
270
|
- key: clientId
|
|
@@ -326,14 +326,14 @@ reference:
|
|
|
326
326
|
optional: true
|
|
327
327
|
description: (authentication.impersonator.reason)
|
|
328
328
|
originalPath: >-
|
|
329
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
329
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication/organization-selection.mdx
|
|
330
330
|
---
|
|
331
331
|
|
|
332
332
|
## Authenticate with organization selection
|
|
333
333
|
|
|
334
334
|
Authenticates a user into an organization they are a member of.
|
|
335
335
|
|
|
336
|
-
When a user who is a member of multiple organizations attempts to authenticate with their credentials, the API will return an [organization selection error](/reference/
|
|
336
|
+
When a user who is a member of multiple organizations attempts to authenticate with their credentials, the API will return an [organization selection error](/reference/authkit/authentication-errors/organization-selection-error) that contains a pending authentication token. To continue with the authentication flow, your application should display the list of organizations for the user to choose.
|
|
337
337
|
|
|
338
338
|
Use the pending authentication token from the error and the organization the user selected in your UI to complete the authentication.
|
|
339
339
|
|
package/.docs/organized/docs/reference/{user-management → authkit}/authentication/password.mdx
RENAMED
|
@@ -3,7 +3,7 @@ reference:
|
|
|
3
3
|
curl:
|
|
4
4
|
- key: password
|
|
5
5
|
id: authenticate_password_user
|
|
6
|
-
url: /reference/
|
|
6
|
+
url: /reference/authkit/authentication/password
|
|
7
7
|
title: /user_management/authenticate
|
|
8
8
|
type: POST
|
|
9
9
|
parameters:
|
|
@@ -53,7 +53,7 @@ reference:
|
|
|
53
53
|
js:
|
|
54
54
|
- key: authenticateWithPassword
|
|
55
55
|
id: authenticate_password_user
|
|
56
|
-
url: /reference/
|
|
56
|
+
url: /reference/authkit/authentication/password
|
|
57
57
|
title: userManagement.authenticateWithPassword()
|
|
58
58
|
parameters:
|
|
59
59
|
- key: options
|
|
@@ -116,7 +116,7 @@ reference:
|
|
|
116
116
|
python:
|
|
117
117
|
- key: authenticate_with_password
|
|
118
118
|
id: authenticate_password_user
|
|
119
|
-
url: /reference/
|
|
119
|
+
url: /reference/authkit/authentication/password
|
|
120
120
|
title: user_management.authenticate_with_password()
|
|
121
121
|
parameters:
|
|
122
122
|
- key: email
|
|
@@ -156,7 +156,7 @@ reference:
|
|
|
156
156
|
go:
|
|
157
157
|
- key: AuthenticateWithPassword
|
|
158
158
|
id: authenticate_password_user
|
|
159
|
-
url: /reference/
|
|
159
|
+
url: /reference/authkit/authentication/password
|
|
160
160
|
title: usermanagement.AuthenticateWithPassword()
|
|
161
161
|
parameters:
|
|
162
162
|
- (ctx)
|
|
@@ -197,7 +197,7 @@ reference:
|
|
|
197
197
|
php:
|
|
198
198
|
- key: authenticateWithPassword
|
|
199
199
|
id: authenticate_password_user
|
|
200
|
-
url: /reference/
|
|
200
|
+
url: /reference/authkit/authentication/password
|
|
201
201
|
title: $userManagement->authenticateWithPassword()
|
|
202
202
|
parameters:
|
|
203
203
|
- key: options
|
|
@@ -236,7 +236,7 @@ reference:
|
|
|
236
236
|
ruby:
|
|
237
237
|
- key: authenticate_with_password
|
|
238
238
|
id: authenticate_password_user
|
|
239
|
-
url: /reference/
|
|
239
|
+
url: /reference/authkit/authentication/password
|
|
240
240
|
title: UserManagement.authenticate_with_password()
|
|
241
241
|
parameters:
|
|
242
242
|
- key: options
|
|
@@ -275,7 +275,7 @@ reference:
|
|
|
275
275
|
java:
|
|
276
276
|
- key: authenticateWithPassword
|
|
277
277
|
id: authenticate_password_user
|
|
278
|
-
url: /reference/
|
|
278
|
+
url: /reference/authkit/authentication/password
|
|
279
279
|
title: userManagement.authenticateWithPassword()
|
|
280
280
|
parameters:
|
|
281
281
|
- key: clientId
|
|
@@ -337,7 +337,7 @@ reference:
|
|
|
337
337
|
optional: true
|
|
338
338
|
description: (authentication.impersonator.reason)
|
|
339
339
|
originalPath: >-
|
|
340
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
340
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication/password.mdx
|
|
341
341
|
---
|
|
342
342
|
|
|
343
343
|
## Authenticate a user with password
|