@workos/mcp-docs-server 0.1.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 +277 -0
- package/.docs/organized/docs/admin-portal/_navigation.mdx +16 -0
- package/.docs/organized/docs/admin-portal/custom-branding.mdx +111 -0
- package/.docs/organized/docs/admin-portal/example-apps.mdx +46 -0
- package/.docs/organized/docs/admin-portal/index.mdx +240 -0
- package/.docs/organized/docs/audit-logs/_navigation.mdx +22 -0
- package/.docs/organized/docs/audit-logs/admin-portal.mdx +20 -0
- package/.docs/organized/docs/audit-logs/editing-events.mdx +27 -0
- package/.docs/organized/docs/audit-logs/exporting-events.mdx +29 -0
- package/.docs/organized/docs/audit-logs/index.mdx +110 -0
- package/.docs/organized/docs/audit-logs/log-streams.mdx +56 -0
- package/.docs/organized/docs/audit-logs/metadata-schema.mdx +21 -0
- package/.docs/organized/docs/custom-domains/_navigation.mdx +16 -0
- package/.docs/organized/docs/custom-domains/admin-portal.mdx +38 -0
- package/.docs/organized/docs/custom-domains/auth-api.mdx +59 -0
- package/.docs/organized/docs/custom-domains/authkit.mdx +36 -0
- package/.docs/organized/docs/custom-domains/email.mdx +41 -0
- package/.docs/organized/docs/custom-domains/index.mdx +19 -0
- package/.docs/organized/docs/dashboard.mdx +244 -0
- package/.docs/organized/docs/demo/_navigation.mdx +26 -0
- package/.docs/organized/docs/demo/accordion.mdx +34 -0
- package/.docs/organized/docs/demo/checklist.mdx +33 -0
- package/.docs/organized/docs/demo/code-block.mdx +185 -0
- package/.docs/organized/docs/demo/definition-list.mdx +35 -0
- package/.docs/organized/docs/demo/index.mdx +7 -0
- package/.docs/organized/docs/demo/punctuation.mdx +37 -0
- package/.docs/organized/docs/demo/replacements.mdx +26 -0
- package/.docs/organized/docs/demo/table.mdx +26 -0
- package/.docs/organized/docs/demo/tabs.mdx +17 -0
- package/.docs/organized/docs/directory-sync/_navigation.mdx +28 -0
- package/.docs/organized/docs/directory-sync/attributes.mdx +209 -0
- package/.docs/organized/docs/directory-sync/example-apps.mdx +46 -0
- package/.docs/organized/docs/directory-sync/handle-inactive-users.mdx +52 -0
- package/.docs/organized/docs/directory-sync/identity-provider-role-assignment.mdx +134 -0
- package/.docs/organized/docs/directory-sync/index.mdx +107 -0
- package/.docs/organized/docs/directory-sync/quick-start.mdx +129 -0
- package/.docs/organized/docs/directory-sync/understanding-events.mdx +209 -0
- package/.docs/organized/docs/domain-verification/_navigation.mdx +10 -0
- package/.docs/organized/docs/domain-verification/api.mdx +60 -0
- package/.docs/organized/docs/domain-verification/index.mdx +67 -0
- package/.docs/organized/docs/email.mdx +109 -0
- package/.docs/organized/docs/events/_navigation.mdx +22 -0
- package/.docs/organized/docs/events/data-syncing/data-reconciliation.mdx +56 -0
- package/.docs/organized/docs/events/data-syncing/events-api.mdx +114 -0
- package/.docs/organized/docs/events/data-syncing/index.mdx +66 -0
- package/.docs/organized/docs/events/data-syncing/webhooks.mdx +173 -0
- package/.docs/organized/docs/events/index.mdx +783 -0
- package/.docs/organized/docs/events/observability/datadog.mdx +76 -0
- package/.docs/organized/docs/fga/_navigation.mdx +64 -0
- package/.docs/organized/docs/fga/identity-provider-sessions.mdx +68 -0
- package/.docs/organized/docs/fga/index.mdx +60 -0
- package/.docs/organized/docs/fga/local-development.mdx +155 -0
- package/.docs/organized/docs/fga/modeling/abac.mdx +107 -0
- package/.docs/organized/docs/fga/modeling/blocklist.mdx +84 -0
- package/.docs/organized/docs/fga/modeling/conditional-roles.mdx +99 -0
- package/.docs/organized/docs/fga/modeling/custom-roles.mdx +90 -0
- package/.docs/organized/docs/fga/modeling/entitlements.mdx +127 -0
- package/.docs/organized/docs/fga/modeling/managed-service-provider.mdx +131 -0
- package/.docs/organized/docs/fga/modeling/org-roles-and-permissions.mdx +95 -0
- package/.docs/organized/docs/fga/modeling/policy-context.mdx +231 -0
- package/.docs/organized/docs/fga/modeling/public-access.mdx +61 -0
- package/.docs/organized/docs/fga/modeling/shareable-content.mdx +106 -0
- package/.docs/organized/docs/fga/modeling/superusers.mdx +74 -0
- package/.docs/organized/docs/fga/modeling/user-groups.mdx +92 -0
- package/.docs/organized/docs/fga/operations-usage.mdx +104 -0
- package/.docs/organized/docs/fga/playground.mdx +12 -0
- package/.docs/organized/docs/fga/policies.mdx +462 -0
- package/.docs/organized/docs/fga/query-language.mdx +112 -0
- package/.docs/organized/docs/fga/quick-start.mdx +174 -0
- package/.docs/organized/docs/fga/resources.mdx +92 -0
- package/.docs/organized/docs/fga/schema-management.mdx +224 -0
- package/.docs/organized/docs/fga/schema.mdx +388 -0
- package/.docs/organized/docs/fga/warrant-tokens.mdx +44 -0
- package/.docs/organized/docs/fga/warrants.mdx +92 -0
- package/.docs/organized/docs/glossary.mdx +184 -0
- package/.docs/organized/docs/integrations/_navigation.mdx +6 -0
- package/.docs/organized/docs/integrations/access-people-hr.mdx +87 -0
- package/.docs/organized/docs/integrations/adp-oidc.mdx +103 -0
- package/.docs/organized/docs/integrations/apple.mdx +169 -0
- package/.docs/organized/docs/integrations/auth0-directory-sync.mdx +78 -0
- package/.docs/organized/docs/integrations/auth0-enterprise-connection.mdx +92 -0
- package/.docs/organized/docs/integrations/auth0-saml.mdx +81 -0
- package/.docs/organized/docs/integrations/aws-cognito.mdx +81 -0
- package/.docs/organized/docs/integrations/bamboohr.mdx +90 -0
- package/.docs/organized/docs/integrations/breathe-hr.mdx +89 -0
- package/.docs/organized/docs/integrations/bubble.mdx +129 -0
- package/.docs/organized/docs/integrations/cas-saml.mdx +65 -0
- package/.docs/organized/docs/integrations/cezanne.mdx +74 -0
- package/.docs/organized/docs/integrations/classlink-saml.mdx +100 -0
- package/.docs/organized/docs/integrations/cloudflare-saml.mdx +164 -0
- package/.docs/organized/docs/integrations/cyberark-saml.mdx +138 -0
- package/.docs/organized/docs/integrations/cyberark-scim.mdx +100 -0
- package/.docs/organized/docs/integrations/duo-saml.mdx +127 -0
- package/.docs/organized/docs/integrations/entra-id-saml.mdx +156 -0
- package/.docs/organized/docs/integrations/entra-id-scim.mdx +218 -0
- package/.docs/organized/docs/integrations/firebase.mdx +98 -0
- package/.docs/organized/docs/integrations/fourth.mdx +66 -0
- package/.docs/organized/docs/integrations/github-oauth.mdx +85 -0
- package/.docs/organized/docs/integrations/gitlab-oauth.mdx +81 -0
- package/.docs/organized/docs/integrations/google-directory-sync.mdx +86 -0
- package/.docs/organized/docs/integrations/google-oauth.mdx +173 -0
- package/.docs/organized/docs/integrations/google-saml.mdx +135 -0
- package/.docs/organized/docs/integrations/hibob.mdx +98 -0
- package/.docs/organized/docs/integrations/jumpcloud-saml.mdx +96 -0
- package/.docs/organized/docs/integrations/jumpcloud-scim.mdx +106 -0
- package/.docs/organized/docs/integrations/keycloak-saml.mdx +128 -0
- package/.docs/organized/docs/integrations/lastpass-saml.mdx +134 -0
- package/.docs/organized/docs/integrations/linkedin-oauth.mdx +77 -0
- package/.docs/organized/docs/integrations/login-gov-oidc.mdx +103 -0
- package/.docs/organized/docs/integrations/microsoft-ad-fs-saml.mdx +96 -0
- package/.docs/organized/docs/integrations/microsoft-oauth.mdx +101 -0
- package/.docs/organized/docs/integrations/miniorange-saml.mdx +124 -0
- package/.docs/organized/docs/integrations/net-iq-saml.mdx +75 -0
- package/.docs/organized/docs/integrations/next-auth.mdx +257 -0
- package/.docs/organized/docs/integrations/oidc.mdx +64 -0
- package/.docs/organized/docs/integrations/okta-saml.mdx +144 -0
- package/.docs/organized/docs/integrations/okta-scim.mdx +210 -0
- package/.docs/organized/docs/integrations/onelogin-saml.mdx +131 -0
- package/.docs/organized/docs/integrations/onelogin-scim.mdx +150 -0
- package/.docs/organized/docs/integrations/oracle-saml.mdx +76 -0
- package/.docs/organized/docs/integrations/pingfederate-saml.mdx +103 -0
- package/.docs/organized/docs/integrations/pingfederate-scim.mdx +150 -0
- package/.docs/organized/docs/integrations/pingone-saml.mdx +86 -0
- package/.docs/organized/docs/integrations/react-native-expo.mdx +93 -0
- package/.docs/organized/docs/integrations/rippling-saml.mdx +174 -0
- package/.docs/organized/docs/integrations/rippling-scim.mdx +148 -0
- package/.docs/organized/docs/integrations/salesforce-saml.mdx +143 -0
- package/.docs/organized/docs/integrations/saml.mdx +64 -0
- package/.docs/organized/docs/integrations/scim.mdx +64 -0
- package/.docs/organized/docs/integrations/sftp.mdx +150 -0
- package/.docs/organized/docs/integrations/shibboleth-generic-saml.mdx +84 -0
- package/.docs/organized/docs/integrations/shibboleth-unsolicited-saml.mdx +84 -0
- package/.docs/organized/docs/integrations/simple-saml-php.mdx +78 -0
- package/.docs/organized/docs/integrations/slack-oauth.mdx +102 -0
- package/.docs/organized/docs/integrations/supabase.mdx +68 -0
- package/.docs/organized/docs/integrations/vmware-saml.mdx +100 -0
- package/.docs/organized/docs/integrations/workday.mdx +156 -0
- package/.docs/organized/docs/integrations/xero-oauth.mdx +83 -0
- package/.docs/organized/docs/magic-link/_navigation.mdx +16 -0
- package/.docs/organized/docs/magic-link/example-apps.mdx +46 -0
- package/.docs/organized/docs/magic-link/index.mdx +199 -0
- package/.docs/organized/docs/magic-link/launch-checklist.mdx +27 -0
- package/.docs/organized/docs/mfa/_navigation.mdx +18 -0
- package/.docs/organized/docs/mfa/example-apps.mdx +46 -0
- package/.docs/organized/docs/mfa/index.mdx +140 -0
- package/.docs/organized/docs/mfa/ux/enrollment.mdx +74 -0
- package/.docs/organized/docs/mfa/ux/sign-in.mdx +30 -0
- package/.docs/organized/docs/migrate/_navigation.mdx +6 -0
- package/.docs/organized/docs/migrate/auth0.mdx +98 -0
- package/.docs/organized/docs/migrate/aws-cognito.mdx +115 -0
- package/.docs/organized/docs/migrate/clerk.mdx +106 -0
- package/.docs/organized/docs/migrate/firebase.mdx +80 -0
- package/.docs/organized/docs/migrate/other-services.mdx +179 -0
- package/.docs/organized/docs/migrate/standalone-sso.mdx +105 -0
- package/.docs/organized/docs/on-prem-deployment.mdx +119 -0
- package/.docs/organized/docs/postman.mdx +90 -0
- package/.docs/organized/docs/reference/_navigation.mdx +527 -0
- package/.docs/organized/docs/reference/admin-portal/index.mdx +6 -0
- package/.docs/organized/docs/reference/admin-portal/portal-link/generate.mdx +268 -0
- package/.docs/organized/docs/reference/admin-portal/portal-link/index.mdx +15 -0
- package/.docs/organized/docs/reference/admin-portal/provider-icons/index.mdx +52 -0
- package/.docs/organized/docs/reference/api-keys.mdx +22 -0
- package/.docs/organized/docs/reference/audit-logs/audit-log-export.mdx +239 -0
- package/.docs/organized/docs/reference/audit-logs/audit-log-schema.mdx +69 -0
- package/.docs/organized/docs/reference/audit-logs/create-event.mdx +673 -0
- package/.docs/organized/docs/reference/audit-logs/create-export.mdx +308 -0
- package/.docs/organized/docs/reference/audit-logs/create-schema.mdx +95 -0
- package/.docs/organized/docs/reference/audit-logs/get-export.mdx +117 -0
- package/.docs/organized/docs/reference/audit-logs/get-retention.mdx +34 -0
- package/.docs/organized/docs/reference/audit-logs/index.mdx +6 -0
- package/.docs/organized/docs/reference/audit-logs/list-actions.mdx +40 -0
- package/.docs/organized/docs/reference/audit-logs/list-schemas.mdx +40 -0
- package/.docs/organized/docs/reference/audit-logs/set-retention.mdx +39 -0
- package/.docs/organized/docs/reference/client-libraries.mdx +19 -0
- package/.docs/organized/docs/reference/directory-sync/directory/delete.mdx +90 -0
- package/.docs/organized/docs/reference/directory-sync/directory/get.mdx +105 -0
- package/.docs/organized/docs/reference/directory-sync/directory/index.mdx +385 -0
- package/.docs/organized/docs/reference/directory-sync/directory/list.mdx +281 -0
- package/.docs/organized/docs/reference/directory-sync/directory-group/get.mdx +105 -0
- package/.docs/organized/docs/reference/directory-sync/directory-group/index.mdx +277 -0
- package/.docs/organized/docs/reference/directory-sync/directory-group/list.mdx +295 -0
- package/.docs/organized/docs/reference/directory-sync/directory-user/get.mdx +112 -0
- package/.docs/organized/docs/reference/directory-sync/directory-user/index.mdx +470 -0
- package/.docs/organized/docs/reference/directory-sync/directory-user/list.mdx +304 -0
- package/.docs/organized/docs/reference/directory-sync/index.mdx +10 -0
- package/.docs/organized/docs/reference/domain-verification/create.mdx +38 -0
- package/.docs/organized/docs/reference/domain-verification/get.mdx +32 -0
- package/.docs/organized/docs/reference/domain-verification/index.mdx +84 -0
- package/.docs/organized/docs/reference/domain-verification/verify.mdx +36 -0
- package/.docs/organized/docs/reference/errors.mdx +30 -0
- package/.docs/organized/docs/reference/events/index.mdx +9 -0
- package/.docs/organized/docs/reference/events/list.mdx +246 -0
- package/.docs/organized/docs/reference/fga/batch-check.mdx +277 -0
- package/.docs/organized/docs/reference/fga/check.mdx +563 -0
- package/.docs/organized/docs/reference/fga/index.mdx +6 -0
- package/.docs/organized/docs/reference/fga/policy/create.mdx +27 -0
- package/.docs/organized/docs/reference/fga/policy/delete.mdx +18 -0
- package/.docs/organized/docs/reference/fga/policy/get.mdx +23 -0
- package/.docs/organized/docs/reference/fga/policy/index.mdx +52 -0
- package/.docs/organized/docs/reference/fga/policy/list.mdx +41 -0
- package/.docs/organized/docs/reference/fga/policy/update.mdx +26 -0
- package/.docs/organized/docs/reference/fga/query.mdx +375 -0
- package/.docs/organized/docs/reference/fga/resource/batch-write.mdx +175 -0
- package/.docs/organized/docs/reference/fga/resource/create.mdx +130 -0
- package/.docs/organized/docs/reference/fga/resource/delete.mdx +86 -0
- package/.docs/organized/docs/reference/fga/resource/get.mdx +88 -0
- package/.docs/organized/docs/reference/fga/resource/index.mdx +98 -0
- package/.docs/organized/docs/reference/fga/resource/list.mdx +188 -0
- package/.docs/organized/docs/reference/fga/resource/update.mdx +115 -0
- package/.docs/organized/docs/reference/fga/resource-type/apply.mdx +35 -0
- package/.docs/organized/docs/reference/fga/resource-type/create.mdx +24 -0
- package/.docs/organized/docs/reference/fga/resource-type/delete.mdx +22 -0
- package/.docs/organized/docs/reference/fga/resource-type/get.mdx +23 -0
- package/.docs/organized/docs/reference/fga/resource-type/index.mdx +68 -0
- package/.docs/organized/docs/reference/fga/resource-type/list.mdx +36 -0
- package/.docs/organized/docs/reference/fga/resource-type/update.mdx +23 -0
- package/.docs/organized/docs/reference/fga/schema/apply.mdx +42 -0
- package/.docs/organized/docs/reference/fga/schema/get.mdx +24 -0
- package/.docs/organized/docs/reference/fga/schema/index.mdx +39 -0
- package/.docs/organized/docs/reference/fga/warrant/batch-write.mdx +226 -0
- package/.docs/organized/docs/reference/fga/warrant/create.mdx +215 -0
- package/.docs/organized/docs/reference/fga/warrant/delete.mdx +212 -0
- package/.docs/organized/docs/reference/fga/warrant/index.mdx +186 -0
- package/.docs/organized/docs/reference/fga/warrant/list.mdx +282 -0
- package/.docs/organized/docs/reference/idempotency.mdx +21 -0
- package/.docs/organized/docs/reference/index.mdx +194 -0
- package/.docs/organized/docs/reference/magic-link/index.mdx +8 -0
- package/.docs/organized/docs/reference/magic-link/passwordless-session/create.mdx +268 -0
- package/.docs/organized/docs/reference/magic-link/passwordless-session/index.mdx +203 -0
- package/.docs/organized/docs/reference/magic-link/passwordless-session/send-email.mdx +158 -0
- package/.docs/organized/docs/reference/mfa/authentication-challenge.mdx +217 -0
- package/.docs/organized/docs/reference/mfa/authentication-factor.mdx +381 -0
- package/.docs/organized/docs/reference/mfa/challenge-factor.mdx +170 -0
- package/.docs/organized/docs/reference/mfa/delete-factor.mdx +93 -0
- package/.docs/organized/docs/reference/mfa/enroll-factor.mdx +241 -0
- package/.docs/organized/docs/reference/mfa/get-factor.mdx +108 -0
- package/.docs/organized/docs/reference/mfa/index.mdx +8 -0
- package/.docs/organized/docs/reference/mfa/verify-challenge.mdx +228 -0
- package/.docs/organized/docs/reference/organization/create.mdx +216 -0
- package/.docs/organized/docs/reference/organization/delete.mdx +89 -0
- package/.docs/organized/docs/reference/organization/get-by-external-id.mdx +40 -0
- package/.docs/organized/docs/reference/organization/get.mdx +104 -0
- package/.docs/organized/docs/reference/organization/index.mdx +274 -0
- package/.docs/organized/docs/reference/organization/list.mdx +258 -0
- package/.docs/organized/docs/reference/organization/update.mdx +236 -0
- package/.docs/organized/docs/reference/organization-domain.mdx +189 -0
- package/.docs/organized/docs/reference/pagination.mdx +244 -0
- package/.docs/organized/docs/reference/radar/attempts/create.mdx +115 -0
- package/.docs/organized/docs/reference/radar/attempts/index.mdx +7 -0
- package/.docs/organized/docs/reference/radar/attempts/update.mdx +34 -0
- package/.docs/organized/docs/reference/radar/index.mdx +8 -0
- package/.docs/organized/docs/reference/radar/lists/delete.mdx +36 -0
- package/.docs/organized/docs/reference/radar/lists/index.mdx +7 -0
- package/.docs/organized/docs/reference/radar/lists/update.mdx +36 -0
- package/.docs/organized/docs/reference/rate-limits.mdx +50 -0
- package/.docs/organized/docs/reference/roles/index.mdx +268 -0
- package/.docs/organized/docs/reference/roles/list-for-organization.mdx +152 -0
- package/.docs/organized/docs/reference/sso/connection/delete.mdx +89 -0
- package/.docs/organized/docs/reference/sso/connection/get.mdx +104 -0
- package/.docs/organized/docs/reference/sso/connection/index.mdx +388 -0
- package/.docs/organized/docs/reference/sso/connection/list.mdx +320 -0
- package/.docs/organized/docs/reference/sso/get-authorization-url/error-codes.mdx +28 -0
- package/.docs/organized/docs/reference/sso/get-authorization-url/index.mdx +434 -0
- package/.docs/organized/docs/reference/sso/get-authorization-url/redirect-uri.mdx +21 -0
- package/.docs/organized/docs/reference/sso/index.mdx +8 -0
- package/.docs/organized/docs/reference/sso/logout/authorize.mdx +47 -0
- package/.docs/organized/docs/reference/sso/logout/index.mdx +14 -0
- package/.docs/organized/docs/reference/sso/logout/redirect.mdx +32 -0
- package/.docs/organized/docs/reference/sso/profile/get-profile-and-token.mdx +229 -0
- package/.docs/organized/docs/reference/sso/profile/get-user-profile.mdx +127 -0
- package/.docs/organized/docs/reference/sso/profile/index.mdx +364 -0
- package/.docs/organized/docs/reference/testing.mdx +8 -0
- package/.docs/organized/docs/reference/user-management/access-token/index.mdx +13 -0
- package/.docs/organized/docs/reference/user-management/authentication/code.mdx +448 -0
- package/.docs/organized/docs/reference/user-management/authentication/email-verification.mdx +359 -0
- package/.docs/organized/docs/reference/user-management/authentication/get-authorization-url/error-codes.mdx +25 -0
- package/.docs/organized/docs/reference/user-management/authentication/get-authorization-url/index.mdx +425 -0
- package/.docs/organized/docs/reference/user-management/authentication/get-authorization-url/pkce.mdx +9 -0
- package/.docs/organized/docs/reference/user-management/authentication/get-authorization-url/redirect-uri.mdx +23 -0
- package/.docs/organized/docs/reference/user-management/authentication/index.mdx +66 -0
- package/.docs/organized/docs/reference/user-management/authentication/magic-auth.mdx +353 -0
- package/.docs/organized/docs/reference/user-management/authentication/organization-selection.mdx +349 -0
- package/.docs/organized/docs/reference/user-management/authentication/password.mdx +350 -0
- package/.docs/organized/docs/reference/user-management/authentication/refresh-and-seal-session-data.mdx +57 -0
- package/.docs/organized/docs/reference/user-management/authentication/refresh-token.mdx +381 -0
- package/.docs/organized/docs/reference/user-management/authentication/session-cookie.mdx +79 -0
- package/.docs/organized/docs/reference/user-management/authentication/totp.mdx +369 -0
- package/.docs/organized/docs/reference/user-management/authentication-errors/email-verification-required-error.mdx +42 -0
- package/.docs/organized/docs/reference/user-management/authentication-errors/index.mdx +20 -0
- package/.docs/organized/docs/reference/user-management/authentication-errors/mfa-challenge-error.mdx +44 -0
- package/.docs/organized/docs/reference/user-management/authentication-errors/mfa-enrollment-error.mdx +37 -0
- package/.docs/organized/docs/reference/user-management/authentication-errors/organization-authentication-required-error.mdx +68 -0
- package/.docs/organized/docs/reference/user-management/authentication-errors/organization-selection-error.mdx +44 -0
- package/.docs/organized/docs/reference/user-management/authentication-errors/sso-required-error.mdx +51 -0
- package/.docs/organized/docs/reference/user-management/email-verification/get.mdx +88 -0
- package/.docs/organized/docs/reference/user-management/email-verification/index.mdx +227 -0
- package/.docs/organized/docs/reference/user-management/identity/index.mdx +74 -0
- package/.docs/organized/docs/reference/user-management/identity/list.mdx +52 -0
- package/.docs/organized/docs/reference/user-management/index.mdx +13 -0
- package/.docs/organized/docs/reference/user-management/invitation/accept.mdx +39 -0
- package/.docs/organized/docs/reference/user-management/invitation/find-by-token.mdx +87 -0
- package/.docs/organized/docs/reference/user-management/invitation/get.mdx +87 -0
- package/.docs/organized/docs/reference/user-management/invitation/index.mdx +374 -0
- package/.docs/organized/docs/reference/user-management/invitation/list.mdx +247 -0
- package/.docs/organized/docs/reference/user-management/invitation/revoke.mdx +90 -0
- package/.docs/organized/docs/reference/user-management/invitation/send.mdx +230 -0
- package/.docs/organized/docs/reference/user-management/logout/get-logout-url-from-session-cookie.mdx +52 -0
- package/.docs/organized/docs/reference/user-management/logout/get-logout-url.mdx +147 -0
- package/.docs/organized/docs/reference/user-management/logout/index.mdx +26 -0
- package/.docs/organized/docs/reference/user-management/magic-auth/create.mdx +148 -0
- package/.docs/organized/docs/reference/user-management/magic-auth/get.mdx +88 -0
- package/.docs/organized/docs/reference/user-management/magic-auth/index.mdx +225 -0
- package/.docs/organized/docs/reference/user-management/mfa/authentication-challenge.mdx +194 -0
- package/.docs/organized/docs/reference/user-management/mfa/authentication-factor.mdx +324 -0
- package/.docs/organized/docs/reference/user-management/mfa/enroll-auth-factor.mdx +296 -0
- package/.docs/organized/docs/reference/user-management/mfa/index.mdx +5 -0
- package/.docs/organized/docs/reference/user-management/mfa/list-auth-factors.mdx +194 -0
- package/.docs/organized/docs/reference/user-management/organization-membership/create.mdx +155 -0
- package/.docs/organized/docs/reference/user-management/organization-membership/deactivate.mdx +106 -0
- package/.docs/organized/docs/reference/user-management/organization-membership/delete.mdx +76 -0
- package/.docs/organized/docs/reference/user-management/organization-membership/get.mdx +95 -0
- package/.docs/organized/docs/reference/user-management/organization-membership/index.mdx +265 -0
- package/.docs/organized/docs/reference/user-management/organization-membership/list.mdx +291 -0
- package/.docs/organized/docs/reference/user-management/organization-membership/reactivate.mdx +106 -0
- package/.docs/organized/docs/reference/user-management/organization-membership/update.mdx +119 -0
- package/.docs/organized/docs/reference/user-management/password-reset/create.mdx +108 -0
- package/.docs/organized/docs/reference/user-management/password-reset/get.mdx +88 -0
- package/.docs/organized/docs/reference/user-management/password-reset/index.mdx +227 -0
- package/.docs/organized/docs/reference/user-management/password-reset/reset-password.mdx +144 -0
- package/.docs/organized/docs/reference/user-management/session-helpers/authenticate.mdx +176 -0
- package/.docs/organized/docs/reference/user-management/session-helpers/get-logout-url.mdx +42 -0
- package/.docs/organized/docs/reference/user-management/session-helpers/index.mdx +14 -0
- package/.docs/organized/docs/reference/user-management/session-helpers/load-sealed-session.mdx +105 -0
- package/.docs/organized/docs/reference/user-management/session-helpers/refresh.mdx +213 -0
- package/.docs/organized/docs/reference/user-management/session-tokens/access-token.mdx +90 -0
- package/.docs/organized/docs/reference/user-management/session-tokens/index.mdx +5 -0
- package/.docs/organized/docs/reference/user-management/session-tokens/jwks.mdx +110 -0
- package/.docs/organized/docs/reference/user-management/session-tokens/refresh-token.mdx +8 -0
- package/.docs/organized/docs/reference/user-management/user/create.mdx +327 -0
- package/.docs/organized/docs/reference/user-management/user/delete.mdx +76 -0
- package/.docs/organized/docs/reference/user-management/user/get-by-external-id.mdx +39 -0
- package/.docs/organized/docs/reference/user-management/user/get.mdx +103 -0
- package/.docs/organized/docs/reference/user-management/user/index.mdx +322 -0
- package/.docs/organized/docs/reference/user-management/user/list.mdx +260 -0
- package/.docs/organized/docs/reference/user-management/user/update.mdx +344 -0
- package/.docs/organized/docs/reference/vault/index.mdx +6 -0
- package/.docs/organized/docs/reference/vault/key/create-data-key.mdx +106 -0
- package/.docs/organized/docs/reference/vault/key/decrypt-data-key.mdx +84 -0
- package/.docs/organized/docs/reference/vault/key/decrypt-data.mdx +52 -0
- package/.docs/organized/docs/reference/vault/key/encrypt-data.mdx +58 -0
- package/.docs/organized/docs/reference/vault/key/index.mdx +25 -0
- package/.docs/organized/docs/reference/vault/object/create.mdx +62 -0
- package/.docs/organized/docs/reference/vault/object/delete.mdx +75 -0
- package/.docs/organized/docs/reference/vault/object/get.mdx +50 -0
- package/.docs/organized/docs/reference/vault/object/index.mdx +174 -0
- package/.docs/organized/docs/reference/vault/object/list.mdx +105 -0
- package/.docs/organized/docs/reference/vault/object/metadata.mdx +52 -0
- package/.docs/organized/docs/reference/vault/object/update.mdx +67 -0
- package/.docs/organized/docs/reference/vault/object/version.mdx +87 -0
- package/.docs/organized/docs/reference/vault/object/versions.mdx +83 -0
- package/.docs/organized/docs/reference/widgets/get-token.mdx +185 -0
- package/.docs/organized/docs/reference/widgets/index.mdx +6 -0
- package/.docs/organized/docs/reference/workos-connect/authorize/index.mdx +75 -0
- package/.docs/organized/docs/reference/workos-connect/index.mdx +33 -0
- package/.docs/organized/docs/reference/workos-connect/introspection/index.mdx +122 -0
- package/.docs/organized/docs/reference/workos-connect/metadata/index.mdx +25 -0
- package/.docs/organized/docs/reference/workos-connect/metadata/oauth-authorization-server/index.mdx +99 -0
- package/.docs/organized/docs/reference/workos-connect/metadata/openid-configuration/index.mdx +70 -0
- package/.docs/organized/docs/reference/workos-connect/token/authorization-code-grant/access-token.mdx +53 -0
- package/.docs/organized/docs/reference/workos-connect/token/authorization-code-grant/id-token.mdx +60 -0
- package/.docs/organized/docs/reference/workos-connect/token/authorization-code-grant/index.mdx +69 -0
- package/.docs/organized/docs/reference/workos-connect/token/client-credentials-grant/access-token.mdx +46 -0
- package/.docs/organized/docs/reference/workos-connect/token/client-credentials-grant/index.mdx +56 -0
- package/.docs/organized/docs/reference/workos-connect/token/index.mdx +39 -0
- package/.docs/organized/docs/reference/workos-connect/token/refresh-token-grant.mdx +69 -0
- package/.docs/organized/docs/reference/workos-connect/userinfo/index.mdx +46 -0
- package/.docs/organized/docs/sdks/dotnet.mdx +6 -0
- package/.docs/organized/docs/sdks/elixir.mdx +6 -0
- package/.docs/organized/docs/sdks/go.mdx +6 -0
- package/.docs/organized/docs/sdks/java.mdx +9 -0
- package/.docs/organized/docs/sdks/laravel.mdx +6 -0
- package/.docs/organized/docs/sdks/node.mdx +9 -0
- package/.docs/organized/docs/sdks/php.mdx +6 -0
- package/.docs/organized/docs/sdks/python.mdx +6 -0
- package/.docs/organized/docs/sdks/ruby.mdx +9 -0
- package/.docs/organized/docs/sso/_navigation.mdx +44 -0
- package/.docs/organized/docs/sso/_sequence-diagrams/saml-protocol-security-considerations.md +59 -0
- package/.docs/organized/docs/sso/attributes.mdx +110 -0
- package/.docs/organized/docs/sso/domains.mdx +111 -0
- package/.docs/organized/docs/sso/example-apps.mdx +46 -0
- package/.docs/organized/docs/sso/identity-provider-role-assignment.mdx +113 -0
- package/.docs/organized/docs/sso/index.mdx +295 -0
- package/.docs/organized/docs/sso/it-team-faq.mdx +35 -0
- package/.docs/organized/docs/sso/jit-provisioning.mdx +101 -0
- package/.docs/organized/docs/sso/launch-checklist.mdx +71 -0
- package/.docs/organized/docs/sso/login-flows.mdx +101 -0
- package/.docs/organized/docs/sso/redirect-uris.mdx +44 -0
- package/.docs/organized/docs/sso/saml-security.mdx +122 -0
- package/.docs/organized/docs/sso/signing-certificates.mdx +121 -0
- package/.docs/organized/docs/sso/single-logout.mdx +45 -0
- package/.docs/organized/docs/sso/test-sso.mdx +73 -0
- package/.docs/organized/docs/sso/ux/sign-in.mdx +44 -0
- package/.docs/organized/docs/user-management/_navigation.mdx +87 -0
- package/.docs/organized/docs/user-management/actions.mdx +169 -0
- package/.docs/organized/docs/user-management/authkit.mdx +69 -0
- package/.docs/organized/docs/user-management/branding.mdx +143 -0
- package/.docs/organized/docs/user-management/connect.mdx +110 -0
- package/.docs/organized/docs/user-management/custom-emails.mdx +164 -0
- package/.docs/organized/docs/user-management/directory-provisioning.mdx +78 -0
- package/.docs/organized/docs/user-management/domain-verification.mdx +28 -0
- package/.docs/organized/docs/user-management/email-password.mdx +42 -0
- package/.docs/organized/docs/user-management/email-verification.mdx +29 -0
- package/.docs/organized/docs/user-management/entitlements.mdx +46 -0
- package/.docs/organized/docs/user-management/example-apps.mdx +39 -0
- package/.docs/organized/docs/user-management/identity-linking.mdx +52 -0
- package/.docs/organized/docs/user-management/impersonation.mdx +82 -0
- package/.docs/organized/docs/user-management/index.mdx +525 -0
- package/.docs/organized/docs/user-management/invitations.mdx +60 -0
- package/.docs/organized/docs/user-management/invite-only-signup.mdx +72 -0
- package/.docs/organized/docs/user-management/jit-provisioning.mdx +36 -0
- package/.docs/organized/docs/user-management/jwt-templates.mdx +278 -0
- package/.docs/organized/docs/user-management/magic-auth.mdx +36 -0
- package/.docs/organized/docs/user-management/mcp.mdx +146 -0
- package/.docs/organized/docs/user-management/metadata.mdx +119 -0
- package/.docs/organized/docs/user-management/mfa.mdx +32 -0
- package/.docs/organized/docs/user-management/migrations.mdx +20 -0
- package/.docs/organized/docs/user-management/modeling-your-app.mdx +149 -0
- package/.docs/organized/docs/user-management/organization-policies.mdx +33 -0
- package/.docs/organized/docs/user-management/overview.mdx +46 -0
- package/.docs/organized/docs/user-management/passkeys.mdx +42 -0
- package/.docs/organized/docs/user-management/radar.mdx +127 -0
- package/.docs/organized/docs/user-management/roles-and-permissions.mdx +155 -0
- package/.docs/organized/docs/user-management/sessions.mdx +101 -0
- package/.docs/organized/docs/user-management/social-login.mdx +34 -0
- package/.docs/organized/docs/user-management/sso-with-contractors.mdx +85 -0
- package/.docs/organized/docs/user-management/sso.mdx +96 -0
- package/.docs/organized/docs/user-management/users-organizations.mdx +91 -0
- package/.docs/organized/docs/user-management/widgets.mdx +190 -0
- package/.docs/organized/docs/vault/_navigation.mdx +14 -0
- package/.docs/organized/docs/vault/index.mdx +38 -0
- package/.docs/organized/docs/vault/key-context.mdx +32 -0
- package/.docs/organized/docs/vault/quick-start.mdx +82 -0
- package/README.md +252 -0
- package/dist/chunk-64GKEK6G.js +48 -0
- package/dist/chunk-64GKEK6G.js.map +1 -0
- package/dist/get-tools.d.ts +23 -0
- package/dist/get-tools.js +8 -0
- package/dist/get-tools.js.map +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +552 -0
- package/dist/index.js.map +1 -0
- package/dist/prepare.d.ts +2 -0
- package/dist/prepare.js +269 -0
- package/dist/prepare.js.map +1 -0
- package/package.json +49 -0
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
---
|
|
2
|
+
descriptions:
|
|
3
|
+
get_jwks_url:
|
|
4
|
+
url: URL that hosts the JWKS for signing access tokens.
|
|
5
|
+
reference:
|
|
6
|
+
curl:
|
|
7
|
+
- key: getJwksUrl
|
|
8
|
+
id: get_jwks_url
|
|
9
|
+
url: /reference/user-management/session-tokens/jwks
|
|
10
|
+
title: /sso/jwks
|
|
11
|
+
type: GET
|
|
12
|
+
properties:
|
|
13
|
+
- key: clientId
|
|
14
|
+
type: string
|
|
15
|
+
description: (client_id)
|
|
16
|
+
returns:
|
|
17
|
+
- key: url
|
|
18
|
+
type: string
|
|
19
|
+
description: (get_jwks_url.url)
|
|
20
|
+
js:
|
|
21
|
+
- key: getJwksUrl
|
|
22
|
+
id: get_jwks_url
|
|
23
|
+
url: /reference/user-management/session-tokens/jwks
|
|
24
|
+
title: userManagement.getJwksUrl()
|
|
25
|
+
parameters:
|
|
26
|
+
- key: clientId
|
|
27
|
+
type: string
|
|
28
|
+
description: (client_id)
|
|
29
|
+
returns:
|
|
30
|
+
- key: jwksUrl
|
|
31
|
+
type: string
|
|
32
|
+
description: (get_jwks_url.url)
|
|
33
|
+
go:
|
|
34
|
+
- key: GetJwksUrl
|
|
35
|
+
id: get_jwks_url
|
|
36
|
+
url: /reference/user-management/session-tokens/jwks
|
|
37
|
+
title: usermanagement.GetJwksUrl()
|
|
38
|
+
parameters:
|
|
39
|
+
- key: ClientID
|
|
40
|
+
type: string
|
|
41
|
+
description: (client_id)
|
|
42
|
+
returns:
|
|
43
|
+
- key: jwksUrl
|
|
44
|
+
type: string
|
|
45
|
+
description: (get_jwks_url.url)
|
|
46
|
+
- (err)
|
|
47
|
+
ruby:
|
|
48
|
+
- key: get_jwks_url
|
|
49
|
+
id: get_jwks_url
|
|
50
|
+
url: /reference/user-management/session-tokens/jwks
|
|
51
|
+
title: UserManagement.get_jwks_url()
|
|
52
|
+
parameters:
|
|
53
|
+
- key: client_id
|
|
54
|
+
type: String
|
|
55
|
+
description: (client_id)
|
|
56
|
+
returns:
|
|
57
|
+
- key: jwksUrl
|
|
58
|
+
type: string
|
|
59
|
+
description: (get_jwks_url.url)
|
|
60
|
+
java:
|
|
61
|
+
- key: getJwksUrl
|
|
62
|
+
id: get_jwks_url
|
|
63
|
+
url: /reference/user-management/session-tokens/jwks
|
|
64
|
+
title: userManagement.getJwksUrl()
|
|
65
|
+
parameters:
|
|
66
|
+
- key: clientId
|
|
67
|
+
type: String
|
|
68
|
+
description: (client_id)
|
|
69
|
+
returns:
|
|
70
|
+
- key: jwksUrl
|
|
71
|
+
type: String
|
|
72
|
+
description: (get_jwks_url.url)
|
|
73
|
+
php:
|
|
74
|
+
- key: getJwksUrl
|
|
75
|
+
id: get_jwks_url
|
|
76
|
+
url: /reference/user-management/session-tokens/jwks
|
|
77
|
+
title: $userManagement->getJwksUrl()
|
|
78
|
+
parameters:
|
|
79
|
+
- key: clientId
|
|
80
|
+
type: String
|
|
81
|
+
description: (client_id)
|
|
82
|
+
returns:
|
|
83
|
+
- key: jwksUrl
|
|
84
|
+
type: string
|
|
85
|
+
description: (get_jwks_url.url)
|
|
86
|
+
python:
|
|
87
|
+
- key: get_jwks_url
|
|
88
|
+
id: get_jwks_url
|
|
89
|
+
url: /reference/user-management/session-tokens/jwks
|
|
90
|
+
title: user_management.get_jwks_url()
|
|
91
|
+
parameters:
|
|
92
|
+
- key: client_id
|
|
93
|
+
type: String
|
|
94
|
+
description: (client_id)
|
|
95
|
+
returns:
|
|
96
|
+
- key: jwks_url
|
|
97
|
+
type: string
|
|
98
|
+
description: (get_jwks_url.url)
|
|
99
|
+
originalPath: >-
|
|
100
|
+
.tmp-workos-clone/packages/docs/content/reference/user-management/session-tokens/jwks.mdx
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## JWKS URL
|
|
104
|
+
|
|
105
|
+
This hosts the public key that is used for verifying access tokens.
|
|
106
|
+
|
|
107
|
+
<CodeBlock referenceId="get_jwks_url">
|
|
108
|
+
<CodeBlockTab title="Request" file="get-jwks-url-request" />
|
|
109
|
+
<CodeBlockTab title="Response" file="get-jwks-url-response" />
|
|
110
|
+
</CodeBlock>
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
---
|
|
2
|
+
originalPath: >-
|
|
3
|
+
.tmp-workos-clone/packages/docs/content/reference/user-management/session-tokens/refresh-token.mdx
|
|
4
|
+
---
|
|
5
|
+
## Refresh token
|
|
6
|
+
|
|
7
|
+
The refresh token can be used to obtain a new access token using the [authenticate with refresh token
|
|
8
|
+
](reference/user-management/authentication/refresh-token) endpoint. Refresh tokens may only be used once. Refreshes will succeed as long as the user's session is still active.
|
|
@@ -0,0 +1,327 @@
|
|
|
1
|
+
---
|
|
2
|
+
descriptions:
|
|
3
|
+
create_user:
|
|
4
|
+
password: The password to set for the user.
|
|
5
|
+
password_hash: >-
|
|
6
|
+
The hashed password to set for the user. Mutually exclusive with
|
|
7
|
+
`password`.
|
|
8
|
+
password_hash_type: >
|
|
9
|
+
The algorithm originally used to hash the password, used when providing a
|
|
10
|
+
`password_hash`. Valid values are `bcrypt`, `scrypt`, `firebase-scrypt`,
|
|
11
|
+
`ssha`, and `pbkdf2`.
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
See the [Firebase Migration guide](/migrate/firebase) for an example of
|
|
15
|
+
how to format the `password_hash` when importing `firebase-scrypt`
|
|
16
|
+
passwords.
|
|
17
|
+
email_verified: >
|
|
18
|
+
Whether the user’s email address was previously verified.
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
You should normally use the [email verification
|
|
22
|
+
flow](/reference/user-management/authentication/email-verification)
|
|
23
|
+
|
|
24
|
+
to verify a user’s email address. However, if the user’s email was
|
|
25
|
+
previously verified, or
|
|
26
|
+
|
|
27
|
+
is being migrated from an existing user store, this can be set to `true`
|
|
28
|
+
to mark it as
|
|
29
|
+
|
|
30
|
+
already verified.
|
|
31
|
+
external_id: >-
|
|
32
|
+
The [external identifier](/user-management/metadata/external-identifiers)
|
|
33
|
+
of the user.
|
|
34
|
+
metadata: >-
|
|
35
|
+
Object containing [metadata](/user-management/metadata) key/value pairs
|
|
36
|
+
associated with the user.
|
|
37
|
+
reference:
|
|
38
|
+
curl:
|
|
39
|
+
- key: create_user
|
|
40
|
+
id: create_user
|
|
41
|
+
url: /reference/user-management/user/create
|
|
42
|
+
title: /user_management/users
|
|
43
|
+
type: POST
|
|
44
|
+
parameters:
|
|
45
|
+
- key: email
|
|
46
|
+
type: string
|
|
47
|
+
description: (user.email)
|
|
48
|
+
- key: password
|
|
49
|
+
type: string
|
|
50
|
+
optional: true
|
|
51
|
+
description: (create_user.password)
|
|
52
|
+
- key: password_hash
|
|
53
|
+
type: string
|
|
54
|
+
optional: true
|
|
55
|
+
description: (create_user.password_hash)
|
|
56
|
+
- key: password_hash_type
|
|
57
|
+
type: string
|
|
58
|
+
optional: true
|
|
59
|
+
description: (create_user.password_hash_type)
|
|
60
|
+
- key: first_name
|
|
61
|
+
type: string
|
|
62
|
+
optional: true
|
|
63
|
+
description: (user.first_name)
|
|
64
|
+
- key: last_name
|
|
65
|
+
type: string
|
|
66
|
+
optional: true
|
|
67
|
+
description: (user.last_name)
|
|
68
|
+
- key: email_verified
|
|
69
|
+
type: boolean
|
|
70
|
+
optional: true
|
|
71
|
+
description: (create_user.email_verified)
|
|
72
|
+
- key: external_id
|
|
73
|
+
type: string
|
|
74
|
+
optional: true
|
|
75
|
+
description: (user.external_id)
|
|
76
|
+
- key: metadata
|
|
77
|
+
type: object
|
|
78
|
+
optional: true
|
|
79
|
+
description: (user.metadata)
|
|
80
|
+
returns:
|
|
81
|
+
- (user)
|
|
82
|
+
js:
|
|
83
|
+
- key: createUser
|
|
84
|
+
id: create_user
|
|
85
|
+
url: /reference/user-management/user/create
|
|
86
|
+
title: userManagement.createUser()
|
|
87
|
+
parameters:
|
|
88
|
+
- key: options
|
|
89
|
+
type: object
|
|
90
|
+
unwrap: true
|
|
91
|
+
properties:
|
|
92
|
+
- key: email
|
|
93
|
+
type: string
|
|
94
|
+
description: (user.email)
|
|
95
|
+
- key: password
|
|
96
|
+
type: string
|
|
97
|
+
optional: true
|
|
98
|
+
description: (create_user.password)
|
|
99
|
+
- key: passwordHash
|
|
100
|
+
type: string
|
|
101
|
+
optional: true
|
|
102
|
+
description: (create_user.password_hash)
|
|
103
|
+
- key: passwordHashType
|
|
104
|
+
type: string
|
|
105
|
+
optional: true
|
|
106
|
+
description: (create_user.password_hash_type)
|
|
107
|
+
- key: firstName
|
|
108
|
+
type: string
|
|
109
|
+
optional: true
|
|
110
|
+
description: (user.first_name)
|
|
111
|
+
- key: lastName
|
|
112
|
+
type: string
|
|
113
|
+
optional: true
|
|
114
|
+
description: (user.last_name)
|
|
115
|
+
- key: emailVerified
|
|
116
|
+
type: boolean
|
|
117
|
+
optional: true
|
|
118
|
+
description: (create_user.email_verified)
|
|
119
|
+
- key: externalId
|
|
120
|
+
type: string
|
|
121
|
+
optional: true
|
|
122
|
+
description: (user.external_id)
|
|
123
|
+
- key: metadata
|
|
124
|
+
type: object
|
|
125
|
+
optional: true
|
|
126
|
+
description: (user.metadata)
|
|
127
|
+
returns:
|
|
128
|
+
- (User)
|
|
129
|
+
go:
|
|
130
|
+
- key: CreateUser
|
|
131
|
+
id: create_user
|
|
132
|
+
url: /reference/user-management/user/create
|
|
133
|
+
title: usermanagement.CreateUser()
|
|
134
|
+
parameters:
|
|
135
|
+
- (ctx)
|
|
136
|
+
- key: opts
|
|
137
|
+
type: usermanagement.CreateUserOpts
|
|
138
|
+
unwrap: true
|
|
139
|
+
properties:
|
|
140
|
+
- key: Email
|
|
141
|
+
type: string
|
|
142
|
+
description: (user.email)
|
|
143
|
+
- key: Password
|
|
144
|
+
type: string
|
|
145
|
+
optional: true
|
|
146
|
+
description: (create_user.password)
|
|
147
|
+
- key: PasswordHash
|
|
148
|
+
type: string
|
|
149
|
+
optional: true
|
|
150
|
+
description: (create_user.password_hash)
|
|
151
|
+
- key: PasswordHashType
|
|
152
|
+
type: string
|
|
153
|
+
optional: true
|
|
154
|
+
description: (create_user.password_hash_type)
|
|
155
|
+
- key: FirstName
|
|
156
|
+
type: string
|
|
157
|
+
optional: true
|
|
158
|
+
description: (user.first_name)
|
|
159
|
+
- key: LastName
|
|
160
|
+
type: string
|
|
161
|
+
optional: true
|
|
162
|
+
description: (user.last_name)
|
|
163
|
+
- key: EmailVerified
|
|
164
|
+
type: boolean
|
|
165
|
+
optional: true
|
|
166
|
+
description: (create_user.email_verified)
|
|
167
|
+
returns:
|
|
168
|
+
- key: user
|
|
169
|
+
type: usermanagement.User
|
|
170
|
+
description: (user.self)
|
|
171
|
+
- (err)
|
|
172
|
+
php:
|
|
173
|
+
- key: createUser
|
|
174
|
+
id: create_user
|
|
175
|
+
url: /reference/user-management/user/create
|
|
176
|
+
title: $userManagement->createUser()
|
|
177
|
+
parameters:
|
|
178
|
+
- key: email
|
|
179
|
+
type: string
|
|
180
|
+
description: (user.email)
|
|
181
|
+
- key: password
|
|
182
|
+
type: string
|
|
183
|
+
optional: true
|
|
184
|
+
description: (create_user.password)
|
|
185
|
+
- key: passwordHash
|
|
186
|
+
type: string
|
|
187
|
+
optional: true
|
|
188
|
+
description: (create_user.password_hash)
|
|
189
|
+
- key: passwordHashType
|
|
190
|
+
type: string
|
|
191
|
+
optional: true
|
|
192
|
+
description: (create_user.password_hash_type)
|
|
193
|
+
- key: firstName
|
|
194
|
+
type: string
|
|
195
|
+
optional: true
|
|
196
|
+
description: (user.first_name)
|
|
197
|
+
- key: lastName
|
|
198
|
+
type: string
|
|
199
|
+
optional: true
|
|
200
|
+
description: (user.last_name)
|
|
201
|
+
- key: emailVerified
|
|
202
|
+
type: boolean
|
|
203
|
+
optional: true
|
|
204
|
+
description: (create_user.email_verified)
|
|
205
|
+
returns:
|
|
206
|
+
- (User)
|
|
207
|
+
python:
|
|
208
|
+
- key: create_user
|
|
209
|
+
id: create_user
|
|
210
|
+
url: /reference/user-management/user/create
|
|
211
|
+
title: user_management.create_user()
|
|
212
|
+
parameters:
|
|
213
|
+
- key: email
|
|
214
|
+
type: str
|
|
215
|
+
description: (user.email)
|
|
216
|
+
- key: password
|
|
217
|
+
type: str
|
|
218
|
+
optional: true
|
|
219
|
+
description: (create_user.password)
|
|
220
|
+
- key: password_hash
|
|
221
|
+
type: str
|
|
222
|
+
optional: true
|
|
223
|
+
description: (create_user.password_hash)
|
|
224
|
+
- key: password_hash_type
|
|
225
|
+
type: PasswordHashType
|
|
226
|
+
optional: true
|
|
227
|
+
description: (create_user.password_hash_type)
|
|
228
|
+
- key: first_name
|
|
229
|
+
type: str
|
|
230
|
+
optional: true
|
|
231
|
+
description: (user.first_name)
|
|
232
|
+
- key: last_name
|
|
233
|
+
type: str
|
|
234
|
+
optional: true
|
|
235
|
+
description: (user.last_name)
|
|
236
|
+
- key: email_verified
|
|
237
|
+
type: bool
|
|
238
|
+
optional: true
|
|
239
|
+
description: (create_user.email_verified)
|
|
240
|
+
returns:
|
|
241
|
+
- (User)
|
|
242
|
+
ruby:
|
|
243
|
+
- key: create_user
|
|
244
|
+
id: create_user
|
|
245
|
+
url: /reference/user-management/user/create
|
|
246
|
+
title: UserManagement.create_user()
|
|
247
|
+
parameters:
|
|
248
|
+
- key: email
|
|
249
|
+
type: String
|
|
250
|
+
description: (user.email)
|
|
251
|
+
- key: password
|
|
252
|
+
type: String
|
|
253
|
+
optional: true
|
|
254
|
+
description: (create_user.password)
|
|
255
|
+
- key: password_hash
|
|
256
|
+
type: String
|
|
257
|
+
optional: true
|
|
258
|
+
description: (create_user.password_hash)
|
|
259
|
+
- key: password_hash_type
|
|
260
|
+
type: String
|
|
261
|
+
optional: true
|
|
262
|
+
description: (create_user.password_hash_type)
|
|
263
|
+
- key: first_name
|
|
264
|
+
type: String
|
|
265
|
+
optional: true
|
|
266
|
+
description: (user.first_name)
|
|
267
|
+
- key: last_name
|
|
268
|
+
type: String
|
|
269
|
+
optional: true
|
|
270
|
+
description: (user.last_name)
|
|
271
|
+
- key: email_verified
|
|
272
|
+
type: Boolean
|
|
273
|
+
optional: true
|
|
274
|
+
description: (create_user.email_verified)
|
|
275
|
+
returns:
|
|
276
|
+
- (User)
|
|
277
|
+
java:
|
|
278
|
+
- key: createUser
|
|
279
|
+
id: create_user
|
|
280
|
+
url: /reference/user-management/user/create
|
|
281
|
+
title: userManagement.createUser()
|
|
282
|
+
parameters:
|
|
283
|
+
- key: options
|
|
284
|
+
type: CreateUserOptions
|
|
285
|
+
unwrap: true
|
|
286
|
+
properties:
|
|
287
|
+
- key: email
|
|
288
|
+
type: String
|
|
289
|
+
description: (user.email)
|
|
290
|
+
- key: password
|
|
291
|
+
type: String
|
|
292
|
+
optional: true
|
|
293
|
+
description: (create_user.password)
|
|
294
|
+
- key: passwordHash
|
|
295
|
+
type: String
|
|
296
|
+
optional: true
|
|
297
|
+
description: (create_user.password_hash)
|
|
298
|
+
- key: passwordHashType
|
|
299
|
+
type: PasswordHashTypeEnumType
|
|
300
|
+
optional: true
|
|
301
|
+
description: (create_user.password_hash_type)
|
|
302
|
+
- key: firstName
|
|
303
|
+
type: String
|
|
304
|
+
optional: true
|
|
305
|
+
description: (user.first_name)
|
|
306
|
+
- key: lastName
|
|
307
|
+
type: String
|
|
308
|
+
optional: true
|
|
309
|
+
description: (user.last_name)
|
|
310
|
+
- key: emailVerified
|
|
311
|
+
type: Boolean
|
|
312
|
+
optional: true
|
|
313
|
+
description: (create_user.email_verified)
|
|
314
|
+
returns:
|
|
315
|
+
- (User)
|
|
316
|
+
originalPath: >-
|
|
317
|
+
.tmp-workos-clone/packages/docs/content/reference/user-management/user/create.mdx
|
|
318
|
+
---
|
|
319
|
+
|
|
320
|
+
## Create a user
|
|
321
|
+
|
|
322
|
+
Create a new user in the current environment.
|
|
323
|
+
|
|
324
|
+
<CodeBlock title="Request" referenceId="create_user">
|
|
325
|
+
<CodeBlockTab title="Request" file="create-user-request" />
|
|
326
|
+
<CodeBlockTab title="Response" file="create-user-response" />
|
|
327
|
+
</CodeBlock>
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
---
|
|
2
|
+
reference:
|
|
3
|
+
curl:
|
|
4
|
+
- key: delete_user
|
|
5
|
+
id: delete_user
|
|
6
|
+
url: /reference/user-management/user/delete
|
|
7
|
+
title: '/user_management/users/:id'
|
|
8
|
+
type: DELETE
|
|
9
|
+
parameters:
|
|
10
|
+
- (user.id)
|
|
11
|
+
js:
|
|
12
|
+
- key: deleteUser
|
|
13
|
+
id: delete_user
|
|
14
|
+
url: /reference/user-management/user/delete
|
|
15
|
+
title: userManagement.deleteUser()
|
|
16
|
+
parameters:
|
|
17
|
+
- (User.id)
|
|
18
|
+
php:
|
|
19
|
+
- key: deleteUser
|
|
20
|
+
id: delete_user
|
|
21
|
+
url: /reference/user-management/user/delete
|
|
22
|
+
title: $userManagement->deleteUser()
|
|
23
|
+
parameters:
|
|
24
|
+
- key: id
|
|
25
|
+
type: string
|
|
26
|
+
description: (user.id)
|
|
27
|
+
go:
|
|
28
|
+
- key: DeleteUser
|
|
29
|
+
id: delete_user
|
|
30
|
+
url: /reference/user-management/user/delete
|
|
31
|
+
title: usermanagement.DeleteUser()
|
|
32
|
+
parameters:
|
|
33
|
+
- (ctx)
|
|
34
|
+
- key: opts
|
|
35
|
+
type: usermanagement.DeleteUserOpts
|
|
36
|
+
unwrap: true
|
|
37
|
+
properties:
|
|
38
|
+
- key: User
|
|
39
|
+
type: string
|
|
40
|
+
description: (user.id)
|
|
41
|
+
python:
|
|
42
|
+
- key: delete_user
|
|
43
|
+
id: delete_user
|
|
44
|
+
url: /reference/user-management/user/delete
|
|
45
|
+
title: user_management.delete_user()
|
|
46
|
+
parameters:
|
|
47
|
+
- key: user_id
|
|
48
|
+
type: string
|
|
49
|
+
description: (user.id)
|
|
50
|
+
ruby:
|
|
51
|
+
- key: delete_user
|
|
52
|
+
id: delete_user
|
|
53
|
+
url: /reference/user-management/user/delete
|
|
54
|
+
title: UserManagement.delete_user()
|
|
55
|
+
parameters:
|
|
56
|
+
- key: id
|
|
57
|
+
type: String
|
|
58
|
+
description: (user.id)
|
|
59
|
+
java:
|
|
60
|
+
- key: deleteUser
|
|
61
|
+
id: delete_user
|
|
62
|
+
url: /reference/user-management/user/delete
|
|
63
|
+
title: userManagement.deleteUser()
|
|
64
|
+
parameters:
|
|
65
|
+
- key: userId
|
|
66
|
+
type: String
|
|
67
|
+
description: (user.id)
|
|
68
|
+
originalPath: >-
|
|
69
|
+
.tmp-workos-clone/packages/docs/content/reference/user-management/user/delete.mdx
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## Delete a user
|
|
73
|
+
|
|
74
|
+
Permanently deletes a user in the current environment. It cannot be undone.
|
|
75
|
+
|
|
76
|
+
<CodeBlock title="Request" referenceId="delete_user" file="delete-user" />
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
---
|
|
2
|
+
reference:
|
|
3
|
+
curl:
|
|
4
|
+
- key: get_user_by_external_id
|
|
5
|
+
id: get_user_by_external_id
|
|
6
|
+
url: /reference/user-management/user/get-by-external-id
|
|
7
|
+
title: '/user_management/users/external_id/:external_id'
|
|
8
|
+
type: GET
|
|
9
|
+
parameters:
|
|
10
|
+
- key: external_id
|
|
11
|
+
type: string
|
|
12
|
+
description: (user.external_id)
|
|
13
|
+
returns:
|
|
14
|
+
- (user)
|
|
15
|
+
js:
|
|
16
|
+
- key: getUserByExternalId
|
|
17
|
+
patternBefore: userManagement.
|
|
18
|
+
id: get_user_by_external_id
|
|
19
|
+
url: /reference/user-management/user/get-by-external-id
|
|
20
|
+
title: userManagement.getUserByExternalId()
|
|
21
|
+
type: GET
|
|
22
|
+
parameters:
|
|
23
|
+
- key: externalId
|
|
24
|
+
type: string
|
|
25
|
+
description: (user.external_id)
|
|
26
|
+
returns:
|
|
27
|
+
- (User)
|
|
28
|
+
originalPath: >-
|
|
29
|
+
.tmp-workos-clone/packages/docs/content/reference/user-management/user/get-by-external-id.mdx
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## Get a user by external ID
|
|
33
|
+
|
|
34
|
+
Get the details of an existing user by an [external identifier](/user-management/metadata/external-identifiers).
|
|
35
|
+
|
|
36
|
+
<CodeBlock referenceId="get_user_by_external_id">
|
|
37
|
+
<CodeBlockTab title="Request" file="get-user-by-external-id-request" />
|
|
38
|
+
<CodeBlockTab title="Response" file="get-user-response" />
|
|
39
|
+
</CodeBlock>
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
---
|
|
2
|
+
reference:
|
|
3
|
+
curl:
|
|
4
|
+
- key: get_user
|
|
5
|
+
id: get_user
|
|
6
|
+
url: /reference/user-management/user/get
|
|
7
|
+
title: '/user_management/users/:id'
|
|
8
|
+
type: GET
|
|
9
|
+
parameters:
|
|
10
|
+
- (user.id)
|
|
11
|
+
returns:
|
|
12
|
+
- (user)
|
|
13
|
+
js:
|
|
14
|
+
- key: getUser
|
|
15
|
+
patternBefore: userManagement.
|
|
16
|
+
id: get_user
|
|
17
|
+
url: /reference/user-management/user/get
|
|
18
|
+
title: userManagement.getUser()
|
|
19
|
+
type: GET
|
|
20
|
+
parameters:
|
|
21
|
+
- (User.id)
|
|
22
|
+
returns:
|
|
23
|
+
- (User)
|
|
24
|
+
go:
|
|
25
|
+
- key: GetUser
|
|
26
|
+
patternBefore: usermanagement.
|
|
27
|
+
id: get_user
|
|
28
|
+
url: /reference/user-management/user/get
|
|
29
|
+
title: usermanagement.GetUser()
|
|
30
|
+
parameters:
|
|
31
|
+
- (ctx)
|
|
32
|
+
- key: opts
|
|
33
|
+
type: usermanagement.GetUserOpts
|
|
34
|
+
unwrap: true
|
|
35
|
+
properties:
|
|
36
|
+
- key: User
|
|
37
|
+
type: string
|
|
38
|
+
description: (user.id)
|
|
39
|
+
returns:
|
|
40
|
+
- key: user
|
|
41
|
+
type: usermanagement.User
|
|
42
|
+
description: (user.self)
|
|
43
|
+
- (err)
|
|
44
|
+
php:
|
|
45
|
+
- key: getUser
|
|
46
|
+
patternBefore: userManagement->
|
|
47
|
+
id: get_user
|
|
48
|
+
url: /reference/user-management/user/get
|
|
49
|
+
title: $userManagement->getUser()
|
|
50
|
+
type: GET
|
|
51
|
+
parameters:
|
|
52
|
+
- key: id
|
|
53
|
+
type: string
|
|
54
|
+
description: (user.id)
|
|
55
|
+
returns:
|
|
56
|
+
- (User)
|
|
57
|
+
python:
|
|
58
|
+
- key: get_user
|
|
59
|
+
patternBefore: user_management.
|
|
60
|
+
id: get_user
|
|
61
|
+
url: /reference/user-management/user/get
|
|
62
|
+
title: user_management.get_user()
|
|
63
|
+
parameters:
|
|
64
|
+
- key: user_id
|
|
65
|
+
type: str
|
|
66
|
+
description: (user.id)
|
|
67
|
+
returns:
|
|
68
|
+
- (User)
|
|
69
|
+
ruby:
|
|
70
|
+
- key: get_user
|
|
71
|
+
id: get_user
|
|
72
|
+
url: /reference/user-management/user/get
|
|
73
|
+
title: UserManagement.get_user()
|
|
74
|
+
type: GET
|
|
75
|
+
parameters:
|
|
76
|
+
- key: id
|
|
77
|
+
type: String
|
|
78
|
+
description: (user.id)
|
|
79
|
+
returns:
|
|
80
|
+
- (User)
|
|
81
|
+
java:
|
|
82
|
+
- key: getUser
|
|
83
|
+
id: get_user
|
|
84
|
+
url: /reference/user-management/user/get
|
|
85
|
+
title: userManagement.getUser()
|
|
86
|
+
type: GET
|
|
87
|
+
parameters:
|
|
88
|
+
- key: userId
|
|
89
|
+
type: String
|
|
90
|
+
description: (user.id)
|
|
91
|
+
returns:
|
|
92
|
+
- (User)
|
|
93
|
+
originalPath: .tmp-workos-clone/packages/docs/content/reference/user-management/user/get.mdx
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
## Get a user
|
|
97
|
+
|
|
98
|
+
Get the details of an existing user.
|
|
99
|
+
|
|
100
|
+
<CodeBlock referenceId="get_user">
|
|
101
|
+
<CodeBlockTab title="Request" file="get-user-request" />
|
|
102
|
+
<CodeBlockTab title="Response" file="get-user-response" />
|
|
103
|
+
</CodeBlock>
|