Core Driver Interface

This is the API exposed by the SuperTokens Core. To be consumed by your backend only.

appid-{appId} and {tenantId} in all the APIs are optional. Their default values are appid-public and public respectively.

Those that do not have {tenantId} in the path will enforce that the API is called from public tenant only.

Account Linking Recipe

• GET
  Check primary user creation possibility/appid-{appId}/recipe/accountlinking/user/primary/check
• GET
  Check account linking possibility/appid-{appId}/recipe/accountlinking/user/link/check
• POST
  Create primary user account/appid-{appId}/recipe/accountlinking/user/primary
• POST
  Link user accounts together/appid-{appId}/recipe/accountlinking/user/link
• POST
  Unlink user accounts/appid-{appId}/recipe/accountlinking/user/unlink

Totp Recipe

• PUT
  Update TOTP device name/appid-{appId}/recipe/totp/device
• POST
  Add TOTP device for user/appid-{appId}/recipe/totp/device
• GET
  List user TOTP devices/appid-{appId}/recipe/totp/device/list
• POST
  Import existing TOTP device/recipe/totp/device/import
• POST
  Remove TOTP device/appid-{appId}/recipe/totp/device/remove
• POST
  Verify TOTP code/appid-{appId}/{tenantId}/recipe/totp/verify
• POST
  Verify TOTP device/appid-{appId}/{tenantId}/recipe/totp/device/verify

UserIdMapping Recipe

• GET
  Get user ID mapping/appid-{appId}/recipe/userid/map
• POST
  Create user ID mapping/appid-{appId}/recipe/userid/map
• POST
  Remove user ID mapping/appid-{appId}/recipe/userid/map/remove
• PUT
  Update external user info/appid-{appId}/recipe/userid/external-user-id-info

Passwordless Recipe

• POST
  Check passwordless code/appid-{appId}/{tenantId}/recipe/signinup/code/check
• POST
  Consume passwordless code/appid-{appId}/{tenantId}/recipe/signinup/code/consume
• POST
  Start passwordless sign in/appid-{appId}/{tenantId}/recipe/signinup/code
• POST
  Revoke passwordless code/appid-{appId}/{tenantId}/recipe/signinup/code/remove
• GET
  List passwordless codes/appid-{appId}/{tenantId}/recipe/signinup/codes
• POST
  Revoke all user codes/appid-{appId}/{tenantId}/recipe/signinup/codes/remove
• GET
  Get passwordless user/appid-{appId}/{tenantId}/recipe/user ⠀
• PUT
  Update passwordless user/appid-{appId}/{tenantId}/recipe/user ⠀

EmailPassword Recipe

• POST
  Sign in user/appid-{appId}/{tenantId}/recipe/signin
• POST
  Sign up user/appid-{appId}/{tenantId}/recipe/signup
• GET
  Get email password user/appid-{appId}/{tenantId}/recipe/user
• PUT
  Update user info/appid-{appId}/{tenantId}/recipe/user
• POST
  Generate password reset token/appid-{appId}/{tenantId}/recipe/user/password/reset/token
• POST
  Reset user password/appid-{appId}/{tenantId}/recipe/user/password/reset
• POST
  Import user with hash/appid-{appId}/{tenantId}/recipe/user/passwordhash/import
• POST
  Consume password reset token/appid-{appId}/{tenantId}/recipe/user/password/reset/token/consume

ThirdParty Recipe

• POST
  Sign in/up third party user/appid-{appId}/{tenantId}/recipe/signinup
• GET
  Get third party user/appid-{appId}/{tenantId}/recipe/user⠀
• GET
  Get users by email/appid-{appId}/{tenantId}/recipe/users/by-email

EmailVerification Recipe

• POST
  Generate email verification token/appid-{appId}/{tenantId}/recipe/user/email/verify/token
• POST
  Remove email verification tokens/appid-{appId}/{tenantId}/recipe/user/email/verify/token/remove
• POST
  Verify email/appid-{appId}/{tenantId}/recipe/user/email/verify
• GET
  Check email verification/appid-{appId}/recipe/user/email/verify
• POST
  Unverify email/appid-{appId}/recipe/user/email/verify/remove

User Metadata Recipe

• GET
  Get user metadata/appid-{appId}/recipe/user/metadata
• PUT
  Update user metadata/appid-{appId}/recipe/user/metadata
• POST
  Remove user metadata/appid-{appId}/recipe/user/metadata/remove

User Roles Recipe

• PUT
  Add user role/appid-{appId}/{tenantId}/recipe/user/role
• POST
  Remove user role/appid-{appId}/{tenantId}/recipe/user/role/remove
• GET
  Get user roles/appid-{appId}/{tenantId}/recipe/user/roles
• GET
  Get users with role/appid-{appId}/{tenantId}/recipe/role/users
• PUT
  Create or update role/appid-{appId}/recipe/role
• GET
  Get role permissions/appid-{appId}/recipe/role/permissions
