# Auth (*auth*) ## Overview ### Available Operations * [createAdmin](#createadmin) * [createUser](#createuser) * [login](#login) * [getOne](#getone) * [logout](#logout) * [update](#update) * [generateToken](#generatetoken) * [get](#get) * [generate2FASecret](#generate2fasecret) * [verify2faSetup](#verify2fasetup) * [verifyLogin2FA](#verifylogin2fa) * [disable2FA](#disable2fa) * [sendResetPasswordEmail](#sendresetpasswordemail) * [resetPassword](#resetpassword) * [confirmEmail](#confirmemail) ## createAdmin ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.auth.createAdmin({ email: "Margarett.Keeling@hotmail.com", password: "tugyh_JW5kT5IDW", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { authCreateAdmin } from "dokploy/funcs/authCreateAdmin.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await authCreateAdmin(dokploy, { email: "Margarett.Keeling@hotmail.com", password: "tugyh_JW5kT5IDW", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("authCreateAdmin failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AuthCreateAdminRequest](../../models/operations/authcreateadminrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## createUser ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.auth.createUser({ password: "MRqGkWGKqLanNcu", id: "", token: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { authCreateUser } from "dokploy/funcs/authCreateUser.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await authCreateUser(dokploy, { password: "MRqGkWGKqLanNcu", id: "", token: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("authCreateUser failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AuthCreateUserRequest](../../models/operations/authcreateuserrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## login ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.auth.login({ email: "Lloyd_Howe41@gmail.com", password: "NBiV2yTHHqOmb69", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { authLogin } from "dokploy/funcs/authLogin.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await authLogin(dokploy, { email: "Lloyd_Howe41@gmail.com", password: "NBiV2yTHHqOmb69", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("authLogin failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AuthLoginRequest](../../models/operations/authloginrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## getOne ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.auth.getOne(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { authGetOne } from "dokploy/funcs/authGetOne.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await authGetOne(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("authGetOne failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## logout ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.auth.logout(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { authLogout } from "dokploy/funcs/authLogout.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await authLogout(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("authLogout failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## update ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.auth.update({ email: "Larissa_Aufderhar@hotmail.com", password: "lGQCLAhWN3Y4KOT", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { authUpdate } from "dokploy/funcs/authUpdate.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await authUpdate(dokploy, { email: "Larissa_Aufderhar@hotmail.com", password: "lGQCLAhWN3Y4KOT", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("authUpdate failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AuthUpdateRequest](../../models/operations/authupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## generateToken ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.auth.generateToken(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { authGenerateToken } from "dokploy/funcs/authGenerateToken.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await authGenerateToken(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("authGenerateToken failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## get ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.auth.get({ id: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { authGet } from "dokploy/funcs/authGet.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await authGet(dokploy, { id: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("authGet failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AuthOneRequest](../../models/operations/authonerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## generate2FASecret ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.auth.generate2FASecret(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { authGenerate2FASecret } from "dokploy/funcs/authGenerate2FASecret.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await authGenerate2FASecret(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("authGenerate2FASecret failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## verify2faSetup ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.auth.verify2faSetup({ pin: "8291", secret: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { authVerify2faSetup } from "dokploy/funcs/authVerify2faSetup.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await authVerify2faSetup(dokploy, { pin: "8291", secret: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("authVerify2faSetup failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AuthVerify2FASetupRequest](../../models/operations/authverify2fasetuprequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## verifyLogin2FA ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.auth.verifyLogin2FA({ pin: "5896", id: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { authVerifyLogin2FA } from "dokploy/funcs/authVerifyLogin2FA.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await authVerifyLogin2FA(dokploy, { pin: "5896", id: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("authVerifyLogin2FA failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AuthVerifyLogin2FARequest](../../models/operations/authverifylogin2farequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## disable2FA ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.auth.disable2FA(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { authDisable2FA } from "dokploy/funcs/authDisable2FA.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await authDisable2FA(dokploy); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("authDisable2FA failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## sendResetPasswordEmail ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.auth.sendResetPasswordEmail({ email: "Rubye_Stanton63@hotmail.com", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { authSendResetPasswordEmail } from "dokploy/funcs/authSendResetPasswordEmail.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await authSendResetPasswordEmail(dokploy, { email: "Rubye_Stanton63@hotmail.com", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("authSendResetPasswordEmail failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AuthSendResetPasswordEmailRequest](../../models/operations/authsendresetpasswordemailrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## resetPassword ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.auth.resetPassword({ resetPasswordToken: "", password: "gZLRGbfCK0k8C4F", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { authResetPassword } from "dokploy/funcs/authResetPassword.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await authResetPassword(dokploy, { resetPasswordToken: "", password: "gZLRGbfCK0k8C4F", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("authResetPassword failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AuthResetPasswordRequest](../../models/operations/authresetpasswordrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* | ## confirmEmail ### Example Usage ```typescript import { Dokploy } from "dokploy"; const dokploy = new Dokploy({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const result = await dokploy.auth.confirmEmail({ confirmationToken: "", }); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { DokployCore } from "dokploy/core.js"; import { authConfirmEmail } from "dokploy/funcs/authConfirmEmail.js"; // Use `DokployCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const dokploy = new DokployCore({ authorization: process.env["DOKPLOY_AUTHORIZATION"] ?? "", }); async function run() { const res = await authConfirmEmail(dokploy, { confirmationToken: "", }); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("authConfirmEmail failed:", res.error); } } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AuthConfirmEmailRequest](../../models/operations/authconfirmemailrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[models.ErrorT](../../models/errort.md)\>** ### Errors | Error Type | Status Code | Content Type | | -------------------------- | -------------------------- | -------------------------- | | errors.DokployDefaultError | 4XX, 5XX | \*/\* |