@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,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: AuthKit Domain
|
|
3
|
+
description: Guidance on configuring a custom domain for AuthKit.
|
|
4
|
+
showNextPage: true
|
|
5
|
+
originalPath: .tmp-workos-clone/packages/docs/content/custom-domains/authkit.mdx
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Configuring a domain
|
|
9
|
+
|
|
10
|
+
The domain for AuthKit will consist of a randomly generated phrase plus the domain `authkit.app`, for instance `youthful-ginger-43.authkit.app`.
|
|
11
|
+
|
|
12
|
+
This is the default in the staging environment, in Production environments a custom domain can be configured via the dashboard.
|
|
13
|
+
|
|
14
|
+
> You must configure an [Authentication API domain](/custom-domains/auth-api) first in order for your custom AuthKit domain to work properly.
|
|
15
|
+
|
|
16
|
+
### (1) Navigate to Domains configuration
|
|
17
|
+
|
|
18
|
+
With the production environment selected, navigate to the _Domains_ section of the [WorkOS Dashboard](https://dashboard.workos.com/).
|
|
19
|
+
|
|
20
|
+

|
|
21
|
+
|
|
22
|
+
### (2) Add an AuthKit domain
|
|
23
|
+
|
|
24
|
+
Click the _Configure AuthKit domain_ button and enter the domain you would like to use.
|
|
25
|
+
|
|
26
|
+

|
|
27
|
+
|
|
28
|
+
### (3) Create CNAME records
|
|
29
|
+
|
|
30
|
+
You will be prompted to add a CNAME record to your DNS provider. If your DNS provider is Cloudflare, ensure the CNAME record is configured as DNS-only and is not proxied. To manage custom domains, WorkOS uses Cloudflare, who prohibit domains from being proxied across accounts.
|
|
31
|
+
|
|
32
|
+

|
|
33
|
+
|
|
34
|
+
> It can take some time for DNS changes to take effect. If the initial verification attempt is not successful, WorkOS will continue trying to verify your domain for 72 hours.
|
|
35
|
+
|
|
36
|
+
Once your domain is successfully verified, users signing in via AuthKit will be redirected to your custom domain.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Email Domain
|
|
3
|
+
description: Guidance on configuring a custom domain for emails.
|
|
4
|
+
showNextPage: true
|
|
5
|
+
originalPath: .tmp-workos-clone/packages/docs/content/custom-domains/email.mdx
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Configuring a domain
|
|
9
|
+
|
|
10
|
+
Several User Management features require sending emails:
|
|
11
|
+
|
|
12
|
+
- Magic Auth
|
|
13
|
+
- Email verification
|
|
14
|
+
- Password resets
|
|
15
|
+
- Invitations
|
|
16
|
+
|
|
17
|
+
While developing with WorkOS in a staging environment, WorkOS will send User Management emails from `workos.dev`.
|
|
18
|
+
|
|
19
|
+
In production environments, emails are sent from a custom domain when configured or from `workos-mail.com` by default.
|
|
20
|
+
|
|
21
|
+
### (1) Navigate to Domains configuration
|
|
22
|
+
|
|
23
|
+
With the production environment selected, navigate to the _Domains_ section of the [WorkOS Dashboard](https://dashboard.workos.com/).
|
|
24
|
+
|
|
25
|
+

|
|
26
|
+
|
|
27
|
+
### (2) Add an email domain
|
|
28
|
+
|
|
29
|
+
Click the _Add Domain_ button and enter the domain you would like to use for sending emails.
|
|
30
|
+
|
|
31
|
+

|
|
32
|
+
|
|
33
|
+
### (3) Create CNAME records
|
|
34
|
+
|
|
35
|
+
You will be prompted to create 3 CNAME records with your DNS provider. After creating these DNS records, click _Verify now_.
|
|
36
|
+
|
|
37
|
+

|
|
38
|
+
|
|
39
|
+
> It can take some time for DNS changes to take effect. If the initial verification attempt is not successful, WorkOS will continue trying to verify your domain for 72 hours.
|
|
40
|
+
|
|
41
|
+
Once your domain is successfully verified, authentication emails and Admin Portal invites will be sent from `no-reply@your-domain.com`. It’s important to keep the CNAME records in place to ensure that WorkOS can deliver mail on your behalf.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Custom Domains
|
|
3
|
+
description: Configure your integration to match your brand identity.
|
|
4
|
+
showNextPage: true
|
|
5
|
+
originalPath: .tmp-workos-clone/packages/docs/content/custom-domains/index.mdx
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## Overview
|
|
9
|
+
|
|
10
|
+
By default, a WorkOS domain will be used for services such as sending email and hosting AuthKit. In the staging environment these will always use a WorkOS domain, however in production you have the option to provide your own custom domain.
|
|
11
|
+
|
|
12
|
+
This is a paid service, for which you can find additional details on our [pricing page](https://workos.com/pricing).
|
|
13
|
+
|
|
14
|
+
Custom domains can be set for:
|
|
15
|
+
|
|
16
|
+
- [Email](/custom-domains/email)
|
|
17
|
+
- [AuthKit](/custom-domains/authkit)
|
|
18
|
+
- [Admin Portal](/custom-domains/admin-portal)
|
|
19
|
+
- [Authentication API](/custom-domains/auth-api)
|
|
@@ -0,0 +1,244 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Dashboard
|
|
3
|
+
description: "Set up your account on the\_WorkOS\_Dashboard."
|
|
4
|
+
breadcrumb:
|
|
5
|
+
title: Home
|
|
6
|
+
url: /
|
|
7
|
+
originalPath: .tmp-workos-clone/packages/docs/content/dashboard.mdx
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
## Manage your team
|
|
11
|
+
|
|
12
|
+
You can manage your team from your [team settings](https://dashboard.workos.com/settings/team).
|
|
13
|
+
|
|
14
|
+

|
|
15
|
+
|
|
16
|
+
### Change your team name
|
|
17
|
+
|
|
18
|
+
To edit your team name select the “Edit” button under team details.
|
|
19
|
+
|
|
20
|
+
### Change your team's support email address
|
|
21
|
+
|
|
22
|
+
To edit your team's support email address for Admin Portal emails sent to your customers, select the “Edit” button under team details.
|
|
23
|
+
|
|
24
|
+
### Invite team members
|
|
25
|
+
|
|
26
|
+
To invite members, select the “Invite team member” button under team members. When adding a member, you’ll be prompted to select a role for this new member. The following roles are available:
|
|
27
|
+
|
|
28
|
+
- **Admin** – Admins are able to invite members, change roles of existing members, and revoke access, in addition to capabilities available to a Developer.
|
|
29
|
+
- **Developer** – Developers are able to view and edit configuration for the Environment, including resources like API keys, Redirect URI’s, or OAuth credentials. In addition, they have all of the capabilities available to a Support user.
|
|
30
|
+
- **Support** – Support users are able to view and edit customer-level resources like Organizations, Connections, and Directories. Support users are not able to view or edit Environment-level settings, like API keys or OAuth credentials.
|
|
31
|
+
|
|
32
|
+

|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## Manage your billing
|
|
37
|
+
|
|
38
|
+
You can manage billing from your [account settings page](https://dashboard.workos.com/settings/billing). Select the “Workspace” left menu option from the main dashboard, and then select the “Billing” tab.
|
|
39
|
+
|
|
40
|
+
If you don’t have billing set up, you can input your billing address and credit card information. This also unlocks access to your Production environment in the dashboard. If you have billing set up, you’ll be able to update your billing address and credit card information.
|
|
41
|
+
|
|
42
|
+

|
|
43
|
+
|
|
44
|
+
---
|
|
45
|
+
|
|
46
|
+
## Manage your user account
|
|
47
|
+
|
|
48
|
+
You can manage your user account from the [profile page](https://dashboard.workos.com/profile). Select the dropdown menu under your name in the top right corner, and then select the “User Settings” menu option.
|
|
49
|
+
|
|
50
|
+

|
|
51
|
+
|
|
52
|
+
On the Profile page, you can update your email notification settings. At this time, it’s not possible to update your user information. [Reach out to us](mailto:support@workos.com) if you need this information updated.
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## Set up a support email address
|
|
57
|
+
|
|
58
|
+
Add a support email in the Dashboard to streamline communication with your customers’ organization admins. This email will be included in the footer of messages sent to them and set as the reply-to address, making it easy for admins to reach out with any questions. Learn how to update the support email in [team settings](/dashboard/manage-your-team).
|
|
59
|
+
|
|
60
|
+

|
|
61
|
+
|
|
62
|
+
---
|
|
63
|
+
|
|
64
|
+
## Add the Organization admin email address
|
|
65
|
+
|
|
66
|
+
You can add the email addresses of your organization’s IT administrators directly to an organization. This enables you to send Admin Portal setup links directly to an organization's admin. Additionally, WorkOS will automatically email admins about important organization-related events that require their attention.
|
|
67
|
+
|
|
68
|
+
The organization admin email addresses can be set on the Settings page of each organization.
|
|
69
|
+
|
|
70
|
+

|
|
71
|
+
|
|
72
|
+
## Automated emails for Organization admins
|
|
73
|
+
|
|
74
|
+
Once added to an organization, the organization admin can receive the following types of automated emails:
|
|
75
|
+
|
|
76
|
+
- **X509 certificate expiration**: Sent when the X509 certificate for a SAML connection is about to expire or has already expired.
|
|
77
|
+
- **SSO connection misconfiguration**: Sent when a SAML connection is misconfigured in the Identity Provider.
|
|
78
|
+
- **Admin Portal setup**: Sent when an admin is invited to set up various products in the Admin Portal, such as SSO, Directory Sync, and more.
|
|
79
|
+
|
|
80
|
+
## Change the theme
|
|
81
|
+
|
|
82
|
+
You can change the dashboard theme from the dropdown menu under your name in the top right corner.
|
|
83
|
+
|
|
84
|
+

|
|
85
|
+
|
|
86
|
+
---
|
|
87
|
+
|
|
88
|
+
## Client ID
|
|
89
|
+
|
|
90
|
+
Navigate to the Configuration page on your WorkOS Dashboard to see your [Client ID](/glossary/client-id). This is needed in many API calls, including the [Get Authorization URL endpoint](/reference/sso/get-authorization-url). The Client ID is specific to the environment in the WorkOS dashboard.
|
|
91
|
+
|
|
92
|
+

|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
## Redirect URIs
|
|
97
|
+
|
|
98
|
+
Set your allowed Redirect URIs on the Configuration page. The Redirect URI is the callback route where you’ll receive a `code` if a user successfully authenticates. You can then exchange this code for a user profile via the [Get Profile and Token API endpoint](/reference/sso/profile/get-profile-and-token).
|
|
99
|
+
|
|
100
|
+

|
|
101
|
+
|
|
102
|
+
Check out our [Redirect URI tutorial](/sso/redirect-uris) for information on Redirect URI best practices.
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## Configure global OAuth providers
|
|
107
|
+
|
|
108
|
+
You can configure global settings for Google OAuth and Microsoft OAuth on the Configuration page. These providers allow anyone that can log in to Google or Microsoft to authenticate to your application. Our provider documentation on [Google OAuth](/integrations/google-oauth), [Microsoft OAuth](/integrations/microsoft-oauth), [GitHub OAuth](/integrations/github-oauth), and [Sign in with Apple](/integrations/apple) can help you set up these authentication methods.
|
|
109
|
+
|
|
110
|
+

|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## Configure the Admin Portal
|
|
115
|
+
|
|
116
|
+
You can set the Admin Portal Redirect Link on the Configuration page. This is where users will be directed after setting up a connection in the Admin Portal. We also offer custom labeling of the Admin Portal. [Reach out to us](mailto:support@workos.com) to learn more.
|
|
117
|
+
|
|
118
|
+

|
|
119
|
+
|
|
120
|
+
---
|
|
121
|
+
|
|
122
|
+
## Set up custom attributes
|
|
123
|
+
|
|
124
|
+
On the “Custom Attributes” tab of the Configuration page, you can define custom standardized attributes for your Directory Sync connections. By default, fields like `first_name` and `email` are standardized in Directory Sync. However, you may want to standardize other fields, such as manager. On the Configuration page, you can set the custom attributes you’d like to standardize.
|
|
125
|
+
|
|
126
|
+

|
|
127
|
+
|
|
128
|
+
When custom attributes are configured, you can map them to a specific attribute for a given directory sync connection.
|
|
129
|
+
|
|
130
|
+

|
|
131
|
+
|
|
132
|
+
The attribute mapped needs to be found in the raw data from the directory, and once mapped to a custom attribute, you’ll see it in the `custom_attributes` for a [Directory User](/reference/directory-sync/directory-user). Check out our [blog post on custom attributes](https://workos.com/blog/custom-attributes) for more information.
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
## SAML Sessions
|
|
137
|
+
|
|
138
|
+
To assist users in debugging their SAML SSO connections, there is a “Sessions” tab in the Connection Details view for all SAML SSO connections.
|
|
139
|
+
|
|
140
|
+
Here you can see logs for SAML sessions from these connections which enables you to quickly understand the status and health of each connection. You can see the details of each session, its status, if there are any errors, and what those errors are.
|
|
141
|
+
|
|
142
|
+
The Sessions tab is available on the Connection Overview page of each SAML based connection.
|
|
143
|
+
|
|
144
|
+

|
|
145
|
+
|
|
146
|
+
### Sessions Tab
|
|
147
|
+
|
|
148
|
+
When you navigate to the Sessions tab, you are presented with a list of recent user sessions for the given connection in chronological order from newest to oldest. Some basic information is available here, including the state, error message, user, truncated session ID, and when the session was created.
|
|
149
|
+
|
|
150
|
+

|
|
151
|
+
|
|
152
|
+
### Session Details
|
|
153
|
+
|
|
154
|
+
To find more detail for each session, click on the individual session entry. This will navigate you to the Session Details page where you can find the full Session ID along with other more in depth information about the user authenticating via the session.
|
|
155
|
+
|
|
156
|
+

|
|
157
|
+
|
|
158
|
+
One of the most useful aspects of this tool is that it exposes the error messages when a session is not successful. When there are errors, you are presented with the details of the error for review.
|
|
159
|
+
|
|
160
|
+

|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
## SAML Errors
|
|
165
|
+
|
|
166
|
+
There are 5 different errors that can be returned: “Invalid Attributes”, “Invalid X509 Certificate”, “Malformed SAML Response”, “Profile Not Allowed Outside Organization”, and “Decryption Failed”.
|
|
167
|
+
|
|
168
|
+
### Invalid Attributes
|
|
169
|
+
|
|
170
|
+
WorkOS requires that there are certain user attributes included in each SAML Response at minimum. In most cases `firstName`, `lastName`, `email`, and `id` are required. If these attributes are not present in the SAML Response, the Invalid Attributes error is thrown. The received attributes will appear in the error details so you can see what attributes may be missing.
|
|
171
|
+
|
|
172
|
+
### Invalid X.509 Certificate
|
|
173
|
+
|
|
174
|
+
This error occurs when the X.509 Certificate provided by the Identity Provider in the SAML Response does not match the X.509 Certificate that has been uploaded to WorkOS for the connection. If you receive this error, you’ll want to double check that the certificates match between the IdP and WorkOS for this connection and that the certificate is not expired.
|
|
175
|
+
|
|
176
|
+
You can view the X.509 certificate that is being sent by the IdP in the SAML Response Body which is provided below, within the `<X509Certificate>` tags. The X.509 certificate that is uploaded to WorkOS can be found in the Connection’s settings page. These two values should match exactly.
|
|
177
|
+
|
|
178
|
+

|
|
179
|
+
|
|
180
|
+
### Malformed SAML Response
|
|
181
|
+
|
|
182
|
+
This error means that there is an issue with the SAML Response structure or contents and the SAML Response is unable to be validated. There are many factors that could lead to this error, however, there will need to be steps taken on the IdP side in order to resolve it. If you receive this error, please contact [support@workos.com](mailto:support@workos.com) for help.
|
|
183
|
+
|
|
184
|
+
### Profile Not Allowed Outside Organization
|
|
185
|
+
|
|
186
|
+
This error occurs when a user with an email domain that does not appear on the Organization’s User Email Domains allowlist attempts to authenticate with the connection.
|
|
187
|
+
|
|
188
|
+
To resolve this error there are 2 options. The user’s domain can be added to the Organization’s allowlist, or if you do not wish to restrict the Organization to specific domains, you can select the option to allow users with any domain to authenticate with the Organization. Both of these options can be configured on the Organization Overview page.
|
|
189
|
+
|
|
190
|
+

|
|
191
|
+
|
|
192
|
+
### Decryption Failed
|
|
193
|
+
|
|
194
|
+
This error can occur if you are encrypting the SAML Response and WorkOS is unable to successfully decrypt the response. This most often occurs when there is an X.509 certificate used to encrypt the response has a mismatch between the Identity Provider and WorkOS. A good first step towards resolution in this case is to ensure that the certificates in the IdP and WorkOS match.
|
|
195
|
+
|
|
196
|
+
---
|
|
197
|
+
|
|
198
|
+
## SAML Request & SAML Response
|
|
199
|
+
|
|
200
|
+
The Session Detail page also shows the raw SAML Request and SAML Response.
|
|
201
|
+
|
|
202
|
+
### SAML Request
|
|
203
|
+
|
|
204
|
+
The SAML Request is the XML request that is sent to the Identity Provider from a Service Provider (SP), WorkOS in this case, to initiate the login attempt. This will only appear for SP-Initiated login attempts.
|
|
205
|
+
|
|
206
|
+

|
|
207
|
+
|
|
208
|
+
### SAML Response
|
|
209
|
+
|
|
210
|
+
The SAML Response is what is returned to WorkOS from the Identity Provider after a user has authenticated with the IdP. It will contain the user attributes that get processed into the user Profile object.
|
|
211
|
+
|
|
212
|
+

|
|
213
|
+
|
|
214
|
+
## SAML Session States
|
|
215
|
+
|
|
216
|
+
### Started
|
|
217
|
+
|
|
218
|
+
Indicates a user began the authentication process, and a SAML request was sent to the IdP, however, we have yet to receive a SAML response.
|
|
219
|
+
|
|
220
|
+
### Authorized
|
|
221
|
+
|
|
222
|
+
Indicates the user successfully authenticated through the IdP and we returned an auth code to the callback route, but it hasn't exchanged the auth code for a profile.
|
|
223
|
+
|
|
224
|
+
### Successful
|
|
225
|
+
|
|
226
|
+
Indicates a successful login where WorkOS was able to exchange the callback auth code for a profile.
|
|
227
|
+
|
|
228
|
+
### Failed
|
|
229
|
+
|
|
230
|
+
Indicates that there was a successful SAML Request and a Response was provided from the IdP, however, WorkOS was not able to generate a profile from the data in the SAML response.
|
|
231
|
+
|
|
232
|
+
---
|
|
233
|
+
|
|
234
|
+
## Compliance Documents
|
|
235
|
+
|
|
236
|
+
You can download the following documents from the [Compliance Documents page](https://dashboard.workos.com/settings/compliance-documents):
|
|
237
|
+
|
|
238
|
+
- **SIG Lite**
|
|
239
|
+
- **SOC 3**
|
|
240
|
+
- **SOC 2 Type 2**
|
|
241
|
+
|
|
242
|
+
> Only users with the Workspace Admin role are able to download documents from the Compliance Documents page.
|
|
243
|
+
|
|
244
|
+

|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Docs
|
|
3
|
+
links:
|
|
4
|
+
- title: Demo
|
|
5
|
+
url: /demo
|
|
6
|
+
- title: Accordion
|
|
7
|
+
url: /demo/accordion
|
|
8
|
+
- title: Checklist
|
|
9
|
+
url: /demo/checklist
|
|
10
|
+
- title: Code Block
|
|
11
|
+
url: /demo/code-block
|
|
12
|
+
- title: Definition List
|
|
13
|
+
url: /demo/definition-list
|
|
14
|
+
- title: Punctuation
|
|
15
|
+
url: /demo/punctuation
|
|
16
|
+
- title: Replacements
|
|
17
|
+
url: /demo/replacements
|
|
18
|
+
- title: Share Images
|
|
19
|
+
url: /demo/share-images
|
|
20
|
+
- title: Table
|
|
21
|
+
url: /demo/table
|
|
22
|
+
- title: Tabs
|
|
23
|
+
url: /demo/tabs
|
|
24
|
+
originalPath: .tmp-workos-clone/packages/docs/content/demo/_navigation.mdx
|
|
25
|
+
---
|
|
26
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Accordion
|
|
3
|
+
description: Test page for the accordion component
|
|
4
|
+
originalPath: .tmp-workos-clone/packages/docs/content/demo/accordion.mdx
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Accordion syntax stress test
|
|
8
|
+
|
|
9
|
+
Adjacent lists shouldn’t be mangled.
|
|
10
|
+
|
|
11
|
+
- ### One?
|
|
12
|
+
Two.
|
|
13
|
+
- ### Three?
|
|
14
|
+
Four.
|
|
15
|
+
- ### Five?
|
|
16
|
+
Six.
|
|
17
|
+
- ### Seven?
|
|
18
|
+
Eight.
|
|
19
|
+
- Nine
|
|
20
|
+
- Ten
|
|
21
|
+
- Eleven
|
|
22
|
+
- Twelve
|
|
23
|
+
- ### `dsync.deactivated` <Small>A Directory Sync connection is activated.</Small>
|
|
24
|
+
Accordion content goes here.
|
|
25
|
+
- ### `dsync.activated` <Small>A Directory Sync connection is activated.</Small>
|
|
26
|
+
Accordion content goes here.
|
|
27
|
+
- ### `dsync.deactivated` <Small>A Directory Sync connection is deactivated.</Small>
|
|
28
|
+
Accordion content goes here.
|
|
29
|
+
- ### `dsync.deleted` <Small>A Directory Sync connection is deleted.</Small>
|
|
30
|
+
Accordion content goes here.
|
|
31
|
+
- One
|
|
32
|
+
- Two
|
|
33
|
+
- Four
|
|
34
|
+
- Three
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Checklist
|
|
3
|
+
description: Test page for the checklist component
|
|
4
|
+
originalPath: .tmp-workos-clone/packages/docs/content/demo/checklist.mdx
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Checklist syntax stress test
|
|
8
|
+
|
|
9
|
+
Adjacent lists shouldn’t be mangled.
|
|
10
|
+
|
|
11
|
+
- [ ] One two.
|
|
12
|
+
- [x] Three four.
|
|
13
|
+
- [ ] Five six.
|
|
14
|
+
- [ ] Seven eight.
|
|
15
|
+
- Nine
|
|
16
|
+
- Ten
|
|
17
|
+
- Eleven
|
|
18
|
+
- Twelve
|
|
19
|
+
|
|
20
|
+
- [ ] Implement an SSO UI/UX. See our guide for ideas – [UI/UX Best Practices for IdP & SP-Initiated SSO](/)
|
|
21
|
+
- [ ] Unlock your Production environment by adding your billing information
|
|
22
|
+
> Only enterprise connections in your Production environment will be charged. Any Google OAuth, Microsoft OAuth, GitHub OAuth, Sign in with Apple, or Magic Link connections will be free.
|
|
23
|
+
- [ ] Set your Production Client’s ID and API Key as environment variables
|
|
24
|
+
- [ ] Secure your Production Project’s API key
|
|
25
|
+
- [ ] Configure production redirect URI(s) in your Product Project. Verify the default redirect URI is correct
|
|
26
|
+
- [ ] Ensure that your application can receive redirects from WorkOS.
|
|
27
|
+
Depending on your network architecture, you may need to allowlist incoming redirect traffic from `api.workos.com` → WorkOS currently cannot promise that redirect traffic will originate from a static set of IP addresses.
|
|
28
|
+
- [ ] Add Connections for your customers in the Production Environment
|
|
29
|
+
|
|
30
|
+
- one
|
|
31
|
+
- two
|
|
32
|
+
- three
|
|
33
|
+
- four
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Code Block
|
|
3
|
+
description: Test page for the code block component
|
|
4
|
+
originalPath: .tmp-workos-clone/packages/docs/content/demo/code-block.mdx
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## From file
|
|
8
|
+
|
|
9
|
+
<CodeBlock file="install-sdk" title="Install SDK" />
|
|
10
|
+
<CodeBlock file="auth-endpoint" title="Add authentication endpoint" />
|
|
11
|
+
<CodeBlock file="directory-user-example" />
|
|
12
|
+
|
|
13
|
+
## From markdown
|
|
14
|
+
|
|
15
|
+
```js language="js" title="Example Code"
|
|
16
|
+
const express = require('express');
|
|
17
|
+
const { WorkOS } = require('@workos-inc/node');
|
|
18
|
+
|
|
19
|
+
const app = express();
|
|
20
|
+
|
|
21
|
+
const workos = new WorkOS(process.env.WORKOS_API_KEY);
|
|
22
|
+
const clientId = process.env.WORKOS_CLIENT_ID;
|
|
23
|
+
|
|
24
|
+
app.get('/callback', async (req, res) => {
|
|
25
|
+
const { code } = req.query;
|
|
26
|
+
|
|
27
|
+
const { profile } = await workos.sso.getProfileAndToken({
|
|
28
|
+
code,
|
|
29
|
+
clientId,
|
|
30
|
+
});
|
|
31
|
+
|
|
32
|
+
// Use the information in `profile` for further business logic.
|
|
33
|
+
|
|
34
|
+
res.redirect('/');
|
|
35
|
+
});
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## From JSX and markdown
|
|
39
|
+
|
|
40
|
+
<CodeBlock title="Test Code Block">
|
|
41
|
+
|
|
42
|
+
```js language="js" title="Console JS"
|
|
43
|
+
console.warn('This is a warning!');
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
```xml language="java"
|
|
47
|
+
<dependency>
|
|
48
|
+
<groupId>com.workos</groupId>
|
|
49
|
+
<artifactId>workos</artifactId>
|
|
50
|
+
<version>{version}</version>
|
|
51
|
+
</dependency>
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
```jsx
|
|
55
|
+
<Box>
|
|
56
|
+
{/* highlight-start */}
|
|
57
|
+
Hello world
|
|
58
|
+
{/* highlight-end */}
|
|
59
|
+
</Box>
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
</CodeBlock>
|
|
63
|
+
|
|
64
|
+
## Without title
|
|
65
|
+
|
|
66
|
+
```js
|
|
67
|
+
console.log();
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Empty code block
|
|
71
|
+
|
|
72
|
+
```plain
|
|
73
|
+
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## With tabs across all languages
|
|
77
|
+
|
|
78
|
+
Input:
|
|
79
|
+
|
|
80
|
+
```html
|
|
81
|
+
<CodeBlock>
|
|
82
|
+
<CodeBlockTab file="get-organization-request" title="Request" />
|
|
83
|
+
<CodeBlockTab file="get-organization-response" title="Response" />
|
|
84
|
+
</CodeBlock>
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Output:
|
|
88
|
+
|
|
89
|
+
<CodeBlock>
|
|
90
|
+
|
|
91
|
+
```js language="js" title="Request" tab="1"
|
|
92
|
+
import { WorkOS } from '@workos-inc/node';
|
|
93
|
+
|
|
94
|
+
const workos = new WorkOS('sk_example_123456789');
|
|
95
|
+
|
|
96
|
+
const organization = await workos.organizations.getOrganization(
|
|
97
|
+
'org_01EHZNVPK3SFK441A1RGBFSHRT',
|
|
98
|
+
);
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
```java language="java" title="Request" tab="1"
|
|
102
|
+
import com.workos.WorkOS;
|
|
103
|
+
|
|
104
|
+
WorkOS workos = new WorkOS("sk_example_123456789");
|
|
105
|
+
|
|
106
|
+
Organization org = workos.organizations.getOrganization("org_01EHZNVPK3SFK441A1RGBFSHRT");
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
```go language="go" title="Request" tab="1"
|
|
110
|
+
import "github.com/workos/workos-go/v3/pkg/organizations"
|
|
111
|
+
|
|
112
|
+
organizations.SetAPIKey("sk_example_123456789")
|
|
113
|
+
|
|
114
|
+
org, err := organizations.GetOrganization(
|
|
115
|
+
context.Background(),
|
|
116
|
+
organizations.GetOrganizationOpts {
|
|
117
|
+
Organization: "org_01EHZNVPK3SFK441A1RGBFSHRT"
|
|
118
|
+
}
|
|
119
|
+
)
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
```json language="json" title="Response" tab="2"
|
|
123
|
+
{
|
|
124
|
+
"id": "org_01EHZNVPK3SFK441A1RGBFSHRT",
|
|
125
|
+
"object": "organization",
|
|
126
|
+
"name": "Foo Corp",
|
|
127
|
+
"allow_profiles_outside_organization": false,
|
|
128
|
+
"created_at": "2021-06-25T19:07:33.155Z",
|
|
129
|
+
"updated_at": "2021-06-25T19:07:33.155Z",
|
|
130
|
+
"domains": [
|
|
131
|
+
{
|
|
132
|
+
"id": "org_domain_01EHZNVPK2QXHMVWCEDQEKY69A",
|
|
133
|
+
"object": "organization_domain",
|
|
134
|
+
"domain": "foo-corp.com"
|
|
135
|
+
}
|
|
136
|
+
]
|
|
137
|
+
}
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
</CodeBlock>
|
|
141
|
+
|
|
142
|
+
## One language with tabs
|
|
143
|
+
|
|
144
|
+
Only Java should have tabs here.
|
|
145
|
+
|
|
146
|
+
Input:
|
|
147
|
+
|
|
148
|
+
```html
|
|
149
|
+
<CodeBlock file="install-sdk">
|
|
150
|
+
<CodeBlockTab language="java" file="install-sdk-maven" title="Maven" />
|
|
151
|
+
<CodeBlockTab language="java" file="install-sdk-gradle" title="Gradle" />
|
|
152
|
+
</CodeBlock>
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
Output:
|
|
156
|
+
|
|
157
|
+
<CodeBlock>
|
|
158
|
+
|
|
159
|
+
```bash language="js" title="Install the WorkOS SDK"
|
|
160
|
+
npm install workos-node
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
```bash language="dotnet" title="Install the WorkOS SDK"
|
|
164
|
+
nuget install WorkOS.net
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
```bash language="go" title="Install the WorkOS SDK"
|
|
168
|
+
go get -u github.com/workos/workos-go/...
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
```xml language="java" title="Maven" tab="java-1"
|
|
172
|
+
<dependency>
|
|
173
|
+
<groupId>com.workos</groupId>
|
|
174
|
+
<artifactId>workos</artifactId>
|
|
175
|
+
<version>VERSION</version>
|
|
176
|
+
</dependency>
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
```json language="java" title="Gradle" tab="java-2"
|
|
180
|
+
dependencies {
|
|
181
|
+
implementation 'com.workos:workos:VERSION'
|
|
182
|
+
}
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
</CodeBlock>
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Definition List
|
|
3
|
+
description: Demo example of a definition list.
|
|
4
|
+
originalPath: .tmp-workos-clone/packages/docs/content/demo/definition-list.mdx
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
Not a definition item.
|
|
8
|
+
|
|
9
|
+
Term 1
|
|
10
|
+
: Definition 1
|
|
11
|
+
|
|
12
|
+
Not a definition item.
|
|
13
|
+
|
|
14
|
+
Term 2
|
|
15
|
+
: Definition 2
|
|
16
|
+
|
|
17
|
+
**Term 3**
|
|
18
|
+
: _Definition_ 3
|
|
19
|
+
|
|
20
|
+
**Term 4**
|
|
21
|
+
: Definition 4
|
|
22
|
+
|
|
23
|
+
Term 5
|
|
24
|
+
: `Definition 5`
|
|
25
|
+
|
|
26
|
+
Term 6
|
|
27
|
+
: Definition `6`
|
|
28
|
+
|
|
29
|
+
Term `7`
|
|
30
|
+
: Definition 7
|
|
31
|
+
|
|
32
|
+
: Not a definition item.
|
|
33
|
+
|
|
34
|
+
Not a term
|
|
35
|
+
:
|