• POST
  Remove role permissions/appid-{appId}/recipe/role/permissions/remove
• GET
  Get permission roles/appid-{appId}/recipe/permission/roles
• POST
  Delete role/appid-{appId}/recipe/role/remove
• GET
  Get all roles/appid-{appId}/recipe/roles

Session Recipe

• POST
  Create new session/appid-{appId}/{tenantId}/recipe/session
• GET
  Get session info/appid-{appId}/recipe/session
• POST
  Delete session/appid-{appId}/{tenantId}/recipe/session/remove
• POST
  Verify session/appid-{appId}/recipe/session/verify
• POST
  Refresh session/appid-{appId}/recipe/session/refresh
• GET
  Get user session handles/appid-{appId}/{tenantId}/recipe/session/user
• POST
  Regenerate session/appid-{appId}/recipe/session/regenerate
• GET
  Get session data/appid-{appId}/recipe/session/data
• PUT
  Update session data/appid-{appId}/recipe/session/data
• GET
  Get JWT data/appid-{appId}/{tenantId}/recipe/jwt/data
• PUT
  Update JWT data/appid-{appId}/{tenantId}/recipe/jwt/data

JWT Recipe

• POST
  Create signed JWT/appid-{appId}/recipe/jwt
• GET
  Get JWT keys/appid-{appId}/recipe/jwt/jwks

Core

• GET
  Get well-known JWT keys/appid-{appId}/.well-known/jwks.json
• GET
  Get API version/appid-{appId}/apiversion
• GET
  Get config file path/config
• GET
  Get hello message on root path/appid-{appId}/{tenantId}/
• GET
  Get hello message/appid-{appId}/{tenantId}/hello
• PUT
  Put hello message/appid-{appId}/{tenantId}/hello
• POST
  Post hello message/appid-{appId}/{tenantId}/hello
• DELETE
  Delete hello message/appid-{appId}/{tenantId}/hello
• GET
  Get telemetry ID/appid-{appId}/telemetry
• GET
  Get users count/appid-{appId}/{tenantId}/users/count
• GET
  Get active users count/appid-{appId}/users/count/active
• GET
  Get users/appid-{appId}/{tenantId}/users
• POST
  Delete user/appid-{appId}/user/remove
• GET
  Get search tags/appid-{appId}/user/search/tags
• GET
  Get enterprise features/appid-{appId}/ee/featureflag
• GET
  Get license key/appid-{appId}/ee/license
• PUT
  Set license key/appid-{appId}/ee/license
• DELETE
  Delete license key/appid-{appId}/ee/license
• GET
  Get user ID/appid-{appId}/user/id
• GET
  Get users by account info/appid-{appId}/{tenantId}/users/by-accountinfo
• GET
  Get requests stats/appid-{appId}/requests/stats

Dashboard Recipe

• PUT
  Update dashboard user/appid-{appId}/recipe/dashboard/user
• POST
  Create dashboard user/appid-{appId}/recipe/dashboard/user
• DELETE
  Delete dashboard user/appid-{appId}/recipe/dashboard/user
• GET
  Get all dashboard users/appid-{appId}/recipe/dashboard/users
• POST
  Verify dashboard user session/appid-{appId}/recipe/dashboard/session/verify
• DELETE
  Revoke dashboard user session/appid-{appId}/recipe/dashboard/session
• POST
  Sign in dashboard user/appid-{appId}/recipe/dashboard/signin
• GET
  Get all sessions for dashboard user/appid-{appId}/recipe/dashboard/user/sessions
• GET
  Get the core config/appid-{appId}/{tenantId}/recipe/dashboard/tenant/core-config

Multitenancy Recipe

• PUT
  Upsert connection URI domain/recipe/multitenancy/connectionuridomain
• PUT
  Upsert connection uri domain/recipe/multitenancy/connectionuridomain/v2
• POST
  Remove connection uri domain/recipe/multitenancy/connectionuridomain/remove
• GET
  List connection uri domains (deprecated)/recipe/multitenancy/connectionuridomain/list
• GET
  List connection uri domains/recipe/multitenancy/connectionuridomain/list/v2
• PUT
  Upsert app (deprecated)/recipe/multitenancy/app
• PUT
  Upsert app/recipe/multitenancy/app/v2
• POST
  Delete app/recipe/multitenancy/app/remove
• GET
  List apps (deprecated)/recipe/multitenancy/app/list
• GET
  List apps/recipe/multitenancy/app/list/v2
• PUT
  Upsert tenant (deprecated)/appid-{appId}/recipe/multitenancy/tenant
• PUT
  Upsert tenant/appid-{appId}/recipe/multitenancy/tenant/v2
• GET
  Get tenant configuration (deprecated)/appid-{appId}/{tenantId}/recipe/multitenancy/tenant
• GET
  Get tenant configuration/appid-{appId}/{tenantId}/recipe/multitenancy/tenant/v2
