supertokens-node
Version:
NodeJS driver for SuperTokens core
1,653 lines (1,651 loc) • 420 kB
TypeScript
// @ts-nocheck
/**
* This file was auto-generated by openapi-typescript.
* Do not make direct changes to the file.
*/
export interface paths {
"/recipe/accountlinking/user/primary/check": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Check if primary user can be created for given user id */
get: operations["canCreatePrimaryUser"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/accountlinking/user/link/check": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Check if accounts can be linked for given primary and recipe user id */
get: operations["canLinkAccounts"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/accountlinking/user/primary": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Create a primary user for given user id */
post: operations["createPrimaryUser"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/accountlinking/user/link": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Link accounts for given primary and recipe user id */
post: operations["linkAccounts"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/accountlinking/user/unlink": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Unlink accounts for given recipe user id */
post: operations["unlinkAccounts"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/totp/device": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** @description Update the name of a TOTP device for a user. */
put: operations["updateTotpDeviceName"];
/** @description Add a TOTP device for a user and enable TOTP if not already enabled. */
post: operations["createTotpDevice"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/totp/device/list": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Retrieve a list of TOTP devices for a user. */
get: operations["getTotpDevices"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/totp/device/import": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Add a TOTP device for a user and enable TOTP if not already enabled. */
post: operations["importTotpDevice"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/totp/device/remove": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Remove a TOTP device for a user. If all devices are removed, TOTP is disabled for the user. */
post: operations["removeTotpDevice"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/totp/verify": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Check if a TOTP code is valid against any of the TOTP devices for a user. */
post: operations["verifyTotpCode"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/totp/device/verify": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Mark a TOTP device as verified if the given TOTP code is valid for that device. */
post: operations["verifyTotpDevice"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/userid/map": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Retrieve a UserIdMapping */
get: operations["userIdMappingGetMapping"];
put?: never;
/** @description Create a mapping between a SuperTokens userId and an external userId. */
post: operations["userIdMappingCreateMapping"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/userid/map/remove": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Delete a mapping between a SuperTokens userId and an external userId. */
post: operations["userIdMappingRemoveMapping"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/userid/external-user-id-info": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** @description Update or delete externalUserIdInfo */
put: operations["userIdMappingUpateExternalUserIdInfo"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/signinup/code/check": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Tries to check if the passed userInputCode+deviceId combo or the linkCode is valid */
post: operations["passwordlessCheckCode"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/signinup/code/consume": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Tries to consume the passed userInputCode+deviceId combo or the linkCode to sign the user in */
post: operations["passwordlessTryUseCode"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/signinup/code": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* @description Starts a sign in process by requesting a linkCode and a deviceId + userInputCode combination the user can use to sign in.
* Passing the optional deviceId signifies a resend code flow.
*/
post: operations["passwordlessStartSignIn"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/signinup/code/remove": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Revokes a code by id */
post: operations["passwordlessRevokeCode"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/signinup/codes": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Lists all active passwordless codes of the user */
get: operations["passwordlessListCodes"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/signinup/codes/remove": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Revokes all codes issued for the user */
post: operations["passwordlessRevokeAllCodesOfUser"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/user\u2800\u2800": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* @deprecated
* @description Get a user's information.
*
* API is tenant specific if querying by email or phone number.
* If querying by userId, tenantId will be ignored.
*
* Note that there is an invisible character at the end of the path, this was to avoid a conflict with the OpenAPI spec.
*/
get: operations["passwordlessGetUser"];
/**
* @description Update a user's information.
* If the email or phoneNumber is set to null the previous value will be deleted. If they are not set (i.e., undefined/missing from the request), they are left as-is.
*/
put: operations["passwordlessPutUser"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/signin": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Signin a user with email ID and password */
post: operations["emailPasswordSignin"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/signup": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Signup a user with email ID and password */
post: operations["emailPasswordSignup"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/user": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* @deprecated
* @description Get a user's information
*
* API is tenant specific if querying by email.
* If querying by userId, tenantId will be ignored.
*/
get: operations["emailPasswordGetUser"];
/** @description Update a user's information */
put: operations["emailPasswordPutUser"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/user/password/reset/token": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Generate a new reset password token for this user */
post: operations["emailPasswordGetPasswordResetToken"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/user/password/reset": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* @deprecated
* @description Reset a password using password reset token
*/
post: operations["emailPasswordGetPasswordReset"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/user/passwordhash/import": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Import a user with email ID and password hash */
post: operations["userImport"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/user/password/reset/token/consume": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Consume a password reset token */
post: operations["emailPasswordResetPasswordConsumeToken"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/signinup": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Signin/up a user */
post: operations["thirdPartySigninup"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/user\u2800": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* @deprecated
* @description Get a user's information.
*
* API is tenant specific if querying by email.
* If querying by userId, tenantId will be ignored.
*
* Note that there is an invisible character at the end of the path, this was to avoid a conflict with the OpenAPI spec.
*/
get: operations["thirdPartyGetUser"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/users/by-email": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* @deprecated
* @description Get all users accounts associated with given email
*/
get: operations["thirdPartyGetUsersByEmail"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/user/email/verify/token": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Generate a new email verification token for this user */
post: operations["emailVerificationVerifyToken"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/user/email/verify/token/remove": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Remove all unused email verification tokens for this user */
post: operations["emailVerificationVerifyTokenRemove"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/user/email/verify": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Verify an email */
post: operations["emailVerificationVerify"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/user/email/verify": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Check if an email is verified */
get: operations["emailVerificationVerifyGet"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/user/email/verify/remove": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Unverify an email */
post: operations["emailVerificationVerifyRemove"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/user/metadata": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Gets the stored metadata object of the user */
get: operations["userMetadataRead"];
/**
* @description Updates the metadata object stored about the user by doing a shallow merge of the stored and the update JSONs
* and removing properties set to null on the root level of the update object. The merged object is then reserialized and stored.
*
* e.g.:
* - stored: `{ "preferences": { "theme":"dark" }, "notifications": { "email": true }, "todos": ["example"] }`
*
* - update: `{ "notifications": { "sms": true }, "todos": null }`
*
* - result: `{ "preferences": { "theme":"dark" }, "notifications": { "sms": true } }`
*/
put: operations["userMetadataUpdate"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/user/metadata/remove": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Removes the entire metadata JSON stored about the user. */
post: operations["userMetadataDelete"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/user/role": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** @description Creates a User Role mapping */
put: operations["addUserRole"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/user/role/remove": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Removes a User Role mapping */
post: operations["removeUserRole"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/user/roles": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Retrive the roles associated with the user. */
get: operations["getUserRoles"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/role/users": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Retrive the users associated with the role. */
get: operations["getRoleUsers"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/role": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** @description Creates a role with permissions, can also be used to add permissions to a role */
put: operations["putRole"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/role/permissions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Retrive the permissions associated with a role */
get: operations["getRolePermissions"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/role/permissions/remove": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Removes permissions mapped to a role, if no permissions are passed all permissions mapped to the role are removed */
post: operations["removeRolePermissions"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/permission/roles": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Retrive the roles associated with the permission */
get: operations["getPermissionRoles"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/role/remove": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Deletes a role */
post: operations["removeRole"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/roles": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Retrive all created roles */
get: operations["getRoles"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/session": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Create a new Session */
post: operations["createNewSession"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/session": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Get user and session information for a given session handle */
get: operations["getSessionInfo"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/session/remove": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* @description Delete a sesion
*
* If revoking session by `userId`, the sessions are cleared across all tenants by default.
*
* Note: If `revokeAcrossAllTenants` is set to `true`, this API can only be called from `public` tenant.
*/
post: operations["deleteSession"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/session/remove": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* @description Delete a sesion
*
* If revoking session by `userId`, the sessions are cleared across all tenants by default.
*
* Note: If `revokeAcrossAllTenants` is set to `true`, this API can only be called from `public` tenant.
*/
post: operations["deleteSession"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/session/verify": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Verify a Session */
post: operations["verifySession"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/session/refresh": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Refresh a Session */
post: operations["refreshSession"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/recipe/session/user": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* @description Get session handles for a user
*
* By default, the session handles are fetched across all tenants. Set `fetchAcrossAllTenants` to `false` to get sessionHandles for the user for a particular tenant.
*
* Note: If `fetchAcrossAllTenants` is set to `true`, this API can only be called from `public` tenant.
*/
get: operations["getUserSessionHandles"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/session/user": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* @description Get session handles for a user
*
* By default, the session handles are fetched across all tenants. Set `fetchAcrossAllTenants` to `false` to get sessionHandles for the user for a particular tenant.
*
* Note: If `fetchAcrossAllTenants` is set to `true`, this API can only be called from `public` tenant.
*/
get: operations["getUserSessionHandles"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/session/regenerate": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Regenerate a session */
post: operations["regenerateSession"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/session/data": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* @deprecated
* @description Get session data
*/
get: operations["getSessionData"];
/** @description Change session data */
put: operations["putSessionData"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/jwt": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Create a signed JWT */
post: operations["createSignedJWT"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/jwt/jwks": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* @deprecated
* @description Retrieve JWKs for JWT verification, containing both static and dynamic keys.
*/
get: {
parameters: {
query?: never;
header?: {
/** @example jwt */
rid?: components["parameters"]["jwtRID"];
/** @example ajs30Nlbs0DjvsdFIne934n8NVee5n */
Authorization?: components["parameters"]["api-key"];
/**
* @description X.Y of the X.Y.Z CDI version.
* @example 5.4
*/
"cdi-version"?: components["parameters"]["cdi-version"];
};
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Retrieve JWKs for JWT verification, containing both static and dynamic keys. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
/** @enum {string} */
status: "OK";
keys?: components["schemas"]["jwk"][];
};
};
};
400: components["responses"]["400"];
404: components["responses"]["404"];
500: components["responses"]["500"];
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/.well-known/jwks.json": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Retrieve JWKs for JWT verification, containing both static and dynamic keys. */
get: {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
requestBody?: never;
responses: {
/** @description Retrieve JWKs for JWT verification, containing both static and dynamic keys. */
200: {
headers: {
[name: string]: unknown;
};
content: {
"application/json": {
keys: components["schemas"]["jwk"][];
};
};
};
400: components["responses"]["400"];
404: components["responses"]["404"];
500: components["responses"]["500"];
};
};
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/jwt/data": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* @deprecated
* @description Get JWT data for a session
*/
get: operations["getJWTData"];
/** @description Change JWT data for a session */
put: operations["putJWTData"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/dashboard/user": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** @description Update a user's email or password */
put: operations["updateDashboardUser"];
/** @description Create a dashboard user */
post: operations["createDashboardUser"];
/** @description Delete a dashboard user with their userId or email */
delete: operations["deleteDashboardUser"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/dashboard/users": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Get a list of call the dashboard users */
get: operations["getAllDashboardUsers"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/dashboard/session/verify": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Verify a Dashboard user's sessionId */
post: operations["verifyDashboardUserSession"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/dashboard/session": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** @description Revoke a Dashboard user's session */
delete: operations["RevokeDashboardUsersSession"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/dashboard/signin": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Signin a Dashboard user */
post: operations["signInDashboardUser"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/dashboard/user/sessions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Get a list of the sessions for the dashboard user */
get: operations["getAllSessionsForDashboardUser"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/apiversion": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Get a list of compatible CDI versions */
get: operations["getApiVersion"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/config": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Get path to the loaded config file */
get: operations["getConfig"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Return a simple hello message */
get: operations["getHelloOnRootPath"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/hello": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Return a simple hello message */
get: operations["getHello"];
/** @description Return a simple hello message */
put: operations["putHello"];
/** @description Return a simple hello message */
post: operations["postHello"];
/** @description Return a simple hello message */
delete: operations["deleteHello"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/telemetry": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Returns the telemetryID if it exists */
get: operations["getTelemetry"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/users/count": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* @description Get number of users.
*
* API is tenant specific if `includeAllTenants` is false.
* Else, `tenantId` is ignored.
*/
get: operations["getUsersCount"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/users/count/active": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Get number of active users. */
get: operations["getActiveUsersCount"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/users": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description User Pagination */
get: operations["getUsers"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/user/remove": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** @description Delete user */
post: operations["deleteUser"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/user/search/tags": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Retrieve available tags for search */
get: operations["getSearchTags"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/ee/featureflag": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Get a list of the enabled enterprise features */
get: operations["getFeatureFlag"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/ee/license": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Retrieve license key */
get: operations["getLicense"];
/** @description Set or sync license key */
put: operations["setLicense"];
post?: never;
/** @description Delete license key */
delete: operations["deleteLicense"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/user/id": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Get user id from email or phone number */
get: operations["getUserId"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/<tenantId>/users/by-accountinfo": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** @description Get users by email, phoneNumber or thirdParty info */
get: operations["getUsersByAccountInfo"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/requests/stats": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* @description Get requests stats for last 24 hours
*
* `averageRequestsPerSecond` and `peakRequestsPerSecond` would countain `1440` values corresponding to `now - 1440 minutes` until `now - 1 minute`.
*
* A value of `-1` would mean that there is no data for that minute.
*/
get: operations["getRequestsStats"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/multitenancy/connectionuridomain": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* @deprecated
* @description This API is deprecated. Please use the v2 version of this API. In the v2 version of the API, the login methods are no longer enabled using the `emailPasswordEnabled`, `thirdPartyEnabled` and `passwordlessEnabled` inputs. Instead, they are enabled using factorIds (such as emailpassword, otp-email, etc) specified in the `firstFactors` and `requiredSecondaryFactors` inputs. Please refer [Multitenancy Docs](https://supertokens.com/docs/multitenancy/new-tenant) to know the list of factorIds available.
*
* Note: This deprecated API still accepts those `emailPasswordEnabled`, `thirdPartyEnabled` and `passwordlessEnabled` inputs for backward compatibility.
*
* Create or update a connection uri domain.
*
* SuperTokens subscription license key is required, if not using the base connection uri domain.
*
* This request must originate from public app and public tenant on the base
* connection uri domain.
*
* If creating a new connection uri domain, only the login methods set to true will be enabled and rest will be disabled by default.
*
* `firstFactors` and `requiredSecondaryFactors` can be set to null to remove all entries in the core, or a non empty string array to be updated in the core. Setting of empty array is disallowed.
*
* Note: the create/update will fail if a login method is not enabled and a relavant factor is added to either `firstFactors` or `requiredSecondaryFactors`. For example, `emailPasswordEnabled` cannot be set to `false` if `emailpassword` is present in the `firstFactors` array.
*
* If updating an existing connection uri domain,
* 1. core will keep the existing state of login methods and only update the ones that are specified in the request body.
* 2. Core config will be merged into existing config. To delete a key in the config, use a null value
*
* Note: The core config must contain a unique connection to the storage layer, because sharing of database between 2 different connection uri domains is not allowed.
*
* Note: Updation of core config is not allowed for the default connectionUriDomain. In order to update config for the default connectionUriDomain, you must edit the config.yaml or the docker env directly.
*/
put: operations["createOrUpdateConnectionURIDomainPUT"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/recipe/multitenancy/connectionuridomain/v2": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* @description Create or update a connection uri domain.
*
* SuperTokens subscription license key is required, if not using the base connection uri domain.
*
* This request must originate from public app and public tenant on the base
* connection uri domain.
*
* The `firstFactors` can be set to following values:
*
* - `null`: When set to `null`, all the login methods will be available for the connection URI domain (public app, public tenant).
* - `[]` (empty array): No login methods will be enabled for the connection URI domain (public app, public tenant).
* - `['factor1', 'factor2', ...]` (non-empty array): The list of login methods to enable for the connection URI domain (public app, public tenant). For eg. if this is set to `['emailpassword', 'thirdparty']`, the users of the tenant will be able to login using emailpassword and third party providers.
*
* List of built-in first factors are as follows:
*
* - Email password auth: `emailpassword`
* - Social login / enterprise SSO auth: `thirdparty`
* - Passwordless:
* - With email OTP: `otp-email`
* - With SMS OTP: `otp-phone`