{"data":{"id":"767807","string_id":"dx2Ipzwx","status":"1","parent_id":"0","slug":"develop-the-integration","order":"1","name":"Develop the integration","type":"1","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"","seo_keyword":"","seo_desc":"","author":"","published_time":"0","add_time":"1776241463","update_time":"1780975062","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"1","tags":[],"child":[{"id":"805087","string_id":"w2203AnC","status":"1","parent_id":"767807","slug":"api","order":"0","name":"API Mode Integration","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"API Mode Integration","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1780387635","add_time":"1780385529","update_time":"1781060474","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"3","file_type":"","auth_id":"[\"805087\", \"767807\"]","content":{"content_id":"805087","content":"
RootAuth API Mode provides a pre-packaged frontend API interface without any UI. You are free to implement login, registration, and other pages according to your own design style, and call the SDK to complete the authentication logic.<\/span><\/p>\n
<\/h2>\n

1. Preparation<\/span><\/h2>\n
Create an application in the <\/span>RootAuth Console<\/span><\/a> and copy the <\/span>app_id<\/code> (format: <\/span>app_******<\/code>).<\/span><\/p>\n
<\/span><\/h2>\n2. Prerequisite<\/span><\/h2>\nPlease add the following configuration line to the .npmrc<\/span> file in the project root directory:<\/span><\/p>\n
@rootauth:registry=http:\/\/gitlab.standard-software.co\/api\/v4\/projects\/12421\/packages\/npm\/<\/code><\/pre>\n <\/p>\n
3. Install the SDK<\/span><\/h2>\nRun the following command in your project root directory to install the dependency package:<\/span><\/p>\n
\nnpm install @rootauth\/core<\/code><\/pre>\n <\/pre>\n<\/div>\n4. Create a RootAuthClient Instance<\/span><\/h2>\nCreate an instance in your entry file (e.g., <\/span>main.js<\/code>):<\/span><\/p>\n
\n\n\n\n\n\/\/ main.js\nimport { RootAuthClient, type RootAuthClientConfig } from '@rootauth\/core'\n\nconst options: RootAuthClientConfig = {\n    app_id: 'app_******', \/\/ Required: app_id generated from the workspace\n}\nconst client = new RootAuthClient(options)<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n <\/pre>\n<\/div>\n4.1 Complete Configuration Options<\/span><\/h3>\nRootAuthClientConfig<\/code><\/p>\n
\ninterface RootAuthClientConfig {\n  app_id: string \/\/ Required: obtained from the workspace application configuration\n  api_base_url?: string \/\/ Backend API endpoint path, defaults to https:\/\/rootauth-api.rootauth.com\n  redirect_uri?: string \/\/ Redirect path after successful login, defaults to location.origin\n  state?: string \/\/ Custom parameter, returned as-is by the API\n  locale?: string \/\/ Current language, defaults to zh-CN; currently supports zh-CN, en-US\n  scope?: string[]  \/\/ Scope mapping, defaults to ['openid']; add fields like avatar, username here\n  grant_type?: string \/\/ Authorization mode, defaults to authorization_code\n  enable_google_one_tap?: boolean \/\/ Enable Google One Tap login, defaults to false\n}<\/code><\/pre>\n<\/div>\n\nNote:<\/span><\/strong> The <\/span>mode<\/code> parameter is deprecated in this version and should not be passed.<\/span><\/p>\n<\/blockquote>\n
 <\/h2>\n5. Inject the Global Instance<\/span><\/h2>\n(Using Nuxt as an example)<\/span><\/p>\n
For other frameworks (Vue, React, etc.), you can follow a similar approach and mount the <\/span>client<\/code> globally.<\/span><\/p>\n
5.1 Create the Plugin File<\/span><\/h3>\nplugins\/rootauth.client.ts<\/code>:<\/span><\/p>\n
\n\/\/ plugins\/rootauth.client.ts\nimport { RootAuthClient, type RootAuthClientConfig } from '@rootauth\/core'\nexport default defineNuxtPlugin(() => {\n  const options: RootAuthClientConfig = {\n    app_id: 'app_******', \/\/ Required: app_id generated from the workspace\n  }\n  const client = new RootAuthClient(options)\n\n  return {\n    provide: {\n      rootauth: client,\n    },\n  }\n})<\/code><\/pre>\n <\/pre>\n<\/div>\n5.2 Register the Plugin<\/span><\/h3>\nnuxt.config.ts<\/code>:<\/span><\/p>\n
\n\/\/ nuxt.config.ts\nexport default defineNuxtConfig({\n  plugins: [\n    '@\/plugins\/rootauth.client.ts',\n  ]\n})<\/code><\/pre>\n <\/pre>\n<\/div>\n5.3 Access the Instance in a Component<\/span><\/h3>\n\n\n\n\n\nconst { $rootauth } = useNuxtApp()\n$rootauth?.xxx()<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n <\/pre>\n<\/div>\n5.4 Wrap in a Composable (Recommended)<\/span><\/h3>\ncomposables\/useRootAuth.ts<\/code>:<\/span><\/p>\n
\n\n\n\n\n\/\/ composables\/useRootAuth.ts\nimport type { RootAuthClient } from '@rootauth\/core'\n\n\/** RootAuth client (injected by `plugins\/rootauth.client` when `ROOTAUTH_APP_ID` is configured) *\/\nexport function useRootAuth(): RootAuthClient | undefined {\n  return useNuxtApp().$rootauth as RootAuthClient | undefined\n}<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n <\/pre>\n<\/div>\nUsage:<\/span><\/p>\n
\n\n\n\n\nconst rootauth = useRootAuth()\nrootauth?.xxx()<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n <\/pre>\n<\/div>\n6. General Notes<\/span><\/h2>\n\n\nForm validation<\/span><\/strong>: RootAuth does not perform frontend validation. Please validate before calling the API.<\/span><\/p>\n<\/li>\n
\nPassword encryption<\/span><\/strong>: Only plaintext passwords are required; the SDK will encrypt them automatically.<\/span><\/p>\n<\/li>\n
\nCallback override<\/span><\/strong>: The second parameter <\/span>callbacks<\/code> of each method can accept <\/span>onSuccess<\/code>, which <\/span>completely overrides<\/span><\/strong> the SDK’s default behavior. If you only need to add extra logic (e.g., closing a loading indicator), use the Promise chain (<\/span>.then()<\/code> \/ <\/span>.catch()<\/code>) directly without passing the second parameter.<\/span><\/p>\n<\/li>\n
\nSuccess \/ failure handling<\/span><\/strong>: Failed requests uniformly use Promise <\/span>reject<\/code>. Both success and failure responses include a <\/span>rootauth_message<\/code> object (containing <\/span>type<\/code> and <\/span>msg<\/code>), which is internationalized (Chinese\/English). API mode does <\/span>not<\/span><\/strong> automatically show any UI prompts; you must handle error displays yourself.<\/span><\/p>\n<\/li>\n<\/ul>\n
 <\/h2>\n7. API Method Details<\/span><\/h2>\n7.1 Login<\/span><\/h3>\nThis interface is also used when the workspace option <\/span>“Combine Login and Registration”<\/span><\/strong> is selected.<\/span><\/p>\n
\n\n\n\n\nconst rootauth = useRootAuth()\n\ninterface LoginParams {\n  type: string \/\/ Required: login method: EMAIL_PASS|EMAIL_CODE|PHONE_PASS|PHONE_CODE. Currently supports EMAIL_PASS (email+password), EMAIL_CODE (email verification code), PHONE_CODE (phone verification code), PHONE_PASS (phone+password)\n  email: string \/\/ Required: user email\n  password?: string \/\/ Required when type is EMAIL_PASS\/PHONE_PASS; note: only plaintext password is required, RootAuth handles encryption\n  code?: string \/\/ Required when type is EMAIL_CODE\/PHONE_CODE\n\n  redirect_uri?: string \/\/ Redirect path after login; recommended to omit and use the global redirect_uri\n  scope?: string[] \/\/ Scope mapping; recommended to omit and use the global scope\n  state?: string \/\/ Custom parameter, returned as-is; recommended to omit and use the global state\n  grant_type?: string \/\/ Authorization mode; recommended to omit and use the global grant_type\n}\n\/\/ Second parameter of the login method\ninterface RootAuthFlowCallbacks<T = unknown> {\n  onSuccess?: (data: T) => void\n}\n\/\/ Success\/failure response includes this message for user display\ntype RootAuthClientSuccessResponse {\n  rootauth_message?: {\n    type: string \/\/ success, error, warning\n    msg: string \/\/ Prompt text, already internationalized\n  }\n}\n\n\/\/ Available type\nrootauth?.login(\n  params: LoginParams,\n  callbacks?: RootAuthFlowCallbacks<RootAuthClientSuccessResponse<CustomerLoginResponse>>,\n)\n.then((res) => {\n  \/\/ Add your own logic based on RootAuth's default behavior\n})\n.catch((err) => {\n  \/\/ Handle request failures here\n  console.log('err', err)\n})\n.finally(() => {\n  \/\/ Close loading indicator, etc.\n})<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n <\/pre>\n<\/div>\nExample of overriding default behavior (passing the second parameter):<\/span><\/strong><\/p>\n
\n\n\n\n\nconst handleSubmit = () => {\n  \/\/ User handles pre-validation\n  loading.value = true\n  rootauth?.login({\n    type: 'EMAIL_PASS',\n    email: '123456@qq.com',\n    password: '123456'\n  },\n  {\n    onSuccess: (res) => {\n      \/\/ Custom login success callback, including notifications, etc.\n      if (res.rootauth_message.msg) {\n        message[res.rootauth_message.type || 'success'](\n          res.rootauth_message.msg\n        )\n      }\n    }\n  })\n  .catch(err => {\n    \/\/ Handle request failures here\n    if (err.rootauth_message.msg) {\n      message[err.rootauth_message.type || 'error'](\n        err.rootauth_message.msg\n      )\n    }\n  })\n  .finally(() => {\n    loading.value = false\n  })\n}<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n <\/pre>\n<\/div>\n7.2 Register<\/span><\/h3>\n\n\n\n\n\ninterface RegisterParams {\n  type?: string \/\/ Registration type: EMAIL_CODE_PASS|PHONE_CODE_PASS. Defaults to EMAIL_CODE_PASS (email verification code). Supports EMAIL_CODE_PASS and PHONE_CODE_PASS (SMS verification code)\n  email?: string \/\/ User email, required when type=EMAIL_CODE_PASS\n  code: string \/\/ Required: email\/phone activation code\n  password: string \/\/ Required: password; note: only plaintext password is required, RootAuth handles encryption\n  phone_code?: string \/\/ Phone country code, required when type=PHONE_CODE_PASS, e.g., '86'\n  phone_num?: string \/\/ Phone number, required when type=PHONE_CODE_PASS\n\n  redirect_uri?: string \/\/ Redirect path after login; recommended to omit and use the global redirect_uri\n  scope?: string[] \/\/ Scope mapping; recommended to omit and use the global scope\n  state?: string \/\/ Custom parameter, returned as-is; recommended to omit and use the global state\n  grant_type?: string \/\/ Authorization mode; recommended to omit and use the global grant_type\n}\n\/\/ Same as the second parameter of the login method\ninterface RootAuthFlowCallbacks<T = unknown> {\n  onSuccess?: (data: T) => void\n}\n\/\/ Success\/failure response includes this message for user display, same as login\ntype RootAuthClientSuccessResponse {\n  rootauth_message?: {\n    type: string \/\/ success, error, warning\n    msg: string \/\/ Prompt text, already internationalized\n  }\n}\n\nconst params: RegisterParams = {\n  email: '123456@qq.com',\n  password: '123456',\n  code: '123456',\n}\n\nrootauth?.register(params)\n.then((res) => {\n  \/\/ Add your own logic based on RootAuth's default behavior\n})\n.catch((err) => {\n  console.error(err)\n})\n.finally(() => {\n})<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n <\/pre>\n<\/div>\n7.3 Send Verification Code<\/span><\/h3>\n\n\n\n\n\ninterface SendCodeParams {\n  type?: string \/\/ Verification code type: EMAIL|PHONE_TEXT. Defaults to EMAIL. Supports EMAIL and PHONE_TEXT (SMS)\n  email?: string \/\/ User email, required when type=EMAIL\n  email_template_type?: string \/\/ Template type, required when type=EMAIL. Values: register_code|login_code|reset_pass_code|login_mfa_code. register_code and login_mfa_code: registration code; login_code: login code; reset_pass_code: password reset code; login_mfa_code: MFA login code\n  phone_code?: string \/\/ Phone country code, required when type=PHONE_TEXT, e.g., '86'\n  phone_num?: string \/\/ Phone number, required when type=PHONE_TEXT\n  phone_text_template_type?: string \/\/ SMS template, required when type=PHONE_TEXT. Values: register_code|login_code|reset_pass_code|login_mfa_code. Supports register_code, login_code, reset_pass_code, login_mfa_code\n  redirect_uri?: string \/\/ Redirect path after login; recommended to omit and use the global redirect_uri\n  scope?: string[] \/\/ Scope mapping; recommended to omit and use the global scope\n  state?: string \/\/ Custom parameter, returned as-is; recommended to omit and use the global state\n  grant_type?: string \/\/ Authorization mode; recommended to omit and use the global grant_type\n}\n\/\/ Same as the second parameter of the login method\ninterface RootAuthFlowCallbacks<T = unknown> {\n  onSuccess?: (data: T) => void\n}\n\/\/ Success\/failure response includes this message for user display, same as login\ntype RootAuthClientSuccessResponse {\n  rootauth_message?: {\n    type: string \/\/ success, error, warning\n    msg: string \/\/ Prompt text, already internationalized\n  }\n}\n\nconst params: SendCodeParams = {\n  email: '123456@qq.com',\n  email_template_type: 'register_code'\n}\n\nrootauth?.sendCode(params)\n.then((res) => {\n  \/\/ Add your own logic based on RootAuth's default behavior\n})\n.catch((err) => {\n  console.error(err)\n})\n.finally(() => {\n})<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n\nNote:<\/span><\/strong> Verification codes have a 60\u2011second cooldown. Please implement a countdown timer yourself.<\/span><\/p>\n<\/blockquote>\n
 <\/h3>\n7.4 Reset Password<\/span><\/h3>\n\ninterface ResetPasswordUParams {\n  type?: string \/\/ Verification code type: EMAIL_CODE|PHONE_CODE. Defaults to EMAIL_CODE. Supports EMAIL_CODE and PHONE_CODE\n  email?: string \/\/ Email, required when type=EMAIL_CODE\n  password: string \/\/ New password; note: only plaintext password is required, RootAuth handles encryption\n  password_confirmation: string \/\/ Confirm password; note: only plaintext password is required, RootAuth handles encryption\n  code: string\n  phone_code?: string \/\/ Phone country code, required when type=PHONE_CODE, e.g., '86'\n  phone_num?: string \/\/ Phone number, required when type=PHONE_CODE\n\n  redirect_uri?: string \/\/ Redirect path after login; recommended to omit and use the global redirect_uri\n  scope?: string[] \/\/ Scope mapping; recommended to omit and use the global scope\n  state?: string \/\/ Custom parameter, returned as-is; recommended to omit and use the global state\n  grant_type?: string \/\/ Authorization mode; recommended to omit and use the global grant_type\n}\n\/\/ Same as the second parameter of the login method\ninterface RootAuthFlowCallbacks<T = unknown> {\n  onSuccess?: (data: T) => void\n}\n\/\/ Success\/failure response includes this message for user display, same as login\ntype RootAuthClientSuccessResponse {\n  rootauth_message?: {\n    type: string \/\/ success, error, warning\n    msg: string \/\/ Prompt text, already internationalized\n  }\n}\n\nconst params: ResetPasswordUParams = {\n  email: '123456@qq.com',\n  password: '123456',\n  password_confirmation: '123456',\n  code: '111111'\n}\n\nrootauth?.resetPassword(params)\n.then((res) => {\n  \/\/ Add your own logic based on RootAuth's default behavior\n})\n.catch((err) => {\n  console.error(err)\n})\n.finally(() => {\n})<\/code><\/pre>\n <\/pre>\n<\/div>\n7.5 Third\u2011Party Login<\/span><\/h3>\n\n\n\n\n\ninterface ThirdPartyLoginParams {\n  auth_by: string \/\/ Third-party type: google_oauth|telegram|facebook. google_oauth: Google login, telegram: Telegram login, facebook: Facebook login\n  redirect_uri?: string \/\/ Redirect path after login; recommended to omit and use the global redirect_uri\n  scope?: string[] \/\/ Scope mapping; recommended to omit and use the global scope\n  state?: string \/\/ Custom parameter, returned as-is; recommended to omit and use the global state\n  grant_type?: string \/\/ Authorization mode; recommended to omit and use the global grant_type\n  response_type?: string \/\/ Response type, defaults to 'code'\n}\n\/\/ Success\/failure response includes this message for user display, same as login\ntype RootAuthClientSuccessResponse {\n  rootauth_message?: {\n    type: string \/\/ success, error, warning\n    msg: string \/\/ Prompt text, already internationalized\n  }\n}\n\nconst params: ThirdPartyLoginParams = {\n  auth_by: 'google_oauth',\n  redirect_uri: '****\/search'\n}\n\nrootauth?.thirdPartyLogin(params)\n.then((res) => {\n  \/\/ Add your own logic based on RootAuth's default behavior\n})\n.catch((err) => {\n  console.error(err)\n})\n.finally(() => {\n})<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n <\/pre>\n<\/div>\n7.6 Google One Tap Login<\/span><\/h3>\nYou need to enable the <\/span>enable_google_one_tap: true<\/code> option when creating the instance.<\/span><\/p>\n
\nconst options: RootAuthClientConfig = {\n  app_id: 'app_******', \/\/ Required: app_id generated from the workspace\n  enable_google_one_tap: true \/\/ Set to true to enable One Tap login\n}\nconst client = new RootAuthClient(options)\n\nclient?.googleOneTapLogin()<\/code><\/pre>\n

<\/span><\/pre>\n<\/div>\n7.7 MFA Two\u2011Factor Verification<\/span><\/h3>\nWhen email verification, OTP verification, or SMS verification is enabled in the workspace, the login API will return <\/span>mfa_token<\/code> and <\/span>mfa_methods<\/code> when logging in with email\/password. Based on the <\/span>mfa_methods<\/code> hints, call <\/span>verifyLoginMfa<\/code> to complete verification.<\/span><\/p>\n
Meanings of returned <\/span>mfa_methods<\/code> values:<\/span><\/strong><\/p>\n
\n\n\n\n\n\n\n\n\n\n\nmfa_methods<\/code> value<\/span><\/th>\n Description<\/span><\/th>\n<\/tr>\n<\/thead>\n
['EMAIL_BIND']<\/code><\/td>\n Need to bind an email address and verify it<\/span><\/td>\n<\/tr>\n
['EMAIL']<\/code><\/td>\n Need an email verification code<\/span><\/td>\n<\/tr>\n
['TOTP_BIND']<\/code><\/td>\n First\u2011time binding of OTP authenticator (returns an extra <\/span>totp_secret<\/code>)<\/span><\/td>\n<\/tr>\n
['TOTP']<\/code><\/td>\n Enter OTP verification code<\/span><\/td>\n<\/tr>\n
['PHONE_CODE_BIND']<\/code><\/td>\n Need to bind a phone number and verify it<\/span><\/td>\n<\/tr>\n
['PHONE_CODE']<\/code><\/td>\n Need an SMS verification code<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n <\/p>\n
Call the verification interface:<\/span><\/strong><\/p>\n
\n\n\n\n\ninterface LoginMfaVerifyParams {\n  mfa_token: string \/\/ mfa_token returned by the login API\n  mfa_type: string \/\/ MFA type: EMAIL|EMAIL_BIND|TOTP_BIND|TOTP|PHONE_CODE|PHONE_CODE_BIND. EMAIL: email authentication; EMAIL_BIND: email binding; TOTP_BIND: first\u2011time OTP authenticator binding; TOTP: OTP verification (authenticator already bound); PHONE_CODE: phone authentication; PHONE_CODE_BIND: phone binding\n  code: string \/\/ When mfa_type=EMAIL\/EMAIL_BIND, code is the email verification code; when mfa_type=TOTP\/TOTP_BIND, code is the authenticator code; when mfa_type=PHONE_CODE\/PHONE_CODE_BIND, code is the SMS verification code\n  totp_bind_code?: string \/\/ When mfa_type=TOTP_BIND, the email\/phone verification code to be entered\n  email?: string \/\/ Email, required when type=EMAIL_BIND\n  phone_code?: string \/\/ Phone country code, required when type=PHONE_CODE_BIND, e.g., '86'\n  phone_num?: string \/\/ Phone number, required when type=PHONE_CODE_BIND\n\n  redirect_uri?: string \/\/ Redirect path after login; recommended to omit and use the global redirect_uri\n  scope?: string[] \/\/ Scope mapping; recommended to omit and use the global scope\n  state?: string \/\/ Custom parameter, returned as-is; recommended to omit and use the global state\n  grant_type?: string \/\/ Authorization mode; recommended to omit and use the global grant_type\n  response_type?: string \/\/ Response type, defaults to 'code'\n}\n\/\/ Same as the second parameter of the login method\ninterface RootAuthFlowCallbacks<T = unknown> {\n  onSuccess?: (data: T) => void\n}\n\/\/ Success\/failure response includes this message for user display, same as login\ntype RootAuthClientSuccessResponse {\n  rootauth_message?: {\n    type: string \/\/ success, error, warning\n    msg: string \/\/ Prompt text, already internationalized\n  }\n}\n\nconst params: LoginMfaVerifyParams = {\n  mfa_token: 'fsdfsdf',\n  mfa_type: 'EMAIL',\n  code: '123456',\n  email_code: '123456'\n}\n\nrootauth?.verifyLoginMfa(params)\n.then((res) => {\n  \/\/ Add your own logic based on RootAuth's default behavior\n})\n.catch((err) => {\n  console.error(err)\n})\n.finally(() => {\n})<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n <\/pre>\n<\/div>\n7.8 Other Utility Methods<\/span><\/h3>\n\n\n\n\n\n\n\n\n\n\nMethod<\/span><\/th>\n Description<\/span><\/th>\n<\/tr>\n<\/thead>\n
client?.getAppConfig()<\/code><\/td>\n Get application configuration<\/span><\/td>\n<\/tr>\n
client?.logout()<\/code><\/td>\n Log out and clear the token<\/span><\/td>\n<\/tr>\n
client?.getToken()<\/code><\/td>\n Get the current token<\/span><\/td>\n<\/tr>\n
client?.isAuthenticated()<\/code><\/td>\n Check whether the user is logged in<\/span><\/td>\n<\/tr>\n
client?.setLocale('en-US')<\/code><\/td>\n \nSwitch language (zh-CN \/ en-US)<\/span><\/p>\n
\nLanguage priority:<\/strong> In API mode, the value passed to new RootAuthClient({ locale })<\/code> takes precedence.<\/span><\/p>\n<\/blockquote>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>\n
 <\/p>","pure_content":"RootAuth API Mode provides a pre-packaged frontend API interface without any UI. You are free to implement login, registration, and other pages according to your own design style, and call the SDK to complete the authentication logic.\n\u00a0\n1. Preparation\nCreate an application in the\u00a0RootAuth Console\u00a0and copy the\u00a0app_id\u00a0(format:\u00a0app_******).\n\n2. Prerequisite\nPlease add the following configuration line to the\u00a0.npmrc file in the project root directory:\n@rootauth:registry=http:\/\/gitlab.standard-software.co\/api\/v4\/projects\/12421\/packages\/npm\/\n\u00a0\n3. Install the SDK\nRun the following command in your project root directory to install the dependency package:\n\nnpm install @rootauth\/core\n\u00a0\n\n4. Create a RootAuthClient Instance\nCreate an instance in your entry file (e.g.,\u00a0main.js):\n\n\n\n\n\n\/\/ main.js\nimport { RootAuthClient, type RootAuthClientConfig } from '@rootauth\/core'\n\nconst options: RootAuthClientConfig = {\n    app_id: 'app_******', \/\/ Required: app_id generated from the workspace\n}\nconst client = new RootAuthClient(options)\n\n\n\n\n\u00a0\n\n4.1 Complete Configuration Options\nRootAuthClientConfig\n\ninterface RootAuthClientConfig {\n  app_id: string \/\/ Required: obtained from the workspace application configuration\n  api_base_url?: string \/\/ Backend API endpoint path, defaults to https:\/\/rootauth-api.rootauth.com\n  redirect_uri?: string \/\/ Redirect path after successful login, defaults to location.origin\n  state?: string \/\/ Custom parameter, returned as-is by the API\n  locale?: string \/\/ Current language, defaults to zh-CN; currently supports zh-CN, en-US\n  scope?: string[]  \/\/ Scope mapping, defaults to ['openid']; add fields like avatar, username here\n  grant_type?: string \/\/ Authorization mode, defaults to authorization_code\n  enable_google_one_tap?: boolean \/\/ Enable Google One Tap login, defaults to false\n}\n\n\nNote:\u00a0The\u00a0mode\u00a0parameter is deprecated in this version and should not be passed.\n\n\u00a0\n5. Inject the Global Instance\n(Using Nuxt as an example)\nFor other frameworks (Vue, React, etc.), you can follow a similar approach and mount the\u00a0client\u00a0globally.\n5.1 Create the Plugin File\nplugins\/rootauth.client.ts:\n\n\/\/ plugins\/rootauth.client.ts\nimport { RootAuthClient, type RootAuthClientConfig } from '@rootauth\/core'\nexport default defineNuxtPlugin(() => {\n  const options: RootAuthClientConfig = {\n    app_id: 'app_******', \/\/ Required: app_id generated from the workspace\n  }\n  const client = new RootAuthClient(options)\n\n  return {\n    provide: {\n      rootauth: client,\n    },\n  }\n})\n\u00a0\n\n5.2 Register the Plugin\nnuxt.config.ts:\n\n\/\/ nuxt.config.ts\nexport default defineNuxtConfig({\n  plugins: [\n    '@\/plugins\/rootauth.client.ts',\n  ]\n})\n\u00a0\n\n5.3 Access the Instance in a Component\n\n\n\n\n\nconst { $rootauth } = useNuxtApp()\n$rootauth?.xxx()\n\n\n\n\n\u00a0\n\n5.4 Wrap in a Composable (Recommended)\ncomposables\/useRootAuth.ts:\n\n\n\n\n\n\/\/ composables\/useRootAuth.ts\nimport type { RootAuthClient } from '@rootauth\/core'\n\n\/** RootAuth client (injected by `plugins\/rootauth.client` when `ROOTAUTH_APP_ID` is configured) *\/\nexport function useRootAuth(): RootAuthClient | undefined {\n  return useNuxtApp().$rootauth as RootAuthClient | undefined\n}\n\n\n\n\n\u00a0\n\nUsage:\n\n\n\n\n\nconst rootauth = useRootAuth()\nrootauth?.xxx()\n\n\n\n\n\u00a0\n\n6. General Notes\n\n\nForm validation: RootAuth does not perform frontend validation. Please validate before calling the API.\n\n\nPassword encryption: Only plaintext passwords are required; the SDK will encrypt them automatically.\n\n\nCallback override: The second parameter\u00a0callbacks\u00a0of each method can accept\u00a0onSuccess, which\u00a0completely overrides\u00a0the SDK\u2019s default behavior. If you only need to add extra logic (e.g., closing a loading indicator), use the Promise chain (.then()\u00a0\/\u00a0.catch()) directly without passing the second parameter.\n\n\nSuccess \/ failure handling: Failed requests uniformly use Promise\u00a0reject. Both success and failure responses include a\u00a0rootauth_message\u00a0object (containing\u00a0type\u00a0and\u00a0msg), which is internationalized (Chinese\/English). API mode does\u00a0not\u00a0automatically show any UI prompts; you must handle error displays yourself.\n\n\n\u00a0\n7. API Method Details\n7.1 Login\nThis interface is also used when the workspace option\u00a0\u201cCombine Login and Registration\u201d\u00a0is selected.\n\n\n\n\n\nconst rootauth = useRootAuth()\n\ninterface LoginParams {\n  type: string \/\/ Required: login method: EMAIL_PASS|EMAIL_CODE|PHONE_PASS|PHONE_CODE. Currently supports EMAIL_PASS (email+password), EMAIL_CODE (email verification code), PHONE_CODE (phone verification code), PHONE_PASS (phone+password)\n  email: string \/\/ Required: user email\n  password?: string \/\/ Required when type is EMAIL_PASS\/PHONE_PASS; note: only plaintext password is required, RootAuth handles encryption\n  code?: string \/\/ Required when type is EMAIL_CODE\/PHONE_CODE\n\n  redirect_uri?: string \/\/ Redirect path after login; recommended to omit and use the global redirect_uri\n  scope?: string[] \/\/ Scope mapping; recommended to omit and use the global scope\n  state?: string \/\/ Custom parameter, returned as-is; recommended to omit and use the global state\n  grant_type?: string \/\/ Authorization mode; recommended to omit and use the global grant_type\n}\n\/\/ Second parameter of the login method\ninterface RootAuthFlowCallbacks {\n  onSuccess?: (data: T) => void\n}\n\/\/ Success\/failure response includes this message for user display\ntype RootAuthClientSuccessResponse {\n  rootauth_message?: {\n    type: string \/\/ success, error, warning\n    msg: string \/\/ Prompt text, already internationalized\n  }\n}\n\n\/\/ Available type\nrootauth?.login(\n  params: LoginParams,\n  callbacks?: RootAuthFlowCallbacks>,\n)\n.then((res) => {\n  \/\/ Add your own logic based on RootAuth's default behavior\n})\n.catch((err) => {\n  \/\/ Handle request failures here\n  console.log('err', err)\n})\n.finally(() => {\n  \/\/ Close loading indicator, etc.\n})\n\n\n\n\n\u00a0\n\nExample of overriding default behavior (passing the second parameter):\n\n\n\n\n\nconst handleSubmit = () => {\n  \/\/ User handles pre-validation\n  loading.value = true\n  rootauth?.login({\n    type: 'EMAIL_PASS',\n    email: '123456@qq.com',\n    password: '123456'\n  },\n  {\n    onSuccess: (res) => {\n      \/\/ Custom login success callback, including notifications, etc.\n      if (res.rootauth_message.msg) {\n        message[res.rootauth_message.type || 'success'](\n          res.rootauth_message.msg\n        )\n      }\n    }\n  })\n  .catch(err => {\n    \/\/ Handle request failures here\n    if (err.rootauth_message.msg) {\n      message[err.rootauth_message.type || 'error'](\n        err.rootauth_message.msg\n      )\n    }\n  })\n  .finally(() => {\n    loading.value = false\n  })\n}\n\n\n\n\n\u00a0\n\n7.2 Register\n\n\n\n\n\ninterface RegisterParams {\n  type?: string \/\/ Registration type: EMAIL_CODE_PASS|PHONE_CODE_PASS. Defaults to EMAIL_CODE_PASS (email verification code). Supports EMAIL_CODE_PASS and PHONE_CODE_PASS (SMS verification code)\n  email?: string \/\/ User email, required when type=EMAIL_CODE_PASS\n  code: string \/\/ Required: email\/phone activation code\n  password: string \/\/ Required: password; note: only plaintext password is required, RootAuth handles encryption\n  phone_code?: string \/\/ Phone country code, required when type=PHONE_CODE_PASS, e.g., '86'\n  phone_num?: string \/\/ Phone number, required when type=PHONE_CODE_PASS\n\n  redirect_uri?: string \/\/ Redirect path after login; recommended to omit and use the global redirect_uri\n  scope?: string[] \/\/ Scope mapping; recommended to omit and use the global scope\n  state?: string \/\/ Custom parameter, returned as-is; recommended to omit and use the global state\n  grant_type?: string \/\/ Authorization mode; recommended to omit and use the global grant_type\n}\n\/\/ Same as the second parameter of the login method\ninterface RootAuthFlowCallbacks {\n  onSuccess?: (data: T) => void\n}\n\/\/ Success\/failure response includes this message for user display, same as login\ntype RootAuthClientSuccessResponse {\n  rootauth_message?: {\n    type: string \/\/ success, error, warning\n    msg: string \/\/ Prompt text, already internationalized\n  }\n}\n\nconst params: RegisterParams = {\n  email: '123456@qq.com',\n  password: '123456',\n  code: '123456',\n}\n\nrootauth?.register(params)\n.then((res) => {\n  \/\/ Add your own logic based on RootAuth's default behavior\n})\n.catch((err) => {\n  console.error(err)\n})\n.finally(() => {\n})\n\n\n\n\n\u00a0\n\n7.3 Send Verification Code\n\n\n\n\n\ninterface SendCodeParams {\n  type?: string \/\/ Verification code type: EMAIL|PHONE_TEXT. Defaults to EMAIL. Supports EMAIL and PHONE_TEXT (SMS)\n  email?: string \/\/ User email, required when type=EMAIL\n  email_template_type?: string \/\/ Template type, required when type=EMAIL. Values: register_code|login_code|reset_pass_code|login_mfa_code. register_code and login_mfa_code: registration code; login_code: login code; reset_pass_code: password reset code; login_mfa_code: MFA login code\n  phone_code?: string \/\/ Phone country code, required when type=PHONE_TEXT, e.g., '86'\n  phone_num?: string \/\/ Phone number, required when type=PHONE_TEXT\n  phone_text_template_type?: string \/\/ SMS template, required when type=PHONE_TEXT. Values: register_code|login_code|reset_pass_code|login_mfa_code. Supports register_code, login_code, reset_pass_code, login_mfa_code\n  redirect_uri?: string \/\/ Redirect path after login; recommended to omit and use the global redirect_uri\n  scope?: string[] \/\/ Scope mapping; recommended to omit and use the global scope\n  state?: string \/\/ Custom parameter, returned as-is; recommended to omit and use the global state\n  grant_type?: string \/\/ Authorization mode; recommended to omit and use the global grant_type\n}\n\/\/ Same as the second parameter of the login method\ninterface RootAuthFlowCallbacks {\n  onSuccess?: (data: T) => void\n}\n\/\/ Success\/failure response includes this message for user display, same as login\ntype RootAuthClientSuccessResponse {\n  rootauth_message?: {\n    type: string \/\/ success, error, warning\n    msg: string \/\/ Prompt text, already internationalized\n  }\n}\n\nconst params: SendCodeParams = {\n  email: '123456@qq.com',\n  email_template_type: 'register_code'\n}\n\nrootauth?.sendCode(params)\n.then((res) => {\n  \/\/ Add your own logic based on RootAuth's default behavior\n})\n.catch((err) => {\n  console.error(err)\n})\n.finally(() => {\n})\n\n\n\n\n\n\nNote:\u00a0Verification codes have a 60\u2011second cooldown. Please implement a countdown timer yourself.\n\n\u00a0\n7.4 Reset Password\n\ninterface ResetPasswordUParams {\n  type?: string \/\/ Verification code type: EMAIL_CODE|PHONE_CODE. Defaults to EMAIL_CODE. Supports EMAIL_CODE and PHONE_CODE\n  email?: string \/\/ Email, required when type=EMAIL_CODE\n  password: string \/\/ New password; note: only plaintext password is required, RootAuth handles encryption\n  password_confirmation: string \/\/ Confirm password; note: only plaintext password is required, RootAuth handles encryption\n  code: string\n  phone_code?: string \/\/ Phone country code, required when type=PHONE_CODE, e.g., '86'\n  phone_num?: string \/\/ Phone number, required when type=PHONE_CODE\n\n  redirect_uri?: string \/\/ Redirect path after login; recommended to omit and use the global redirect_uri\n  scope?: string[] \/\/ Scope mapping; recommended to omit and use the global scope\n  state?: string \/\/ Custom parameter, returned as-is; recommended to omit and use the global state\n  grant_type?: string \/\/ Authorization mode; recommended to omit and use the global grant_type\n}\n\/\/ Same as the second parameter of the login method\ninterface RootAuthFlowCallbacks {\n  onSuccess?: (data: T) => void\n}\n\/\/ Success\/failure response includes this message for user display, same as login\ntype RootAuthClientSuccessResponse {\n  rootauth_message?: {\n    type: string \/\/ success, error, warning\n    msg: string \/\/ Prompt text, already internationalized\n  }\n}\n\nconst params: ResetPasswordUParams = {\n  email: '123456@qq.com',\n  password: '123456',\n  password_confirmation: '123456',\n  code: '111111'\n}\n\nrootauth?.resetPassword(params)\n.then((res) => {\n  \/\/ Add your own logic based on RootAuth's default behavior\n})\n.catch((err) => {\n  console.error(err)\n})\n.finally(() => {\n})\n\u00a0\n\n7.5 Third\u2011Party Login\n\n\n\n\n\ninterface ThirdPartyLoginParams {\n  auth_by: string \/\/ Third-party type: google_oauth|telegram|facebook. google_oauth: Google login, telegram: Telegram login, facebook: Facebook login\n  redirect_uri?: string \/\/ Redirect path after login; recommended to omit and use the global redirect_uri\n  scope?: string[] \/\/ Scope mapping; recommended to omit and use the global scope\n  state?: string \/\/ Custom parameter, returned as-is; recommended to omit and use the global state\n  grant_type?: string \/\/ Authorization mode; recommended to omit and use the global grant_type\n  response_type?: string \/\/ Response type, defaults to 'code'\n}\n\/\/ Success\/failure response includes this message for user display, same as login\ntype RootAuthClientSuccessResponse {\n  rootauth_message?: {\n    type: string \/\/ success, error, warning\n    msg: string \/\/ Prompt text, already internationalized\n  }\n}\n\nconst params: ThirdPartyLoginParams = {\n  auth_by: 'google_oauth',\n  redirect_uri: '****\/search'\n}\n\nrootauth?.thirdPartyLogin(params)\n.then((res) => {\n  \/\/ Add your own logic based on RootAuth's default behavior\n})\n.catch((err) => {\n  console.error(err)\n})\n.finally(() => {\n})\n\n\n\n\n\u00a0\n\n7.6 Google One Tap Login\nYou need to enable the\u00a0enable_google_one_tap: true option when creating the instance.\n\nconst options: RootAuthClientConfig = {\n  app_id: 'app_******', \/\/ Required: app_id generated from the workspace\n  enable_google_one_tap: true \/\/ Set to true to enable One Tap login\n}\nconst client = new RootAuthClient(options)\n\nclient?.googleOneTapLogin()\n\n\n7.7 MFA Two\u2011Factor Verification\nWhen email verification, OTP verification, or SMS verification is enabled in the workspace, the login API will return\u00a0mfa_token\u00a0and\u00a0mfa_methods\u00a0when logging in with email\/password. Based on the\u00a0mfa_methods\u00a0hints, call\u00a0verifyLoginMfa\u00a0to complete verification.\nMeanings of returned\u00a0mfa_methods values:\n\n\n\n\n mfa_methods\u00a0value\n Description\n\n\n\n\n ['EMAIL_BIND']\n Need to bind an email address and verify it\n\n\n ['EMAIL']\n Need an email verification code\n\n\n ['TOTP_BIND']\n First\u2011time binding of OTP authenticator (returns an extra\u00a0totp_secret)\n\n\n ['TOTP']\n Enter OTP verification code\n\n\n ['PHONE_CODE_BIND']\n Need to bind a phone number and verify it\n\n\n ['PHONE_CODE']\n Need an SMS verification code\n\n\n\n\n\u00a0\nCall the verification interface:\n\n\n\n\n\ninterface LoginMfaVerifyParams {\n  mfa_token: string \/\/ mfa_token returned by the login API\n  mfa_type: string \/\/ MFA type: EMAIL|EMAIL_BIND|TOTP_BIND|TOTP|PHONE_CODE|PHONE_CODE_BIND. EMAIL: email authentication; EMAIL_BIND: email binding; TOTP_BIND: first\u2011time OTP authenticator binding; TOTP: OTP verification (authenticator already bound); PHONE_CODE: phone authentication; PHONE_CODE_BIND: phone binding\n  code: string \/\/ When mfa_type=EMAIL\/EMAIL_BIND, code is the email verification code; when mfa_type=TOTP\/TOTP_BIND, code is the authenticator code; when mfa_type=PHONE_CODE\/PHONE_CODE_BIND, code is the SMS verification code\n  totp_bind_code?: string \/\/ When mfa_type=TOTP_BIND, the email\/phone verification code to be entered\n  email?: string \/\/ Email, required when type=EMAIL_BIND\n  phone_code?: string \/\/ Phone country code, required when type=PHONE_CODE_BIND, e.g., '86'\n  phone_num?: string \/\/ Phone number, required when type=PHONE_CODE_BIND\n\n  redirect_uri?: string \/\/ Redirect path after login; recommended to omit and use the global redirect_uri\n  scope?: string[] \/\/ Scope mapping; recommended to omit and use the global scope\n  state?: string \/\/ Custom parameter, returned as-is; recommended to omit and use the global state\n  grant_type?: string \/\/ Authorization mode; recommended to omit and use the global grant_type\n  response_type?: string \/\/ Response type, defaults to 'code'\n}\n\/\/ Same as the second parameter of the login method\ninterface RootAuthFlowCallbacks {\n  onSuccess?: (data: T) => void\n}\n\/\/ Success\/failure response includes this message for user display, same as login\ntype RootAuthClientSuccessResponse {\n  rootauth_message?: {\n    type: string \/\/ success, error, warning\n    msg: string \/\/ Prompt text, already internationalized\n  }\n}\n\nconst params: LoginMfaVerifyParams = {\n  mfa_token: 'fsdfsdf',\n  mfa_type: 'EMAIL',\n  code: '123456',\n  email_code: '123456'\n}\n\nrootauth?.verifyLoginMfa(params)\n.then((res) => {\n  \/\/ Add your own logic based on RootAuth's default behavior\n})\n.catch((err) => {\n  console.error(err)\n})\n.finally(() => {\n})\n\n\n\n\n\u00a0\n\n7.8 Other Utility Methods\n\n\n\n\n Method\n Description\n\n\n\n\n client?.getAppConfig()\n Get application configuration\n\n\n client?.logout()\n Log out and clear the token\n\n\n client?.getToken()\n Get the current token\n\n\n client?.isAuthenticated()\n Check whether the user is logged in\n\n\n client?.setLocale('en-US')\n Switch language (zh-CN \/ en-US)\n\nLanguage priority:\u00a0In API mode, the value passed to\u00a0new RootAuthClient({ locale }) takes precedence.\n\n\n\n\n\u00a0","is_draft":"0","editor_type":"3","file_path":"","add_time":"1780385529","update_time":"1781060474"},"pure_content":"RootAuth API Mode provides a pre-packaged frontend API interface without any UI. You are free to implement login, registration, and other pages according to your own design style, and call the SDK to"},{"id":"805135","string_id":"ezFg6IZh","status":"1","parent_id":"767807","slug":"vue","order":"0","name":"Vue Mode Integration","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"Vue Mode Integration","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1780388184","add_time":"1780387631","update_time":"1781060483","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"3","file_type":"","auth_id":"[\"805135\", \"767807\"]","content":{"content_id":"805135","content":"
Vue Mode provides RootAuth’s complete UI pages (login, registration, password reset) for quick integration. <\/span>Only supports Vue 3 framework.<\/span><\/strong> The instance also includes all methods available in API mode (such as <\/span>getToken<\/code>, <\/span>setLocale<\/code>, etc.).<\/span><\/p>\n
 <\/h2>\n1. Preparation<\/span><\/h2>\nCreate an application in the <\/span>RootAuth Console<\/span><\/a> and copy the <\/span>app_id<\/code> (format: <\/span>app_******<\/code>).<\/span><\/p>\n
<\/span><\/h2>\n2. Prerequisite<\/span><\/h2>\nPlease add the following configuration line to the .npmrc<\/span> file in the project root directory:<\/span><\/p>\n
@rootauth:registry=http:\/\/gitlab.standard-software.co\/api\/v4\/projects\/12421\/packages\/npm\/<\/code><\/pre>\n <\/p>\n
3. Install Dependencies<\/span><\/h2>\n\n\n\n\n\nnpm install @rootauth\/vue vue vue-router<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n <\/pre>\n<\/div>\n4. Create an Instance and Mount Routes<\/span><\/h2>\nIn the entry file <\/span>main.js<\/code>:<\/span><\/p>\n
\n\n\n\n\n\/\/ main.js\nimport type { Router, RouteRecordRaw } from 'vue-router'\nimport { RootAuthClient, type RootAuthClientConfig } from '@rootauth\/vue'\n\nconst options: RootAuthClientConfig = {\n    app_id: 'app_******', \/\/ Required: app_id generated from the workspace\n}\nconst client = new RootAuthClient(options)\nclient.install(router)<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n <\/pre>\n<\/div>\n4.1 Complete Configuration Options<\/span><\/h3>\nVue Mode supports the following specific parameters:<\/span><\/p>\n
\n\n\n\n\ninterface RootAuthClientConfig {\n  app_id: string \/\/ Required: obtained from the workspace application configuration\n  \/** Base path for routes in hosted mode, e.g., '\/auth' results in routes like \/auth\/login, \/auth\/register, \/auth\/reset-password, etc.; if omitted, routes start from site root \/ *\/\n  base_path?: string\n  api_base_url?: string \/\/ Backend API endpoint path, defaults to https:\/\/rootauth-api.rootauth.com\n  redirect_uri?: string \/\/ Redirect path after successful login, defaults to location.origin\n  state?: string \/\/ Custom parameter, returned as-is by the API\n  locale?: string \/\/ Current language, defaults to zh-CN; currently supports zh-CN, en-US\n  scope?: string[]  \/\/ Scope mapping, defaults to ['openid']; add fields like email, username here to retrieve avatar, username, etc.\n  grant_type?: string \/\/ Authorization mode, defaults to authorization_code\n  enable_google_one_tap?: boolean \/\/ Enable Google One Tap login, defaults to false\n  \/** Hosted mode login success callback; returns false to prevent default redirect *\/\n  onLoginSuccess?: LoginSuccessCallback;\n  \/** Hosted mode registration success callback; returns false to prevent default redirect *\/\n  onRegisterSuccess?: RegisterSuccessCallback;\n}<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n <\/pre>\n<\/div>\n5. View Merged Routes<\/span><\/h2>\n\n\n\n\n\nclient.getSdkRoutes()<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n <\/pre>\n<\/div>\n6. Unmount the SDK<\/span><\/h2>\nWhen authentication features are no longer needed, you can manually unmount to free memory:<\/span><\/p>\n
client.unmount()<\/code><\/pre>\n\n <\/pre>\n<\/div>\n7. Google One Tap Login<\/span><\/h2>\nYou need to enable the <\/span>enable_google_one_tap: true<\/code> option when creating the instance.<\/span><\/p>\n
\nconst options: RootAuthClientConfig = {\n  app_id: 'app_******', \/\/ Required: app_id generated from the workspace\n  enable_google_one_tap: true \/\/ Set to true to enable One Tap login\n}\nconst client = new RootAuthClient(options)\n\nclient?.googleOneTapLogin()<\/code><\/pre>\n

<\/span><\/pre>\n<\/div>\n8. Other Methods<\/span><\/h2>\nThe client instance in Vue Mode also supports the following methods (usage is the same as in API mode):<\/span><\/p>\n
\n\n\n\n\n\n\n\n\n\nMethod<\/span><\/th>\n Description<\/span><\/th>\n<\/tr>\n<\/thead>\n
client?.getAppConfig()<\/code><\/td>\n Get application configuration<\/span><\/td>\n<\/tr>\n
client?.logout()<\/code><\/td>\n Log out and clear the token<\/span><\/td>\n<\/tr>\n
client?.getToken()<\/code><\/td>\n Get the current token<\/span><\/td>\n<\/tr>\n
client?.isAuthenticated()<\/code><\/td>\n Check whether the user is logged in<\/span><\/td>\n<\/tr>\n
client?.setLocale('en-US')<\/code><\/td>\n Switch language (zh-CN \/ en-US)<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>","pure_content":"Vue Mode provides RootAuth\u2019s complete UI pages (login, registration, password reset) for quick integration.\u00a0Only supports Vue 3 framework.\u00a0The instance also includes all methods available in API mode (such as\u00a0getToken,\u00a0setLocale, etc.).\n\u00a0\n1. Preparation\nCreate an application in the\u00a0RootAuth Console\u00a0and copy the\u00a0app_id\u00a0(format:\u00a0app_******).\n\n2. Prerequisite\nPlease add the following configuration line to the\u00a0.npmrc file in the project root directory:\n@rootauth:registry=http:\/\/gitlab.standard-software.co\/api\/v4\/projects\/12421\/packages\/npm\/\n\u00a0\n3. Install Dependencies\n\n\n\n\n\nnpm install @rootauth\/vue vue vue-router\n\n\n\n\n\u00a0\n\n4. Create an Instance and Mount Routes\nIn the entry file\u00a0main.js:\n\n\n\n\n\n\/\/ main.js\nimport type { Router, RouteRecordRaw } from 'vue-router'\nimport { RootAuthClient, type RootAuthClientConfig } from '@rootauth\/vue'\n\nconst options: RootAuthClientConfig = {\n    app_id: 'app_******', \/\/ Required: app_id generated from the workspace\n}\nconst client = new RootAuthClient(options)\nclient.install(router)\n\n\n\n\n\u00a0\n\n4.1 Complete Configuration Options\nVue Mode supports the following specific parameters:\n\n\n\n\n\ninterface RootAuthClientConfig {\n  app_id: string \/\/ Required: obtained from the workspace application configuration\n  \/** Base path for routes in hosted mode, e.g., '\/auth' results in routes like \/auth\/login, \/auth\/register, \/auth\/reset-password, etc.; if omitted, routes start from site root \/ *\/\n  base_path?: string\n  api_base_url?: string \/\/ Backend API endpoint path, defaults to https:\/\/rootauth-api.rootauth.com\n  redirect_uri?: string \/\/ Redirect path after successful login, defaults to location.origin\n  state?: string \/\/ Custom parameter, returned as-is by the API\n  locale?: string \/\/ Current language, defaults to zh-CN; currently supports zh-CN, en-US\n  scope?: string[]  \/\/ Scope mapping, defaults to ['openid']; add fields like email, username here to retrieve avatar, username, etc.\n  grant_type?: string \/\/ Authorization mode, defaults to authorization_code\n  enable_google_one_tap?: boolean \/\/ Enable Google One Tap login, defaults to false\n  \/** Hosted mode login success callback; returns false to prevent default redirect *\/\n  onLoginSuccess?: LoginSuccessCallback;\n  \/** Hosted mode registration success callback; returns false to prevent default redirect *\/\n  onRegisterSuccess?: RegisterSuccessCallback;\n}\n\n\n\n\n\u00a0\n\n5. View Merged Routes\n\n\n\n\n\nclient.getSdkRoutes()\n\n\n\n\n\u00a0\n\n6. Unmount the SDK\nWhen authentication features are no longer needed, you can manually unmount to free memory:\nclient.unmount()\n\n\u00a0\n\n7. Google One Tap Login\nYou need to enable the\u00a0enable_google_one_tap: true option when creating the instance.\n\nconst options: RootAuthClientConfig = {\n  app_id: 'app_******', \/\/ Required: app_id generated from the workspace\n  enable_google_one_tap: true \/\/ Set to true to enable One Tap login\n}\nconst client = new RootAuthClient(options)\n\nclient?.googleOneTapLogin()\n\n\n8. Other Methods\nThe client instance in Vue Mode also supports the following methods (usage is the same as in API mode):\n\n\n\n\n Method\n Description\n\n\n\n\n client?.getAppConfig()\n Get application configuration\n\n\n client?.logout()\n Log out and clear the token\n\n\n client?.getToken()\n Get the current token\n\n\n client?.isAuthenticated()\n Check whether the user is logged in\n\n\n client?.setLocale('en-US')\n Switch language (zh-CN \/ en-US)","is_draft":"0","editor_type":"3","file_path":"","add_time":"1780387631","update_time":"1781060483"},"pure_content":"Vue Mode provides RootAuth\u2019s complete UI pages (login, registration, password reset) for quick integration.\u00a0Only supports Vue 3 framework.\u00a0The instance also includes all methods available in API mode"},{"id":"805143","string_id":"ha9Y9wOp","status":"1","parent_id":"767807","slug":"react","order":"0","name":"React Mode Integration","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"React Mode Integration","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1780388411","add_time":"1780388186","update_time":"1781080965","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"3","file_type":"","auth_id":"[\"805143\", \"767807\"]","content":{"content_id":"805143","content":"React Mode provides RootAuth’s complete UI pages. <\/span>Only supports React 18+ framework.<\/span><\/strong> The instance also includes all methods available in API mode.<\/span><\/p>\n
 <\/h2>\n1. Preparation<\/span><\/h2>\nCreate an application in the <\/span>RootAuth Console<\/span><\/a> and copy the <\/span>app_id<\/code> (format: <\/span>app_******<\/code>).<\/span><\/p>\n
<\/span><\/h2>\n2. Prerequisite<\/span><\/h2>\nPlease add the following configuration line to the .npmrc<\/span> file in the project root directory:<\/span><\/p>\n
@rootauth:registry=http:\/\/gitlab.standard-software.co\/api\/v4\/projects\/12421\/packages\/npm\/<\/code><\/pre>\n <\/p>\n
3. Install Dependencies<\/span><\/h2>\n\n\n\n\n\nnpm install @rootauth\/react react react-dom<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n <\/pre>\n<\/div>\n4. Create the RootAuth Page Component<\/span><\/h2>\nCreate a new file <\/span>RootAuth.tsx<\/code> (or <\/span>RootAuth.jsx<\/code>):<\/span><\/p>\n
\n\n\n\n\n\/\/ RootAuth.tsx\nimport { RootAuthClient, RootAuthMount, type RootAuthClientConfig } from \"@rootauth\/react\";\n\nconst options: RootAuthClientConfig = {\n  app_id: \"******\",\n  base_path: \"\/auth\",\n}\nconst client = new RootAuthClient(options);\n\nfunction AuthPage() {\n  return <RootAuthMount client={client} \/>;\n}\n\nexport default AuthPage;<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n <\/pre>\n<\/div>\n4.1 Configuration Options<\/span><\/h3>\nReact Mode supports exactly the same configuration options as Vue Mode (<\/span>app_id<\/code>, <\/span>base_path<\/code>, <\/span>api_base_url<\/code>, <\/span>redirect_uri<\/code>, <\/span>onLoginSuccess<\/code>, <\/span>onRegisterSuccess<\/code>, etc.).<\/span><\/p>\n
\n\n\n\n\ninterface RootAuthClientConfig {\n  app_id: string \/\/ Required: obtained from the workspace application configuration\n  \/** Base path for routes in hosted mode, e.g., '\/auth' results in routes like \/auth\/login, \/auth\/register, \/auth\/reset-password, etc.; if omitted, routes start from site root \/ *\/\n  base_path?: string\n  api_base_url?: string \/\/ Backend API endpoint path, defaults to https:\/\/rootauth-api.rootauth.com\n  redirect_uri?: string \/\/ Redirect path after successful login, defaults to location.origin\n  state?: string \/\/ Custom parameter, returned as-is by the API\n  locale?: string \/\/ Current language, defaults to zh-CN; currently supports zh-CN, en-US\n  scope?: string[]  \/\/ Scope mapping, defaults to ['openid']; add fields like email, username here to retrieve avatar, username, etc.\n  grant_type?: string \/\/ Authorization mode, defaults to authorization_code\n  enable_google_one_tap?: boolean \/\/ Enable Google One Tap login, defaults to false\n  \/** Hosted mode login success callback; returns false to prevent default redirect *\/\n  onLoginSuccess?: LoginSuccessCallback;\n  \/** Hosted mode registration success callback; returns false to prevent default redirect *\/\n  onRegisterSuccess?: RegisterSuccessCallback;\n}<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n <\/pre>\n<\/div>\n5. Mount in Routes<\/span><\/h2>\nAdd the <\/span>\/auth\/*<\/code> route in your routing configuration file (e.g., <\/span>App.tsx<\/code>):<\/span><\/p>\n
\n\n\n\n\n\/\/ App.tsx\nimport { BrowserRouter, Navigate, Route, Routes } from \"react-router-dom\";\nimport AuthPage from \".\/RootAuth\";\n\nfunction App() {\n  return (\n    <BrowserRouter>\n      <Routes>\n        <Route path=\"\/auth\/*\" element={<AuthPage \/>} \/> \/\/ Add the \/auth route\n      <\/Routes>\n    <\/BrowserRouter>\n  );\n}\n\nexport default App;<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n <\/pre>\n<\/div>\n6. Other Methods<\/span><\/h2>\nThe client instance in React Mode also supports the following methods:<\/span><\/p>\n
\n\n\n\n\n\n\n\n\n\nMethod<\/span><\/th>\n Description<\/span><\/th>\n<\/tr>\n<\/thead>\n
client?.getAppConfig()<\/code><\/td>\n Get application configuration<\/span><\/td>\n<\/tr>\n
client?.logout()<\/code><\/td>\n Log out and clear the token<\/span><\/td>\n<\/tr>\n
client?.getToken()<\/code><\/td>\n Get the current token<\/span><\/td>\n<\/tr>\n
client?.isAuthenticated()<\/code><\/td>\n Check whether the user is logged in<\/span><\/td>\n<\/tr>\n
client?.setLocale('en-US')<\/code><\/td>\n Switch language (zh-CN \/ en-US)<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/div>","pure_content":"React Mode provides RootAuth\u2019s complete UI pages.\u00a0Only supports React 18+ framework.\u00a0The instance also includes all methods available in API mode.\n\u00a0\n1. Preparation\nCreate an application in the\u00a0RootAuth Console\u00a0and copy the\u00a0app_id\u00a0(format:\u00a0app_******).\n\n2. Prerequisite\nPlease add the following configuration line to the\u00a0.npmrc file in the project root directory:\n@rootauth:registry=http:\/\/gitlab.standard-software.co\/api\/v4\/projects\/12421\/packages\/npm\/\n\u00a0\n3. Install Dependencies\n\n\n\n\n\nnpm install @rootauth\/react react react-dom\n\n\n\n\n\u00a0\n\n4. Create the RootAuth Page Component\nCreate a new file\u00a0RootAuth.tsx\u00a0(or\u00a0RootAuth.jsx):\n\n\n\n\n\n\/\/ RootAuth.tsx\nimport { RootAuthClient, RootAuthMount, type RootAuthClientConfig } from \"@rootauth\/react\";\n\nconst options: RootAuthClientConfig = {\n  app_id: \"******\",\n  base_path: \"\/auth\",\n}\nconst client = new RootAuthClient(options);\n\nfunction AuthPage() {\n  return ;\n}\n\nexport default AuthPage;\n\n\n\n\n\u00a0\n\n4.1 Configuration Options\nReact Mode supports exactly the same configuration options as Vue Mode (app_id,\u00a0base_path,\u00a0api_base_url,\u00a0redirect_uri,\u00a0onLoginSuccess,\u00a0onRegisterSuccess, etc.).\n\n\n\n\n\ninterface RootAuthClientConfig {\n  app_id: string \/\/ Required: obtained from the workspace application configuration\n  \/** Base path for routes in hosted mode, e.g., '\/auth' results in routes like \/auth\/login, \/auth\/register, \/auth\/reset-password, etc.; if omitted, routes start from site root \/ *\/\n  base_path?: string\n  api_base_url?: string \/\/ Backend API endpoint path, defaults to https:\/\/rootauth-api.rootauth.com\n  redirect_uri?: string \/\/ Redirect path after successful login, defaults to location.origin\n  state?: string \/\/ Custom parameter, returned as-is by the API\n  locale?: string \/\/ Current language, defaults to zh-CN; currently supports zh-CN, en-US\n  scope?: string[]  \/\/ Scope mapping, defaults to ['openid']; add fields like email, username here to retrieve avatar, username, etc.\n  grant_type?: string \/\/ Authorization mode, defaults to authorization_code\n  enable_google_one_tap?: boolean \/\/ Enable Google One Tap login, defaults to false\n  \/** Hosted mode login success callback; returns false to prevent default redirect *\/\n  onLoginSuccess?: LoginSuccessCallback;\n  \/** Hosted mode registration success callback; returns false to prevent default redirect *\/\n  onRegisterSuccess?: RegisterSuccessCallback;\n}\n\n\n\n\n\u00a0\n\n5. Mount in Routes\nAdd the\u00a0\/auth\/*\u00a0route in your routing configuration file (e.g.,\u00a0App.tsx):\n\n\n\n\n\n\/\/ App.tsx\nimport { BrowserRouter, Navigate, Route, Routes } from \"react-router-dom\";\nimport AuthPage from \".\/RootAuth\";\n\nfunction App() {\n  return (\n    \n      \n        } \/> \/\/ Add the \/auth route\n      <\/Routes>\n    <\/BrowserRouter>\n  );\n}\n\nexport default App;\n\n\n\n\n\u00a0\n\n6. Other Methods\nThe client instance in React Mode also supports the following methods:\n\n\n\n\n Method\n Description\n\n\n\n\n client?.getAppConfig()\n Get application configuration\n\n\n client?.logout()\n Log out and clear the token\n\n\n client?.getToken()\n Get the current token\n\n\n client?.isAuthenticated()\n Check whether the user is logged in\n\n\n client?.setLocale('en-US')\n Switch language (zh-CN \/ en-US)","is_draft":"0","editor_type":"3","file_path":"","add_time":"1780388186","update_time":"1781060491"},"pure_content":"React Mode provides RootAuth\u2019s complete UI pages.\u00a0Only supports React 18+ framework.\u00a0The instance also includes all methods available in API mode.\n\u00a0\n1. Preparation\nCreate an application in the\u00a0RootAut"},{"id":"805144","string_id":"qedrujeI","status":"1","parent_id":"767807","slug":"error-code","order":"0","name":"Error Code Reference","type":"2","cover":"","cover_alt":"","desc":null,"website":"","contact":"","seo_title":"Error Code Reference","seo_keyword":"","seo_desc":"","share_switch":"0","share_code":"","author":"","published_time":"1780388639","add_time":"1780388191","update_time":"1780388639","corp_auth_id":"0","verify_code_auth_id":"0","editor_type":"3","file_type":"","auth_id":"[\"805144\", \"767807\"]","content":{"content_id":"805144","content":"When a request fails, the backend returns a response in the following format:<\/span><\/p>\n
\n\n\n\n\n{\n    \"status_code\": 200,\n    \"error_code\": 1405, \/\/ Use error_code to look up the corresponding message from get_error_code_setting\n    \"error_msg\": \"Email or Password incorrect\", \/\/ error_msg is the backend’s original English message, not suitable for frontend display\n    \"data\": null\n}<\/code><\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n\n\nerror_code<\/code> is a numeric error code. Use it to look up the corresponding message in the tables below for frontend display.<\/span><\/p>\n<\/li>\n
\nerror_msg<\/code> is the backend’s raw English message and is <\/span>not suitable for direct display to users<\/span><\/strong>.<\/span><\/p>\n<\/li>\n<\/ul>\n
You can also dynamically fetch the latest error code messages (supporting both Chinese and English) via the endpoint <\/span>auth\/v1\/application\/get_error_code_setting<\/code>. The tables below are current (may be updated over time).<\/span><\/p>\n
 <\/h2>\n1. Chinese Error Code Messages<\/span><\/h2>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nerror_code<\/span><\/th>\n Chinese Message<\/span><\/th>\n<\/tr>\n<\/thead>\n
429<\/span><\/td>\n \u8bf7\u6c42\u8fc7\u4e8e\u9891\u7e41\uff0c\u8bf7\u7a0d\u540e\u91cd\u8bd5<\/span><\/td>\n<\/tr>\n
500<\/span><\/td>\n \u670d\u52a1\u5668\u9519\u8bef\uff0c\u8bf7\u7a0d\u540e\u91cd\u8bd5<\/span><\/td>\n<\/tr>\n
1000<\/span><\/td>\n Token\u6821\u9a8c\u5931\u8d25<\/span><\/td>\n<\/tr>\n
1001<\/span><\/td>\n \u53c2\u6570\u9519\u8bef\uff0c\u8bf7\u91cd\u8bd5\uff01<\/span><\/td>\n<\/tr>\n
1100<\/span><\/td>\n \u6ce8\u518c\u8d26\u53f7\u5df2\u5b58\u5728<\/span><\/td>\n<\/tr>\n
1101<\/span><\/td>\n \u90ae\u4ef6\u9a8c\u8bc1\u7801\u9519\u8bef<\/span><\/td>\n<\/tr>\n
1102<\/span><\/td>\n \u90ae\u4ef6\u5730\u5740\u6216\u5bc6\u7801\u9519\u8bef<\/span><\/td>\n<\/tr>\n
1103<\/span><\/td>\n \u8d26\u53f7\u5df2\u88ab\u505c\u7528<\/span><\/td>\n<\/tr>\n
1104<\/span><\/td>\n \u90ae\u4ef6\u5730\u5740\u6216\u9a8c\u8bc1\u7801\u9519\u8bef<\/span><\/td>\n<\/tr>\n
1105<\/span><\/td>\n \u90ae\u7bb1\u5730\u5740\u9519\u8bef<\/span><\/td>\n<\/tr>\n
1106<\/span><\/td>\n \u9a8c\u8bc1\u7801\u9519\u8bef\u6216\u8fc7\u671f\uff0c\u8bf7\u91cd\u65b0\u8f93\u5165<\/span><\/td>\n<\/tr>\n
1107<\/span><\/td>\n MFA\u5df2\u88ab\u7981\u7528\uff0c\u8bf7\u7a0d\u540e\u91cd\u8bd5<\/span><\/td>\n<\/tr>\n
1108<\/span><\/td>\n \u9a8c\u8bc1\u5df2\u8d85\u65f6\uff0c\u8bf7\u91cd\u65b0\u767b\u5f55\u540e\u518d\u8fdb\u884c\u4e8c\u6b21\u9a8c\u8bc1\u3002<\/span><\/td>\n<\/tr>\n
1109<\/span><\/td>\n \u4e00\u6b21\u6027\u9a8c\u8bc1\u7801\u9519\u8bef\u6216\u8fc7\u671f\uff0c\u8bf7\u91cd\u65b0\u8f93\u5165<\/span><\/td>\n<\/tr>\n
1200<\/span><\/td>\n \u9080\u8bf7\u6210\u5458\u5df2\u5b58\u5728<\/span><\/td>\n<\/tr>\n
1201<\/span><\/td>\n \u6b64\u90ae\u7bb1\u9080\u8bf7\u8bb0\u5f55\u5df2\u5b58\u5728<\/span><\/td>\n<\/tr>\n
1202<\/span><\/td>\n \u9080\u8bf7\u94fe\u63a5\u5df2\u5931\u6548\uff0c\u8bf7\u91cd\u65b0\u53d1\u8d77\u9080\u8bf7\u3002<\/span><\/td>\n<\/tr>\n
1203<\/span><\/td>\n \u9080\u8bf7\u8bb0\u5f55\u5df2\u8fc7\u671f<\/span><\/td>\n<\/tr>\n
1300<\/span><\/td>\n \u89d2\u8272\u540d\u79f0\u5df2\u5b58\u5728<\/span><\/td>\n<\/tr>\n
1301<\/span><\/td>\n \u89d2\u8272\u4ee3\u7801\u5df2\u5b58\u5728<\/span><\/td>\n<\/tr>\n
1302<\/span><\/td>\n \u89d2\u8272\u5728\u7ec4\u7ec7\u4f7f\u7528\u4e2d<\/span><\/td>\n<\/tr>\n
1400<\/span><\/td>\n \u624b\u673a\u53f7\u5df2\u88ab\u5360\u7528<\/span><\/td>\n<\/tr>\n
1401<\/span><\/td>\n \u90ae\u7bb1\u53f7\u5df2\u5b58\u5728<\/span><\/td>\n<\/tr>\n
1402<\/span><\/td>\n \u672a\u914d\u7f6e\u56de\u8c03\u57df\u540d<\/span><\/td>\n<\/tr>\n
1403<\/span><\/td>\n \u767b\u5f55\u90ae\u7bb1\u6216\u9a8c\u8bc1\u7801\u9519\u8bef\u6216\u90ae\u7bb1\u672a\u6ce8\u518c<\/span><\/td>\n<\/tr>\n
1404<\/span><\/td>\n \u8be5\u8d26\u53f7\u5df2\u88ab\u7981\u6b62\u767b\u5f55\uff0c\u5982\u6709\u7591\u95ee\u8bf7\u8054\u7cfb\u7ba1\u7406\u5458\u6216\u5ba2\u670d\u3002<\/span><\/td>\n<\/tr>\n
1405<\/span><\/td>\n \u767b\u5f55\u90ae\u7bb1\u6216\u5bc6\u7801\u9519\u8bef\u6216\u90ae\u7bb1\u672a\u6ce8\u518c<\/span><\/td>\n<\/tr>\n
1406<\/span><\/td>\n \u767b\u5f55\u9700\u8981\u9a8c\u8bc1\u7801\u7968\u636e<\/span><\/td>\n<\/tr>\n
1407<\/span><\/td>\n \u4e0d\u5141\u8bb8\u4f7f\u7528\u6b64\u56de\u8c03\u57df\u540d<\/span><\/td>\n<\/tr>\n
1408<\/span><\/td>\n \u4e0d\u5141\u8bb8\u4f7f\u7528\u6b64\u6388\u6743\u65b9\u5f0f<\/span><\/td>\n<\/tr>\n
1409<\/span><\/td>\n \u65e0\u6548\u6216\u8fc7\u671f\u7684REFRESH_TOKEN<\/span><\/td>\n<\/tr>\n
1410<\/span><\/td>\n \u65e0\u6548\u6216\u8fc7\u671f\u7684AUTHORIZATION_CODE<\/span><\/td>\n<\/tr>\n
1411<\/span><\/td>\n \u5f53\u524d\u7f51\u7edc\u4e0d\u5728\u7cfb\u7edf\u5141\u8bb8\u7684\u8bbf\u95ee\u8303\u56f4\u5185\uff0c\u8bf7\u68c0\u67e5\u60a8\u7684IP\u8bbf\u95ee\u9650\u5236\u914d\u7f6e\uff0c\u6216\u8054\u7cfb\u5ba2\u670d\u3002<\/span><\/td>\n<\/tr>\n
1412<\/span><\/td>\n \u8bf7\u4f7f\u7528\u5e38\u7528\u90ae\u7bb1\uff0c\u4e0d\u652f\u6301\u4e34\u65f6\u90ae\u7bb1\u3002<\/span><\/td>\n<\/tr>\n
1413<\/span><\/td>\n \u975e\u5141\u8bb8\u7684\u767b\u5f55\u65b9\u5f0f<\/span><\/td>\n<\/tr>\n
1414<\/span><\/td>\n \u5f53\u524d\u7f51\u7edc\u73af\u5883\u5b58\u5728\u5b89\u5168\u98ce\u9669\uff0c\u6682\u4e0d\u652f\u6301\u6ce8\u518c\/\u767b\u5f55\u3002\u8bf7\u7a0d\u540e\u91cd\u8bd5\u6216\u8054\u7cfb\u5ba2\u670d\u3002<\/span><\/td>\n<\/tr>\n
1415<\/span><\/td>\n \u90ae\u4ef6\u9a8c\u8bc1\u7801\u9519\u8bef<\/span><\/td>\n<\/tr>\n
1416<\/span><\/td>\n \u90ae\u7bb1\u5730\u5740\u9519\u8bef\u6216\u90ae\u7bb1\u672a\u6ce8\u518c<\/span><\/td>\n<\/tr>\n
1417<\/span><\/td>\n \u7528\u6237\u5bc6\u7801\u9519\u8bef<\/span><\/td>\n<\/tr>\n
1418<\/span><\/td>\n \u9a8c\u8bc1\u7801\u9519\u8bef\u6216\u8fc7\u671f\uff0c\u8bf7\u91cd\u65b0\u8f93\u5165<\/span><\/td>\n<\/tr>\n
1419<\/span><\/td>\n MFA\u9a8c\u8bc1\u9519\u8bef\u8fc7\u591a\uff0c\u8bf7\u7a0d\u540e\u91cd\u8bd5<\/span><\/td>\n<\/tr>\n
1420<\/span><\/td>\n \u9a8c\u8bc1\u5df2\u8d85\u65f6\uff0c\u8bf7\u91cd\u65b0\u767b\u5f55\u540e\u518d\u8fdb\u884c\u4e8c\u6b21\u9a8c\u8bc1\u3002<\/span><\/td>\n<\/tr>\n
1421<\/span><\/td>\n \u4e00\u6b21\u6027\u9a8c\u8bc1\u7801\u9519\u8bef\u6216\u8fc7\u671f\uff0c\u8bf7\u91cd\u65b0\u8f93\u5165<\/span><\/td>\n<\/tr>\n
1422<\/span><\/td>\n \u624b\u673a\u53f7\u9519\u8bef\u6216\u624b\u673a\u53f7\u672a\u6ce8\u518c<\/span><\/td>\n<\/tr>\n
1423<\/span><\/td>\n \u767b\u5f55\u624b\u673a\u53f7\u6216\u5bc6\u7801\u9519\u8bef\u6216\u624b\u673a\u53f7\u672a\u6ce8\u518c<\/span><\/td>\n<\/tr>\n
1424<\/span><\/td>\n \u624b\u673a\u9a8c\u8bc1\u7801\u9519\u8bef\u6216\u5df2\u8fc7\u671f\u6216\u624b\u673a\u53f7\u672a\u6ce8\u518c<\/span><\/td>\n<\/tr>\n
1425<\/span><\/td>\n \u8be5\u624b\u673a\u53f7\u6240\u5728\u533a\u53f7\u672a\u88ab\u6388\u6743<\/span><\/td>\n<\/tr>\n
1426<\/span><\/td>\n \u77ed\u4fe1\u9a8c\u8bc1\u7801\u9519\u8bef\u6216\u8fc7\u671f\uff0c\u8bf7\u91cd\u65b0\u8f93\u5165<\/span><\/td>\n<\/tr>\n
1427<\/span><\/td>\n \u624b\u673a\u53f7\u7801\u683c\u5f0f\u4e0d\u6b63\u786e<\/span><\/td>\n<\/tr>\n
1428<\/span><\/td>\n \u8be5\u7528\u6237\u5904\u4e8e\u88ab\u7981\u6b62\u72b6\u6001\uff0c\u65e0\u6cd5\u6dfb\u52a0\u81f3\u7ec4\u7ec7\u3002<\/span><\/td>\n<\/tr>\n
1500<\/span><\/td>\n \u7b2c\u4e09\u65b9\u767b\u5f55\u65b9\u5f0f\u672a\u542f\u7528<\/span><\/td>\n<\/tr>\n
1501<\/span><\/td>\n \u7b2c\u4e09\u65b9\u767b\u5f55\u65b9\u5f0f\u914d\u7f6e\u9519\u8bef<\/span><\/td>\n<\/tr>\n
1502<\/span><\/td>\n \u7b2c\u4e09\u65b9\u767b\u5f55\u5df2\u8fc7\u671f<\/span><\/td>\n<\/tr>\n
1503<\/span><\/td>\n \u7b2c\u4e09\u65b9\u767b\u5f55\u6388\u6743\u5931\u8d25<\/span><\/td>\n<\/tr>\n
1504<\/span><\/td>\n \u7b2c\u4e09\u65b9\u767b\u5f55\u83b7\u53d6\u7528\u6237\u4fe1\u606f\u5931\u8d25<\/span><\/td>\n<\/tr>\n
1505<\/span><\/td>\n \u7b2c\u4e09\u65b9\u767b\u5f55 ID Token \u65e0\u6548\u6216\u5df2\u8fc7\u671f<\/span><\/td>\n<\/tr>\n
1506<\/span><\/td>\n \u672a\u6388\u6743\u624b\u673a\u53f7\uff0c\u8bf7\u5728\u7b2c\u4e09\u65b9\u6388\u6743\u9875\u9762\u540c\u610f\u5206\u4eab\u624b\u673a\u53f7\u540e\u91cd\u8bd5<\/span><\/td>\n<\/tr>\n
1507<\/span><\/td>\n \u672a\u627e\u5230\u5bf9\u5e94\u7684\u7b2c\u4e09\u65b9\u8eab\u4efd\u6216\u8be5\u8eab\u4efd\u4e0d\u5c5e\u4e8e\u5f53\u524d\u8d26\u53f7<\/span><\/td>\n<\/tr>\n
1508<\/span><\/td>\n \u8fd9\u662f\u5f53\u524d\u552f\u4e00\u7684\u767b\u5f55\u65b9\u5f0f\uff0c\u4e0d\u80fd\u89e3\u7ed1<\/span><\/td>\n<\/tr>\n
1600<\/span><\/td>\n \u7ec4\u7ec7\u540d\u79f0\u5df2\u5b58\u5728<\/span><\/td>\n<\/tr>\n
1700<\/span><\/td>\n Claim key\u5df2\u5b58\u5728<\/span><\/td>\n<\/tr>\n
1701<\/span><\/td>\n Scope\u5df2\u5b58\u5728<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n <\/p>\n
2. English Error Code Messages<\/span><\/h2>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nerror_code<\/span><\/th>\n English Message<\/span><\/th>\n<\/tr>\n<\/thead>\n
429<\/span><\/td>\n Too many requests. Please try again later.<\/span><\/td>\n<\/tr>\n
500<\/span><\/td>\n Server error. Please try again later.<\/span><\/td>\n<\/tr>\n
1000<\/span><\/td>\n Token validation failed<\/span><\/td>\n<\/tr>\n
1001<\/span><\/td>\n Parameter error, please try again!<\/span><\/td>\n<\/tr>\n
1100<\/span><\/td>\n Account already exists<\/span><\/td>\n<\/tr>\n
1101<\/span><\/td>\n Invalid email verification code<\/span><\/td>\n<\/tr>\n
1102<\/span><\/td>\n Invalid email or password<\/span><\/td>\n<\/tr>\n
1103<\/span><\/td>\n Account has been disabled<\/span><\/td>\n<\/tr>\n
1104<\/span><\/td>\n Invalid email or verification code<\/span><\/td>\n<\/tr>\n
1105<\/span><\/td>\n Invalid email address<\/span><\/td>\n<\/tr>\n
1106<\/span><\/td>\n Verification code error or expired. Please enter again.<\/span><\/td>\n<\/tr>\n
1107<\/span><\/td>\n MFA has been disabled. Please try again later.<\/span><\/td>\n<\/tr>\n
1108<\/span><\/td>\n The verification has timed out. Please log in again and then perform two-factor authentication.<\/span><\/td>\n<\/tr>\n
1109<\/span><\/td>\n One-time verification code error or expired. Please enter again.<\/span><\/td>\n<\/tr>\n
1200<\/span><\/td>\n Member already invited<\/span><\/td>\n<\/tr>\n
1201<\/span><\/td>\n Invitation record for this email already exists<\/span><\/td>\n<\/tr>\n
1202<\/span><\/td>\n Invitation link has expired. Please request a new invitation.<\/span><\/td>\n<\/tr>\n
1203<\/span><\/td>\n Invitation has expired<\/span><\/td>\n<\/tr>\n
1300<\/span><\/td>\n Role name already exists in application<\/span><\/td>\n<\/tr>\n
1301<\/span><\/td>\n Role code already exists in application<\/span><\/td>\n<\/tr>\n
1302<\/span><\/td>\n Role is in use in organization<\/span><\/td>\n<\/tr>\n
1400<\/span><\/td>\n Phone number already in use in application<\/span><\/td>\n<\/tr>\n
1401<\/span><\/td>\n Email already exists in application<\/span><\/td>\n<\/tr>\n
1402<\/span><\/td>\n Callback URL not configured<\/span><\/td>\n<\/tr>\n
1403<\/span><\/td>\n User login email or verification code error or email not registered<\/span><\/td>\n<\/tr>\n
1404<\/span><\/td>\n This account has been disabled. Please contact the administrator or customer service if you have any questions.<\/span><\/td>\n<\/tr>\n
1405<\/span><\/td>\n User login email or password error or email not registered<\/span><\/td>\n<\/tr>\n
1406<\/span><\/td>\n User login requires verification code ticket<\/span><\/td>\n<\/tr>\n
1407<\/span><\/td>\n Does not allow this callback URL<\/span><\/td>\n<\/tr>\n
1408<\/span><\/td>\n Does not allow this authorization method<\/span><\/td>\n<\/tr>\n
1409<\/span><\/td>\n Invalid or expired REFRESH_TOKEN<\/span><\/td>\n<\/tr>\n
1410<\/span><\/td>\n Invalid or expired AUTHORIZATION_CODE<\/span><\/td>\n<\/tr>\n
1411<\/span><\/td>\n Current network is not in the allowed access range of the system.<\/span>
Please check your IP access restriction configuration or contact customer service.<\/span><\/td>\n<\/tr>\n
1412<\/span><\/td>\n Permanent email required. Disposable emails not allowed.<\/span><\/td>\n<\/tr>\n
1413<\/span><\/td>\n Non-application allowed login method<\/span><\/td>\n<\/tr>\n
1414<\/span><\/td>\n Current network environment has security risks and registration\/login is not supported.<\/span>
Please try again later or contact customer service.<\/span><\/td>\n<\/tr>\n
1415<\/span><\/td>\n Invalid email verification code<\/span><\/td>\n<\/tr>\n
1416<\/span><\/td>\n Invalid email address or email not registered<\/span><\/td>\n<\/tr>\n
1417<\/span><\/td>\n Invalid user password<\/span><\/td>\n<\/tr>\n
1418<\/span><\/td>\n One-time verification code error or expired. Please re-enter.<\/span><\/td>\n<\/tr>\n
1419<\/span><\/td>\n MFA verification error too many. Please try again later.<\/span><\/td>\n<\/tr>\n
1420<\/span><\/td>\n Verification has timed out. Please log in again and then perform two-factor authentication.<\/span><\/td>\n<\/tr>\n
1421<\/span><\/td>\n One-time verification code error or expired. Please enter again.<\/span><\/td>\n<\/tr>\n
1422<\/span><\/td>\n Invalid phone number or phone not registered<\/span><\/td>\n<\/tr>\n
1423<\/span><\/td>\n User login phone or password error or phone not registered<\/span><\/td>\n<\/tr>\n
1424<\/span><\/td>\n Invalid or expired phone verification code, or phone not registered<\/span><\/td>\n<\/tr>\n
1425<\/span><\/td>\n Phone region code is not allowed for this application<\/span><\/td>\n<\/tr>\n
1426<\/span><\/td>\n SMS verification code error or expired. Please enter again.<\/span><\/td>\n<\/tr>\n
1427<\/span><\/td>\n Invalid phone number format<\/span><\/td>\n<\/tr>\n
1428<\/span><\/td>\n This user is disabled and cannot be added to the organization.<\/span><\/td>\n<\/tr>\n
1500<\/span><\/td>\n Third-party login method not enabled<\/span><\/td>\n<\/tr>\n
1501<\/span><\/td>\n Third-party login method configuration error<\/span><\/td>\n<\/tr>\n
1502<\/span><\/td>\n Third-party login has expired<\/span><\/td>\n<\/tr>\n
1503<\/span><\/td>\n Third-party login authorization failed<\/span><\/td>\n<\/tr>\n
1504<\/span><\/td>\n Third-party login failed to get user information<\/span><\/td>\n<\/tr>\n
1505<\/span><\/td>\n Invalid or expired third-party ID token<\/span><\/td>\n<\/tr>\n
1506<\/span><\/td>\n Phone number not authorized. Please grant phone permission on the third-party consent page and try again.<\/span><\/td>\n<\/tr>\n
1507<\/span><\/td>\n Third-party identity not found or does not belong to the current account<\/span><\/td>\n<\/tr>\n
1508<\/span><\/td>\n This is the only remaining login method and cannot be unbound<\/span><\/td>\n<\/tr>\n
1600<\/span><\/td>\n Organization name already exists<\/span><\/td>\n<\/tr>\n
1700<\/span><\/td>\n Claim key already exists<\/span><\/td>\n<\/tr>\n
1701<\/span><\/td>\n Scope already exists<\/span><\/td>\n<\/tr>\n<\/tbody>\n<\/table>","pure_content":"When a request fails, the backend returns a response in the following format:\n\n\n\n\n\n{\n    \"status_code\": 200,\n    \"error_code\": 1405, \/\/ Use error_code to look up the corresponding message from get_error_code_setting\n    \"error_msg\": \"Email or Password incorrect\", \/\/ error_msg is the backend\u2019s original English message, not suitable for frontend display\n    \"data\": null\n}\n\n\n\n\n\n\n\nerror_code\u00a0is a numeric error code. Use it to look up the corresponding message in the tables below for frontend display.\n\n\nerror_msg\u00a0is the backend\u2019s raw English message and is\u00a0not suitable for direct display to users.\n\n\nYou can also dynamically fetch the latest error code messages (supporting both Chinese and English) via the endpoint\u00a0auth\/v1\/application\/get_error_code_setting. The tables below are current (may be updated over time).\n\u00a0\n1. Chinese Error Code Messages\n\n\n\n error_code\n Chinese Message\n\n\n\n\n 429\n \u8bf7\u6c42\u8fc7\u4e8e\u9891\u7e41\uff0c\u8bf7\u7a0d\u540e\u91cd\u8bd5\n\n\n 500\n \u670d\u52a1\u5668\u9519\u8bef\uff0c\u8bf7\u7a0d\u540e\u91cd\u8bd5\n\n\n 1000\n Token\u6821\u9a8c\u5931\u8d25\n\n\n 1001\n \u53c2\u6570\u9519\u8bef\uff0c\u8bf7\u91cd\u8bd5\uff01\n\n\n 1100\n \u6ce8\u518c\u8d26\u53f7\u5df2\u5b58\u5728\n\n\n 1101\n \u90ae\u4ef6\u9a8c\u8bc1\u7801\u9519\u8bef\n\n\n 1102\n \u90ae\u4ef6\u5730\u5740\u6216\u5bc6\u7801\u9519\u8bef\n\n\n 1103\n \u8d26\u53f7\u5df2\u88ab\u505c\u7528\n\n\n 1104\n \u90ae\u4ef6\u5730\u5740\u6216\u9a8c\u8bc1\u7801\u9519\u8bef\n\n\n 1105\n \u90ae\u7bb1\u5730\u5740\u9519\u8bef\n\n\n 1106\n \u9a8c\u8bc1\u7801\u9519\u8bef\u6216\u8fc7\u671f\uff0c\u8bf7\u91cd\u65b0\u8f93\u5165\n\n\n 1107\n MFA\u5df2\u88ab\u7981\u7528\uff0c\u8bf7\u7a0d\u540e\u91cd\u8bd5\n\n\n 1108\n \u9a8c\u8bc1\u5df2\u8d85\u65f6\uff0c\u8bf7\u91cd\u65b0\u767b\u5f55\u540e\u518d\u8fdb\u884c\u4e8c\u6b21\u9a8c\u8bc1\u3002\n\n\n 1109\n \u4e00\u6b21\u6027\u9a8c\u8bc1\u7801\u9519\u8bef\u6216\u8fc7\u671f\uff0c\u8bf7\u91cd\u65b0\u8f93\u5165\n\n\n 1200\n \u9080\u8bf7\u6210\u5458\u5df2\u5b58\u5728\n\n\n 1201\n \u6b64\u90ae\u7bb1\u9080\u8bf7\u8bb0\u5f55\u5df2\u5b58\u5728\n\n\n 1202\n \u9080\u8bf7\u94fe\u63a5\u5df2\u5931\u6548\uff0c\u8bf7\u91cd\u65b0\u53d1\u8d77\u9080\u8bf7\u3002\n\n\n 1203\n \u9080\u8bf7\u8bb0\u5f55\u5df2\u8fc7\u671f\n\n\n 1300\n \u89d2\u8272\u540d\u79f0\u5df2\u5b58\u5728\n\n\n 1301\n \u89d2\u8272\u4ee3\u7801\u5df2\u5b58\u5728\n\n\n 1302\n \u89d2\u8272\u5728\u7ec4\u7ec7\u4f7f\u7528\u4e2d\n\n\n 1400\n \u624b\u673a\u53f7\u5df2\u88ab\u5360\u7528\n\n\n 1401\n \u90ae\u7bb1\u53f7\u5df2\u5b58\u5728\n\n\n 1402\n \u672a\u914d\u7f6e\u56de\u8c03\u57df\u540d\n\n\n 1403\n \u767b\u5f55\u90ae\u7bb1\u6216\u9a8c\u8bc1\u7801\u9519\u8bef\u6216\u90ae\u7bb1\u672a\u6ce8\u518c\n\n\n 1404\n \u8be5\u8d26\u53f7\u5df2\u88ab\u7981\u6b62\u767b\u5f55\uff0c\u5982\u6709\u7591\u95ee\u8bf7\u8054\u7cfb\u7ba1\u7406\u5458\u6216\u5ba2\u670d\u3002\n\n\n 1405\n \u767b\u5f55\u90ae\u7bb1\u6216\u5bc6\u7801\u9519\u8bef\u6216\u90ae\u7bb1\u672a\u6ce8\u518c\n\n\n 1406\n \u767b\u5f55\u9700\u8981\u9a8c\u8bc1\u7801\u7968\u636e\n\n\n 1407\n \u4e0d\u5141\u8bb8\u4f7f\u7528\u6b64\u56de\u8c03\u57df\u540d\n\n\n 1408\n \u4e0d\u5141\u8bb8\u4f7f\u7528\u6b64\u6388\u6743\u65b9\u5f0f\n\n\n 1409\n \u65e0\u6548\u6216\u8fc7\u671f\u7684REFRESH_TOKEN\n\n\n 1410\n \u65e0\u6548\u6216\u8fc7\u671f\u7684AUTHORIZATION_CODE\n\n\n 1411\n \u5f53\u524d\u7f51\u7edc\u4e0d\u5728\u7cfb\u7edf\u5141\u8bb8\u7684\u8bbf\u95ee\u8303\u56f4\u5185\uff0c\u8bf7\u68c0\u67e5\u60a8\u7684IP\u8bbf\u95ee\u9650\u5236\u914d\u7f6e\uff0c\u6216\u8054\u7cfb\u5ba2\u670d\u3002\n\n\n 1412\n \u8bf7\u4f7f\u7528\u5e38\u7528\u90ae\u7bb1\uff0c\u4e0d\u652f\u6301\u4e34\u65f6\u90ae\u7bb1\u3002\n\n\n 1413\n \u975e\u5141\u8bb8\u7684\u767b\u5f55\u65b9\u5f0f\n\n\n 1414\n \u5f53\u524d\u7f51\u7edc\u73af\u5883\u5b58\u5728\u5b89\u5168\u98ce\u9669\uff0c\u6682\u4e0d\u652f\u6301\u6ce8\u518c\/\u767b\u5f55\u3002\u8bf7\u7a0d\u540e\u91cd\u8bd5\u6216\u8054\u7cfb\u5ba2\u670d\u3002\n\n\n 1415\n \u90ae\u4ef6\u9a8c\u8bc1\u7801\u9519\u8bef\n\n\n 1416\n \u90ae\u7bb1\u5730\u5740\u9519\u8bef\u6216\u90ae\u7bb1\u672a\u6ce8\u518c\n\n\n 1417\n \u7528\u6237\u5bc6\u7801\u9519\u8bef\n\n\n 1418\n \u9a8c\u8bc1\u7801\u9519\u8bef\u6216\u8fc7\u671f\uff0c\u8bf7\u91cd\u65b0\u8f93\u5165\n\n\n 1419\n MFA\u9a8c\u8bc1\u9519\u8bef\u8fc7\u591a\uff0c\u8bf7\u7a0d\u540e\u91cd\u8bd5\n\n\n 1420\n \u9a8c\u8bc1\u5df2\u8d85\u65f6\uff0c\u8bf7\u91cd\u65b0\u767b\u5f55\u540e\u518d\u8fdb\u884c\u4e8c\u6b21\u9a8c\u8bc1\u3002\n\n\n 1421\n \u4e00\u6b21\u6027\u9a8c\u8bc1\u7801\u9519\u8bef\u6216\u8fc7\u671f\uff0c\u8bf7\u91cd\u65b0\u8f93\u5165\n\n\n 1422\n \u624b\u673a\u53f7\u9519\u8bef\u6216\u624b\u673a\u53f7\u672a\u6ce8\u518c\n\n\n 1423\n \u767b\u5f55\u624b\u673a\u53f7\u6216\u5bc6\u7801\u9519\u8bef\u6216\u624b\u673a\u53f7\u672a\u6ce8\u518c\n\n\n 1424\n \u624b\u673a\u9a8c\u8bc1\u7801\u9519\u8bef\u6216\u5df2\u8fc7\u671f\u6216\u624b\u673a\u53f7\u672a\u6ce8\u518c\n\n\n 1425\n \u8be5\u624b\u673a\u53f7\u6240\u5728\u533a\u53f7\u672a\u88ab\u6388\u6743\n\n\n 1426\n \u77ed\u4fe1\u9a8c\u8bc1\u7801\u9519\u8bef\u6216\u8fc7\u671f\uff0c\u8bf7\u91cd\u65b0\u8f93\u5165\n\n\n 1427\n \u624b\u673a\u53f7\u7801\u683c\u5f0f\u4e0d\u6b63\u786e\n\n\n 1428\n \u8be5\u7528\u6237\u5904\u4e8e\u88ab\u7981\u6b62\u72b6\u6001\uff0c\u65e0\u6cd5\u6dfb\u52a0\u81f3\u7ec4\u7ec7\u3002\n\n\n 1500\n \u7b2c\u4e09\u65b9\u767b\u5f55\u65b9\u5f0f\u672a\u542f\u7528\n\n\n 1501\n \u7b2c\u4e09\u65b9\u767b\u5f55\u65b9\u5f0f\u914d\u7f6e\u9519\u8bef\n\n\n 1502\n \u7b2c\u4e09\u65b9\u767b\u5f55\u5df2\u8fc7\u671f\n\n\n 1503\n \u7b2c\u4e09\u65b9\u767b\u5f55\u6388\u6743\u5931\u8d25\n\n\n 1504\n \u7b2c\u4e09\u65b9\u767b\u5f55\u83b7\u53d6\u7528\u6237\u4fe1\u606f\u5931\u8d25\n\n\n 1505\n \u7b2c\u4e09\u65b9\u767b\u5f55 ID Token \u65e0\u6548\u6216\u5df2\u8fc7\u671f\n\n\n 1506\n \u672a\u6388\u6743\u624b\u673a\u53f7\uff0c\u8bf7\u5728\u7b2c\u4e09\u65b9\u6388\u6743\u9875\u9762\u540c\u610f\u5206\u4eab\u624b\u673a\u53f7\u540e\u91cd\u8bd5\n\n\n 1507\n \u672a\u627e\u5230\u5bf9\u5e94\u7684\u7b2c\u4e09\u65b9\u8eab\u4efd\u6216\u8be5\u8eab\u4efd\u4e0d\u5c5e\u4e8e\u5f53\u524d\u8d26\u53f7\n\n\n 1508\n \u8fd9\u662f\u5f53\u524d\u552f\u4e00\u7684\u767b\u5f55\u65b9\u5f0f\uff0c\u4e0d\u80fd\u89e3\u7ed1\n\n\n 1600\n \u7ec4\u7ec7\u540d\u79f0\u5df2\u5b58\u5728\n\n\n 1700\n Claim key\u5df2\u5b58\u5728\n\n\n 1701\n Scope\u5df2\u5b58\u5728\n\n\n\n\u00a0\n2. English Error Code Messages\n\n\n\n error_code\n English Message\n\n\n\n\n 429\n Too many requests. Please try again later.\n\n\n 500\n Server error. Please try again later.\n\n\n 1000\n Token validation failed\n\n\n 1001\n Parameter error, please try again!\n\n\n 1100\n Account already exists\n\n\n 1101\n Invalid email verification code\n\n\n 1102\n Invalid email or password\n\n\n 1103\n Account has been disabled\n\n\n 1104\n Invalid email or verification code\n\n\n 1105\n Invalid email address\n\n\n 1106\n Verification code error or expired. Please enter again.\n\n\n 1107\n MFA has been disabled. Please try again later.\n\n\n 1108\n The verification has timed out. Please log in again and then perform two-factor authentication.\n\n\n 1109\n One-time verification code error or expired. Please enter again.\n\n\n 1200\n Member already invited\n\n\n 1201\n Invitation record for this email already exists\n\n\n 1202\n Invitation link has expired. Please request a new invitation.\n\n\n 1203\n Invitation has expired\n\n\n 1300\n Role name already exists in application\n\n\n 1301\n Role code already exists in application\n\n\n 1302\n Role is in use in organization\n\n\n 1400\n Phone number already in use in application\n\n\n 1401\n Email already exists in application\n\n\n 1402\n Callback URL not configured\n\n\n 1403\n User login email or verification code error or email not registered\n\n\n 1404\n This account has been disabled. Please contact the administrator or customer service if you have any questions.\n\n\n 1405\n User login email or password error or email not registered\n\n\n 1406\n User login requires verification code ticket\n\n\n 1407\n Does not allow this callback URL\n\n\n 1408\n Does not allow this authorization method\n\n\n 1409\n Invalid or expired REFRESH_TOKEN\n\n\n 1410\n Invalid or expired AUTHORIZATION_CODE\n\n\n 1411\n Current network is not in the allowed access range of the system.Please check your IP access restriction configuration or contact customer service.\n\n\n 1412\n Permanent email required. Disposable emails not allowed.\n\n\n 1413\n Non-application allowed login method\n\n\n 1414\n Current network environment has security risks and registration\/login is not supported.Please try again later or contact customer service.\n\n\n 1415\n Invalid email verification code\n\n\n 1416\n Invalid email address or email not registered\n\n\n 1417\n Invalid user password\n\n\n 1418\n One-time verification code error or expired. Please re-enter.\n\n\n 1419\n MFA verification error too many. Please try again later.\n\n\n 1420\n Verification has timed out. Please log in again and then perform two-factor authentication.\n\n\n 1421\n One-time verification code error or expired. Please enter again.\n\n\n 1422\n Invalid phone number or phone not registered\n\n\n 1423\n User login phone or password error or phone not registered\n\n\n 1424\n Invalid or expired phone verification code, or phone not registered\n\n\n 1425\n Phone region code is not allowed for this application\n\n\n 1426\n SMS verification code error or expired. Please enter again.\n\n\n 1427\n Invalid phone number format\n\n\n 1428\n This user is disabled and cannot be added to the organization.\n\n\n 1500\n Third-party login method not enabled\n\n\n 1501\n Third-party login method configuration error\n\n\n 1502\n Third-party login has expired\n\n\n 1503\n Third-party login authorization failed\n\n\n 1504\n Third-party login failed to get user information\n\n\n 1505\n Invalid or expired third-party ID token\n\n\n 1506\n Phone number not authorized. Please grant phone permission on the third-party consent page and try again.\n\n\n 1507\n Third-party identity not found or does not belong to the current account\n\n\n 1508\n This is the only remaining login method and cannot be unbound\n\n\n 1600\n Organization name already exists\n\n\n 1700\n Claim key already exists\n\n\n 1701\n Scope already exists","is_draft":"0","editor_type":"3","file_path":"","add_time":"1780388191","update_time":"1780388639"},"pure_content":"When a request fails, the backend returns a response in the following format:\n\n\n\n\n\n{\n    \"status_code\": 200,\n    \"error_code\": 1405, \/\/ Use error_code to look up the corresponding message from get_err"}],"content":{"icon":"\/docker_production\/49w7c5\/content_icon\/dx2Ipzwx?rand=891341915","desc":"","content_id":"767807","add_time":"1776241463","update_time":"1776241516","content":"","is_traffic_less":"0","file_type":""},"hot_list":[],"user_read_num":"0","is_auth":"0"},"msg":"Success","code":200}