• POST
  Delete a tenant/appid-{appId}/recipe/multitenancy/tenant/remove
• GET
  List tenants in an app (deprecated)/appid-{appId}/recipe/multitenancy/tenant/list
• GET
  List tenants in an app/appid-{appId}/recipe/multitenancy/tenant/list/v2
• PUT
  Upsert ThirdParty Provider configuration/appid-{appId}/{tenantId}/recipe/multitenancy/config/thirdparty
• POST
  Delete ThirdParty Provider configuration/appid-{appId}/{tenantId}/recipe/multitenancy/config/thirdparty/remove
• POST
  Add user tenant association/appid-{appId}/{tenantId}/recipe/multitenancy/tenant/user
• POST
  Remove user tenant association/appid-{appId}/{tenantId}/recipe/multitenancy/tenant/user/remove

OAuth2Provider Recipe

• GET
  Get OAuth2 Client/appid-{appId}/recipe/oauth/clients
• PUT
  Update OAuth2 Client/appid-{appId}/recipe/oauth/clients
• POST
  Create OAuth2 Client/appid-{appId}/recipe/oauth/clients
• GET
  List OAuth2 Clients/appid-{appId}/recipe/oauth/clients/list
• POST
  Remove OAuth2 Client/appid-{appId}/recipe/oauth/clients/remove
• GET
  Get OAuth2 Consent Request/appid-{appId}/recipe/oauth/auth/requests/consent
• PUT
  Accept OAuth2 Consent Request/appid-{appId}/recipe/oauth/auth/requests/consent/accept
• PUT
  Reject OAuth2 Consent Request/appid-{appId}/recipe/oauth/auth/requests/consent/reject
• GET
  Get OAuth2 Login Request/appid-{appId}/recipe/oauth/auth/requests/login
• PUT
  Accept OAuth2 Login Request/appid-{appId}/recipe/oauth/auth/requests/login/accept
• PUT
  Reject OAuth2 Login Request/appid-{appId}/recipe/oauth/auth/requests/login/reject
• PUT
  Accept OAuth2 Logout Request/appid-{appId}/recipe/oauth/auth/requests/logout/accept
• PUT
  Reject OAuth2 Logout Request/appid-{appId}/recipe/oauth/auth/requests/logout/reject
• POST
  Revoke OAuth2 Session/appid-{appId}/recipe/oauth/session/revoke
• POST
  Revoke OAuth2 Token/appid-{appId}/recipe/oauth/token/revoke
• POST
  Revoke OAuth2 tokens for a client/appid-{appId}/recipe/oauth/tokens/revoke
• GET
  Get OAuth2 Auth/appid-{appId}/recipe/oauth/auth
• POST
  Get OAuth2 Token/appid-{appId}/recipe/oauth/token
• GET
  Get OAuth2 Sessions Logout/appid-{appId}/recipe/oauth/sessions/logout
• POST
  Introspect OAuth2 Token/appid-{appId}/recipe/oauth/introspect

Bulk Import

• GET
  List bulk import users/appid-{appId}/bulk-import/users
• POST
  Add bulk import users/appid-{appId}/bulk-import/users
• POST
  Delete bulk import users/appid-{appId}/bulk-import/users/remove
• GET
  Count bulk import users/appid-{appId}/bulk-import/users/count
• POST
  Import one user directly/appid-{appId}/bulk-import/import

WebAuthn Recipe

• GET
  Get WebAuthn credential/appid-{appId}/{tenantId}/recipe/webauthn/user/credential
• GET
  List WebAuthn credentials/appid-{appId}/{tenantId}/recipe/webauthn/user/credential/list
• GET
  Get WebAuthn options/appid-{appId}/{tenantId}/recipe/webauthn/options
• GET
  Recover WebAuthn user/appid-{appId}/{tenantId}/recipe/webauthn/user/recover
• POST
  Generate registration options/appid-{appId}/{tenantId}/recipe/webauthn/options/register
• POST
  Generate authentication options/appid-{appId}/{tenantId}/recipe/webauthn/options/signin
• POST
  Register WebAuthn credential/appid-{appId}/{tenantId}/recipe/webauthn/user/credential/register
• POST
  Sign up WebAuthn user/appid-{appId}/{tenantId}/recipe/webauthn/signup
• POST
  Sign in WebAuthn user/appid-{appId}/{tenantId}/recipe/webauthn/signin
• POST
  Generate recovery token/appid-{appId}/{tenantId}/recipe/webauthn/user/recover/token
• POST
  Consume recovery token/appid-{appId}/{tenantId}/recipe/webauthn/user/recover/token/consume
• PUT
  Update email/appid-{appId}/{tenantId}/recipe/webauthn/user/email
• DELETE
  Remove WebAuthn credential/appid-{appId}/{tenantId}/recipe/webauthn/user/credential/remove
• DELETE
  Remove WebAuthn options/appid-{appId}/{tenantId}/recipe/webauthn/options/remove