@workos/mcp-docs-server 0.1.0 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.docs/organized/changelogs/workos-platform.json +125 -125
- package/.docs/organized/docs/admin-portal/custom-branding.mdx +2 -4
- package/.docs/organized/docs/admin-portal/example-apps.mdx +11 -11
- package/.docs/organized/docs/admin-portal/index.mdx +39 -33
- package/.docs/organized/docs/audit-logs/admin-portal.mdx +1 -1
- package/.docs/organized/docs/audit-logs/editing-events.mdx +1 -1
- package/.docs/organized/docs/audit-logs/exporting-events.mdx +1 -1
- package/.docs/organized/docs/audit-logs/index.mdx +17 -2
- package/.docs/organized/docs/audit-logs/log-streams.mdx +325 -1
- package/.docs/organized/docs/audit-logs/metadata-schema.mdx +1 -1
- package/.docs/organized/docs/authkit/_navigation.mdx +108 -0
- package/.docs/organized/docs/{user-management → authkit}/actions.mdx +3 -4
- package/.docs/organized/docs/authkit/add-ons/google-analytics.mdx +79 -0
- package/.docs/organized/docs/authkit/add-ons/segment.mdx +77 -0
- package/.docs/organized/docs/authkit/add-ons/stripe.mdx +103 -0
- package/.docs/organized/docs/authkit/api-keys.mdx +99 -0
- package/.docs/organized/docs/{user-management → authkit}/branding.mdx +220 -2
- package/.docs/organized/docs/authkit/cli-auth.mdx +76 -0
- package/.docs/organized/docs/authkit/cli-installer.mdx +157 -0
- package/.docs/organized/docs/authkit/connect/m2m.mdx +65 -0
- package/.docs/organized/docs/authkit/connect/oauth.mdx +88 -0
- package/.docs/organized/docs/authkit/connect/standalone.mdx +179 -0
- package/.docs/organized/docs/authkit/connect.mdx +65 -0
- package/.docs/organized/docs/authkit/custom-email-providers.mdx +141 -0
- package/.docs/organized/docs/{user-management → authkit}/custom-emails.mdx +15 -15
- package/.docs/organized/docs/authkit/directory-provisioning.mdx +89 -0
- package/.docs/organized/docs/{user-management → authkit}/domain-verification.mdx +5 -6
- package/.docs/organized/docs/{user-management → authkit}/email-password.mdx +2 -2
- package/.docs/organized/docs/authkit/email-verification.mdx +31 -0
- package/.docs/organized/docs/{user-management → authkit}/example-apps.mdx +3 -3
- package/.docs/organized/docs/authkit/hosted-ui.mdx +165 -0
- package/.docs/organized/docs/{user-management → authkit}/identity-linking.mdx +9 -9
- package/.docs/organized/docs/{user-management → authkit}/impersonation.mdx +8 -8
- package/.docs/organized/docs/{user-management → authkit}/index.mdx +141 -74
- package/.docs/organized/docs/{user-management → authkit}/invitations.mdx +4 -4
- package/.docs/organized/docs/{user-management → authkit}/invite-only-signup.mdx +3 -3
- package/.docs/organized/docs/authkit/jit-provisioning.mdx +42 -0
- package/.docs/organized/docs/{user-management → authkit}/jwt-templates.mdx +37 -3
- package/.docs/organized/docs/authkit/landing.mdx +22 -0
- package/.docs/organized/docs/{user-management → authkit}/magic-auth.mdx +3 -5
- package/.docs/organized/docs/{user-management → authkit}/mcp.mdx +46 -9
- package/.docs/organized/docs/{user-management → authkit}/metadata.mdx +9 -9
- package/.docs/organized/docs/{user-management → authkit}/mfa.mdx +2 -2
- package/.docs/organized/docs/{user-management → authkit}/migrations.mdx +4 -4
- package/.docs/organized/docs/{user-management → authkit}/modeling-your-app.mdx +11 -11
- package/.docs/organized/docs/{user-management → authkit}/organization-policies.mdx +3 -4
- package/.docs/organized/docs/authkit/overview.mdx +46 -0
- package/.docs/organized/docs/{user-management → authkit}/passkeys.mdx +3 -3
- package/.docs/organized/docs/authkit/pipes.mdx +75 -0
- package/.docs/organized/docs/{user-management → authkit}/radar.mdx +39 -4
- package/.docs/organized/docs/authkit/roles-and-permissions.mdx +208 -0
- package/.docs/organized/docs/{user-management → authkit}/sessions.mdx +32 -20
- package/.docs/organized/docs/{user-management → authkit}/social-login.mdx +16 -2
- package/.docs/organized/docs/{user-management → authkit}/sso-with-contractors.mdx +3 -4
- package/.docs/organized/docs/{user-management → authkit}/sso.mdx +2 -2
- package/.docs/organized/docs/authkit/users-organizations.mdx +107 -0
- package/.docs/organized/docs/custom-domains/admin-portal.mdx +0 -2
- package/.docs/organized/docs/custom-domains/authkit.mdx +0 -2
- package/.docs/organized/docs/custom-domains/email.mdx +2 -2
- package/.docs/organized/docs/deprecations/_navigation.mdx +8 -0
- package/.docs/organized/docs/deprecations/raw-attributes.mdx +136 -0
- package/.docs/organized/docs/directory-sync/attributes.mdx +50 -31
- package/.docs/organized/docs/directory-sync/example-apps.mdx +11 -11
- package/.docs/organized/docs/directory-sync/identity-provider-role-assignment.mdx +23 -26
- package/.docs/organized/docs/directory-sync/index.mdx +4 -2
- package/.docs/organized/docs/directory-sync/quick-start.mdx +3 -3
- package/.docs/organized/docs/directory-sync/understanding-events.mdx +2 -2
- package/.docs/organized/docs/domain-verification/api.mdx +8 -8
- package/.docs/organized/docs/domain-verification/index.mdx +3 -3
- package/.docs/organized/docs/email.mdx +49 -5
- package/.docs/organized/docs/events/data-syncing/events-api.mdx +3 -3
- package/.docs/organized/docs/events/data-syncing/index.mdx +2 -3
- package/.docs/organized/docs/events/data-syncing/webhooks.mdx +4 -4
- package/.docs/organized/docs/events/index.mdx +419 -33
- package/.docs/organized/docs/feature-flags/_navigation.mdx +10 -0
- package/.docs/organized/docs/feature-flags/index.mdx +80 -0
- package/.docs/organized/docs/feature-flags/slack-notifications.mdx +58 -0
- package/.docs/organized/docs/fga/_navigation.mdx +34 -54
- package/.docs/organized/docs/fga/access-checks.mdx +109 -0
- package/.docs/organized/docs/fga/assignments.mdx +124 -0
- package/.docs/organized/docs/fga/authkit-integration.mdx +92 -0
- package/.docs/organized/docs/fga/high-cardinality-entities.mdx +172 -0
- package/.docs/organized/docs/fga/idp-role-assignment.mdx +66 -0
- package/.docs/organized/docs/fga/index.mdx +94 -29
- package/.docs/organized/docs/fga/migration-openfga.mdx +306 -0
- package/.docs/organized/docs/fga/migration-oso.mdx +372 -0
- package/.docs/organized/docs/fga/migration-spicedb.mdx +364 -0
- package/.docs/organized/docs/fga/quick-start.mdx +283 -98
- package/.docs/organized/docs/fga/resource-discovery.mdx +78 -0
- package/.docs/organized/docs/fga/resource-types.mdx +165 -0
- package/.docs/organized/docs/fga/resources.mdx +179 -59
- package/.docs/organized/docs/fga/roles-and-permissions.mdx +122 -0
- package/.docs/organized/docs/fga/standalone-integration.mdx +176 -0
- package/.docs/organized/docs/glossary.mdx +7 -3
- package/.docs/organized/docs/integrations/access-people-hr.mdx +1 -1
- package/.docs/organized/docs/integrations/adp-oidc.mdx +1 -1
- package/.docs/organized/docs/integrations/apple.mdx +112 -69
- package/.docs/organized/docs/integrations/auth0-directory-sync.mdx +3 -1
- package/.docs/organized/docs/integrations/auth0-enterprise-connection.mdx +3 -1
- package/.docs/organized/docs/integrations/auth0-saml.mdx +3 -1
- package/.docs/organized/docs/integrations/bamboohr.mdx +4 -4
- package/.docs/organized/docs/integrations/breathe-hr.mdx +1 -1
- package/.docs/organized/docs/integrations/bubble.mdx +1 -1
- package/.docs/organized/docs/integrations/cas-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/classlink-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/clever-oidc.mdx +94 -0
- package/.docs/organized/docs/integrations/cloudflare-saml.mdx +35 -2
- package/.docs/organized/docs/integrations/cyberark-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/cyberark-scim.mdx +1 -1
- package/.docs/organized/docs/integrations/duo-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/entra-id-oidc.mdx +198 -0
- package/.docs/organized/docs/integrations/entra-id-saml.mdx +3 -3
- package/.docs/organized/docs/integrations/entra-id-scim.mdx +5 -1
- package/.docs/organized/docs/integrations/fourth.mdx +2 -2
- package/.docs/organized/docs/integrations/github-oauth.mdx +80 -33
- package/.docs/organized/docs/integrations/gitlab-oauth.mdx +86 -31
- package/.docs/organized/docs/integrations/google-directory-sync.mdx +5 -1
- package/.docs/organized/docs/integrations/google-oauth.mdx +87 -70
- package/.docs/organized/docs/integrations/google-oidc.mdx +142 -0
- package/.docs/organized/docs/integrations/google-saml.mdx +3 -3
- package/.docs/organized/docs/integrations/hibob.mdx +17 -4
- package/.docs/organized/docs/integrations/intuit-oauth.mdx +128 -0
- package/.docs/organized/docs/integrations/jumpcloud-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/jumpcloud-scim.mdx +5 -1
- package/.docs/organized/docs/integrations/keycloak-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/lastpass-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/linkedin-oauth.mdx +69 -30
- package/.docs/organized/docs/integrations/microsoft-ad-fs-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/microsoft-oauth.mdx +95 -38
- package/.docs/organized/docs/integrations/miniorange-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/net-iq-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/next-auth.mdx +1 -1
- package/.docs/organized/docs/integrations/oidc.mdx +37 -24
- package/.docs/organized/docs/integrations/okta-oidc.mdx +149 -0
- package/.docs/organized/docs/integrations/okta-saml.mdx +3 -3
- package/.docs/organized/docs/integrations/okta-scim.mdx +6 -2
- package/.docs/organized/docs/integrations/onelogin-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/onelogin-scim.mdx +1 -1
- package/.docs/organized/docs/integrations/oracle-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/pingfederate-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/pingfederate-scim.mdx +1 -1
- package/.docs/organized/docs/integrations/pingone-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/rippling-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/rippling-scim.mdx +1 -1
- package/.docs/organized/docs/integrations/sailpoint-scim.mdx +77 -0
- package/.docs/organized/docs/integrations/salesforce-oauth.mdx +116 -0
- package/.docs/organized/docs/integrations/salesforce-saml.mdx +4 -4
- package/.docs/organized/docs/integrations/saml.mdx +43 -23
- package/.docs/organized/docs/integrations/scim.mdx +36 -24
- package/.docs/organized/docs/integrations/sftp.mdx +59 -36
- package/.docs/organized/docs/integrations/shibboleth-generic-saml.mdx +1 -1
- package/.docs/organized/docs/integrations/shibboleth-unsolicited-saml.mdx +1 -1
- package/.docs/organized/docs/integrations/simple-saml-php.mdx +2 -2
- package/.docs/organized/docs/integrations/slack-oauth.mdx +53 -49
- package/.docs/organized/docs/integrations/supabase-authkit.mdx +46 -0
- package/.docs/organized/docs/integrations/{supabase.mdx → supabase-sso.mdx} +6 -4
- package/.docs/organized/docs/integrations/vercel-oauth.mdx +120 -0
- package/.docs/organized/docs/integrations/vmware-saml.mdx +2 -2
- package/.docs/organized/docs/integrations/workday.mdx +1 -1
- package/.docs/organized/docs/integrations/xero-oauth.mdx +77 -32
- package/.docs/organized/docs/magic-link/example-apps.mdx +11 -11
- package/.docs/organized/docs/magic-link/index.mdx +2 -0
- package/.docs/organized/docs/mfa/example-apps.mdx +2 -2
- package/.docs/organized/docs/mfa/index.mdx +2 -2
- package/.docs/organized/docs/mfa/ux/enrollment.mdx +1 -1
- package/.docs/organized/docs/mfa/ux/sign-in.mdx +1 -1
- package/.docs/organized/docs/migrate/_navigation.mdx +21 -1
- package/.docs/organized/docs/migrate/auth0.mdx +5 -5
- package/.docs/organized/docs/migrate/aws-cognito.mdx +5 -5
- package/.docs/organized/docs/migrate/better-auth.mdx +282 -0
- package/.docs/organized/docs/migrate/clerk.mdx +9 -11
- package/.docs/organized/docs/migrate/descope.mdx +290 -0
- package/.docs/organized/docs/migrate/firebase.mdx +4 -4
- package/.docs/organized/docs/migrate/other-services.mdx +25 -6
- package/.docs/organized/docs/migrate/standalone-sso.mdx +14 -14
- package/.docs/organized/docs/migrate/stytch.mdx +363 -0
- package/.docs/organized/docs/migrate/supabase.mdx +255 -0
- package/.docs/organized/docs/on-prem-deployment.mdx +1 -1
- package/.docs/organized/docs/pipes/_navigation.mdx +12 -0
- package/.docs/organized/docs/pipes/index.mdx +75 -0
- package/.docs/organized/docs/pipes/providers.mdx +9 -0
- package/.docs/organized/docs/rbac/_navigation.mdx +16 -0
- package/.docs/organized/docs/rbac/configuration.mdx +80 -0
- package/.docs/organized/docs/rbac/idp-role-assignment.mdx +79 -0
- package/.docs/organized/docs/rbac/index.mdx +24 -0
- package/.docs/organized/docs/rbac/integration.mdx +59 -0
- package/.docs/organized/docs/rbac/organization-roles.mdx +38 -0
- package/.docs/organized/docs/rbac/quick-start.mdx +52 -0
- package/.docs/organized/docs/reference/_navigation.mdx +437 -284
- package/.docs/organized/docs/reference/admin-portal/portal-link/index.mdx +1 -1
- package/.docs/organized/docs/reference/admin-portal/provider-icons/index.mdx +3 -3
- package/.docs/organized/docs/reference/{api-keys.mdx → api-authentication/index.mdx} +3 -3
- package/.docs/organized/docs/reference/audit-logs/configuration/index.mdx +97 -0
- package/.docs/organized/docs/reference/audit-logs/{create-event.mdx → event/create.mdx} +12 -2
- package/.docs/organized/docs/reference/audit-logs/event/index.mdx +92 -0
- package/.docs/organized/docs/reference/audit-logs/{create-export.mdx → export/create.mdx} +1 -1
- package/.docs/organized/docs/reference/audit-logs/{get-export.mdx → export/get.mdx} +1 -1
- package/.docs/organized/docs/reference/audit-logs/{audit-log-export.mdx → export/index.mdx} +11 -12
- package/.docs/organized/docs/reference/audit-logs/{get-retention.mdx → retention/get.mdx} +1 -1
- package/.docs/organized/docs/reference/audit-logs/retention/index.mdx +25 -0
- package/.docs/organized/docs/reference/audit-logs/{set-retention.mdx → retention/set.mdx} +1 -1
- package/.docs/organized/docs/reference/audit-logs/{create-schema.mdx → schema/create.mdx} +1 -1
- package/.docs/organized/docs/reference/audit-logs/{audit-log-schema.mdx → schema/index.mdx} +5 -6
- package/.docs/organized/docs/reference/audit-logs/{list-actions.mdx → schema/list-actions.mdx} +2 -1
- package/.docs/organized/docs/reference/audit-logs/{list-schemas.mdx → schema/list.mdx} +1 -1
- package/.docs/organized/docs/reference/authkit/api-keys/create-for-organization.mdx +40 -0
- package/.docs/organized/docs/reference/authkit/api-keys/delete.mdx +23 -0
- package/.docs/organized/docs/reference/authkit/api-keys/index.mdx +275 -0
- package/.docs/organized/docs/reference/authkit/api-keys/list-for-organization.mdx +41 -0
- package/.docs/organized/docs/reference/authkit/api-keys/validate.mdx +77 -0
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/code.mdx +138 -18
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/email-verification.mdx +10 -10
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/get-authorization-url/error-codes.mdx +3 -3
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/get-authorization-url/index.mdx +64 -17
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/get-authorization-url/pkce.mdx +2 -2
- package/.docs/organized/docs/reference/authkit/authentication/get-authorization-url/redirect-uri.mdx +47 -0
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/index.mdx +19 -11
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/magic-auth.mdx +9 -9
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/organization-selection.mdx +9 -9
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/password.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/refresh-and-seal-session-data.mdx +3 -3
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/refresh-token.mdx +17 -17
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/session-cookie.mdx +7 -3
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication/totp.mdx +10 -10
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/email-verification-required-error.mdx +3 -3
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/index.mdx +1 -3
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/mfa-challenge-error.mdx +3 -3
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/mfa-enrollment-error.mdx +3 -3
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/organization-authentication-required-error.mdx +3 -3
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/organization-selection-error.mdx +3 -4
- package/.docs/organized/docs/reference/{user-management → authkit}/authentication-errors/sso-required-error.mdx +3 -3
- package/.docs/organized/docs/reference/authkit/cli-auth/device-authorization.mdx +61 -0
- package/.docs/organized/docs/reference/authkit/cli-auth/device-code.mdx +57 -0
- package/.docs/organized/docs/reference/authkit/cli-auth/error-codes.mdx +31 -0
- package/.docs/organized/docs/reference/authkit/cli-auth/index.mdx +22 -0
- package/.docs/organized/docs/reference/{user-management → authkit}/email-verification/get.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/email-verification/index.mdx +9 -11
- package/.docs/organized/docs/reference/{user-management → authkit}/identity/index.mdx +6 -9
- package/.docs/organized/docs/reference/{user-management → authkit}/identity/list.mdx +5 -6
- package/.docs/organized/docs/reference/authkit/index.mdx +13 -0
- package/.docs/organized/docs/reference/{user-management → authkit}/invitation/accept.mdx +5 -5
- package/.docs/organized/docs/reference/{user-management → authkit}/invitation/find-by-token.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/invitation/get.mdx +8 -9
- package/.docs/organized/docs/reference/{user-management → authkit}/invitation/index.mdx +10 -15
- package/.docs/organized/docs/reference/{user-management → authkit}/invitation/list.mdx +10 -11
- package/.docs/organized/docs/reference/authkit/invitation/resend.mdx +109 -0
- package/.docs/organized/docs/reference/{user-management → authkit}/invitation/revoke.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/invitation/send.mdx +23 -13
- package/.docs/organized/docs/reference/{user-management → authkit}/logout/get-logout-url-from-session-cookie.mdx +2 -2
- package/.docs/organized/docs/reference/{user-management → authkit}/logout/get-logout-url.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/logout/index.mdx +4 -5
- package/.docs/organized/docs/reference/{user-management → authkit}/magic-auth/create.mdx +10 -10
- package/.docs/organized/docs/reference/{user-management → authkit}/magic-auth/get.mdx +9 -10
- package/.docs/organized/docs/reference/{user-management → authkit}/magic-auth/index.mdx +10 -15
- package/.docs/organized/docs/reference/{user-management → authkit}/mfa/authentication-challenge.mdx +9 -10
- package/.docs/organized/docs/reference/{user-management → authkit}/mfa/authentication-factor.mdx +11 -11
- package/.docs/organized/docs/reference/{user-management → authkit}/mfa/enroll-auth-factor.mdx +19 -15
- package/.docs/organized/docs/reference/authkit/mfa/index.mdx +11 -0
- package/.docs/organized/docs/reference/{user-management → authkit}/mfa/list-auth-factors.mdx +9 -9
- package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/create.mdx +27 -10
- package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/deactivate.mdx +10 -10
- package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/delete.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/get.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/index.mdx +107 -14
- package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/list.mdx +10 -10
- package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/reactivate.mdx +11 -11
- package/.docs/organized/docs/reference/{user-management → authkit}/organization-membership/update.mdx +25 -9
- package/.docs/organized/docs/reference/{user-management → authkit}/password-reset/create.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/password-reset/get.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/password-reset/index.mdx +10 -12
- package/.docs/organized/docs/reference/{user-management → authkit}/password-reset/reset-password.mdx +8 -8
- package/.docs/organized/docs/reference/authkit/session/index.mdx +128 -0
- package/.docs/organized/docs/reference/authkit/session/list.mdx +110 -0
- package/.docs/organized/docs/reference/authkit/session/revoke.mdx +73 -0
- package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/authenticate.mdx +22 -6
- package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/get-logout-url.mdx +5 -5
- package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/index.mdx +2 -2
- package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/load-sealed-session.mdx +4 -4
- package/.docs/organized/docs/reference/{user-management → authkit}/session-helpers/refresh.mdx +18 -6
- package/.docs/organized/docs/reference/{user-management → authkit}/session-tokens/access-token.mdx +16 -8
- package/.docs/organized/docs/reference/authkit/session-tokens/index.mdx +5 -0
- package/.docs/organized/docs/reference/{user-management → authkit}/session-tokens/jwks.mdx +8 -8
- package/.docs/organized/docs/reference/authkit/session-tokens/refresh-token.mdx +8 -0
- package/.docs/organized/docs/reference/{user-management → authkit}/user/create.mdx +36 -17
- package/.docs/organized/docs/reference/{user-management → authkit}/user/delete.mdx +8 -9
- package/.docs/organized/docs/reference/{user-management → authkit}/user/get-by-external-id.mdx +16 -4
- package/.docs/organized/docs/reference/{user-management → authkit}/user/get.mdx +8 -8
- package/.docs/organized/docs/reference/{user-management → authkit}/user/index.mdx +25 -15
- package/.docs/organized/docs/reference/{user-management → authkit}/user/list.mdx +9 -12
- package/.docs/organized/docs/reference/{user-management → authkit}/user/update.mdx +43 -20
- package/.docs/organized/docs/reference/{client-libraries.mdx → client-libraries/index.mdx} +2 -2
- package/.docs/organized/docs/reference/directory-sync/directory/index.mdx +1 -1
- package/.docs/organized/docs/reference/directory-sync/directory-group/index.mdx +1 -24
- package/.docs/organized/docs/reference/directory-sync/directory-user/index.mdx +1 -29
- package/.docs/organized/docs/reference/directory-sync/directory-user/list.mdx +1 -1
- package/.docs/organized/docs/reference/directory-sync/index.mdx +1 -1
- package/.docs/organized/docs/reference/domain-verification/create.mdx +35 -0
- package/.docs/organized/docs/reference/domain-verification/delete.mdx +55 -0
- package/.docs/organized/docs/reference/domain-verification/get.mdx +29 -0
- package/.docs/organized/docs/reference/domain-verification/index.mdx +57 -1
- package/.docs/organized/docs/reference/domain-verification/verify.mdx +29 -0
- package/.docs/organized/docs/reference/{errors.mdx → errors/index.mdx} +1 -1
- package/.docs/organized/docs/reference/events/list.mdx +5 -4
- package/.docs/organized/docs/reference/feature-flags/flag/disable.mdx +33 -0
- package/.docs/organized/docs/reference/feature-flags/flag/enable.mdx +33 -0
- package/.docs/organized/docs/reference/feature-flags/flag/get.mdx +32 -0
- package/.docs/organized/docs/reference/feature-flags/flag/index.mdx +116 -0
- package/.docs/organized/docs/reference/feature-flags/flag/list.mdx +67 -0
- package/.docs/organized/docs/reference/feature-flags/index.mdx +123 -0
- package/.docs/organized/docs/reference/feature-flags/targeting/add.mdx +43 -0
- package/.docs/organized/docs/reference/feature-flags/targeting/index.mdx +23 -0
- package/.docs/organized/docs/reference/feature-flags/targeting/list-for-organization.mdx +132 -0
- package/.docs/organized/docs/reference/feature-flags/targeting/list-for-user.mdx +94 -0
- package/.docs/organized/docs/reference/feature-flags/targeting/remove.mdx +43 -0
- package/.docs/organized/docs/reference/fga/access-check/check.mdx +102 -0
- package/.docs/organized/docs/reference/fga/access-check/index.mdx +6 -0
- package/.docs/organized/docs/reference/fga/access-check/list-memberships-by-external-id.mdx +143 -0
- package/.docs/organized/docs/reference/fga/access-check/list-memberships.mdx +127 -0
- package/.docs/organized/docs/reference/fga/access-check/list-resources.mdx +152 -0
- package/.docs/organized/docs/reference/fga/index.mdx +14 -2
- package/.docs/organized/docs/reference/fga/resource/create.mdx +74 -88
- package/.docs/organized/docs/reference/fga/resource/delete-by-external-id.mdx +78 -0
- package/.docs/organized/docs/reference/fga/resource/delete.mdx +38 -62
- package/.docs/organized/docs/reference/fga/resource/get-by-external-id.mdx +60 -0
- package/.docs/organized/docs/reference/fga/resource/get.mdx +15 -63
- package/.docs/organized/docs/reference/fga/resource/index.mdx +74 -73
- package/.docs/organized/docs/reference/fga/resource/list.mdx +90 -131
- package/.docs/organized/docs/reference/fga/resource/update-by-external-id.mdx +81 -0
- package/.docs/organized/docs/reference/fga/resource/update.mdx +29 -85
- package/.docs/organized/docs/reference/fga/role-assignment/create.mdx +89 -0
- package/.docs/organized/docs/reference/fga/role-assignment/delete-by-id.mdx +59 -0
- package/.docs/organized/docs/reference/fga/role-assignment/delete.mdx +90 -0
- package/.docs/organized/docs/reference/fga/role-assignment/index.mdx +106 -0
- package/.docs/organized/docs/reference/fga/role-assignment/list.mdx +86 -0
- package/.docs/organized/docs/reference/index.mdx +21 -12
- package/.docs/organized/docs/reference/magic-link/passwordless-session/index.mdx +1 -1
- package/.docs/organized/docs/reference/mfa/{challenge-factor.mdx → challenge/create.mdx} +1 -1
- package/.docs/organized/docs/reference/mfa/{authentication-challenge.mdx → challenge/index.mdx} +11 -14
- package/.docs/organized/docs/reference/mfa/{verify-challenge.mdx → challenge/verify.mdx} +10 -12
- package/.docs/organized/docs/reference/mfa/{delete-factor.mdx → factor/delete.mdx} +1 -1
- package/.docs/organized/docs/reference/mfa/{enroll-factor.mdx → factor/enroll.mdx} +1 -1
- package/.docs/organized/docs/reference/mfa/{get-factor.mdx → factor/get.mdx} +1 -1
- package/.docs/organized/docs/reference/mfa/{authentication-factor.mdx → factor/index.mdx} +11 -12
- package/.docs/organized/docs/reference/organization/create.mdx +1 -6
- package/.docs/organized/docs/reference/organization/get-by-external-id.mdx +1 -1
- package/.docs/organized/docs/reference/organization/index.mdx +5 -5
- package/.docs/organized/docs/reference/organization/update.mdx +1 -1
- package/.docs/organized/docs/reference/{pagination.mdx → pagination/index.mdx} +1 -3
- package/.docs/organized/docs/reference/pipes/access-token/get.mdx +174 -0
- package/.docs/organized/docs/reference/pipes/access-token/index.mdx +44 -0
- package/.docs/organized/docs/reference/pipes/connected-account/delete.mdx +42 -0
- package/.docs/organized/docs/reference/pipes/connected-account/get-authorize-url.mdx +49 -0
- package/.docs/organized/docs/reference/pipes/connected-account/get.mdx +42 -0
- package/.docs/organized/docs/reference/pipes/connected-account/index.mdx +69 -0
- package/.docs/organized/docs/reference/pipes/index.mdx +8 -0
- package/.docs/organized/docs/reference/pipes/provider/index.mdx +70 -0
- package/.docs/organized/docs/reference/pipes/provider/list.mdx +47 -0
- package/.docs/organized/docs/reference/radar/attempts/index.mdx +1 -1
- package/.docs/organized/docs/reference/radar/lists/index.mdx +1 -1
- package/.docs/organized/docs/reference/rate-limits/index.mdx +56 -0
- package/.docs/organized/docs/reference/roles/index.mdx +12 -262
- package/.docs/organized/docs/reference/roles/organization-role/add-permission.mdx +75 -0
- package/.docs/organized/docs/reference/roles/organization-role/create.mdx +95 -0
- package/.docs/organized/docs/reference/roles/organization-role/delete.mdx +47 -0
- package/.docs/organized/docs/reference/roles/organization-role/get.mdx +55 -0
- package/.docs/organized/docs/reference/roles/organization-role/index.mdx +148 -0
- package/.docs/organized/docs/reference/roles/organization-role/list.mdx +68 -0
- package/.docs/organized/docs/reference/roles/organization-role/remove-permission.mdx +68 -0
- package/.docs/organized/docs/reference/roles/organization-role/set-permissions.mdx +79 -0
- package/.docs/organized/docs/reference/roles/organization-role/update.mdx +85 -0
- package/.docs/organized/docs/reference/roles/permission/create.mdx +101 -0
- package/.docs/organized/docs/reference/roles/permission/delete.mdx +38 -0
- package/.docs/organized/docs/reference/roles/permission/get.mdx +45 -0
- package/.docs/organized/docs/reference/roles/permission/index.mdx +128 -0
- package/.docs/organized/docs/reference/roles/permission/list.mdx +91 -0
- package/.docs/organized/docs/reference/roles/permission/update.mdx +80 -0
- package/.docs/organized/docs/reference/roles/role/add-permission.mdx +63 -0
- package/.docs/organized/docs/reference/roles/role/create.mdx +103 -0
- package/.docs/organized/docs/reference/roles/role/get.mdx +52 -0
- package/.docs/organized/docs/reference/roles/role/index.mdx +135 -0
- package/.docs/organized/docs/reference/roles/role/list.mdx +56 -0
- package/.docs/organized/docs/reference/roles/role/set-permissions.mdx +67 -0
- package/.docs/organized/docs/reference/roles/role/update.mdx +78 -0
- package/.docs/organized/docs/reference/sso/connection/index.mdx +2 -2
- package/.docs/organized/docs/reference/sso/get-authorization-url/error-codes.mdx +5 -3
- package/.docs/organized/docs/reference/sso/get-authorization-url/index.mdx +24 -2
- package/.docs/organized/docs/reference/sso/get-authorization-url/redirect-uri.mdx +25 -1
- package/.docs/organized/docs/reference/sso/index.mdx +1 -1
- package/.docs/organized/docs/reference/sso/logout/authorize.mdx +0 -1
- package/.docs/organized/docs/reference/sso/logout/index.mdx +1 -2
- package/.docs/organized/docs/reference/sso/logout/redirect.mdx +0 -1
- package/.docs/organized/docs/reference/sso/profile/get-profile-and-token.mdx +13 -1
- package/.docs/organized/docs/reference/sso/profile/index.mdx +25 -24
- package/.docs/organized/docs/reference/{testing.mdx → testing/index.mdx} +1 -1
- package/.docs/organized/docs/reference/vault/key/create-data-key.mdx +29 -0
- package/.docs/organized/docs/reference/vault/key/decrypt-data-key.mdx +20 -0
- package/.docs/organized/docs/reference/vault/key/decrypt-data.mdx +24 -0
- package/.docs/organized/docs/reference/vault/key/encrypt-data.mdx +20 -0
- package/.docs/organized/docs/reference/vault/object/create.mdx +17 -0
- package/.docs/organized/docs/reference/vault/object/delete.mdx +12 -0
- package/.docs/organized/docs/reference/vault/object/get-by-name.mdx +61 -0
- package/.docs/organized/docs/reference/vault/object/get.mdx +11 -0
- package/.docs/organized/docs/reference/vault/object/index.mdx +50 -4
- package/.docs/organized/docs/reference/vault/object/list.mdx +40 -1
- package/.docs/organized/docs/reference/vault/object/update.mdx +18 -0
- package/.docs/organized/docs/reference/vault/object/version.mdx +15 -2
- package/.docs/organized/docs/reference/vault/object/versions.mdx +13 -0
- package/.docs/organized/docs/reference/widgets/get-token.mdx +8 -5
- package/.docs/organized/docs/reference/workos-connect/applications/client-secrets/create.mdx +55 -0
- package/.docs/organized/docs/reference/workos-connect/applications/client-secrets/delete.mdx +28 -0
- package/.docs/organized/docs/reference/workos-connect/applications/client-secrets/index.mdx +60 -0
- package/.docs/organized/docs/reference/workos-connect/applications/client-secrets/list.mdx +52 -0
- package/.docs/organized/docs/reference/workos-connect/applications/create.mdx +79 -0
- package/.docs/organized/docs/reference/workos-connect/applications/delete.mdx +28 -0
- package/.docs/organized/docs/reference/workos-connect/applications/get.mdx +59 -0
- package/.docs/organized/docs/reference/workos-connect/applications/index.mdx +40 -0
- package/.docs/organized/docs/reference/workos-connect/applications/list.mdx +49 -0
- package/.docs/organized/docs/reference/workos-connect/applications/m2m.mdx +52 -0
- package/.docs/organized/docs/reference/workos-connect/applications/oauth.mdx +85 -0
- package/.docs/organized/docs/reference/workos-connect/applications/update.mdx +59 -0
- package/.docs/organized/docs/reference/workos-connect/authorize/index.mdx +29 -1
- package/.docs/organized/docs/reference/workos-connect/cli-auth/authorize-device/index.mdx +81 -0
- package/.docs/organized/docs/reference/workos-connect/cli-auth/device-code-grant.mdx +74 -0
- package/.docs/organized/docs/reference/workos-connect/cli-auth/index.mdx +23 -0
- package/.docs/organized/docs/reference/workos-connect/index.mdx +1 -1
- package/.docs/organized/docs/reference/workos-connect/introspection/index.mdx +8 -3
- package/.docs/organized/docs/reference/workos-connect/metadata/index.mdx +1 -1
- package/.docs/organized/docs/reference/workos-connect/metadata/oauth-authorization-server/index.mdx +1 -1
- package/.docs/organized/docs/reference/workos-connect/standalone/complete.mdx +68 -0
- package/.docs/organized/docs/reference/workos-connect/standalone/index.mdx +9 -0
- package/.docs/organized/docs/reference/workos-connect/standalone/user-consent-options.mdx +41 -0
- package/.docs/organized/docs/reference/workos-connect/token/authorization-code-grant/access-token.mdx +6 -0
- package/.docs/organized/docs/reference/workos-connect/token/authorization-code-grant/id-token.mdx +1 -1
- package/.docs/organized/docs/reference/workos-connect/token/{authorization-code-grant/index.mdx → authorization-code-grant.mdx} +23 -2
- package/.docs/organized/docs/reference/workos-connect/token/client-credentials-grant/access-token.mdx +1 -1
- package/.docs/organized/docs/reference/workos-connect/token/{client-credentials-grant/index.mdx → client-credentials-grant.mdx} +2 -2
- package/.docs/organized/docs/reference/workos-connect/token/index.mdx +5 -4
- package/.docs/organized/docs/reference/workos-connect/token/refresh-token-grant.mdx +1 -1
- package/.docs/organized/docs/reference/workos-connect/userinfo/index.mdx +2 -2
- package/.docs/organized/docs/sdks/authkit-js.mdx +14 -0
- package/.docs/organized/docs/sdks/authkit-nextjs.mdx +14 -0
- package/.docs/organized/docs/sdks/authkit-react-router.mdx +14 -0
- package/.docs/organized/docs/sdks/authkit-react.mdx +14 -0
- package/.docs/organized/docs/sdks/authkit-remix.mdx +14 -0
- package/.docs/organized/docs/sdks/authkit-tanstack-start.mdx +14 -0
- package/.docs/organized/docs/sso/_navigation.mdx +8 -2
- package/.docs/organized/docs/sso/attributes.mdx +15 -3
- package/.docs/organized/docs/sso/domains.mdx +8 -6
- package/.docs/organized/docs/sso/example-apps.mdx +2 -2
- package/.docs/organized/docs/sso/identity-provider-role-assignment.mdx +30 -30
- package/.docs/organized/docs/sso/index.mdx +7 -6
- package/.docs/organized/docs/sso/it-team-faq.mdx +1 -1
- package/.docs/organized/docs/sso/jit-provisioning.mdx +2 -3
- package/.docs/organized/docs/sso/launch-checklist.mdx +2 -2
- package/.docs/organized/docs/sso/login-flows.mdx +3 -3
- package/.docs/organized/docs/sso/redirect-uris.mdx +22 -11
- package/.docs/organized/docs/sso/saml-security.mdx +1 -1
- package/.docs/organized/docs/sso/sign-in-consent.mdx +59 -0
- package/.docs/organized/docs/sso/signing-certificates.mdx +7 -7
- package/.docs/organized/docs/sso/single-logout.mdx +0 -1
- package/.docs/organized/docs/sso/ux/sessions.mdx +99 -0
- package/.docs/organized/docs/sso/ux/sign-in.mdx +1 -1
- package/.docs/organized/docs/vault/_navigation.mdx +2 -0
- package/.docs/organized/docs/vault/byok.mdx +140 -0
- package/.docs/organized/docs/vault/index.mdx +1 -1
- package/.docs/organized/docs/widgets/_navigation.mdx +48 -0
- package/.docs/organized/docs/widgets/admin-portal-domain-verification.mdx +24 -0
- package/.docs/organized/docs/widgets/admin-portal-sso-connection.mdx +20 -0
- package/.docs/organized/docs/widgets/api-keys.mdx +28 -0
- package/.docs/organized/docs/widgets/audit-log-streaming.mdx +25 -0
- package/.docs/organized/docs/widgets/directory-sync.mdx +23 -0
- package/.docs/organized/docs/widgets/index.mdx +12 -0
- package/.docs/organized/docs/widgets/localization.mdx +111 -0
- package/.docs/organized/docs/widgets/organization-switcher.mdx +47 -0
- package/.docs/organized/docs/widgets/pipes.mdx +27 -0
- package/.docs/organized/docs/widgets/quick-start.mdx +38 -0
- package/.docs/organized/docs/widgets/styling/css-customization.mdx +100 -0
- package/.docs/organized/docs/widgets/styling/index.mdx +29 -0
- package/.docs/organized/docs/widgets/styling/theme-customization.mdx +51 -0
- package/.docs/organized/docs/widgets/tokens.mdx +17 -0
- package/.docs/organized/docs/widgets/user-management.mdx +28 -0
- package/.docs/organized/docs/widgets/user-profile.mdx +30 -0
- package/.docs/organized/docs/widgets/user-security.mdx +31 -0
- package/.docs/organized/docs/widgets/user-sessions.mdx +26 -0
- package/LICENSE +21 -0
- package/README.md +14 -1
- package/dist/prepare.js +1 -1
- package/dist/prepare.js.map +1 -1
- package/package.json +2 -1
- package/.docs/organized/docs/dashboard.mdx +0 -244
- package/.docs/organized/docs/demo/_navigation.mdx +0 -26
- package/.docs/organized/docs/demo/accordion.mdx +0 -34
- package/.docs/organized/docs/demo/checklist.mdx +0 -33
- package/.docs/organized/docs/demo/code-block.mdx +0 -185
- package/.docs/organized/docs/demo/definition-list.mdx +0 -35
- package/.docs/organized/docs/demo/index.mdx +0 -7
- package/.docs/organized/docs/demo/punctuation.mdx +0 -37
- package/.docs/organized/docs/demo/replacements.mdx +0 -26
- package/.docs/organized/docs/demo/table.mdx +0 -26
- package/.docs/organized/docs/demo/tabs.mdx +0 -17
- package/.docs/organized/docs/fga/identity-provider-sessions.mdx +0 -68
- package/.docs/organized/docs/fga/local-development.mdx +0 -155
- package/.docs/organized/docs/fga/modeling/abac.mdx +0 -107
- package/.docs/organized/docs/fga/modeling/blocklist.mdx +0 -84
- package/.docs/organized/docs/fga/modeling/conditional-roles.mdx +0 -99
- package/.docs/organized/docs/fga/modeling/custom-roles.mdx +0 -90
- package/.docs/organized/docs/fga/modeling/entitlements.mdx +0 -127
- package/.docs/organized/docs/fga/modeling/managed-service-provider.mdx +0 -131
- package/.docs/organized/docs/fga/modeling/org-roles-and-permissions.mdx +0 -95
- package/.docs/organized/docs/fga/modeling/policy-context.mdx +0 -231
- package/.docs/organized/docs/fga/modeling/public-access.mdx +0 -61
- package/.docs/organized/docs/fga/modeling/shareable-content.mdx +0 -106
- package/.docs/organized/docs/fga/modeling/superusers.mdx +0 -74
- package/.docs/organized/docs/fga/modeling/user-groups.mdx +0 -92
- package/.docs/organized/docs/fga/operations-usage.mdx +0 -104
- package/.docs/organized/docs/fga/playground.mdx +0 -12
- package/.docs/organized/docs/fga/policies.mdx +0 -462
- package/.docs/organized/docs/fga/query-language.mdx +0 -112
- package/.docs/organized/docs/fga/schema-management.mdx +0 -224
- package/.docs/organized/docs/fga/schema.mdx +0 -388
- package/.docs/organized/docs/fga/warrant-tokens.mdx +0 -44
- package/.docs/organized/docs/fga/warrants.mdx +0 -92
- package/.docs/organized/docs/reference/fga/batch-check.mdx +0 -277
- package/.docs/organized/docs/reference/fga/check.mdx +0 -563
- package/.docs/organized/docs/reference/fga/policy/create.mdx +0 -27
- package/.docs/organized/docs/reference/fga/policy/delete.mdx +0 -18
- package/.docs/organized/docs/reference/fga/policy/get.mdx +0 -23
- package/.docs/organized/docs/reference/fga/policy/index.mdx +0 -52
- package/.docs/organized/docs/reference/fga/policy/list.mdx +0 -41
- package/.docs/organized/docs/reference/fga/policy/update.mdx +0 -26
- package/.docs/organized/docs/reference/fga/query.mdx +0 -375
- package/.docs/organized/docs/reference/fga/resource/batch-write.mdx +0 -175
- package/.docs/organized/docs/reference/fga/resource-type/apply.mdx +0 -35
- package/.docs/organized/docs/reference/fga/resource-type/create.mdx +0 -24
- package/.docs/organized/docs/reference/fga/resource-type/delete.mdx +0 -22
- package/.docs/organized/docs/reference/fga/resource-type/get.mdx +0 -23
- package/.docs/organized/docs/reference/fga/resource-type/index.mdx +0 -68
- package/.docs/organized/docs/reference/fga/resource-type/list.mdx +0 -36
- package/.docs/organized/docs/reference/fga/resource-type/update.mdx +0 -23
- package/.docs/organized/docs/reference/fga/schema/apply.mdx +0 -42
- package/.docs/organized/docs/reference/fga/schema/get.mdx +0 -24
- package/.docs/organized/docs/reference/fga/schema/index.mdx +0 -39
- package/.docs/organized/docs/reference/fga/warrant/batch-write.mdx +0 -226
- package/.docs/organized/docs/reference/fga/warrant/create.mdx +0 -215
- package/.docs/organized/docs/reference/fga/warrant/delete.mdx +0 -212
- package/.docs/organized/docs/reference/fga/warrant/index.mdx +0 -186
- package/.docs/organized/docs/reference/fga/warrant/list.mdx +0 -282
- package/.docs/organized/docs/reference/idempotency.mdx +0 -21
- package/.docs/organized/docs/reference/organization-domain.mdx +0 -189
- package/.docs/organized/docs/reference/rate-limits.mdx +0 -50
- package/.docs/organized/docs/reference/roles/list-for-organization.mdx +0 -152
- package/.docs/organized/docs/reference/user-management/access-token/index.mdx +0 -13
- package/.docs/organized/docs/reference/user-management/authentication/get-authorization-url/redirect-uri.mdx +0 -23
- package/.docs/organized/docs/reference/user-management/index.mdx +0 -13
- package/.docs/organized/docs/reference/user-management/mfa/index.mdx +0 -5
- package/.docs/organized/docs/reference/user-management/session-tokens/index.mdx +0 -5
- package/.docs/organized/docs/reference/user-management/session-tokens/refresh-token.mdx +0 -8
- package/.docs/organized/docs/user-management/_navigation.mdx +0 -87
- package/.docs/organized/docs/user-management/authkit.mdx +0 -69
- package/.docs/organized/docs/user-management/connect.mdx +0 -110
- package/.docs/organized/docs/user-management/directory-provisioning.mdx +0 -78
- package/.docs/organized/docs/user-management/email-verification.mdx +0 -29
- package/.docs/organized/docs/user-management/entitlements.mdx +0 -46
- package/.docs/organized/docs/user-management/jit-provisioning.mdx +0 -36
- package/.docs/organized/docs/user-management/overview.mdx +0 -46
- package/.docs/organized/docs/user-management/roles-and-permissions.mdx +0 -155
- package/.docs/organized/docs/user-management/users-organizations.mdx +0 -91
- package/.docs/organized/docs/user-management/widgets.mdx +0 -190
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
descriptions:
|
|
3
3
|
user:
|
|
4
|
-
self: 'The corresponding [user](/reference/
|
|
4
|
+
self: 'The corresponding [user](/reference/authkit/user) object.'
|
|
5
5
|
object: Distinguishes the user object.
|
|
6
6
|
id: The unique ID of the user.
|
|
7
7
|
email: The email address of the user.
|
|
@@ -15,16 +15,17 @@ descriptions:
|
|
|
15
15
|
Currently, this URL will be present for users who have a profile picture
|
|
16
16
|
from a linked Google or GitHub OAuth identity. New image sources may be
|
|
17
17
|
added in the future.
|
|
18
|
+
locale: The user's preferred locale.
|
|
18
19
|
last_sign_in_at: The timestamp when the user last signed in.
|
|
19
20
|
external_id: The external ID of the user.
|
|
20
21
|
metadata: >
|
|
21
|
-
Object containing [metadata](/
|
|
22
|
-
|
|
22
|
+
Object containing [metadata](/authkit/metadata) key/value pairs associated
|
|
23
|
+
with the user.
|
|
23
24
|
created_at: The timestamp when the user was created.
|
|
24
25
|
updated_at: The timestamp when the user was last updated.
|
|
25
26
|
reference:
|
|
26
27
|
curl:
|
|
27
|
-
- url: /reference/
|
|
28
|
+
- url: /reference/authkit/user
|
|
28
29
|
key: user
|
|
29
30
|
id: user
|
|
30
31
|
title: user
|
|
@@ -64,6 +65,10 @@ reference:
|
|
|
64
65
|
- key: metadata
|
|
65
66
|
type: object
|
|
66
67
|
description: (user.metadata)
|
|
68
|
+
- key: locale
|
|
69
|
+
optional: true
|
|
70
|
+
type: string
|
|
71
|
+
description: (user.locale)
|
|
67
72
|
- key: created_at
|
|
68
73
|
type: string
|
|
69
74
|
description: (user.created_at)
|
|
@@ -71,7 +76,7 @@ reference:
|
|
|
71
76
|
type: string
|
|
72
77
|
description: (user.updated_at)
|
|
73
78
|
js:
|
|
74
|
-
- url: /reference/
|
|
79
|
+
- url: /reference/authkit/user
|
|
75
80
|
key: User
|
|
76
81
|
id: user
|
|
77
82
|
title: interface User
|
|
@@ -118,7 +123,7 @@ reference:
|
|
|
118
123
|
type: string
|
|
119
124
|
description: (user.updated_at)
|
|
120
125
|
go:
|
|
121
|
-
- url: /reference/
|
|
126
|
+
- url: /reference/authkit/user
|
|
122
127
|
key: User
|
|
123
128
|
id: user
|
|
124
129
|
title: usermanagement.User
|
|
@@ -148,6 +153,14 @@ reference:
|
|
|
148
153
|
optional: true
|
|
149
154
|
type: string
|
|
150
155
|
description: (user.last_sign_in_at)
|
|
156
|
+
- key: ExternalID
|
|
157
|
+
type: string
|
|
158
|
+
optional: true
|
|
159
|
+
description: (user.external_id)
|
|
160
|
+
- key: Metadata
|
|
161
|
+
type: 'map[string]string'
|
|
162
|
+
optional: true
|
|
163
|
+
description: (user.metadata)
|
|
151
164
|
- key: CreatedAt
|
|
152
165
|
type: string
|
|
153
166
|
description: (user.created_at)
|
|
@@ -155,7 +168,7 @@ reference:
|
|
|
155
168
|
type: string
|
|
156
169
|
description: (user.updated_at)
|
|
157
170
|
php:
|
|
158
|
-
- url: /reference/
|
|
171
|
+
- url: /reference/authkit/user
|
|
159
172
|
key: User
|
|
160
173
|
id: user
|
|
161
174
|
title: WorkOS\Resource\User
|
|
@@ -195,7 +208,7 @@ reference:
|
|
|
195
208
|
type: string
|
|
196
209
|
description: (user.updated_at)
|
|
197
210
|
python:
|
|
198
|
-
- url: /reference/
|
|
211
|
+
- url: /reference/authkit/user
|
|
199
212
|
key: User
|
|
200
213
|
id: user
|
|
201
214
|
title: User
|
|
@@ -232,7 +245,7 @@ reference:
|
|
|
232
245
|
type: str
|
|
233
246
|
description: (user.updated_at)
|
|
234
247
|
ruby:
|
|
235
|
-
- url: /reference/
|
|
248
|
+
- url: /reference/authkit/user
|
|
236
249
|
key: User
|
|
237
250
|
id: user
|
|
238
251
|
title: class User
|
|
@@ -269,7 +282,7 @@ reference:
|
|
|
269
282
|
type: String
|
|
270
283
|
description: (user.updated_at)
|
|
271
284
|
java:
|
|
272
|
-
- url: /reference/
|
|
285
|
+
- url: /reference/authkit/user
|
|
273
286
|
key: User
|
|
274
287
|
id: user
|
|
275
288
|
title: class User
|
|
@@ -305,15 +318,12 @@ reference:
|
|
|
305
318
|
- key: updatedAt
|
|
306
319
|
type: String
|
|
307
320
|
description: (user.updated_at)
|
|
308
|
-
originalPath:
|
|
309
|
-
.tmp-workos-clone/packages/docs/content/reference/user-management/user/index.mdx
|
|
310
|
-
---
|
|
311
|
-
|
|
321
|
+
originalPath: .tmp-workos-clone/packages/docs/content/reference/authkit/user/index.mdx
|
|
312
322
|
---
|
|
313
323
|
|
|
314
324
|
# User
|
|
315
325
|
|
|
316
|
-
Represents a user identity in your application. A user can sign up in your application directly with a method like password, or they can be [JIT-provisioned](/
|
|
326
|
+
Represents a user identity in your application. A user can sign up in your application directly with a method like password, or they can be [JIT-provisioned](/authkit/jit-provisioning) through an organization’s SSO connection.
|
|
317
327
|
|
|
318
328
|
Users may belong to [organizations](/reference/organization) as members.
|
|
319
329
|
|
|
@@ -4,14 +4,12 @@ descriptions:
|
|
|
4
4
|
type: Filter users by their type.
|
|
5
5
|
email: Filter users by their email.
|
|
6
6
|
organization_id: Filter users by the organization they are members of.
|
|
7
|
-
data:
|
|
8
|
-
Array of [users](/reference/user-management/user) ordered by creation
|
|
9
|
-
time.
|
|
7
|
+
data: 'Array of [users](/reference/authkit/user) ordered by creation time.'
|
|
10
8
|
reference:
|
|
11
9
|
curl:
|
|
12
10
|
- key: list_users
|
|
13
11
|
id: list_users
|
|
14
|
-
url: /reference/
|
|
12
|
+
url: /reference/authkit/user/list
|
|
15
13
|
title: /user_management/users
|
|
16
14
|
type: GET
|
|
17
15
|
parameters:
|
|
@@ -44,7 +42,7 @@ reference:
|
|
|
44
42
|
- key: listUsers
|
|
45
43
|
patternBefore: userManagement.
|
|
46
44
|
id: list_users
|
|
47
|
-
url: /reference/
|
|
45
|
+
url: /reference/authkit/user/list
|
|
48
46
|
title: userManagement.listUsers()
|
|
49
47
|
parameters:
|
|
50
48
|
- key: options
|
|
@@ -80,7 +78,7 @@ reference:
|
|
|
80
78
|
- key: ListUsers
|
|
81
79
|
patternBefore: usermanagement.
|
|
82
80
|
id: list_users
|
|
83
|
-
url: /reference/
|
|
81
|
+
url: /reference/authkit/user/list
|
|
84
82
|
title: usermanagement.ListUsers()
|
|
85
83
|
parameters:
|
|
86
84
|
- (ctx)
|
|
@@ -118,7 +116,7 @@ reference:
|
|
|
118
116
|
- key: listUsers
|
|
119
117
|
patternBefore: userManagement->
|
|
120
118
|
id: list_users
|
|
121
|
-
url: /reference/
|
|
119
|
+
url: /reference/authkit/user/list
|
|
122
120
|
title: $userManagement->listUsers()
|
|
123
121
|
parameters:
|
|
124
122
|
- key: options
|
|
@@ -151,7 +149,7 @@ reference:
|
|
|
151
149
|
- key: list_users
|
|
152
150
|
patternBefore: user_management.
|
|
153
151
|
id: list_users
|
|
154
|
-
url: /reference/
|
|
152
|
+
url: /reference/authkit/user/list
|
|
155
153
|
title: user_management.list_users()
|
|
156
154
|
parameters:
|
|
157
155
|
- key: email
|
|
@@ -182,7 +180,7 @@ reference:
|
|
|
182
180
|
ruby:
|
|
183
181
|
- key: list_users
|
|
184
182
|
id: list_users
|
|
185
|
-
url: /reference/
|
|
183
|
+
url: /reference/authkit/user/list
|
|
186
184
|
title: UserManagement.list_users()
|
|
187
185
|
parameters:
|
|
188
186
|
- key: email
|
|
@@ -213,7 +211,7 @@ reference:
|
|
|
213
211
|
java:
|
|
214
212
|
- key: listUsers
|
|
215
213
|
id: list_users
|
|
216
|
-
url: /reference/
|
|
214
|
+
url: /reference/authkit/user/list
|
|
217
215
|
title: userManagement.listUsers()
|
|
218
216
|
parameters:
|
|
219
217
|
- key: options
|
|
@@ -246,8 +244,7 @@ reference:
|
|
|
246
244
|
properties:
|
|
247
245
|
- (before)
|
|
248
246
|
- (after)
|
|
249
|
-
originalPath:
|
|
250
|
-
.tmp-workos-clone/packages/docs/content/reference/user-management/user/list.mdx
|
|
247
|
+
originalPath: .tmp-workos-clone/packages/docs/content/reference/authkit/user/list.mdx
|
|
251
248
|
---
|
|
252
249
|
|
|
253
250
|
## List users
|
|
@@ -8,14 +8,14 @@ descriptions:
|
|
|
8
8
|
|
|
9
9
|
|
|
10
10
|
Changing a user's email will set `email_verified` to false.
|
|
11
|
-
[Identities](/reference/
|
|
12
|
-
|
|
11
|
+
[Identities](/reference/authkit/identity) that do not match the new email
|
|
12
|
+
will be unlinked.
|
|
13
13
|
email_verified: >
|
|
14
14
|
Whether the user’s email address was previously verified.
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
You should normally use the [email verification
|
|
18
|
-
flow](/reference/
|
|
18
|
+
flow](/reference/authkit/authentication/email-verification)
|
|
19
19
|
|
|
20
20
|
to verify a user’s email address. However, if the user’s email was
|
|
21
21
|
previously verified, or
|
|
@@ -25,16 +25,16 @@ descriptions:
|
|
|
25
25
|
|
|
26
26
|
already verified.
|
|
27
27
|
metadata: >-
|
|
28
|
-
Object containing [metadata](/
|
|
29
|
-
|
|
28
|
+
Object containing [metadata](/authkit/metadata) key/value pairs associated
|
|
29
|
+
with the user.
|
|
30
30
|
external_id: >-
|
|
31
|
-
The [external identifier](/
|
|
32
|
-
|
|
31
|
+
The [external identifier](/authkit/metadata/external-identifiers) of the
|
|
32
|
+
user.
|
|
33
33
|
reference:
|
|
34
34
|
curl:
|
|
35
35
|
- key: update_user
|
|
36
36
|
id: update_user
|
|
37
|
-
url: /reference/
|
|
37
|
+
url: /reference/authkit/user/update
|
|
38
38
|
title: '/user_management/users/:id'
|
|
39
39
|
type: PUT
|
|
40
40
|
parameters:
|
|
@@ -70,17 +70,21 @@ reference:
|
|
|
70
70
|
- key: external_id
|
|
71
71
|
type: string
|
|
72
72
|
optional: true
|
|
73
|
-
description: (
|
|
73
|
+
description: (update_user.external_id)
|
|
74
74
|
- key: metadata
|
|
75
75
|
type: object
|
|
76
76
|
optional: true
|
|
77
|
-
description: (
|
|
77
|
+
description: (update_user.metadata)
|
|
78
|
+
- key: locale
|
|
79
|
+
type: string
|
|
80
|
+
optional: true
|
|
81
|
+
description: (user.locale)
|
|
78
82
|
returns:
|
|
79
83
|
- (user)
|
|
80
84
|
js:
|
|
81
85
|
- key: updateUser
|
|
82
86
|
id: update_user
|
|
83
|
-
url: /reference/
|
|
87
|
+
url: /reference/authkit/user/update
|
|
84
88
|
title: userManagement.updateUser()
|
|
85
89
|
parameters:
|
|
86
90
|
- key: userId
|
|
@@ -117,17 +121,17 @@ reference:
|
|
|
117
121
|
- key: externalId
|
|
118
122
|
type: string
|
|
119
123
|
optional: true
|
|
120
|
-
description: (
|
|
124
|
+
description: (update_user.external_id)
|
|
121
125
|
- key: metadata
|
|
122
126
|
type: object
|
|
123
127
|
optional: true
|
|
124
|
-
description: (
|
|
128
|
+
description: (update_user.metadata)
|
|
125
129
|
returns:
|
|
126
130
|
- (User)
|
|
127
131
|
php:
|
|
128
132
|
- key: updateUser
|
|
129
133
|
id: update_user
|
|
130
|
-
url: /reference/
|
|
134
|
+
url: /reference/authkit/user/update
|
|
131
135
|
title: $userManagement->updateUser()
|
|
132
136
|
parameters:
|
|
133
137
|
- key: id
|
|
@@ -166,7 +170,7 @@ reference:
|
|
|
166
170
|
go:
|
|
167
171
|
- key: UpdateUser
|
|
168
172
|
id: update_user
|
|
169
|
-
url: /reference/
|
|
173
|
+
url: /reference/authkit/user/update
|
|
170
174
|
title: usermanagement.UpdateUser()
|
|
171
175
|
parameters:
|
|
172
176
|
- (ctx)
|
|
@@ -205,6 +209,14 @@ reference:
|
|
|
205
209
|
type: string
|
|
206
210
|
optional: true
|
|
207
211
|
description: (create_user.password_hash_type)
|
|
212
|
+
- key: ExternalID
|
|
213
|
+
type: string
|
|
214
|
+
optional: true
|
|
215
|
+
description: (update_user.external_id)
|
|
216
|
+
- key: Metadata
|
|
217
|
+
type: 'map[string]string'
|
|
218
|
+
optional: true
|
|
219
|
+
description: (update_user.metadata)
|
|
208
220
|
returns:
|
|
209
221
|
- key: user
|
|
210
222
|
type: usermanagement.User
|
|
@@ -213,7 +225,7 @@ reference:
|
|
|
213
225
|
python:
|
|
214
226
|
- key: update_user
|
|
215
227
|
id: update_user
|
|
216
|
-
url: /reference/
|
|
228
|
+
url: /reference/authkit/user/update
|
|
217
229
|
title: user_management.update_user()
|
|
218
230
|
parameters:
|
|
219
231
|
- key: user_id
|
|
@@ -247,12 +259,20 @@ reference:
|
|
|
247
259
|
type: PasswordHashType
|
|
248
260
|
optional: true
|
|
249
261
|
description: (create_user.password_hash_type)
|
|
262
|
+
- key: external_id
|
|
263
|
+
type: str
|
|
264
|
+
optional: true
|
|
265
|
+
description: (update_user.external_id)
|
|
266
|
+
- key: metadata
|
|
267
|
+
type: 'Dict[str, str]'
|
|
268
|
+
optional: true
|
|
269
|
+
description: (update_user.metadata)
|
|
250
270
|
returns:
|
|
251
271
|
- (User)
|
|
252
272
|
ruby:
|
|
253
273
|
- key: update_user
|
|
254
274
|
id: update_user
|
|
255
|
-
url: /reference/
|
|
275
|
+
url: /reference/authkit/user/update
|
|
256
276
|
title: UserManagement.update_user()
|
|
257
277
|
parameters:
|
|
258
278
|
- key: id
|
|
@@ -286,12 +306,16 @@ reference:
|
|
|
286
306
|
type: String
|
|
287
307
|
optional: true
|
|
288
308
|
description: (create_user.password_hash_type)
|
|
309
|
+
- key: external_id
|
|
310
|
+
type: str
|
|
311
|
+
optional: true
|
|
312
|
+
description: (update_user.external_id)
|
|
289
313
|
returns:
|
|
290
314
|
- (User)
|
|
291
315
|
java:
|
|
292
316
|
- key: updateUser
|
|
293
317
|
id: update_user
|
|
294
|
-
url: /reference/
|
|
318
|
+
url: /reference/authkit/user/update
|
|
295
319
|
title: userManagement.updateUser()
|
|
296
320
|
parameters:
|
|
297
321
|
- key: userId
|
|
@@ -330,8 +354,7 @@ reference:
|
|
|
330
354
|
description: (create_user.password_hash_type)
|
|
331
355
|
returns:
|
|
332
356
|
- (User)
|
|
333
|
-
originalPath:
|
|
334
|
-
.tmp-workos-clone/packages/docs/content/reference/user-management/user/update.mdx
|
|
357
|
+
originalPath: .tmp-workos-clone/packages/docs/content/reference/authkit/user/update.mdx
|
|
335
358
|
---
|
|
336
359
|
|
|
337
360
|
## Update a user
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
---
|
|
2
|
-
originalPath: .tmp-workos-clone/packages/docs/content/reference/client-libraries.mdx
|
|
2
|
+
originalPath: .tmp-workos-clone/packages/docs/content/reference/client-libraries/index.mdx
|
|
3
3
|
---
|
|
4
4
|
# Client libraries
|
|
5
5
|
|
|
6
|
-
WorkOS offers native SDKs in several popular programming languages. Choose one language below to see our API Reference in your application
|
|
6
|
+
WorkOS offers native SDKs in several popular programming languages. Choose one language below to see our API Reference in your application's language.
|
|
7
7
|
|
|
8
8
|
<LanguageSelector>
|
|
9
9
|
Install the SDK using the command below.
|
|
@@ -12,9 +12,6 @@ descriptions:
|
|
|
12
12
|
name: The name of the Directory Group.
|
|
13
13
|
created_at: The timestamp when the Directory Group was created.
|
|
14
14
|
updated_at: The timestamp when the Directory Group was last updated.
|
|
15
|
-
raw_attributes: >-
|
|
16
|
-
This field is deprecated. An object containing the data returned from the
|
|
17
|
-
Directory Provider.
|
|
18
15
|
reference:
|
|
19
16
|
curl:
|
|
20
17
|
- url: /reference/directory-sync/directory-group
|
|
@@ -44,9 +41,6 @@ reference:
|
|
|
44
41
|
- key: updated_at
|
|
45
42
|
type: string
|
|
46
43
|
description: (directory_group.updated_at)
|
|
47
|
-
- key: 'raw_attributes [Deprecated]'
|
|
48
|
-
type: object
|
|
49
|
-
description: (directory_group.raw_attributes)
|
|
50
44
|
dotnet:
|
|
51
45
|
- url: /reference/directory-sync/directory-group
|
|
52
46
|
key: Group
|
|
@@ -106,9 +100,6 @@ reference:
|
|
|
106
100
|
- key: updated_at
|
|
107
101
|
type: String
|
|
108
102
|
description: (directory_group.updated_at)
|
|
109
|
-
- key: 'raw_attributes [Deprecated]'
|
|
110
|
-
type: Hash
|
|
111
|
-
description: (directory_group.raw_attributes)
|
|
112
103
|
python:
|
|
113
104
|
- url: /reference/directory-sync/directory-group
|
|
114
105
|
key: DirectoryGroup
|
|
@@ -133,8 +124,6 @@ reference:
|
|
|
133
124
|
- key: updated_at
|
|
134
125
|
type: str
|
|
135
126
|
description: (directory_group.updated_at)
|
|
136
|
-
- key: 'raw_attributes [Deprecated]'
|
|
137
|
-
type: dict
|
|
138
127
|
js:
|
|
139
128
|
- url: /reference/directory-sync/directory-group
|
|
140
129
|
key: DirectoryGroup
|
|
@@ -163,9 +152,6 @@ reference:
|
|
|
163
152
|
- key: updatedAt
|
|
164
153
|
type: string
|
|
165
154
|
description: (directory_group.updated_at)
|
|
166
|
-
- key: rawAttributes
|
|
167
|
-
type: object
|
|
168
|
-
description: (directory_group.raw_attributes)
|
|
169
155
|
go:
|
|
170
156
|
- url: /reference/directory-sync/directory-group
|
|
171
157
|
key: Group
|
|
@@ -194,9 +180,6 @@ reference:
|
|
|
194
180
|
- key: UpdatedAt
|
|
195
181
|
type: string
|
|
196
182
|
description: (directory_group.updated_at)
|
|
197
|
-
- key: 'RawAttributes [Deprecated]'
|
|
198
|
-
type: json.RawMessage
|
|
199
|
-
description: (directory_group.raw_attributes)
|
|
200
183
|
php:
|
|
201
184
|
- url: /reference/directory-sync/directory-group
|
|
202
185
|
key: DirectoryGroup
|
|
@@ -225,9 +208,6 @@ reference:
|
|
|
225
208
|
- key: updatedAt
|
|
226
209
|
type: string
|
|
227
210
|
description: (directory_group.updated_at)
|
|
228
|
-
- key: 'rawAttributes [Deprecated]'
|
|
229
|
-
type: array
|
|
230
|
-
description: (directory_group.raw_attributes)
|
|
231
211
|
java:
|
|
232
212
|
- url: /reference/directory-sync/directory-group
|
|
233
213
|
key: Group
|
|
@@ -259,14 +239,11 @@ reference:
|
|
|
259
239
|
- key: updatedAt
|
|
260
240
|
type: String
|
|
261
241
|
description: (directory_group.updated_at)
|
|
262
|
-
- key: 'rawAttributes [Deprecated]'
|
|
263
|
-
type: 'Map<String, Any>'
|
|
264
|
-
description: (directory_group.raw_attributes)
|
|
265
242
|
originalPath: >-
|
|
266
243
|
.tmp-workos-clone/packages/docs/content/reference/directory-sync/directory-group/index.mdx
|
|
267
244
|
---
|
|
268
245
|
|
|
269
|
-
|
|
246
|
+
# Directory Group
|
|
270
247
|
|
|
271
248
|
A directory group represents an organizational unit of users in a directory provider.
|
|
272
249
|
|
|
@@ -32,10 +32,6 @@ descriptions:
|
|
|
32
32
|
custom_attributes: >-
|
|
33
33
|
An object containing the custom attribute mapping for the Directory
|
|
34
34
|
Provider.
|
|
35
|
-
raw_attributes: >-
|
|
36
|
-
This field is deprecated, use [custom
|
|
37
|
-
attributes](/directory-sync/attributes/custom-attributes) instead. An
|
|
38
|
-
object containing the data returned from the Directory Provider.
|
|
39
35
|
role:
|
|
40
36
|
slug: The unique role identifier
|
|
41
37
|
created_at: The timestamp when the Directory User was created.
|
|
@@ -81,9 +77,6 @@ reference:
|
|
|
81
77
|
- key: custom_attributes
|
|
82
78
|
type: object
|
|
83
79
|
description: (directory_user.custom_attributes)
|
|
84
|
-
- key: 'raw_attributes [Deprecated]'
|
|
85
|
-
type: object
|
|
86
|
-
description: (directory_user.raw_attributes)
|
|
87
80
|
- key: role
|
|
88
81
|
type: object
|
|
89
82
|
optional: true
|
|
@@ -141,9 +134,6 @@ reference:
|
|
|
141
134
|
- key: CustomAttributes
|
|
142
135
|
type: 'Dictionary<string, object>'
|
|
143
136
|
description: (directory_user.custom_attributes)
|
|
144
|
-
- key: RawAttributes
|
|
145
|
-
type: 'Dictionary<string, object>'
|
|
146
|
-
description: (directory_user.raw_attributes)
|
|
147
137
|
- key: CreatedAt
|
|
148
138
|
type: string
|
|
149
139
|
description: (directory_user.created_at)
|
|
@@ -190,9 +180,6 @@ reference:
|
|
|
190
180
|
- key: custom_attributes
|
|
191
181
|
type: Hash
|
|
192
182
|
description: (directory_user.custom_attributes)
|
|
193
|
-
- key: 'raw_attributes [Deprecated]'
|
|
194
|
-
type: Hash
|
|
195
|
-
description: (directory_user.raw_attributes)
|
|
196
183
|
python:
|
|
197
184
|
- url: /reference/directory-sync/directory-user
|
|
198
185
|
key: DirectoryUser
|
|
@@ -233,9 +220,6 @@ reference:
|
|
|
233
220
|
- key: custom_attributes
|
|
234
221
|
type: dict
|
|
235
222
|
description: (directory_user.custom_attributes)
|
|
236
|
-
- key: 'raw_attributes [Deprecated]'
|
|
237
|
-
type: dict
|
|
238
|
-
description: (directory_user.raw_attributes)
|
|
239
223
|
- key: role
|
|
240
224
|
type: InlineRole
|
|
241
225
|
optional: true
|
|
@@ -290,9 +274,6 @@ reference:
|
|
|
290
274
|
- key: customAttributes
|
|
291
275
|
type: object
|
|
292
276
|
description: (directory_user.custom_attributes)
|
|
293
|
-
- key: 'rawAttributes [Deprecated]'
|
|
294
|
-
type: object
|
|
295
|
-
description: (directory_user.raw_attributes)
|
|
296
277
|
- key: role
|
|
297
278
|
type: object
|
|
298
279
|
optional: true
|
|
@@ -341,9 +322,6 @@ reference:
|
|
|
341
322
|
- key: CustomAttributes
|
|
342
323
|
type: json.RawMessage
|
|
343
324
|
description: (directory_user.custom_attributes)
|
|
344
|
-
- key: 'RawAttributes [Deprecated]'
|
|
345
|
-
type: json.RawMessage
|
|
346
|
-
description: (directory_user.raw_attributes)
|
|
347
325
|
- key: Role
|
|
348
326
|
type: object
|
|
349
327
|
description: (directory_user.role)
|
|
@@ -391,9 +369,6 @@ reference:
|
|
|
391
369
|
- key: customAttributes
|
|
392
370
|
type: array
|
|
393
371
|
description: (directory_user.custom_attributes)
|
|
394
|
-
- key: 'rawAttributes [Deprecated]'
|
|
395
|
-
type: array
|
|
396
|
-
description: (directory_user.raw_attributes)
|
|
397
372
|
- key: createdAt
|
|
398
373
|
type: string
|
|
399
374
|
description: (directory_user.created_at)
|
|
@@ -450,14 +425,11 @@ reference:
|
|
|
450
425
|
- key: customAttributes
|
|
451
426
|
type: 'Map<String, Any?>'
|
|
452
427
|
description: (directory_user.custom_attributes)
|
|
453
|
-
- key: 'rawAttributes [Deprecated]'
|
|
454
|
-
type: 'Map<String, Any?>'
|
|
455
|
-
description: (directory_user.raw_attributes)
|
|
456
428
|
originalPath: >-
|
|
457
429
|
.tmp-workos-clone/packages/docs/content/reference/directory-sync/directory-user/index.mdx
|
|
458
430
|
---
|
|
459
431
|
|
|
460
|
-
|
|
432
|
+
# Directory User
|
|
461
433
|
|
|
462
434
|
A Directory User represents an active organization user.
|
|
463
435
|
|
|
@@ -7,4 +7,4 @@ Directory Sync allows you to connect with directory providers to inform your app
|
|
|
7
7
|
|
|
8
8
|
Using Directory Sync, one integration grants your application the ability to support multiple directory providers. Get real-time updates of any changes to the organization's access rules, groups, and users by integrating webhooks into your application.
|
|
9
9
|
|
|
10
|
-
To automatically respond to changes in the connected directories and their users and groups, use the [Directory
|
|
10
|
+
To automatically respond to changes in the connected directories and their users and groups, use the [Directory Sync events](/events/directory-sync).
|
|
@@ -24,6 +24,41 @@ reference:
|
|
|
24
24
|
- (OrganizationDomain.domain)
|
|
25
25
|
returns:
|
|
26
26
|
- (OrganizationDomain)
|
|
27
|
+
go:
|
|
28
|
+
- key: CreateOrganizationDomain
|
|
29
|
+
id: create_organization_domain
|
|
30
|
+
url: /reference/domain-verification/create
|
|
31
|
+
title: organization_domains.CreateOrganizationDomain()
|
|
32
|
+
parameters:
|
|
33
|
+
- (ctx)
|
|
34
|
+
- key: opts
|
|
35
|
+
type: organization_domains.CreateOrganizationDomainOpts
|
|
36
|
+
expanded: true
|
|
37
|
+
properties:
|
|
38
|
+
- key: OrganizationID
|
|
39
|
+
type: string
|
|
40
|
+
description: (organization_domain.organization_id)
|
|
41
|
+
- key: Domain
|
|
42
|
+
type: string
|
|
43
|
+
description: (organization_domain.domain)
|
|
44
|
+
returns:
|
|
45
|
+
- key: organizationDomain
|
|
46
|
+
type: OrganizationDomain
|
|
47
|
+
- (err)
|
|
48
|
+
python:
|
|
49
|
+
- key: create_organization_domain
|
|
50
|
+
id: create_organization_domain
|
|
51
|
+
url: /reference/domain-verification/create
|
|
52
|
+
title: organization_domains.create_organization_domain()
|
|
53
|
+
parameters:
|
|
54
|
+
- key: organization_id
|
|
55
|
+
type: str
|
|
56
|
+
description: (organization_domain.organization_id)
|
|
57
|
+
- key: domain
|
|
58
|
+
type: str
|
|
59
|
+
description: (organization_domain.domain)
|
|
60
|
+
returns:
|
|
61
|
+
- (OrganizationDomain)
|
|
27
62
|
originalPath: >-
|
|
28
63
|
.tmp-workos-clone/packages/docs/content/reference/domain-verification/create.mdx
|
|
29
64
|
---
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
---
|
|
2
|
+
reference:
|
|
3
|
+
curl:
|
|
4
|
+
- key: delete_organization_domain
|
|
5
|
+
id: delete_organization_domain
|
|
6
|
+
url: /reference/domain-verification/delete
|
|
7
|
+
title: '/organization_domains/:id'
|
|
8
|
+
type: DELETE
|
|
9
|
+
parameters:
|
|
10
|
+
- (organization_domain.id)
|
|
11
|
+
js:
|
|
12
|
+
- key: deleteOrganizationDomain
|
|
13
|
+
id: delete_organization_domain
|
|
14
|
+
url: /reference/domain-verification/delete
|
|
15
|
+
title: organizationDomains.delete()
|
|
16
|
+
parameters:
|
|
17
|
+
- (OrganizationDomain.id)
|
|
18
|
+
go:
|
|
19
|
+
- key: DeleteOrganizationDomain
|
|
20
|
+
id: delete_organization_domain
|
|
21
|
+
url: /reference/domain-verification/delete
|
|
22
|
+
title: organization_domains.DeleteOrganizationDomain()
|
|
23
|
+
parameters:
|
|
24
|
+
- (ctx)
|
|
25
|
+
- key: opts
|
|
26
|
+
type: organization_domains.DeleteOrganizationDomainOpts
|
|
27
|
+
expanded: true
|
|
28
|
+
properties:
|
|
29
|
+
- key: DomainID
|
|
30
|
+
type: string
|
|
31
|
+
description: (organization_domain.id)
|
|
32
|
+
returns:
|
|
33
|
+
- (err)
|
|
34
|
+
python:
|
|
35
|
+
- key: delete_organization_domain
|
|
36
|
+
id: delete_organization_domain
|
|
37
|
+
url: /reference/domain-verification/delete
|
|
38
|
+
title: organization_domains.delete_organization_domain()
|
|
39
|
+
parameters:
|
|
40
|
+
- key: organization_domain_id
|
|
41
|
+
type: str
|
|
42
|
+
description: (organization_domain.id)
|
|
43
|
+
originalPath: >-
|
|
44
|
+
.tmp-workos-clone/packages/docs/content/reference/domain-verification/delete.mdx
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## Delete an Organization Domain
|
|
48
|
+
|
|
49
|
+
Permanently deletes an organization domain. It cannot be undone.
|
|
50
|
+
|
|
51
|
+
<CodeBlock
|
|
52
|
+
title="Request"
|
|
53
|
+
file="delete-organization-domain-request"
|
|
54
|
+
referenceId="delete_organization_domain"
|
|
55
|
+
/>
|