@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
|
@@ -3,7 +3,7 @@ reference:
|
|
|
3
3
|
js:
|
|
4
4
|
- key: refreshAndSealSessionData
|
|
5
5
|
id: refresh_and_seal_session_data
|
|
6
|
-
url: /reference/
|
|
6
|
+
url: /reference/authkit/authentication/refresh-and-seal-session-data
|
|
7
7
|
title: userManagement.refreshAndSealSessionData()
|
|
8
8
|
parameters:
|
|
9
9
|
- key: options
|
|
@@ -37,12 +37,12 @@ reference:
|
|
|
37
37
|
The reason authentication failed. Only present if `authenticated
|
|
38
38
|
= false`.
|
|
39
39
|
originalPath: >-
|
|
40
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
40
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication/refresh-and-seal-session-data.mdx
|
|
41
41
|
---
|
|
42
42
|
|
|
43
43
|
## Refresh and seal session data
|
|
44
44
|
|
|
45
|
-
Unseals the provided session data from a user's session cookie, [authenticates with the existing refresh token](/reference/
|
|
45
|
+
Unseals the provided session data from a user's session cookie, [authenticates with the existing refresh token](/reference/authkit/authentication/refresh-token), and returns the sealed data for the refreshed session.
|
|
46
46
|
|
|
47
47
|
<CodeBlock referenceId="refresh_and_seal_session_data">
|
|
48
48
|
<CodeBlockTab title="Request" file="refresh-and-seal-session-data-request" />
|
package/.docs/organized/docs/reference/{user-management → authkit}/authentication/refresh-token.mdx
RENAMED
|
@@ -7,8 +7,8 @@ descriptions:
|
|
|
7
7
|
|
|
8
8
|
session is not authorized for the organization, an appropriate
|
|
9
9
|
|
|
10
|
-
[authentication error](/reference/
|
|
11
|
-
|
|
10
|
+
[authentication error](/reference/authkit/authentication-errors) will be
|
|
11
|
+
returned.
|
|
12
12
|
|
|
13
13
|
|
|
14
14
|
If no organization ID is provided, then the access token will default to
|
|
@@ -19,7 +19,7 @@ reference:
|
|
|
19
19
|
curl:
|
|
20
20
|
- key: authenticate-refresh-token
|
|
21
21
|
id: authenticate_with_refresh_token
|
|
22
|
-
url: /reference/
|
|
22
|
+
url: /reference/authkit/authentication/refresh-token
|
|
23
23
|
title: /user_management/authenticate
|
|
24
24
|
type: POST
|
|
25
25
|
parameters:
|
|
@@ -58,7 +58,7 @@ reference:
|
|
|
58
58
|
- key: organization_id
|
|
59
59
|
type: string
|
|
60
60
|
optional: true
|
|
61
|
-
description: (
|
|
61
|
+
description: (refresh_token_authentication.organization_id)
|
|
62
62
|
- key: access_token
|
|
63
63
|
type: String
|
|
64
64
|
optional: false
|
|
@@ -69,8 +69,8 @@ reference:
|
|
|
69
69
|
optional: false
|
|
70
70
|
description: >
|
|
71
71
|
[Exchange this
|
|
72
|
-
token](/reference/
|
|
73
|
-
|
|
72
|
+
token](/reference/authkit/authentication/refresh-token) for a
|
|
73
|
+
new access token.
|
|
74
74
|
- key: authentication_method
|
|
75
75
|
type: >-
|
|
76
76
|
"SSO" | "Password" | "AppleOAuth" | "GitHubOAuth" |
|
|
@@ -91,7 +91,7 @@ reference:
|
|
|
91
91
|
js:
|
|
92
92
|
- key: authenticateWithRefreshToken
|
|
93
93
|
id: authenticate_with_refresh_token
|
|
94
|
-
url: /reference/
|
|
94
|
+
url: /reference/authkit/authentication/refresh-token
|
|
95
95
|
title: userManagement.authenticateWithRefreshToken()
|
|
96
96
|
parameters:
|
|
97
97
|
- key: options
|
|
@@ -139,7 +139,7 @@ reference:
|
|
|
139
139
|
- key: organizationId
|
|
140
140
|
type: string
|
|
141
141
|
optional: true
|
|
142
|
-
description: (
|
|
142
|
+
description: (refresh_token_authentication.organization_id)
|
|
143
143
|
- key: accessToken
|
|
144
144
|
type: string
|
|
145
145
|
optional: false
|
|
@@ -150,8 +150,8 @@ reference:
|
|
|
150
150
|
optional: false
|
|
151
151
|
description: >
|
|
152
152
|
[Exchange this
|
|
153
|
-
token](/reference/
|
|
154
|
-
|
|
153
|
+
token](/reference/authkit/authentication/refresh-token) for new
|
|
154
|
+
access tokens.
|
|
155
155
|
- key: authenticationMethod
|
|
156
156
|
type: >-
|
|
157
157
|
"SSO" | "Password" | "AppleOAuth" | "GitHubOAuth" |
|
|
@@ -176,7 +176,7 @@ reference:
|
|
|
176
176
|
python:
|
|
177
177
|
- key: authenticate_with_refresh_token
|
|
178
178
|
id: authenticate_with_refresh_token
|
|
179
|
-
url: /reference/
|
|
179
|
+
url: /reference/authkit/authentication/refresh-token
|
|
180
180
|
title: user_management.authenticate_with_refresh_token()
|
|
181
181
|
parameters:
|
|
182
182
|
- key: refresh_token
|
|
@@ -208,7 +208,7 @@ reference:
|
|
|
208
208
|
go:
|
|
209
209
|
- key: AuthenticateWithRefreshToken
|
|
210
210
|
id: authenticate_with_refresh_token
|
|
211
|
-
url: /reference/
|
|
211
|
+
url: /reference/authkit/authentication/refresh-token
|
|
212
212
|
title: usermanagement.AuthenticateWithRefreshToken()
|
|
213
213
|
parameters:
|
|
214
214
|
- (ctx)
|
|
@@ -249,7 +249,7 @@ reference:
|
|
|
249
249
|
ruby:
|
|
250
250
|
- key: authenticate_with_refresh_token
|
|
251
251
|
id: authenticate_with_refresh_token
|
|
252
|
-
url: /reference/
|
|
252
|
+
url: /reference/authkit/authentication/refresh-token
|
|
253
253
|
title: UserManagement.authenticate_with_refreshToken()
|
|
254
254
|
parameters:
|
|
255
255
|
- key: client_id
|
|
@@ -285,7 +285,7 @@ reference:
|
|
|
285
285
|
java:
|
|
286
286
|
- key: authenticateWithRefreshToken
|
|
287
287
|
id: authenticate_with_refresh_token
|
|
288
|
-
url: /reference/
|
|
288
|
+
url: /reference/authkit/authentication/refresh-token
|
|
289
289
|
title: userManagement.authenticateWithRefreshToken()
|
|
290
290
|
parameters:
|
|
291
291
|
- key: client_id
|
|
@@ -329,7 +329,7 @@ reference:
|
|
|
329
329
|
php:
|
|
330
330
|
- key: authenticateWithRefreshToken
|
|
331
331
|
id: authenticate_with_refresh_token
|
|
332
|
-
url: /reference/
|
|
332
|
+
url: /reference/authkit/authentication/refresh-token
|
|
333
333
|
title: $userManagement->authenticateWithRefreshToken()
|
|
334
334
|
parameters:
|
|
335
335
|
- key: clientID
|
|
@@ -362,12 +362,12 @@ reference:
|
|
|
362
362
|
type: string
|
|
363
363
|
description: (authentication.refresh_token)
|
|
364
364
|
originalPath: >-
|
|
365
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
365
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication/refresh-token.mdx
|
|
366
366
|
---
|
|
367
367
|
|
|
368
368
|
## Authenticate with refresh token
|
|
369
369
|
|
|
370
|
-
Use this endpoint to exchange a refresh token for a new access token. Refresh tokens
|
|
370
|
+
Use this endpoint to exchange a refresh token for a new access token. Refresh tokens may be rotated after use, so a replacement refresh token is also provided.
|
|
371
371
|
|
|
372
372
|
<CodeBlock referenceId="authenticate_with_refresh_token">
|
|
373
373
|
<CodeBlockTab
|
package/.docs/organized/docs/reference/{user-management → authkit}/authentication/session-cookie.mdx
RENAMED
|
@@ -11,7 +11,7 @@ reference:
|
|
|
11
11
|
js:
|
|
12
12
|
- key: authenticateWithSessionCookie
|
|
13
13
|
id: authenticate_with_session_cookie
|
|
14
|
-
url: /reference/
|
|
14
|
+
url: /reference/authkit/authentication/session-cookie
|
|
15
15
|
title: userManagement.authenticateWithSessionCookie()
|
|
16
16
|
parameters:
|
|
17
17
|
- key: options
|
|
@@ -43,6 +43,10 @@ reference:
|
|
|
43
43
|
type: string
|
|
44
44
|
optional: true
|
|
45
45
|
description: (access_token.role)
|
|
46
|
+
- key: roles
|
|
47
|
+
type: array
|
|
48
|
+
optional: true
|
|
49
|
+
description: (access_token.roles)
|
|
46
50
|
- key: permissions
|
|
47
51
|
type: string
|
|
48
52
|
optional: true
|
|
@@ -56,12 +60,12 @@ reference:
|
|
|
56
60
|
The reason authentication failed. Only present if `authenticated
|
|
57
61
|
= false`.
|
|
58
62
|
originalPath: >-
|
|
59
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
63
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication/session-cookie.mdx
|
|
60
64
|
---
|
|
61
65
|
|
|
62
66
|
## Authenticate with session cookie
|
|
63
67
|
|
|
64
|
-
Authenticates a user using an AuthKit session cookie. This method does not make a network call, but simply unseals an existing session cookie and decodes the JWT claims from the [access token](/reference/
|
|
68
|
+
Authenticates a user using an AuthKit session cookie. This method does not make a network call, but simply unseals an existing session cookie and decodes the JWT claims from the [access token](/reference/authkit/session-tokens/access-token).
|
|
65
69
|
|
|
66
70
|
<CodeBlock referenceId="authenticate_with_session_cookie">
|
|
67
71
|
<CodeBlockTab
|
|
@@ -11,7 +11,7 @@ reference:
|
|
|
11
11
|
curl:
|
|
12
12
|
- key: authenticate_mfa_totp
|
|
13
13
|
id: authenticate_mfa_totp
|
|
14
|
-
url: /reference/
|
|
14
|
+
url: /reference/authkit/authentication/totp
|
|
15
15
|
title: /user_management/authenticate
|
|
16
16
|
type: POST
|
|
17
17
|
parameters:
|
|
@@ -62,7 +62,7 @@ reference:
|
|
|
62
62
|
js:
|
|
63
63
|
- key: authenticateWithTotp
|
|
64
64
|
id: authenticate_mfa_totp
|
|
65
|
-
url: /reference/
|
|
65
|
+
url: /reference/authkit/authentication/totp
|
|
66
66
|
title: userManagement.authenticateWithTotp()
|
|
67
67
|
parameters:
|
|
68
68
|
- key: clientId
|
|
@@ -122,7 +122,7 @@ reference:
|
|
|
122
122
|
python:
|
|
123
123
|
- key: authenticate_with_totp
|
|
124
124
|
id: authenticate_mfa_totp
|
|
125
|
-
url: /reference/
|
|
125
|
+
url: /reference/authkit/authentication/totp
|
|
126
126
|
title: user_management.authenticate_with_totp()
|
|
127
127
|
parameters:
|
|
128
128
|
- key: code
|
|
@@ -165,7 +165,7 @@ reference:
|
|
|
165
165
|
go:
|
|
166
166
|
- key: AuthenticateWithTOTP
|
|
167
167
|
id: authenticate_mfa_totp
|
|
168
|
-
url: /reference/
|
|
168
|
+
url: /reference/authkit/authentication/totp
|
|
169
169
|
title: usermanagement.AuthenticateWithTOTP()
|
|
170
170
|
parameters:
|
|
171
171
|
- (ctx)
|
|
@@ -209,7 +209,7 @@ reference:
|
|
|
209
209
|
php:
|
|
210
210
|
- key: authenticateWithTotp
|
|
211
211
|
id: authenticate_mfa_totp
|
|
212
|
-
url: /reference/
|
|
212
|
+
url: /reference/authkit/authentication/totp
|
|
213
213
|
title: $userManagement->authenticateWithTotp()
|
|
214
214
|
parameters:
|
|
215
215
|
- key: clientId
|
|
@@ -247,7 +247,7 @@ reference:
|
|
|
247
247
|
ruby:
|
|
248
248
|
- key: authenticate_with_totp
|
|
249
249
|
id: authenticate_mfa_totp
|
|
250
|
-
url: /reference/
|
|
250
|
+
url: /reference/authkit/authentication/totp
|
|
251
251
|
title: UserManagement.authenticate_with_totp()
|
|
252
252
|
parameters:
|
|
253
253
|
- key: client_id
|
|
@@ -285,7 +285,7 @@ reference:
|
|
|
285
285
|
java:
|
|
286
286
|
- key: authenticateWithTotp
|
|
287
287
|
id: authenticate_mfa_totp
|
|
288
|
-
url: /reference/
|
|
288
|
+
url: /reference/authkit/authentication/totp
|
|
289
289
|
title: userManagement.authenticateWithTotp()
|
|
290
290
|
parameters:
|
|
291
291
|
- key: clientId
|
|
@@ -350,16 +350,16 @@ reference:
|
|
|
350
350
|
optional: true
|
|
351
351
|
description: (authentication.impersonator.reason)
|
|
352
352
|
originalPath: >-
|
|
353
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
353
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication/totp.mdx
|
|
354
354
|
---
|
|
355
355
|
|
|
356
356
|
## Authenticate with a time-based one-time password
|
|
357
357
|
|
|
358
358
|
Authenticates a user enrolled into MFA using time-based one-time password (TOTP).
|
|
359
359
|
|
|
360
|
-
Users enrolled into MFA are required to enter a TOTP each time they sign in. When they attempt to authenticate with their credentials, the API will return an [MFA challenge error](/reference/
|
|
360
|
+
Users enrolled into MFA are required to enter a TOTP each time they sign in. When they attempt to authenticate with their credentials, the API will return an [MFA challenge error](/reference/authkit/authentication-errors/mfa-challenge-error) that contains a pending authentication token.
|
|
361
361
|
|
|
362
|
-
To continue with the authentication flow, [challenge](/reference/mfa/challenge
|
|
362
|
+
To continue with the authentication flow, [challenge](/reference/mfa/challenge/create) one of the factors returned by the MFA challenge error response and present a UI to the user to enter the TOTP code. Then, authenticate the user with the TOTP code, the challenge from the factor, and the pending authentication token from the MFA challenge error.
|
|
363
363
|
|
|
364
364
|
MFA can be enabled via the [Authentication page](https://dashboard.workos.com/authentication) in the WorkOS dashboard.
|
|
365
365
|
|
|
@@ -4,7 +4,7 @@ reference:
|
|
|
4
4
|
- key: email_verification_required_error
|
|
5
5
|
id: email_verification_required_error
|
|
6
6
|
url: >-
|
|
7
|
-
/reference/
|
|
7
|
+
/reference/authkit/authentication-errors/email-verification-required-error
|
|
8
8
|
title: email_verification_required
|
|
9
9
|
sendsEmail: true
|
|
10
10
|
properties:
|
|
@@ -24,7 +24,7 @@ reference:
|
|
|
24
24
|
type: string
|
|
25
25
|
description: (email_verification.id)
|
|
26
26
|
originalPath: >-
|
|
27
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
27
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication-errors/email-verification-required-error.mdx
|
|
28
28
|
---
|
|
29
29
|
|
|
30
30
|
## Email verification required error
|
|
@@ -37,6 +37,6 @@ This error indicates that a user with an unverified email address attempted to a
|
|
|
37
37
|
file="email-verification-required-error"
|
|
38
38
|
/>
|
|
39
39
|
|
|
40
|
-
When this error occurs and the [email setting](/
|
|
40
|
+
When this error occurs and 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 and issue a pending authentication token. If the email setting is not enabled, [retrieve the email verification code](/reference/authkit/email-verification/get) to send the email verification email yourself. To complete the authentication process, use the pending authentication token from the error and the one-time code the user received to [authenticate](/reference/authkit/authentication) them and to verify their email address.
|
|
41
41
|
|
|
42
42
|
The same applies when a user attempts to authenticate with OAuth or SSO, but there was already an account with a matching unverified email address.
|
package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/index.mdx
RENAMED
|
@@ -8,9 +8,7 @@ descriptions:
|
|
|
8
8
|
corresponding method after this error occurs.
|
|
9
9
|
email: The email of the authenticating user.
|
|
10
10
|
originalPath: >-
|
|
11
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
12
|
-
---
|
|
13
|
-
|
|
11
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication-errors/index.mdx
|
|
14
12
|
---
|
|
15
13
|
|
|
16
14
|
# Authentication errors
|
|
@@ -7,7 +7,7 @@ reference:
|
|
|
7
7
|
json:
|
|
8
8
|
- key: mfa_challenge_error
|
|
9
9
|
id: mfa_challenge_error
|
|
10
|
-
url: /reference/
|
|
10
|
+
url: /reference/authkit/authentication-errors/mfa-challenge-error
|
|
11
11
|
title: mfa_challenge
|
|
12
12
|
properties:
|
|
13
13
|
- key: code
|
|
@@ -26,7 +26,7 @@ reference:
|
|
|
26
26
|
type: user
|
|
27
27
|
description: (user.self)
|
|
28
28
|
originalPath: >-
|
|
29
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
29
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication-errors/mfa-challenge-error.mdx
|
|
30
30
|
---
|
|
31
31
|
|
|
32
32
|
## MFA challenge error
|
|
@@ -39,6 +39,6 @@ This error indicates that a user enrolled into MFA attempted to authenticate in
|
|
|
39
39
|
file="mfa-challenge-error"
|
|
40
40
|
/>
|
|
41
41
|
|
|
42
|
-
When this error occurs, you’ll need to present an MFA challenge UI to the user and authenticate them with their [TOTP code](/reference/
|
|
42
|
+
When this error occurs, you’ll need to present an MFA challenge UI to the user and authenticate them with their [TOTP code](/reference/authkit/authentication/totp), the pending authentication token from this error, and a [challenge](/reference/mfa/challenge/create) that corresponds to one of the authentication factors.
|
|
43
43
|
|
|
44
44
|
MFA can be enabled via the [Authentication page](https://dashboard.workos.com/authentication) in the WorkOS dashboard.
|
|
@@ -3,7 +3,7 @@ reference:
|
|
|
3
3
|
json:
|
|
4
4
|
- key: mfa_enrollment_error
|
|
5
5
|
id: mfa_enrollment_error
|
|
6
|
-
url: /reference/
|
|
6
|
+
url: /reference/authkit/authentication-errors/mfa-enrollment-error
|
|
7
7
|
title: mfa_enrollment
|
|
8
8
|
properties:
|
|
9
9
|
- key: code
|
|
@@ -19,7 +19,7 @@ reference:
|
|
|
19
19
|
type: user
|
|
20
20
|
description: (user.self)
|
|
21
21
|
originalPath: >-
|
|
22
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
22
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication-errors/mfa-enrollment-error.mdx
|
|
23
23
|
---
|
|
24
24
|
|
|
25
25
|
## MFA enrollment error
|
|
@@ -32,6 +32,6 @@ This error indicates that a user who is not enrolled into MFA attempted to authe
|
|
|
32
32
|
file="mfa-enrollment-error"
|
|
33
33
|
/>
|
|
34
34
|
|
|
35
|
-
When this error occurs, you’ll need to present an [MFA enrollment](/reference/
|
|
35
|
+
When this error occurs, you’ll need to present an [MFA enrollment](/reference/authkit/mfa/enroll-auth-factor) UI to the user. Once the user has enrolled, present an MFA challenge UI to the user and authenticate them with their [TOTP code](/reference/authkit/authentication/totp) and the pending authentication token from this error.
|
|
36
36
|
|
|
37
37
|
MFA can be enabled via the [Authentication page](https://dashboard.workos.com/authentication) in the WorkOS dashboard.
|
|
@@ -15,7 +15,7 @@ reference:
|
|
|
15
15
|
- key: organization_authentication_required_error
|
|
16
16
|
id: organization_authentication_required_error
|
|
17
17
|
url: >-
|
|
18
|
-
/reference/
|
|
18
|
+
/reference/authkit/authentication-errors/organization-authentication-required-error
|
|
19
19
|
title: organization_authentication_methods_required
|
|
20
20
|
properties:
|
|
21
21
|
- key: error
|
|
@@ -52,12 +52,12 @@ reference:
|
|
|
52
52
|
type: boolean
|
|
53
53
|
description: (authentication_errors.password)
|
|
54
54
|
originalPath: >-
|
|
55
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
55
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication-errors/organization-authentication-required-error.mdx
|
|
56
56
|
---
|
|
57
57
|
|
|
58
58
|
## Organization authentication required error
|
|
59
59
|
|
|
60
|
-
This error indicates that a user attempted to authenticate with an authentication method that is not allowed by the organization that has a [domain policy](/
|
|
60
|
+
This error indicates that a user attempted to authenticate with an authentication method that is not allowed by the organization that has a [domain policy](/authkit/organization-policies) managing this user. It includes all the possible methods the user can use to authenticate.
|
|
61
61
|
|
|
62
62
|
<CodeBlock
|
|
63
63
|
title="Organization authentication required error"
|
|
@@ -8,8 +8,7 @@ reference:
|
|
|
8
8
|
json:
|
|
9
9
|
- key: organization_selection_required_error
|
|
10
10
|
id: organization_selection_required_error
|
|
11
|
-
url:
|
|
12
|
-
/reference/user-management/authentication-errors/organization-selection-error
|
|
11
|
+
url: /reference/authkit/authentication-errors/organization-selection-error
|
|
13
12
|
title: organization_selection_required
|
|
14
13
|
properties:
|
|
15
14
|
- key: code
|
|
@@ -28,7 +27,7 @@ reference:
|
|
|
28
27
|
type: array
|
|
29
28
|
description: (authentication_errors.organizations)
|
|
30
29
|
originalPath: >-
|
|
31
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
30
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication-errors/organization-selection-error.mdx
|
|
32
31
|
---
|
|
33
32
|
|
|
34
33
|
## Organization selection required error
|
|
@@ -41,4 +40,4 @@ This error indicates that the user is a member of multiple organizations and mus
|
|
|
41
40
|
file="organization-selection-error"
|
|
42
41
|
/>
|
|
43
42
|
|
|
44
|
-
When this error occurs, you’ll need to display the list of organizations that the user is a member of and authenticate them with the [selected organization](/reference/
|
|
43
|
+
When this error occurs, you’ll need to display the list of organizations that the user is a member of and authenticate them with the [selected organization](/reference/authkit/authentication/organization-selection) using the pending authentication token from the error.
|
|
@@ -15,7 +15,7 @@ reference:
|
|
|
15
15
|
json:
|
|
16
16
|
- key: sso_required_error
|
|
17
17
|
id: sso_required_error
|
|
18
|
-
url: /reference/
|
|
18
|
+
url: /reference/authkit/authentication-errors/sso-required-error
|
|
19
19
|
title: sso_required
|
|
20
20
|
properties:
|
|
21
21
|
- key: error
|
|
@@ -35,7 +35,7 @@ reference:
|
|
|
35
35
|
optional: true
|
|
36
36
|
description: (authentication_errors.optional_pending_authentication_token)
|
|
37
37
|
originalPath: >-
|
|
38
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
38
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/authentication-errors/sso-required-error.mdx
|
|
39
39
|
---
|
|
40
40
|
|
|
41
41
|
## SSO required error
|
|
@@ -48,4 +48,4 @@ This error indicates that a user attempted to authenticate into an organization
|
|
|
48
48
|
file="sso-required-error"
|
|
49
49
|
/>
|
|
50
50
|
|
|
51
|
-
When this error occurs, you’ll need to use one of the SSO connections from the error to [get the authorization URL](/reference/
|
|
51
|
+
When this error occurs, you’ll need to use one of the SSO connections from the error to [get the authorization URL](/reference/authkit/authentication/get-authorization-url) and redirect the user to that URL to complete the authentication with the organization’s identity provider.
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Get a device authorization URL
|
|
3
|
+
description: Initiate the CLI Auth flow by obtaining a device code and verification URLs.
|
|
4
|
+
descriptions:
|
|
5
|
+
device_authorization:
|
|
6
|
+
client_id: The WorkOS client ID for your application.
|
|
7
|
+
device_authorization_response:
|
|
8
|
+
device_code: >-
|
|
9
|
+
A unique identifier for this authorization request. Use this when polling
|
|
10
|
+
the token endpoint.
|
|
11
|
+
user_code: 'A short, user-friendly code that users enter to authorize the device.'
|
|
12
|
+
verification_uri: The URL where users can enter the user code to authorize the device.
|
|
13
|
+
verification_uri_complete: 'A URL with the user code pre-filled, allowing one-click authorization.'
|
|
14
|
+
expires_in: >-
|
|
15
|
+
The lifetime of the device code and user code in seconds. The default is 5
|
|
16
|
+
minutes.
|
|
17
|
+
interval: >-
|
|
18
|
+
The minimum interval in seconds between token requests. The default is 5
|
|
19
|
+
seconds.
|
|
20
|
+
reference:
|
|
21
|
+
curl:
|
|
22
|
+
- key: device-authorization
|
|
23
|
+
id: device_authorization_request
|
|
24
|
+
url: /reference/authkit/cli-auth/device-authorization
|
|
25
|
+
title: /user_management/authorize/device
|
|
26
|
+
type: POST
|
|
27
|
+
parameters:
|
|
28
|
+
- key: client_id
|
|
29
|
+
type: string
|
|
30
|
+
description: (device_authorization.client_id)
|
|
31
|
+
returns:
|
|
32
|
+
- key: device_code
|
|
33
|
+
type: string
|
|
34
|
+
description: (device_authorization_response.device_code)
|
|
35
|
+
- key: user_code
|
|
36
|
+
type: string
|
|
37
|
+
description: (device_authorization_response.user_code)
|
|
38
|
+
- key: verification_uri
|
|
39
|
+
type: string
|
|
40
|
+
description: (device_authorization_response.verification_uri)
|
|
41
|
+
- key: verification_uri_complete
|
|
42
|
+
type: string
|
|
43
|
+
description: (device_authorization_response.verification_uri_complete)
|
|
44
|
+
- key: expires_in
|
|
45
|
+
type: integer
|
|
46
|
+
description: (device_authorization_response.expires_in)
|
|
47
|
+
- key: interval
|
|
48
|
+
type: integer
|
|
49
|
+
description: (device_authorization_response.interval)
|
|
50
|
+
originalPath: >-
|
|
51
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/cli-auth/device-authorization.mdx
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## Get device authorization URL
|
|
55
|
+
|
|
56
|
+
Initiates the CLI Auth flow by requesting a device code and verification URLs. This endpoint implements the OAuth 2.0 Device Authorization Flow ([RFC 8628](https://datatracker.ietf.org/doc/html/rfc8628)) and is designed for command-line applications or other devices with limited input capabilities.
|
|
57
|
+
|
|
58
|
+
<CodeBlock referenceId="device_authorization_request">
|
|
59
|
+
<CodeBlockTab title="Request" file="device-authorization-request" />
|
|
60
|
+
<CodeBlockTab title="Response" file="device-authorization-response" />
|
|
61
|
+
</CodeBlock>
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Device code
|
|
3
|
+
description: Exchange a device code for access and refresh tokens during the CLI Auth flow.
|
|
4
|
+
descriptions:
|
|
5
|
+
device_code_request:
|
|
6
|
+
grant_type: >-
|
|
7
|
+
Must be `urn:ietf:params:oauth:grant-type:device_code` for device
|
|
8
|
+
authorization flow.
|
|
9
|
+
device_code: The device code obtained from the device authorization endpoint.
|
|
10
|
+
client_id: The WorkOS client ID for your application.
|
|
11
|
+
device_code_response:
|
|
12
|
+
access_token: The access token for making authenticated requests.
|
|
13
|
+
refresh_token: The refresh token for obtaining new access tokens.
|
|
14
|
+
token_type: 'The token type, always "Bearer".'
|
|
15
|
+
expires_in: The lifetime of the access token in seconds.
|
|
16
|
+
reference:
|
|
17
|
+
curl:
|
|
18
|
+
- key: device-code
|
|
19
|
+
id: device_code_exchange
|
|
20
|
+
url: /reference/authkit/cli-auth/device-code
|
|
21
|
+
title: /user_management/authenticate
|
|
22
|
+
type: POST
|
|
23
|
+
parameters:
|
|
24
|
+
- key: grant_type
|
|
25
|
+
type: '"urn:ietf:params:oauth:grant-type:device_code"'
|
|
26
|
+
description: (device_code_request.grant_type)
|
|
27
|
+
- key: device_code
|
|
28
|
+
type: string
|
|
29
|
+
description: (device_code_request.device_code)
|
|
30
|
+
- key: client_id
|
|
31
|
+
type: string
|
|
32
|
+
description: (device_code_request.client_id)
|
|
33
|
+
returns:
|
|
34
|
+
- key: access_token
|
|
35
|
+
type: string
|
|
36
|
+
description: (device_code_response.access_token)
|
|
37
|
+
- key: refresh_token
|
|
38
|
+
type: string
|
|
39
|
+
description: (device_code_response.refresh_token)
|
|
40
|
+
- key: token_type
|
|
41
|
+
type: '"Bearer"'
|
|
42
|
+
description: (device_code_response.token_type)
|
|
43
|
+
- key: expires_in
|
|
44
|
+
type: integer
|
|
45
|
+
description: (device_code_response.expires_in)
|
|
46
|
+
originalPath: >-
|
|
47
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/cli-auth/device-code.mdx
|
|
48
|
+
---
|
|
49
|
+
|
|
50
|
+
## Device code
|
|
51
|
+
|
|
52
|
+
Exchanges a device code for access and refresh tokens as part of the [CLI Auth](/authkit/cli-auth) flow. This endpoint should be polled repeatedly until the user authorizes the request, declines it, or the device code expires.
|
|
53
|
+
|
|
54
|
+
<CodeBlock referenceId="device_code_exchange">
|
|
55
|
+
<CodeBlockTab title="Request" file="device-code-request" />
|
|
56
|
+
<CodeBlockTab title="Response" file="device-code-response" />
|
|
57
|
+
</CodeBlock>
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
---
|
|
2
|
+
originalPath: >-
|
|
3
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/cli-auth/error-codes.mdx
|
|
4
|
+
---
|
|
5
|
+
### Error codes
|
|
6
|
+
|
|
7
|
+
When polling the device code endpoint, you may receive various error responses before the user completes authorization or if authorization fails. These errors help your application understand the current state and take appropriate action.
|
|
8
|
+
|
|
9
|
+
Possible error codes and the corresponding descriptions are listed below.
|
|
10
|
+
|
|
11
|
+
| Error code | Description |
|
|
12
|
+
| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
13
|
+
| `authorization_pending` | The authorization request is still pending as the user hasn't yet completed the user interaction flow. Continue polling at the specified interval. |
|
|
14
|
+
| `slow_down` | The client is polling too frequently and should slow down. Increase your polling interval by at least 5 seconds and continue polling. |
|
|
15
|
+
| `access_denied` | The user declined the authorization request. Stop polling and inform the user that authorization was denied. |
|
|
16
|
+
| `expired_token` | The device code has expired (typically after 5 minutes). Stop polling and restart the authorization flow if needed. |
|
|
17
|
+
| `invalid_request` | The request is missing a required parameter or includes an invalid parameter value. Check that `grant_type`, `device_code`, and `client_id` are provided and correct. |
|
|
18
|
+
| `invalid_client` | Client authentication failed (e.g., unknown client, client authentication not included, or unsupported authentication method). |
|
|
19
|
+
| `invalid_grant` | The provided device code is invalid, malformed, or has already been used. |
|
|
20
|
+
| `unsupported_grant_type` | The grant type is not supported. Ensure you're using `urn:ietf:params:oauth:grant-type:device_code`. |
|
|
21
|
+
|
|
22
|
+
### Error response format
|
|
23
|
+
|
|
24
|
+
All error responses are returned with a 400 status code and follow the OAuth 2.0 error response format. For example:
|
|
25
|
+
|
|
26
|
+
```json
|
|
27
|
+
{
|
|
28
|
+
"error": "authorization_pending",
|
|
29
|
+
"error_description": "The authorization request is still pending as the user hasn't yet completed the user interaction flow."
|
|
30
|
+
}
|
|
31
|
+
```
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
---
|
|
2
|
+
descriptions:
|
|
3
|
+
cli_auth:
|
|
4
|
+
device_code: >-
|
|
5
|
+
A unique identifier for the authorization request used when polling the
|
|
6
|
+
token endpoint.
|
|
7
|
+
user_code: 'A short, user-friendly code that users enter to authorize the device.'
|
|
8
|
+
verification_uri: The URL where users can enter the user code to authorize the device.
|
|
9
|
+
verification_uri_complete: A URL with the user code pre-filled for one-click authorization.
|
|
10
|
+
originalPath: .tmp-workos-clone/packages/docs/content/reference/authkit/cli-auth/index.mdx
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# CLI Auth
|
|
14
|
+
|
|
15
|
+
CLI Auth enables command-line applications to authenticate users through the web using the [OAuth 2.0 Device Authorization Flow](https://datatracker.ietf.org/doc/html/rfc8628).
|
|
16
|
+
|
|
17
|
+
The CLI Auth flow involves two main endpoints:
|
|
18
|
+
|
|
19
|
+
1. The **device authorization URL** initiates the flow by obtaining a device code, user code, and verification URIs.
|
|
20
|
+
2. The **device access token URL** is where the device exchanges the device code for access and refresh tokens after the user authenticates.
|
|
21
|
+
|
|
22
|
+
Read more about [CLI Auth here](/authkit/cli-auth).
|