@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
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
---
|
|
2
|
+
descriptions:
|
|
3
|
+
resend_invitation:
|
|
4
|
+
locale: >-
|
|
5
|
+
The locale to use when rendering the invitation email. See [supported
|
|
6
|
+
locales](/authkit/hosted-ui/localization).
|
|
7
|
+
reference:
|
|
8
|
+
curl:
|
|
9
|
+
- key: resend_invitation
|
|
10
|
+
id: resend_invitation
|
|
11
|
+
url: /reference/authkit/invitation/resend
|
|
12
|
+
title: '/user_management/invitations/:id/resend'
|
|
13
|
+
type: POST
|
|
14
|
+
sendsEmail: true
|
|
15
|
+
parameters:
|
|
16
|
+
- (invitation.id)
|
|
17
|
+
- key: locale
|
|
18
|
+
optional: true
|
|
19
|
+
type: string
|
|
20
|
+
description: (resend_invitation.locale)
|
|
21
|
+
returns:
|
|
22
|
+
- (invitation)
|
|
23
|
+
js:
|
|
24
|
+
- key: resendInvitation
|
|
25
|
+
id: resend_invitation
|
|
26
|
+
url: /reference/authkit/invitation/resend
|
|
27
|
+
title: userManagement.resendInvitation()
|
|
28
|
+
sendsEmail: true
|
|
29
|
+
parameters:
|
|
30
|
+
- (Invitation.id)
|
|
31
|
+
- key: locale
|
|
32
|
+
optional: true
|
|
33
|
+
type: string
|
|
34
|
+
description: (resend_invitation.locale)
|
|
35
|
+
returns:
|
|
36
|
+
- (Invitation)
|
|
37
|
+
go:
|
|
38
|
+
- key: ResendInvitation
|
|
39
|
+
id: resend_invitation
|
|
40
|
+
url: /reference/authkit/invitation/resend
|
|
41
|
+
title: usermanagement.ResendInvitation()
|
|
42
|
+
parameters:
|
|
43
|
+
- (ctx)
|
|
44
|
+
- key: opts
|
|
45
|
+
type: usermanagement.ResendInvitationOpts
|
|
46
|
+
unwrap: true
|
|
47
|
+
properties:
|
|
48
|
+
- key: Invitation
|
|
49
|
+
type: string
|
|
50
|
+
description: (invitation.id)
|
|
51
|
+
returns:
|
|
52
|
+
- key: response
|
|
53
|
+
type: usermanagement.Invitation
|
|
54
|
+
description: (invitation.self)
|
|
55
|
+
- (err)
|
|
56
|
+
php:
|
|
57
|
+
- key: resendInvitation
|
|
58
|
+
id: resend_invitation
|
|
59
|
+
url: /reference/authkit/invitation/resend
|
|
60
|
+
title: $userManagement->resendInvitation()
|
|
61
|
+
sendsEmail: true
|
|
62
|
+
parameters:
|
|
63
|
+
- (Invitation.id)
|
|
64
|
+
returns:
|
|
65
|
+
- (Invitation)
|
|
66
|
+
python:
|
|
67
|
+
- key: resend_invitation
|
|
68
|
+
id: resend_invitation
|
|
69
|
+
url: /reference/authkit/invitation/resend
|
|
70
|
+
title: user_management.resend_invitation()
|
|
71
|
+
sendsEmail: true
|
|
72
|
+
parameters:
|
|
73
|
+
- key: invitation_id
|
|
74
|
+
type: str
|
|
75
|
+
description: (invitation.id)
|
|
76
|
+
returns:
|
|
77
|
+
- (Invitation)
|
|
78
|
+
ruby:
|
|
79
|
+
- key: resend_invitation
|
|
80
|
+
id: resend_invitation
|
|
81
|
+
url: /reference/authkit/invitation/resend
|
|
82
|
+
title: UserManagement.resend_invitation()
|
|
83
|
+
sendsEmail: true
|
|
84
|
+
parameters:
|
|
85
|
+
- (Invitation.id)
|
|
86
|
+
returns:
|
|
87
|
+
- (Invitation)
|
|
88
|
+
java:
|
|
89
|
+
- key: resendInvitation
|
|
90
|
+
id: resend_invitation
|
|
91
|
+
url: /reference/authkit/invitation/resend
|
|
92
|
+
title: userManagement.resendInvitation()
|
|
93
|
+
sendsEmail: true
|
|
94
|
+
parameters:
|
|
95
|
+
- (Invitation.id)
|
|
96
|
+
returns:
|
|
97
|
+
- (Invitation)
|
|
98
|
+
originalPath: >-
|
|
99
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/invitation/resend.mdx
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## Resend an invitation
|
|
103
|
+
|
|
104
|
+
Resends an invitation email to the recipient. The invitation must be in a pending state.
|
|
105
|
+
|
|
106
|
+
<CodeBlock referenceId="resend_invitation">
|
|
107
|
+
<CodeBlockTab title="Request" file="resend-invitation-request" />
|
|
108
|
+
<CodeBlockTab title="Response" file="resend-invitation-response" />
|
|
109
|
+
</CodeBlock>
|
|
@@ -3,7 +3,7 @@ reference:
|
|
|
3
3
|
curl:
|
|
4
4
|
- key: revoke_invitation
|
|
5
5
|
id: revoke_invitation
|
|
6
|
-
url: /reference/
|
|
6
|
+
url: /reference/authkit/invitation/revoke
|
|
7
7
|
title: '/user_management/invitations/:id/revoke'
|
|
8
8
|
type: POST
|
|
9
9
|
parameters:
|
|
@@ -13,7 +13,7 @@ reference:
|
|
|
13
13
|
js:
|
|
14
14
|
- key: revokeInvitation
|
|
15
15
|
id: revoke_invitation
|
|
16
|
-
url: /reference/
|
|
16
|
+
url: /reference/authkit/invitation/revoke
|
|
17
17
|
title: userManagement.revokeInvitation()
|
|
18
18
|
parameters:
|
|
19
19
|
- (Invitation.id)
|
|
@@ -22,7 +22,7 @@ reference:
|
|
|
22
22
|
go:
|
|
23
23
|
- key: RevokeInvitation
|
|
24
24
|
id: revoke_invitation
|
|
25
|
-
url: /reference/
|
|
25
|
+
url: /reference/authkit/invitation/revoke
|
|
26
26
|
title: usermanagement.RevokeInvitation()
|
|
27
27
|
parameters:
|
|
28
28
|
- (ctx)
|
|
@@ -41,7 +41,7 @@ reference:
|
|
|
41
41
|
php:
|
|
42
42
|
- key: revokeInvitation
|
|
43
43
|
id: revoke_invitation
|
|
44
|
-
url: /reference/
|
|
44
|
+
url: /reference/authkit/invitation/revoke
|
|
45
45
|
title: $userManagement->revokeInvitation()
|
|
46
46
|
parameters:
|
|
47
47
|
- (Invitation.id)
|
|
@@ -50,7 +50,7 @@ reference:
|
|
|
50
50
|
python:
|
|
51
51
|
- key: revoke_invitation
|
|
52
52
|
id: revoke_invitation
|
|
53
|
-
url: /reference/
|
|
53
|
+
url: /reference/authkit/invitation/revoke
|
|
54
54
|
title: user_management.revoke_invitation()
|
|
55
55
|
parameters:
|
|
56
56
|
- key: invitation_id
|
|
@@ -61,7 +61,7 @@ reference:
|
|
|
61
61
|
ruby:
|
|
62
62
|
- key: revoke_invitation
|
|
63
63
|
id: revoke_invitation
|
|
64
|
-
url: /reference/
|
|
64
|
+
url: /reference/authkit/invitation/revoke
|
|
65
65
|
title: UserManagement.revoke_invitation()
|
|
66
66
|
parameters:
|
|
67
67
|
- (Invitation.id)
|
|
@@ -70,14 +70,14 @@ reference:
|
|
|
70
70
|
java:
|
|
71
71
|
- key: revokeInvitation
|
|
72
72
|
id: revoke_invitation
|
|
73
|
-
url: /reference/
|
|
73
|
+
url: /reference/authkit/invitation/revoke
|
|
74
74
|
title: userManagement.revokeInvitation()
|
|
75
75
|
parameters:
|
|
76
76
|
- (Invitation.id)
|
|
77
77
|
returns:
|
|
78
78
|
- (Invitation)
|
|
79
79
|
originalPath: >-
|
|
80
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
80
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/invitation/revoke.mdx
|
|
81
81
|
---
|
|
82
82
|
|
|
83
83
|
## Revoke an invitation
|
|
@@ -6,16 +6,19 @@ descriptions:
|
|
|
6
6
|
|
|
7
7
|
Must be between 1 and 30 days. Defaults to 7 days if not specified.
|
|
8
8
|
inviter_user_id: >-
|
|
9
|
-
The ID of the [user](/reference/
|
|
10
|
-
|
|
9
|
+
The ID of the [user](/reference/authkit/user) who invites the recipient.
|
|
10
|
+
The invitation email will mention the name of this user.
|
|
11
11
|
role_slug: >-
|
|
12
|
-
The [role](/
|
|
13
|
-
|
|
12
|
+
The [role](/authkit/roles) that the recipient will receive when they join
|
|
13
|
+
the organization in the invitation.
|
|
14
|
+
locale: >-
|
|
15
|
+
The locale to use when rendering the invitation email. See [supported
|
|
16
|
+
locales](/authkit/hosted-ui/localization).
|
|
14
17
|
reference:
|
|
15
18
|
curl:
|
|
16
19
|
- key: send_invitation
|
|
17
20
|
id: send_invitation
|
|
18
|
-
url: /reference/
|
|
21
|
+
url: /reference/authkit/invitation/send
|
|
19
22
|
title: /user_management/invitations
|
|
20
23
|
type: POST
|
|
21
24
|
sendsEmail: true
|
|
@@ -39,12 +42,16 @@ reference:
|
|
|
39
42
|
optional: true
|
|
40
43
|
type: String
|
|
41
44
|
description: (send_invitation.role_slug)
|
|
45
|
+
- key: locale
|
|
46
|
+
optional: true
|
|
47
|
+
type: string
|
|
48
|
+
description: (send_invitation.locale)
|
|
42
49
|
returns:
|
|
43
50
|
- (invitation)
|
|
44
51
|
js:
|
|
45
52
|
- key: sendInvitation
|
|
46
53
|
id: send_invitation
|
|
47
|
-
url: /reference/
|
|
54
|
+
url: /reference/authkit/invitation/send
|
|
48
55
|
title: userManagement.sendInvitation()
|
|
49
56
|
type: POST
|
|
50
57
|
sendsEmail: true
|
|
@@ -68,12 +75,16 @@ reference:
|
|
|
68
75
|
optional: true
|
|
69
76
|
type: String
|
|
70
77
|
description: (send_invitation.role_slug)
|
|
78
|
+
- key: locale
|
|
79
|
+
optional: true
|
|
80
|
+
type: string
|
|
81
|
+
description: (send_invitation.locale)
|
|
71
82
|
returns:
|
|
72
83
|
- (Invitation)
|
|
73
84
|
go:
|
|
74
85
|
- key: SendInvitation
|
|
75
86
|
id: send_invitation
|
|
76
|
-
url: /reference/
|
|
87
|
+
url: /reference/authkit/invitation/send
|
|
77
88
|
title: usermanagement.SendInvitation()
|
|
78
89
|
parameters:
|
|
79
90
|
- (ctx)
|
|
@@ -108,7 +119,7 @@ reference:
|
|
|
108
119
|
php:
|
|
109
120
|
- key: sendInvitation
|
|
110
121
|
id: send_invitation
|
|
111
|
-
url: /reference/
|
|
122
|
+
url: /reference/authkit/invitation/send
|
|
112
123
|
title: $userManagement->sendInvitation()
|
|
113
124
|
type: POST
|
|
114
125
|
sendsEmail: true
|
|
@@ -133,7 +144,7 @@ reference:
|
|
|
133
144
|
python:
|
|
134
145
|
- key: send_invitation
|
|
135
146
|
id: send_invitation
|
|
136
|
-
url: /reference/
|
|
147
|
+
url: /reference/authkit/invitation/send
|
|
137
148
|
title: user_management.send_invitation()
|
|
138
149
|
sendsEmail: true
|
|
139
150
|
parameters:
|
|
@@ -161,7 +172,7 @@ reference:
|
|
|
161
172
|
ruby:
|
|
162
173
|
- key: send_invitation
|
|
163
174
|
id: send_invitation
|
|
164
|
-
url: /reference/
|
|
175
|
+
url: /reference/authkit/invitation/send
|
|
165
176
|
title: UserManagement.send_invitation()
|
|
166
177
|
type: POST
|
|
167
178
|
sendsEmail: true
|
|
@@ -186,7 +197,7 @@ reference:
|
|
|
186
197
|
java:
|
|
187
198
|
- key: sendInvitation
|
|
188
199
|
id: send_invitation
|
|
189
|
-
url: /reference/
|
|
200
|
+
url: /reference/authkit/invitation/send
|
|
190
201
|
title: userManagement.sendInvitation()
|
|
191
202
|
type: POST
|
|
192
203
|
sendsEmail: true
|
|
@@ -216,8 +227,7 @@ reference:
|
|
|
216
227
|
description: (send_invitation.role_slug)
|
|
217
228
|
returns:
|
|
218
229
|
- (Invitation)
|
|
219
|
-
originalPath:
|
|
220
|
-
.tmp-workos-clone/packages/docs/content/reference/user-management/invitation/send.mdx
|
|
230
|
+
originalPath: .tmp-workos-clone/packages/docs/content/reference/authkit/invitation/send.mdx
|
|
221
231
|
---
|
|
222
232
|
|
|
223
233
|
## Send an invitation
|
|
@@ -10,7 +10,7 @@ reference:
|
|
|
10
10
|
js:
|
|
11
11
|
- key: getLogoutUrlFromSessionCookie
|
|
12
12
|
id: get_logout_url_from_session_cookie
|
|
13
|
-
url: /reference/
|
|
13
|
+
url: /reference/authkit/logout/get-logout-url-from-session-cookie
|
|
14
14
|
title: userManagement.getLogoutUrlFromSessionCookie()
|
|
15
15
|
parameters:
|
|
16
16
|
- key: options
|
|
@@ -33,7 +33,7 @@ reference:
|
|
|
33
33
|
type: string
|
|
34
34
|
description: (logout.url)
|
|
35
35
|
originalPath: >-
|
|
36
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
36
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/logout/get-logout-url-from-session-cookie.mdx
|
|
37
37
|
---
|
|
38
38
|
|
|
39
39
|
# Get logout URL from session cookie
|
package/.docs/organized/docs/reference/{user-management → authkit}/logout/get-logout-url.mdx
RENAMED
|
@@ -8,7 +8,7 @@ reference:
|
|
|
8
8
|
curl:
|
|
9
9
|
- key: get_logout_url
|
|
10
10
|
id: get_logout_url
|
|
11
|
-
url: /reference/
|
|
11
|
+
url: /reference/authkit/logout/get-logout-url
|
|
12
12
|
title: /user_management/sessions/logout
|
|
13
13
|
type: GET
|
|
14
14
|
parameters:
|
|
@@ -26,7 +26,7 @@ reference:
|
|
|
26
26
|
js:
|
|
27
27
|
- key: getLogoutUrl
|
|
28
28
|
id: get_logout_url
|
|
29
|
-
url: /reference/
|
|
29
|
+
url: /reference/authkit/logout/get-logout-url
|
|
30
30
|
title: userManagement.getLogoutUrl()
|
|
31
31
|
parameters:
|
|
32
32
|
- key: options
|
|
@@ -47,7 +47,7 @@ reference:
|
|
|
47
47
|
go:
|
|
48
48
|
- key: GetLogoutUrl
|
|
49
49
|
id: get_logout_url
|
|
50
|
-
url: /reference/
|
|
50
|
+
url: /reference/authkit/logout/get-logout-url
|
|
51
51
|
title: usermanagement.GetLogoutUrl()
|
|
52
52
|
parameters:
|
|
53
53
|
- (ctx)
|
|
@@ -70,7 +70,7 @@ reference:
|
|
|
70
70
|
ruby:
|
|
71
71
|
- key: get_logout_url
|
|
72
72
|
id: get_logout_url
|
|
73
|
-
url: /reference/
|
|
73
|
+
url: /reference/authkit/logout/get-logout-url
|
|
74
74
|
title: UserManagement.get_logout_url()
|
|
75
75
|
parameters:
|
|
76
76
|
- key: session_id
|
|
@@ -87,7 +87,7 @@ reference:
|
|
|
87
87
|
java:
|
|
88
88
|
- key: getLogoutUrl
|
|
89
89
|
id: get_logout_url
|
|
90
|
-
url: /reference/
|
|
90
|
+
url: /reference/authkit/logout/get-logout-url
|
|
91
91
|
title: userManagement.getLogoutUrl()
|
|
92
92
|
parameters:
|
|
93
93
|
- key: sessionId
|
|
@@ -104,7 +104,7 @@ reference:
|
|
|
104
104
|
python:
|
|
105
105
|
- key: get_logout_url
|
|
106
106
|
id: get_logout_url
|
|
107
|
-
url: /reference/
|
|
107
|
+
url: /reference/authkit/logout/get-logout-url
|
|
108
108
|
title: user_management.get_logout_url()
|
|
109
109
|
parameters:
|
|
110
110
|
- key: session_id
|
|
@@ -121,7 +121,7 @@ reference:
|
|
|
121
121
|
php:
|
|
122
122
|
- key: get_logout_url
|
|
123
123
|
id: get_logout_url
|
|
124
|
-
url: /reference/
|
|
124
|
+
url: /reference/authkit/logout/get-logout-url
|
|
125
125
|
title: $userManagement->getLogoutUrl()
|
|
126
126
|
parameters:
|
|
127
127
|
- key: session_id
|
|
@@ -136,7 +136,7 @@ reference:
|
|
|
136
136
|
type: string
|
|
137
137
|
description: (logout.url)
|
|
138
138
|
originalPath: >-
|
|
139
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
139
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/logout/get-logout-url.mdx
|
|
140
140
|
---
|
|
141
141
|
|
|
142
142
|
# Get logout URL
|
|
@@ -12,13 +12,12 @@ descriptions:
|
|
|
12
12
|
the session has been ended. Allowed values are configured in the WorkOS
|
|
13
13
|
Dashboard under
|
|
14
14
|
|
|
15
|
-
[
|
|
16
|
-
redirects_](/
|
|
15
|
+
[_Sign-out
|
|
16
|
+
redirects_](/authkit/sessions/configuring-sessions/sign-out-redirect).
|
|
17
17
|
|
|
18
18
|
|
|
19
|
-
If no value is given the default
|
|
20
|
-
originalPath:
|
|
21
|
-
.tmp-workos-clone/packages/docs/content/reference/user-management/logout/index.mdx
|
|
19
|
+
If no value is given the default Sign-out redirect will be used instead.
|
|
20
|
+
originalPath: .tmp-workos-clone/packages/docs/content/reference/authkit/logout/index.mdx
|
|
22
21
|
---
|
|
23
22
|
|
|
24
23
|
# Logout
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
descriptions:
|
|
3
3
|
create_magic_auth:
|
|
4
4
|
invitation_token: >
|
|
5
|
-
The token of an [invitation](/reference/
|
|
5
|
+
The token of an [invitation](/reference/authkit/invitation). The
|
|
6
6
|
invitation should be in the pending state.
|
|
7
7
|
|
|
8
8
|
|
|
@@ -15,7 +15,7 @@ reference:
|
|
|
15
15
|
curl:
|
|
16
16
|
- key: create_magic_auth
|
|
17
17
|
id: create_magic_auth
|
|
18
|
-
url: /reference/
|
|
18
|
+
url: /reference/authkit/magic-auth/create
|
|
19
19
|
title: /user_management/magic_auth
|
|
20
20
|
type: POST
|
|
21
21
|
sendsEmail: true
|
|
@@ -32,7 +32,7 @@ reference:
|
|
|
32
32
|
js:
|
|
33
33
|
- key: createMagicAuth
|
|
34
34
|
id: create_magic_auth
|
|
35
|
-
url: /reference/
|
|
35
|
+
url: /reference/authkit/magic-auth/create
|
|
36
36
|
title: userManagement.createMagicAuth()
|
|
37
37
|
sendsEmail: true
|
|
38
38
|
parameters:
|
|
@@ -52,7 +52,7 @@ reference:
|
|
|
52
52
|
go:
|
|
53
53
|
- key: CreateMagicAuth
|
|
54
54
|
id: create_magic_auth
|
|
55
|
-
url: /reference/
|
|
55
|
+
url: /reference/authkit/magic-auth/create
|
|
56
56
|
title: usermanagement.CreateMagicAuth()
|
|
57
57
|
parameters:
|
|
58
58
|
- (ctx)
|
|
@@ -73,7 +73,7 @@ reference:
|
|
|
73
73
|
php:
|
|
74
74
|
- key: createMagicAuth=
|
|
75
75
|
id: create_magic_auth
|
|
76
|
-
url: /reference/
|
|
76
|
+
url: /reference/authkit/magic-auth/create
|
|
77
77
|
title: $userManagement->createMagicAuth()
|
|
78
78
|
sendsEmail: true
|
|
79
79
|
parameters:
|
|
@@ -89,7 +89,7 @@ reference:
|
|
|
89
89
|
python:
|
|
90
90
|
- key: create_magic_auth
|
|
91
91
|
id: create_magic_auth
|
|
92
|
-
url: /reference/
|
|
92
|
+
url: /reference/authkit/magic-auth/create
|
|
93
93
|
title: user_management.create_magic_auth()
|
|
94
94
|
sendsEmail: true
|
|
95
95
|
parameters:
|
|
@@ -105,7 +105,7 @@ reference:
|
|
|
105
105
|
ruby:
|
|
106
106
|
- key: create_magic_auth
|
|
107
107
|
id: create_magic_auth
|
|
108
|
-
url: /reference/
|
|
108
|
+
url: /reference/authkit/magic-auth/create
|
|
109
109
|
title: UserManagement.create_magic_auth()
|
|
110
110
|
sendsEmail: true
|
|
111
111
|
parameters:
|
|
@@ -121,7 +121,7 @@ reference:
|
|
|
121
121
|
java:
|
|
122
122
|
- key: createMagicAuth
|
|
123
123
|
id: create_magic_auth
|
|
124
|
-
url: /reference/
|
|
124
|
+
url: /reference/authkit/magic-auth/create
|
|
125
125
|
title: userManagement.createMagicAuth()
|
|
126
126
|
sendsEmail: true
|
|
127
127
|
parameters:
|
|
@@ -135,12 +135,12 @@ reference:
|
|
|
135
135
|
returns:
|
|
136
136
|
- (MagicAuth)
|
|
137
137
|
originalPath: >-
|
|
138
|
-
.tmp-workos-clone/packages/docs/content/reference/
|
|
138
|
+
.tmp-workos-clone/packages/docs/content/reference/authkit/magic-auth/create.mdx
|
|
139
139
|
---
|
|
140
140
|
|
|
141
141
|
## Create a Magic Auth code
|
|
142
142
|
|
|
143
|
-
Creates a one-time authentication code that can be sent to the user’s email address. The code expires in
|
|
143
|
+
Creates a one-time authentication code that can be sent to the user’s email address. The code expires in 10 minutes. To verify the code, [authenticate the user with Magic Auth](/reference/authkit/authentication/magic-auth).
|
|
144
144
|
|
|
145
145
|
<CodeBlock referenceId="create_magic_auth">
|
|
146
146
|
<CodeBlockTab title="Request" file="create-magic-auth-request" />
|
|
@@ -3,7 +3,7 @@ reference:
|
|
|
3
3
|
curl:
|
|
4
4
|
- key: get_magic_auth
|
|
5
5
|
id: get_magic_auth
|
|
6
|
-
url: /reference/
|
|
6
|
+
url: /reference/authkit/magic-auth/get
|
|
7
7
|
title: '/user_management/magic_auth/:id'
|
|
8
8
|
type: GET
|
|
9
9
|
parameters:
|
|
@@ -13,7 +13,7 @@ reference:
|
|
|
13
13
|
js:
|
|
14
14
|
- key: getMagicAuth
|
|
15
15
|
id: get_magic_auth
|
|
16
|
-
url: /reference/
|
|
16
|
+
url: /reference/authkit/magic-auth/get
|
|
17
17
|
title: userManagement.getMagicAuth()
|
|
18
18
|
parameters:
|
|
19
19
|
- (MagicAuth.id)
|
|
@@ -22,7 +22,7 @@ reference:
|
|
|
22
22
|
go:
|
|
23
23
|
- key: getMagicAuth
|
|
24
24
|
id: get_magic_auth
|
|
25
|
-
url: /reference/
|
|
25
|
+
url: /reference/authkit/magic-auth/get
|
|
26
26
|
title: usermanagement.GetMagicAuth()
|
|
27
27
|
parameters:
|
|
28
28
|
- (ctx)
|
|
@@ -39,7 +39,7 @@ reference:
|
|
|
39
39
|
php:
|
|
40
40
|
- key: getMagicAuth
|
|
41
41
|
id: get_magic_auth
|
|
42
|
-
url: /reference/
|
|
42
|
+
url: /reference/authkit/magic-auth/get
|
|
43
43
|
title: $userManagement->getMagicAuth()
|
|
44
44
|
parameters:
|
|
45
45
|
- (MagicAuth.id)
|
|
@@ -48,7 +48,7 @@ reference:
|
|
|
48
48
|
python:
|
|
49
49
|
- key: get_magic_auth
|
|
50
50
|
id: get_magic_auth
|
|
51
|
-
url: /reference/
|
|
51
|
+
url: /reference/authkit/magic-auth/get
|
|
52
52
|
title: user_management.get_magic_auth()
|
|
53
53
|
parameters:
|
|
54
54
|
- key: magic_auth_id
|
|
@@ -59,7 +59,7 @@ reference:
|
|
|
59
59
|
ruby:
|
|
60
60
|
- key: get_magic_auth
|
|
61
61
|
id: get_magic_auth
|
|
62
|
-
url: /reference/
|
|
62
|
+
url: /reference/authkit/magic-auth/get
|
|
63
63
|
title: UserManagement.get_magic_auth()
|
|
64
64
|
parameters:
|
|
65
65
|
- (MagicAuth.id)
|
|
@@ -68,17 +68,16 @@ reference:
|
|
|
68
68
|
java:
|
|
69
69
|
- key: getMagicAuth
|
|
70
70
|
id: get_magic_auth
|
|
71
|
-
url: /reference/
|
|
71
|
+
url: /reference/authkit/magic-auth/get
|
|
72
72
|
title: userManagement.getMagicAuth()
|
|
73
73
|
parameters:
|
|
74
74
|
- (MagicAuth.id)
|
|
75
75
|
returns:
|
|
76
76
|
- (MagicAuth)
|
|
77
|
-
originalPath:
|
|
78
|
-
.tmp-workos-clone/packages/docs/content/reference/user-management/magic-auth/get.mdx
|
|
77
|
+
originalPath: .tmp-workos-clone/packages/docs/content/reference/authkit/magic-auth/get.mdx
|
|
79
78
|
---
|
|
80
79
|
|
|
81
|
-
## Get
|
|
80
|
+
## Get Magic Auth code details
|
|
82
81
|
|
|
83
82
|
Get the details of an existing Magic Auth code that can be used to send an email to a user for authentication.
|
|
84
83
|
|
|
@@ -1,9 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
descriptions:
|
|
3
3
|
magic_auth:
|
|
4
|
-
self:
|
|
5
|
-
The corresponding [Magic Auth](/reference/user-management/magic-auth)
|
|
6
|
-
object.
|
|
4
|
+
self: 'The corresponding [Magic Auth](/reference/authkit/magic-auth) object.'
|
|
7
5
|
object: Distinguishes the Magic Auth object.
|
|
8
6
|
id: The unique ID of the Magic Auth code.
|
|
9
7
|
user_id: The unique ID of the user.
|
|
@@ -14,7 +12,7 @@ descriptions:
|
|
|
14
12
|
updated_at: The timestamp when the Magic Auth code was last updated.
|
|
15
13
|
reference:
|
|
16
14
|
curl:
|
|
17
|
-
- url: /reference/
|
|
15
|
+
- url: /reference/authkit/magic-auth
|
|
18
16
|
key: magic_auth
|
|
19
17
|
id: magic_auth
|
|
20
18
|
title: magic_auth
|
|
@@ -41,7 +39,7 @@ reference:
|
|
|
41
39
|
type: string
|
|
42
40
|
description: (magic_auth.updated_at)
|
|
43
41
|
js:
|
|
44
|
-
- url: /reference/
|
|
42
|
+
- url: /reference/authkit/magic-auth
|
|
45
43
|
key: MagicAuth
|
|
46
44
|
id: magic_auth
|
|
47
45
|
title: interface MagicAuth
|
|
@@ -71,7 +69,7 @@ reference:
|
|
|
71
69
|
type: string
|
|
72
70
|
description: (magic_auth.updated_at)
|
|
73
71
|
go:
|
|
74
|
-
- url: /reference/
|
|
72
|
+
- url: /reference/authkit/magic-auth
|
|
75
73
|
key: MagicAuth
|
|
76
74
|
id: magic_auth
|
|
77
75
|
title: usermanagement.MagicAuth
|
|
@@ -98,7 +96,7 @@ reference:
|
|
|
98
96
|
type: string
|
|
99
97
|
description: (magic_auth.updated_at)
|
|
100
98
|
php:
|
|
101
|
-
- url: /reference/
|
|
99
|
+
- url: /reference/authkit/magic-auth
|
|
102
100
|
key: MagicAuth
|
|
103
101
|
id: magic_auth
|
|
104
102
|
title: WorkOS\Resource\MagicAuth
|
|
@@ -128,7 +126,7 @@ reference:
|
|
|
128
126
|
type: string
|
|
129
127
|
description: (magic_auth.updated_at)
|
|
130
128
|
python:
|
|
131
|
-
- url: /reference/
|
|
129
|
+
- url: /reference/authkit/magic-auth
|
|
132
130
|
key: MagicAuth
|
|
133
131
|
id: magic_auth
|
|
134
132
|
title: MagicAuth
|
|
@@ -155,7 +153,7 @@ reference:
|
|
|
155
153
|
type: str
|
|
156
154
|
description: (magic_auth.updated_at)
|
|
157
155
|
ruby:
|
|
158
|
-
- url: /reference/
|
|
156
|
+
- url: /reference/authkit/magic-auth
|
|
159
157
|
key: MagicAuth
|
|
160
158
|
id: magic_auth
|
|
161
159
|
title: class MagicAuth
|
|
@@ -182,7 +180,7 @@ reference:
|
|
|
182
180
|
type: String
|
|
183
181
|
description: (magic_auth.updated_at)
|
|
184
182
|
java:
|
|
185
|
-
- url: /reference/
|
|
183
|
+
- url: /reference/authkit/magic-auth
|
|
186
184
|
key: MagicAuth
|
|
187
185
|
id: magic_auth
|
|
188
186
|
title: class MagicAuth
|
|
@@ -208,15 +206,12 @@ reference:
|
|
|
208
206
|
- key: updatedAt
|
|
209
207
|
type: String
|
|
210
208
|
description: (magic_auth.updated_at)
|
|
211
|
-
originalPath:
|
|
212
|
-
.tmp-workos-clone/packages/docs/content/reference/user-management/magic-auth/index.mdx
|
|
213
|
-
---
|
|
214
|
-
|
|
209
|
+
originalPath: .tmp-workos-clone/packages/docs/content/reference/authkit/magic-auth/index.mdx
|
|
215
210
|
---
|
|
216
211
|
|
|
217
212
|
# Magic Auth
|
|
218
213
|
|
|
219
|
-
Magic Auth is a passwordless authentication method that allows users to sign in or sign up via a unique, six digit one-time-use code sent to their email inbox. To verify the code, [authenticate the user with Magic Auth](/reference/
|
|
214
|
+
Magic Auth is a passwordless authentication method that allows users to sign in or sign up via a unique, six digit one-time-use code sent to their email inbox. To verify the code, [authenticate the user with Magic Auth](/reference/authkit/authentication/magic-auth).
|
|
220
215
|
|
|
221
216
|
<CodeBlock
|
|
222
217
|
title="Example Magic Auth"
|