Back to Apitable

.AccountCenterModuleUserManagementInterfaceApi

packages/api-client/AccountCenterModuleUserManagementInterfaceApi.md

1.13.0-beta.125.5 KB
Original Source

.AccountCenterModuleUserManagementInterfaceApi

All URIs are relative to http://backend/api/v1

MethodHTTP requestDescription
applyForClosingPOST /user/applyForClosingApply for cancellation of user account
bindEmailPOST /user/bindEmailBind mail
cancelClosingPOST /user/cancelClosingApply for account restoration
checkForClosingGET /user/checkForClosingVerify whether the account can be cancelled
delActiveSpaceCacheGET /user/delActiveSpaceCacheDelete Active Space Cache
getEnabledLabFeaturesGET /user/labs/featuresGet the enabled experimental functions
linkInviteEmailPOST /user/link/inviteEmailAssociate the invited mail
resetPasswordPOST /user/resetPasswordreset password router
retrievePwdPOST /user/retrievePwdRetrieve password
unbindEmailPOST /user/unbindEmailUnbind mail
unbindPhonePOST /user/unbindPhoneUnbind mobile phone
updatePOST /user/updateEdit user information
updateLabsFeatureStatusPOST /user/labs/featuresUpdate the usage status of laboratory functions
updatePwdPOST /user/updatePwdChange Password
userInfoGET /user/meget personal information
validBindEmailGET /user/email/bindQuery whether users bind mail
validSameEmailPOST /user/validate/emailQuery whether the user is consistent with the specified mail
verifyPhonePOST /user/bindPhoneBind a new phone

applyForClosing

ResponseDataVoid applyForClosing()

Registered login user applies for account cancellation

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .AccountCenterModuleUserManagementInterfaceApi(configuration);

let body:any = {};

