packages/api-client/AccountCenterModuleUserManagementInterfaceApi.md
All URIs are relative to http://backend/api/v1
| Method | HTTP request | Description |
|---|---|---|
| applyForClosing | POST /user/applyForClosing | Apply for cancellation of user account |
| bindEmail | POST /user/bindEmail | Bind mail |
| cancelClosing | POST /user/cancelClosing | Apply for account restoration |
| checkForClosing | GET /user/checkForClosing | Verify whether the account can be cancelled |
| delActiveSpaceCache | GET /user/delActiveSpaceCache | Delete Active Space Cache |
| getEnabledLabFeatures | GET /user/labs/features | Get the enabled experimental functions |
| linkInviteEmail | POST /user/link/inviteEmail | Associate the invited mail |
| resetPassword | POST /user/resetPassword | reset password router |
| retrievePwd | POST /user/retrievePwd | Retrieve password |
| unbindEmail | POST /user/unbindEmail | Unbind mail |
| unbindPhone | POST /user/unbindPhone | Unbind mobile phone |
| update | POST /user/update | Edit user information |
| updateLabsFeatureStatus | POST /user/labs/features | Update the usage status of laboratory functions |
| updatePwd | POST /user/updatePwd | Change Password |
| userInfo | GET /user/me | get personal information |
| validBindEmail | GET /user/email/bind | Query whether users bind mail |
| validSameEmail | POST /user/validate/email | Query whether the user is consistent with the specified mail |
| verifyPhone | POST /user/bindPhone | Bind a new phone |
ResponseDataVoid applyForClosing()
Registered login user applies for account cancellation
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));
This endpoint does not need any parameter.
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid bindEmail(emailCodeValidateRo)
Bind mail and modify mail
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));
| Name | Type | Description | Notes |
|---|---|---|---|
| emailCodeValidateRo | EmailCodeValidateRo |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid cancelClosing()
User recovery account has been applied for cancellation
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));
This endpoint does not need any parameter.
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid checkForClosing()
Unregistered users verify whether the account meets the cancellation conditions
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));
This endpoint does not need any parameter.
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid delActiveSpaceCache()
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));
This endpoint does not need any parameter.
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataLabsFeatureVo getEnabledLabFeatures()
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));
| Name | Type | Description | Notes |
|---|---|---|---|
| spaceId | [string] | defaults to undefined |
ResponseDataLabsFeatureVo
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid linkInviteEmail(userLinkEmailRo)
Users can only associate with invited mail when they have no other mail
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));
| Name | Type | Description | Notes |
|---|---|---|---|
| userLinkEmailRo | UserLinkEmailRo |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid resetPassword()
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));
This endpoint does not need any parameter.
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid retrievePwd(retrievePwdOpRo)
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));
| Name | Type | Description | Notes |
|---|---|---|---|
| retrievePwdOpRo | RetrievePwdOpRo |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid unbindEmail(codeValidateRo)
Bind mail and modify mail
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));
| Name | Type | Description | Notes |
|---|---|---|---|
| codeValidateRo | CodeValidateRo |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid unbindPhone(codeValidateRo)
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));
| Name | Type | Description | Notes |
|---|---|---|---|
| codeValidateRo | CodeValidateRo |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataString update(userOpRo)
Request parameters cannot be all empty
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));
| Name | Type | Description | Notes |
|---|---|---|---|
| userOpRo | UserOpRo |
ResponseDataString
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid updateLabsFeatureStatus(userLabsFeatureRo)
Update the usage status of laboratory functions
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));
| Name | Type | Description | Notes |
|---|---|---|---|
| userLabsFeatureRo | UserLabsFeatureRo |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid updatePwd(updatePwdOpRo)
Scene: 1. Personal setting and password modification; 2. Initialize after login for accounts without password
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));
| Name | Type | Description | Notes |
|---|---|---|---|
| updatePwdOpRo | UpdatePwdOpRo |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataUserInfoVo userInfo()
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));
| Name | Type | Description | Notes |
|---|---|---|---|
| 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 |
ResponseDataUserInfoVo
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataBoolean validBindEmail()
Query whether users bind mail
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));
This endpoint does not need any parameter.
ResponseDataBoolean
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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
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));
| Name | Type | Description | Notes |
|---|---|---|---|
| checkUserEmailRo | CheckUserEmailRo |
ResponseDataBoolean
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ResponseDataVoid verifyPhone(smsCodeValidateRo)
Bind a new phone
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));
| Name | Type | Description | Notes |
|---|---|---|---|
| smsCodeValidateRo | SmsCodeValidateRo |
ResponseDataVoid
No authorization required
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
| 500 | Internal Server Error | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]