--- title: API Reference links: - title: Overview links: - title: Getting started url: /reference - title: Client libraries url: /reference/client-libraries - title: Testing url: /reference/testing - title: API authentication url: /reference/api-authentication - title: Errors url: /reference/errors - title: Pagination url: /reference/pagination - title: Rate limits url: /reference/rate-limits - title: Admin Portal links: - title: Overview url: /reference/admin-portal - title: Portal Link url: /reference/admin-portal/portal-link links: - title: Generate a Portal Link url: /reference/admin-portal/portal-link/generate - title: Provider Icons url: /reference/admin-portal/provider-icons - title: Audit Logs links: - title: Overview url: /reference/audit-logs - title: Event url: /reference/audit-logs/event links: - title: Create Event url: /reference/audit-logs/event/create - title: Schema url: /reference/audit-logs/schema links: - title: Create Schema url: /reference/audit-logs/schema/create - title: List Schemas url: /reference/audit-logs/schema/list - title: List Actions url: /reference/audit-logs/schema/list-actions - title: Export url: /reference/audit-logs/export links: - title: Create Export url: /reference/audit-logs/export/create - title: Get Export url: /reference/audit-logs/export/get - title: Retention url: /reference/audit-logs/retention links: - title: Get Retention url: /reference/audit-logs/retention/get - title: Set Retention url: /reference/audit-logs/retention/set - title: Configuration url: /reference/audit-logs/configuration - title: AuthKit links: - title: Overview url: /reference/authkit - title: User url: /reference/authkit/user links: - title: Get a user url: /reference/authkit/user/get - title: Get a user by external ID url: /reference/authkit/user/get-by-external-id - title: List users url: /reference/authkit/user/list - title: Create a user url: /reference/authkit/user/create - title: Update a user url: /reference/authkit/user/update - title: Delete a user url: /reference/authkit/user/delete - title: Identity url: /reference/authkit/identity links: - title: List identities url: /reference/authkit/identity/list - title: Authentication url: /reference/authkit/authentication links: - title: Get authorization URL url: /reference/authkit/authentication/get-authorization-url links: - title: Redirect URI url: >- /reference/authkit/authentication/get-authorization-url/redirect-uri - title: PKCE url: /reference/authkit/authentication/get-authorization-url/pkce - title: Error codes url: >- /reference/authkit/authentication/get-authorization-url/error-codes - title: 'AuthKit, OAuth, SSO' url: /reference/authkit/authentication/code - title: Password url: /reference/authkit/authentication/password - title: Magic Auth url: /reference/authkit/authentication/magic-auth - title: Refresh token url: /reference/authkit/authentication/refresh-token - title: Email verification code url: /reference/authkit/authentication/email-verification - title: TOTP code url: /reference/authkit/authentication/totp - title: Organization selection url: /reference/authkit/authentication/organization-selection - title: Session cookie url: /reference/authkit/authentication/session-cookie - title: Refresh and seal session data url: /reference/authkit/authentication/refresh-and-seal-session-data - title: Session tokens url: /reference/authkit/session-tokens links: - title: JWKS url: /reference/authkit/session-tokens/jwks - title: Access token url: /reference/authkit/session-tokens/access-token - title: Refresh token url: /reference/authkit/session-tokens/refresh-token - title: Session url: /reference/authkit/session links: - title: List sessions url: /reference/authkit/session/list - title: Revoke session url: /reference/authkit/session/revoke - title: Session helpers url: /reference/authkit/session-helpers links: - title: Load sealed session url: /reference/authkit/session-helpers/load-sealed-session - title: Authenticate url: /reference/authkit/session-helpers/authenticate - title: Refresh url: /reference/authkit/session-helpers/refresh - title: Get log out URL url: /reference/authkit/session-helpers/get-logout-url - title: Authentication errors url: /reference/authkit/authentication-errors links: - title: Email verification url: >- /reference/authkit/authentication-errors/email-verification-required-error - title: MFA enrollment url: /reference/authkit/authentication-errors/mfa-enrollment-error - title: MFA challenge url: /reference/authkit/authentication-errors/mfa-challenge-error - title: Organization selection url: >- /reference/authkit/authentication-errors/organization-selection-error - title: SSO required url: /reference/authkit/authentication-errors/sso-required-error - title: Organization authentication required url: >- /reference/authkit/authentication-errors/organization-authentication-required-error - title: Magic Auth url: /reference/authkit/magic-auth links: - title: Get Magic Auth code details url: /reference/authkit/magic-auth/get - title: Create a Magic Auth code url: /reference/authkit/magic-auth/create - title: Multi-Factor Auth url: /reference/authkit/mfa links: - title: Authentication factor url: /reference/authkit/mfa/authentication-factor - title: Authentication challenge url: /reference/authkit/mfa/authentication-challenge - title: Enroll an auth factor url: /reference/authkit/mfa/enroll-auth-factor - title: List auth factors url: /reference/authkit/mfa/list-auth-factors - title: Email verification url: /reference/authkit/email-verification links: - title: Get an email verification code url: /reference/authkit/email-verification/get - title: Password reset url: /reference/authkit/password-reset links: - title: Get a password reset token url: /reference/authkit/password-reset/get - title: Create a password reset token url: /reference/authkit/password-reset/create - title: Reset password url: /reference/authkit/password-reset/reset-password - title: Organization membership url: /reference/authkit/organization-membership links: - title: Get membership url: /reference/authkit/organization-membership/get - title: List memberships url: /reference/authkit/organization-membership/list - title: Create membership url: /reference/authkit/organization-membership/create - title: Update membership url: /reference/authkit/organization-membership/update - title: Delete membership url: /reference/authkit/organization-membership/delete - title: Deactivate membership url: /reference/authkit/organization-membership/deactivate - title: Reactivate membership url: /reference/authkit/organization-membership/reactivate - title: Invitation url: /reference/authkit/invitation links: - title: Get an invitation url: /reference/authkit/invitation/get - title: Find an invitation by token url: /reference/authkit/invitation/find-by-token - title: List invitations url: /reference/authkit/invitation/list - title: Send an invitation url: /reference/authkit/invitation/send - title: Resend an invitation url: /reference/authkit/invitation/resend - title: Accept an invitation url: /reference/authkit/invitation/accept - title: Revoke an invitation url: /reference/authkit/invitation/revoke - title: Logout url: /reference/authkit/logout links: - title: Get logout URL url: /reference/authkit/logout/get-logout-url - title: Get logout URL from session cookie url: /reference/authkit/logout/get-logout-url-from-session-cookie - title: CLI Auth url: /reference/authkit/cli-auth links: - title: Get device authorization URL url: /reference/authkit/cli-auth/device-authorization - title: Device code url: /reference/authkit/cli-auth/device-code links: - title: Error codes url: /reference/authkit/cli-auth/device-code/error-codes - title: API Keys url: /reference/authkit/api-keys links: - title: List organization API keys url: /reference/authkit/api-keys/list-for-organization - title: Create organization API key url: /reference/authkit/api-keys/create-for-organization - title: Delete API key url: /reference/authkit/api-keys/delete - title: Validate API key url: /reference/authkit/api-keys/validate - title: Directory Sync links: - title: Overview url: /reference/directory-sync - title: Directory url: /reference/directory-sync/directory links: - title: Get a Directory url: /reference/directory-sync/directory/get - title: List Directories url: /reference/directory-sync/directory/list - title: Delete a Directory url: /reference/directory-sync/directory/delete - title: Directory User url: /reference/directory-sync/directory-user links: - title: Get a Directory User url: /reference/directory-sync/directory-user/get - title: List Directory Users url: /reference/directory-sync/directory-user/list - title: Directory Group url: /reference/directory-sync/directory-group links: - title: Get a Directory Group url: /reference/directory-sync/directory-group/get - title: List Directory Groups url: /reference/directory-sync/directory-group/list - title: Domain Verification links: - title: Organization Domain url: /reference/domain-verification links: - title: Get url: /reference/domain-verification/get - title: Create url: /reference/domain-verification/create - title: Verify url: /reference/domain-verification/verify - title: Delete url: /reference/domain-verification/delete - title: Events links: - title: Event url: /reference/events links: - title: List events url: /reference/events/list - title: Feature Flags links: - title: Overview url: /reference/feature-flags - title: Flag url: /reference/feature-flags/flag links: - title: Get a feature flag url: /reference/feature-flags/flag/get - title: List feature flags url: /reference/feature-flags/flag/list - title: Enable flag url: /reference/feature-flags/flag/enable - title: Disable flag url: /reference/feature-flags/flag/disable - title: Targeting url: /reference/feature-flags/targeting links: - title: List flags for an organization url: /reference/feature-flags/targeting/list-for-organization - title: List flags for a user url: /reference/feature-flags/targeting/list-for-user - title: Add flag target url: /reference/feature-flags/targeting/add - title: Remove flag target url: /reference/feature-flags/targeting/remove - title: Multi-Factor Auth links: - title: Overview url: /reference/mfa - title: Factor url: /reference/mfa/factor links: - title: Enroll Factor url: /reference/mfa/factor/enroll - title: Get Factor url: /reference/mfa/factor/get - title: Delete Factor url: /reference/mfa/factor/delete - title: Challenge url: /reference/mfa/challenge links: - title: Create Challenge url: /reference/mfa/challenge/create - title: Verify Challenge url: /reference/mfa/challenge/verify - title: Organizations links: - title: Organization url: /reference/organization links: - title: Get an Organization url: /reference/organization/get - title: Get an Organization by External ID url: /reference/organization/get-by-external-id - title: List Organizations url: /reference/organization/list - title: Create an Organization url: /reference/organization/create - title: Update an Organization url: /reference/organization/update - title: Delete an Organization url: /reference/organization/delete - title: Pipes links: - title: Overview url: /reference/pipes - title: Provider url: /reference/pipes/provider links: - title: List providers url: /reference/pipes/provider/list - title: Connected Account url: /reference/pipes/connected-account links: - title: Get authorization URL url: /reference/pipes/connected-account/get-authorize-url - title: Get a connected account url: /reference/pipes/connected-account/get - title: Delete a connected account url: /reference/pipes/connected-account/delete - title: Access Token url: /reference/pipes/access-token links: - title: Get an access token url: /reference/pipes/access-token/get - title: Radar links: - title: Overview url: /reference/radar - title: Attempts url: /reference/radar/attempts links: - title: Create attempt url: /reference/radar/attempts/create - title: Update attempt url: /reference/radar/attempts/update - title: Lists url: /reference/radar/lists links: - title: Add entry url: /reference/radar/lists/update - title: Remove entry url: /reference/radar/lists/delete - title: Roles featureFlag: rbac-api-docs links: - title: Overview url: /reference/roles - title: Environment Role url: /reference/roles/role links: - title: List roles url: /reference/roles/role/list - title: Create a role url: /reference/roles/role/create - title: Get a role url: /reference/roles/role/get - title: Update a role url: /reference/roles/role/update - title: Set permissions url: /reference/roles/role/set-permissions - title: Add a permission url: /reference/roles/role/add-permission - title: Organization Role url: /reference/roles/organization-role links: - title: List roles url: /reference/roles/organization-role/list - title: Create a role url: /reference/roles/organization-role/create - title: Get a role url: /reference/roles/organization-role/get - title: Update a role url: /reference/roles/organization-role/update - title: Delete a role url: /reference/roles/organization-role/delete - title: Set permissions url: /reference/roles/organization-role/set-permissions - title: Add a permission url: /reference/roles/organization-role/add-permission - title: Remove a permission url: /reference/roles/organization-role/remove-permission - title: Permissions featureFlag: rbac-api-docs links: - title: Permission url: /reference/roles/permission links: - title: List permissions url: /reference/roles/permission/list - title: Create a permission url: /reference/roles/permission/create - title: Get a permission url: /reference/roles/permission/get - title: Update a permission url: /reference/roles/permission/update - title: Delete a permission url: /reference/roles/permission/delete - title: FGA links: - title: Overview url: /reference/fga - title: Resource url: /reference/fga/resource links: - title: List resources url: /reference/fga/resource/list - title: Create a resource url: /reference/fga/resource/create - title: Get a resource url: /reference/fga/resource/get - title: Get a resource by external ID url: /reference/fga/resource/get-by-external-id - title: Update a resource url: /reference/fga/resource/update - title: Update a resource by external ID url: /reference/fga/resource/update-by-external-id - title: Delete a resource url: /reference/fga/resource/delete - title: Delete a resource by external ID url: /reference/fga/resource/delete-by-external-id - title: Role Assignment url: /reference/fga/role-assignment links: - title: List role assignments url: /reference/fga/role-assignment/list - title: Assign a role url: /reference/fga/role-assignment/create - title: Remove a role assignment url: /reference/fga/role-assignment/delete - title: Remove a role assignment by ID url: /reference/fga/role-assignment/delete-by-id - title: Access Checks url: /reference/fga/access-check links: - title: Check authorization url: /reference/fga/access-check/check - title: List resources for membership url: /reference/fga/access-check/list-resources - title: List memberships for resource url: /reference/fga/access-check/list-memberships - title: List memberships by external ID url: /reference/fga/access-check/list-memberships-by-external-id - title: Single Sign-On links: - title: Overview url: /reference/sso - title: Get authorization URL url: /reference/sso/get-authorization-url links: - title: Redirect URI url: /reference/sso/get-authorization-url/redirect-uri - title: Error codes url: /reference/sso/get-authorization-url/error-codes - title: Profile url: /reference/sso/profile links: - title: Get a Profile and Token url: /reference/sso/profile/get-profile-and-token - title: Get a User Profile url: /reference/sso/profile/get-user-profile - title: Connection url: /reference/sso/connection links: - title: Get a Connection url: /reference/sso/connection/get - title: List Connections url: /reference/sso/connection/list - title: Delete a Connection url: /reference/sso/connection/delete - title: Logout url: /reference/sso/logout links: - title: Logout Authorize url: /reference/sso/logout/authorize - title: Logout Redirect url: /reference/sso/logout/redirect - title: Vault links: - title: Overview url: /reference/vault - title: Encrypted Object url: /reference/vault/object links: - title: Create an object url: /reference/vault/object/create - title: Get an object url: /reference/vault/object/get - title: Get an object by name url: /reference/vault/object/get-by-name - title: Update an object url: /reference/vault/object/update - title: Retrieve metadata url: /reference/vault/object/metadata - title: List objects url: /reference/vault/object/list - title: Delete an object url: /reference/vault/object/delete - title: Object Versions url: /reference/vault/object/version links: - title: List object versions url: /reference/vault/object/versions - title: Encryption Key Management url: /reference/vault/key links: - title: Create a data key url: /reference/vault/key/create-data-key - title: Decrypt a data key url: /reference/vault/key/decrypt-data-key - title: Encrypt data url: /reference/vault/key/encrypt-data - title: Decrypt data url: /reference/vault/key/decrypt-data - title: Widgets links: - title: Widget url: /reference/widgets links: - title: Get Token url: /reference/widgets/get-token - title: WorkOS Connect links: - title: Overview url: /reference/workos-connect - title: Authorize url: /reference/workos-connect/authorize - title: Token url: /reference/workos-connect/token links: - title: Authorization code grant url: /reference/workos-connect/token/authorization-code-grant links: - title: Access token url: >- /reference/workos-connect/token/authorization-code-grant/access-token - title: ID token url: >- /reference/workos-connect/token/authorization-code-grant/id-token - title: Refresh token grant url: /reference/workos-connect/token/refresh-token-grant - title: Client credentials grant url: /reference/workos-connect/token/client-credentials-grant links: - title: Access token url: >- /reference/workos-connect/token/client-credentials-grant/access-token - title: Token introspection url: /reference/workos-connect/introspection - title: User information url: /reference/workos-connect/userinfo - title: Metadata url: /reference/workos-connect/metadata links: - title: OpenID Configuration url: /reference/workos-connect/metadata/openid-configuration - title: OAuth Authorization Server url: /reference/workos-connect/metadata/oauth-authorization-server - title: CLI Auth url: /reference/workos-connect/cli-auth links: - title: Authorize device url: /reference/workos-connect/cli-auth/authorize-device - title: Device code grant url: /reference/workos-connect/cli-auth/device-code-grant - title: Standalone url: /reference/workos-connect/standalone links: - title: Complete url: /reference/workos-connect/standalone/complete - title: User Consent Options url: /reference/workos-connect/standalone/user-consent-options - title: Applications url: /reference/workos-connect/applications links: - title: OAuth Applications url: /reference/workos-connect/applications/oauth - title: M2M Applications url: /reference/workos-connect/applications/m2m - title: Get a Connect Application url: /reference/workos-connect/applications/get - title: List Connect Applications url: /reference/workos-connect/applications/list - title: Create a Connect Application url: /reference/workos-connect/applications/create - title: Update a Connect Application url: /reference/workos-connect/applications/update - title: Delete a Connect Application url: /reference/workos-connect/applications/delete - title: Client Secrets url: /reference/workos-connect/applications/client-secrets links: - title: List Client Secrets url: /reference/workos-connect/applications/client-secrets/list - title: Create a Client Secret url: /reference/workos-connect/applications/client-secrets/create - title: Delete a Client Secret url: /reference/workos-connect/applications/client-secrets/delete - title: Deprecated APIs excludeFromSearch: true links: - title: Magic Link url: /reference/magic-link links: - title: Passwordless Session url: /reference/magic-link/passwordless-session - title: Create Passwordless Session url: /reference/magic-link/passwordless-session/create - title: Email a Magic Link url: /reference/magic-link/passwordless-session/send-email originalPath: .tmp-workos-clone/packages/docs/content/reference/_navigation.mdx ---