apiInstance.applyForClosing(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

bindEmail

ResponseDataVoid bindEmail(emailCodeValidateRo)

Bind mail and modify mail

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .AccountCenterModuleUserManagementInterfaceApi(configuration);

let body:.AccountCenterModuleUserManagementInterfaceApiBindEmailRequest = {
  // EmailCodeValidateRo
  emailCodeValidateRo: {
    email: "[email protected]",
    code: "123456",
  },
};

apiInstance.bindEmail(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
emailCodeValidateRoEmailCodeValidateRo

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

cancelClosing

ResponseDataVoid cancelClosing()

User recovery account has been applied for cancellation

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .AccountCenterModuleUserManagementInterfaceApi(configuration);

let body:any = {};

apiInstance.cancelClosing(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

checkForClosing

ResponseDataVoid checkForClosing()

Unregistered users verify whether the account meets the cancellation conditions

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .AccountCenterModuleUserManagementInterfaceApi(configuration);

let body:any = {};

apiInstance.checkForClosing(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delActiveSpaceCache

ResponseDataVoid delActiveSpaceCache()

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .AccountCenterModuleUserManagementInterfaceApi(configuration);

let body:any = {};

apiInstance.delActiveSpaceCache(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEnabledLabFeatures

ResponseDataLabsFeatureVo getEnabledLabFeatures()

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .AccountCenterModuleUserManagementInterfaceApi(configuration);

let body:.AccountCenterModuleUserManagementInterfaceApiGetEnabledLabFeaturesRequest = {
  // string
  spaceId: "spaceId_example",
};

apiInstance.getEnabledLabFeatures(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
spaceId[string]defaults to undefined

Return type

ResponseDataLabsFeatureVo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

linkInviteEmail

ResponseDataVoid linkInviteEmail(userLinkEmailRo)

Users can only associate with invited mail when they have no other mail

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .AccountCenterModuleUserManagementInterfaceApi(configuration);

let body:.AccountCenterModuleUserManagementInterfaceApiLinkInviteEmailRequest = {
  // UserLinkEmailRo
  userLinkEmailRo: {
    email: "[email protected]",
    spaceId: "spcyQkKp9XJEl",
  },
};

apiInstance.linkInviteEmail(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
userLinkEmailRoUserLinkEmailRo

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

resetPassword

ResponseDataVoid resetPassword()

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .AccountCenterModuleUserManagementInterfaceApi(configuration);

let body:any = {};

apiInstance.resetPassword(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

retrievePwd

ResponseDataVoid retrievePwd(retrievePwdOpRo)

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .AccountCenterModuleUserManagementInterfaceApi(configuration);

let body:.AccountCenterModuleUserManagementInterfaceApiRetrievePwdRequest = {
  // RetrievePwdOpRo
  retrievePwdOpRo: {
    type: "sms_code",
    areaCode: "+86",
    username: "13829291111 | [email protected]",
    code: "123456",
    password: "qwer1234",
  },
};

apiInstance.retrievePwd(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
retrievePwdOpRoRetrievePwdOpRo

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unbindEmail

ResponseDataVoid unbindEmail(codeValidateRo)

Bind mail and modify mail

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .AccountCenterModuleUserManagementInterfaceApi(configuration);

let body:.AccountCenterModuleUserManagementInterfaceApiUnbindEmailRequest = {
  // CodeValidateRo
  codeValidateRo: {
    code: "123456",
  },
};

apiInstance.unbindEmail(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
codeValidateRoCodeValidateRo

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unbindPhone

ResponseDataVoid unbindPhone(codeValidateRo)

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .AccountCenterModuleUserManagementInterfaceApi(configuration);

let body:.AccountCenterModuleUserManagementInterfaceApiUnbindPhoneRequest = {
  // CodeValidateRo
  codeValidateRo: {
    code: "123456",
  },
};

apiInstance.unbindPhone(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
codeValidateRoCodeValidateRo

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update

ResponseDataString update(userOpRo)

Request parameters cannot be all empty

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .AccountCenterModuleUserManagementInterfaceApi(configuration);

let body:.AccountCenterModuleUserManagementInterfaceApiUpdateRequest = {
  // UserOpRo
  userOpRo: {
    maxSize: 1,
    avatar: "https://...",
    avatarColor: 1,
    nickName: "This is a nickname",
    init: true,
    locale: "zh-CN",
    timeZone: "America/Toronto",
  },
};

apiInstance.update(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
userOpRoUserOpRo

Return type

ResponseDataString

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateLabsFeatureStatus

ResponseDataVoid updateLabsFeatureStatus(userLabsFeatureRo)

Update the usage status of laboratory functions

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .AccountCenterModuleUserManagementInterfaceApi(configuration);

let body:.AccountCenterModuleUserManagementInterfaceApiUpdateLabsFeatureStatusRequest = {
  // UserLabsFeatureRo
  userLabsFeatureRo: {
    spaceId: "spc6e2CeZLBFN",
    key: "render_prompt",
    isEnabled: true,
  },
};

apiInstance.updateLabsFeatureStatus(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
userLabsFeatureRoUserLabsFeatureRo

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updatePwd

ResponseDataVoid updatePwd(updatePwdOpRo)

Scene: 1. Personal setting and password modification; 2. Initialize after login for accounts without password

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .AccountCenterModuleUserManagementInterfaceApi(configuration);

let body:.AccountCenterModuleUserManagementInterfaceApiUpdatePwdRequest = {
  // UpdatePwdOpRo
  updatePwdOpRo: {
    type: "sms_code",
    code: "123456",
    password: "qwer1234",
  },
};

apiInstance.updatePwd(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
updatePwdOpRoUpdatePwdOpRo

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

userInfo

ResponseDataUserInfoVo userInfo()

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .AccountCenterModuleUserManagementInterfaceApi(configuration);

let body:.AccountCenterModuleUserManagementInterfaceApiUserInfoRequest = {
  // string | space id (optional)
  spaceId: "spc8mXUeiXyVo",
  // string | node id (optional)
  nodeId: "dstS94qPZFXjC1LKns",
  // boolean | whether to filter space related information (optional)
  filter: true,
};

apiInstance.userInfo(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
spaceId[string]space id(optional) defaults to undefined
nodeId[string]node id(optional) defaults to undefined
filter[boolean]whether to filter space related information(optional) defaults to undefined

Return type

ResponseDataUserInfoVo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

validBindEmail

ResponseDataBoolean validBindEmail()

Query whether users bind mail

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .AccountCenterModuleUserManagementInterfaceApi(configuration);

let body:any = {};

apiInstance.validBindEmail(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

This endpoint does not need any parameter.

Return type

ResponseDataBoolean

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

validSameEmail

ResponseDataBoolean validSameEmail(checkUserEmailRo)

Query whether the user is consistent with the specified mail. It can only be determined if the user has bound the mail

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .AccountCenterModuleUserManagementInterfaceApi(configuration);

let body:.AccountCenterModuleUserManagementInterfaceApiValidSameEmailRequest = {
  // CheckUserEmailRo
  checkUserEmailRo: {
    email: "[email protected]",
  },
};

apiInstance.validSameEmail(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
checkUserEmailRoCheckUserEmailRo

Return type

ResponseDataBoolean

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

verifyPhone

ResponseDataVoid verifyPhone(smsCodeValidateRo)

Bind a new phone

Example

typescript
import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .AccountCenterModuleUserManagementInterfaceApi(configuration);

let body:.AccountCenterModuleUserManagementInterfaceApiVerifyPhoneRequest = {
  // SmsCodeValidateRo
  smsCodeValidateRo: {
    areaCode: "+86",
    phone: "13411112222",
    code: "123456",
  },
};

apiInstance.verifyPhone(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

NameTypeDescriptionNotes
smsCodeValidateRoSmsCodeValidateRo

Return type

ResponseDataVoid

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: /

HTTP response details

Status codeDescriptionResponse headers
200OK-
500Internal Server Error-

[Back to top] [Back to API list] [Back to Model list] [Back to README]