@cherryin/api-client 0.0.9 → 0.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +125 -46
- package/README.md +200 -85
- package/api.ts +4701 -1302
- package/dist/api.d.ts +3503 -1545
- package/dist/api.js +3186 -885
- package/dist/esm/api.d.ts +3503 -1545
- package/dist/esm/api.js +3186 -889
- package/docs/AIModelAdminServiceApi.md +6 -6
- package/docs/AdminEnterpriseMaterials.md +24 -0
- package/docs/AdminEnterpriseUser.md +24 -0
- package/docs/AdminEnterpriseUserMaterials.md +22 -0
- package/docs/AdminPassportItem.md +24 -0
- package/docs/AdminUserItem.md +26 -0
- package/docs/AuthAdminSession.md +39 -0
- package/docs/AuthAdminUser.md +2 -2
- package/docs/AuthEnterpriseMaterials.md +33 -0
- package/docs/AuthEnterpriseSession.md +37 -0
- package/docs/AuthEnterpriseUser.md +37 -0
- package/docs/AuthPassport.md +8 -8
- package/docs/AuthUser.md +10 -10
- package/docs/AuthUserMethod.md +8 -8
- package/docs/AuthUserSession.md +10 -6
- package/docs/ConfigItem.md +4 -0
- package/docs/{PassportAuthUserSendVerificationEmailRequest.md → PassportAdminSendVerificationEmailRequest.md} +3 -3
- package/docs/PassportAdminSendVerificationEmailResponse.md +22 -0
- package/docs/{PassportAuthAdminSignInEmailRequest.md → PassportAdminSignInEmailRequest.md} +7 -5
- package/docs/PassportAdminSignInEmailResponse.md +26 -0
- package/docs/PassportAuthAdminChangePasswordResponse.md +2 -2
- package/docs/PassportAuthAdminEnterpriseMaterialListResponse.md +28 -0
- package/docs/PassportAuthAdminEnterpriseMaterialReviewRequest.md +22 -0
- package/docs/PassportAuthAdminEnterpriseMaterialReviewResponse.md +22 -0
- package/docs/{PassportAuthAdminSignInEmailResponse.md → PassportAuthAdminGetInfoResponse.md} +3 -5
- package/docs/PassportAuthAdminGetSessionResponse.md +1 -1
- package/docs/PassportAuthAdminListSessionsResponse.md +1 -1
- package/docs/PassportAuthAdminPassportDisableRequest.md +22 -0
- package/docs/PassportAuthAdminPassportDisableResponse.md +22 -0
- package/docs/PassportAuthAdminPassportListRequest.md +28 -0
- package/docs/PassportAuthAdminPassportListResponse.md +28 -0
- package/docs/PassportAuthAdminPassportModifyInfoRequest.md +28 -0
- package/docs/{PassportAuthUserRevokeOtherSessionsResponse.md → PassportAuthAdminPassportModifyInfoResponse.md} +5 -5
- package/docs/PassportAuthAdminServiceApi.md +635 -35
- package/docs/{PassportAuthAdminUpdateUserRequest.md → PassportAuthAdminUpdateInfoRequest.md} +5 -5
- package/docs/{PassportAuthAdminUpdateUserResponse.md → PassportAuthAdminUpdateInfoResponse.md} +3 -3
- package/docs/PassportAuthAdminUserDisableRequest.md +26 -0
- package/docs/{PassportAuthUserRevokeSessionsResponse.md → PassportAuthAdminUserDisableResponse.md} +3 -3
- package/docs/PassportAuthAdminUserListRequest.md +28 -0
- package/docs/PassportAuthAdminUserListResponse.md +28 -0
- package/docs/PassportAuthAdminUserModifyInfoRequest.md +32 -0
- package/docs/PassportAuthAdminUserModifyInfoResponse.md +24 -0
- package/docs/PassportAuthAdminUserModifyPermissionRequest.md +22 -0
- package/docs/{PassportAuthUserSendVerificationEmailResponse.md → PassportAuthAdminUserModifyPermissionResponse.md} +5 -3
- package/docs/{PassportAuthUserChangePasswordRequest.md → PassportAuthChangePasswordRequest.md} +3 -3
- package/docs/{PassportAuthUserSignInPhoneResponse.md → PassportAuthChangePasswordResponse.md} +3 -5
- package/docs/{PassportAuthUserDeletePassportRequest.md → PassportAuthDeleteAllRequest.md} +9 -3
- package/docs/PassportAuthDeleteAllResponse.md +22 -0
- package/docs/PassportAuthEnterpriseChangePasswordRequest.md +24 -0
- package/docs/PassportAuthEnterpriseChangePasswordResponse.md +26 -0
- package/docs/PassportAuthEnterpriseChangePhoneRequest.md +24 -0
- package/docs/PassportAuthEnterpriseChangePhoneResponse.md +22 -0
- package/docs/PassportAuthEnterpriseDeleteRequest.md +28 -0
- package/docs/PassportAuthEnterpriseDeleteResponse.md +22 -0
- package/docs/PassportAuthEnterpriseGetSessionResponse.md +24 -0
- package/docs/{PassportAuthUserGetAccountInfoResponse.md → PassportAuthEnterpriseInfoGetResponse.md} +3 -3
- package/docs/PassportAuthEnterpriseListSessionsResponse.md +24 -0
- package/docs/PassportAuthEnterpriseMaterialUploadRequest.md +26 -0
- package/docs/{PassportAuthUserRequestPasswordResetResponse.md → PassportAuthEnterpriseMaterialUploadResponse.md} +3 -3
- package/docs/PassportAuthEnterpriseMaterialVerifyStateResponse.md +24 -0
- package/docs/PassportAuthEnterpriseRefreshTokenRequest.md +20 -0
- package/docs/PassportAuthEnterpriseRefreshTokenResponse.md +24 -0
- package/docs/PassportAuthEnterpriseResetPasswordRequest.md +22 -0
- package/docs/PassportAuthEnterpriseResetPasswordResponse.md +22 -0
- package/docs/{PassportAuthUserDeletePassportResponse.md → PassportAuthEnterpriseRevokeOtherSessionsResponse.md} +3 -3
- package/docs/PassportAuthEnterpriseRevokeSessionRequest.md +20 -0
- package/docs/PassportAuthEnterpriseRevokeSessionResponse.md +22 -0
- package/docs/PassportAuthEnterpriseRevokeSessionsResponse.md +22 -0
- package/docs/PassportAuthEnterpriseServiceApi.md +1170 -0
- package/docs/PassportAuthEnterpriseSignOutRequest.md +20 -0
- package/docs/{PassportAuthUserUnlinkAccountResponse.md → PassportAuthEnterpriseSignOutResponse.md} +3 -3
- package/docs/PassportAuthEnterpriseUpdateInfoRequest.md +22 -0
- package/docs/{PassportAuthUserChangePasswordResponse.md → PassportAuthEnterpriseUpdateInfoResponse.md} +3 -5
- package/docs/PassportAuthEnterpriseVerifyEmailRequest.md +24 -0
- package/docs/PassportAuthEnterpriseVerifyEmailResponse.md +22 -0
- package/docs/PassportAuthEnterpriseVerifyPhoneResponse.md +22 -0
- package/docs/{PassportAuthUserGetPassportInfoResponse.md → PassportAuthInfoGetResponse.md} +3 -3
- package/docs/{PassportAuthUserLinkSocialRequest.md → PassportAuthLinkSocialRequest.md} +3 -3
- package/docs/{PassportAuthUserLinkSocialResponse.md → PassportAuthLinkSocialResponse.md} +3 -3
- package/docs/{PassportAuthUserListMethodsResponse.md → PassportAuthListMethodsResponse.md} +3 -3
- package/docs/{PassportAuthUserListSessionsResponse.md → PassportAuthListSessionsResponse.md} +3 -3
- package/docs/{PassportAuthUserListAccountsResponse.md → PassportAuthListSocialsResponse.md} +3 -3
- package/docs/PassportAuthRefreshSessionTokenRequest.md +20 -0
- package/docs/PassportAuthRefreshSessionTokenResponse.md +24 -0
- package/docs/{PassportAuthUserResetPasswordRequest.md → PassportAuthResetPasswordRequest.md} +5 -5
- package/docs/PassportAuthResetPasswordResponse.md +22 -0
- package/docs/{PassportAuthUserRevokeOtherSessionsRequest.md → PassportAuthRevokeOtherSessionsRequest.md} +3 -3
- package/docs/{PassportAuthUserDeleteUserResponse.md → PassportAuthRevokeOtherSessionsResponse.md} +3 -3
- package/docs/{PassportAuthUserRevokeSessionRequest.md → PassportAuthRevokeSessionRequest.md} +3 -3
- package/docs/PassportAuthRevokeSessionResponse.md +22 -0
- package/docs/{PassportAuthUserRevokeSessionsRequest.md → PassportAuthRevokeSessionsRequest.md} +3 -3
- package/docs/PassportAuthRevokeSessionsResponse.md +22 -0
- package/docs/PassportAuthSendVerificationEmailRequest.md +26 -0
- package/docs/PassportAuthSendVerificationEmailResponse.md +22 -0
- package/docs/PassportAuthSendVerificationPhoneRequest.md +26 -0
- package/docs/PassportAuthSendVerificationPhoneResponse.md +22 -0
- package/docs/{PassportAuthUserRefreshTokenRequest.md → PassportAuthSocialGetAccessTokenRequest.md} +3 -3
- package/docs/{PassportAuthUserRefreshTokenResponse.md → PassportAuthSocialGetAccessTokenResponse.md} +3 -3
- package/docs/{PassportAuthUserGetAccessTokenRequest.md → PassportAuthSocialRefreshTokenRequest.md} +3 -3
- package/docs/{PassportAuthUserGetAccessTokenResponse.md → PassportAuthSocialRefreshTokenResponse.md} +3 -3
- package/docs/{PassportAuthUserUnlinkAccountRequest.md → PassportAuthUnlinkSocialRequest.md} +3 -3
- package/docs/PassportAuthUnlinkSocialResponse.md +22 -0
- package/docs/PassportAuthUserChangePhoneRequest.md +4 -4
- package/docs/{PassportAuthUserDeleteUserRequest.md → PassportAuthUserDeleteRequest.md} +9 -3
- package/docs/PassportAuthUserDeleteResponse.md +22 -0
- package/docs/PassportAuthUserGetSessionResponse.md +2 -2
- package/docs/PassportAuthUserInfoGetResponse.md +24 -0
- package/docs/PassportAuthUserServiceApi.md +546 -329
- package/docs/PassportAuthUserSignOutResponse.md +0 -2
- package/docs/{PassportAuthUserUpdateUserRequest.md → PassportAuthUserUpdateInfoRequest.md} +3 -3
- package/docs/{PassportAuthUserUpdateUserResponse.md → PassportAuthUserUpdateInfoResponse.md} +3 -3
- package/docs/{PassportAuthUserRequestPasswordResetRequest.md → PassportAuthUserVerifyEmailRequest.md} +7 -5
- package/docs/PassportAuthUserVerifyEmailResponse.md +0 -2
- package/docs/PassportAuthUserVerifyPhoneRequest.md +24 -0
- package/docs/PassportAuthUserVerifyPhoneResponse.md +0 -2
- package/docs/PassportEnterprisePasswordResetRequest.md +24 -0
- package/docs/{PassportAuthUserSignUpEmailResponse.md → PassportEnterprisePasswordResetResponse.md} +5 -9
- package/docs/PassportEnterpriseSendVerificationEmailRequest.md +24 -0
- package/docs/PassportEnterpriseSendVerificationEmailResponse.md +22 -0
- package/docs/PassportEnterpriseSendVerificationPhoneRequest.md +24 -0
- package/docs/PassportEnterpriseSendVerificationPhoneResponse.md +22 -0
- package/docs/PassportEnterpriseSignInEmailRequest.md +30 -0
- package/docs/PassportEnterpriseSignInEmailResponse.md +30 -0
- package/docs/PassportEnterpriseSignInPhoneRequest.md +24 -0
- package/docs/PassportEnterpriseSignInPhoneResponse.md +26 -0
- package/docs/PassportEnterpriseSignUpEmailRequest.md +34 -0
- package/docs/PassportEnterpriseSignUpEmailResponse.md +26 -0
- package/docs/PassportSendVerificationEmailRequest.md +26 -0
- package/docs/{PassportAuthUserRevokeSessionResponse.md → PassportSendVerificationEmailResponse.md} +3 -3
- package/docs/PassportSendVerificationPhoneRequest.md +26 -0
- package/docs/{PassportAuthUserResetPasswordResponse.md → PassportSendVerificationPhoneResponse.md} +3 -3
- package/docs/{PassportAuthUserOAuthCallbackResponse.md → PassportUserOAuthCallbackResponse.md} +6 -6
- package/docs/PassportUserPasswordResetRequest.md +28 -0
- package/docs/PassportUserPasswordResetResponse.md +26 -0
- package/docs/{PassportAuthUserSignInEmailRequest.md → PassportUserSignInEmailRequest.md} +9 -5
- package/docs/{PassportAuthUserSignInSocialResponse.md → PassportUserSignInEmailResponse.md} +6 -6
- package/docs/{PassportAuthUserSignInPhoneRequest.md → PassportUserSignInPhoneRequest.md} +7 -5
- package/docs/PassportUserSignInPhoneResponse.md +28 -0
- package/docs/{PassportAuthUserSignInSocialRequest.md → PassportUserSignInSocialRequest.md} +5 -5
- package/docs/PassportUserSignInSocialResponse.md +32 -0
- package/docs/{PassportAuthUserSignUpEmailRequest.md → PassportUserSignUpEmailRequest.md} +8 -6
- package/docs/{PassportAuthUserSignInEmailResponse.md → PassportUserSignUpEmailResponse.md} +6 -6
- package/docs/RemoteConfigAdminServiceApi.md +18 -3
- package/docs/RemoteConfigItemGetResponse.md +2 -2
- package/docs/RemoteConfigItemUpdateRequest.md +6 -0
- package/docs/RemoteConfigItemUpdateResponse.md +2 -2
- package/docs/Status.md +1 -1
- package/package.json +1 -1
|
@@ -4,41 +4,46 @@ All URIs are relative to *http://localhost*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**
|
|
8
|
-
|[**
|
|
9
|
-
|[**
|
|
10
|
-
|[**
|
|
11
|
-
|[**
|
|
12
|
-
|[**
|
|
13
|
-
|[**
|
|
14
|
-
|[**
|
|
15
|
-
|[**
|
|
16
|
-
|[**
|
|
17
|
-
|[**
|
|
18
|
-
|[**
|
|
19
|
-
|[**
|
|
20
|
-
|[**
|
|
21
|
-
|[**
|
|
22
|
-
|[**
|
|
23
|
-
|[**
|
|
24
|
-
|[**
|
|
25
|
-
|[**
|
|
26
|
-
|[**
|
|
27
|
-
|[**
|
|
28
|
-
|[**
|
|
29
|
-
|[**passportAuthUserServicePassportAuthUserSignInPhone**](#passportauthuserservicepassportauthusersigninphone) | **POST** /passport/auth/v1/sign-in/phone | |
|
|
30
|
-
|[**passportAuthUserServicePassportAuthUserSignInSocial**](#passportauthuserservicepassportauthusersigninsocial) | **POST** /passport/auth/v1/sign-in/social | |
|
|
7
|
+
|[**passportAuthUserServicePassportAuthChangePassword**](#passportauthuserservicepassportauthchangepassword) | **POST** /passport/authed/v1/password/change | |
|
|
8
|
+
|[**passportAuthUserServicePassportAuthDeleteAll**](#passportauthuserservicepassportauthdeleteall) | **POST** /passport/authed/v1/passport/request-delete | |
|
|
9
|
+
|[**passportAuthUserServicePassportAuthInfoGet**](#passportauthuserservicepassportauthinfoget) | **GET** /passport/authed/v1/passport/info | |
|
|
10
|
+
|[**passportAuthUserServicePassportAuthLinkSocial**](#passportauthuserservicepassportauthlinksocial) | **POST** /passport/authed/v1/social/link | |
|
|
11
|
+
|[**passportAuthUserServicePassportAuthListMethods**](#passportauthuserservicepassportauthlistmethods) | **GET** /passport/authed/v1/passport/list-auth-methods | |
|
|
12
|
+
|[**passportAuthUserServicePassportAuthListSessions**](#passportauthuserservicepassportauthlistsessions) | **GET** /passport/authed/v1/sessions/list | |
|
|
13
|
+
|[**passportAuthUserServicePassportAuthListSocials**](#passportauthuserservicepassportauthlistsocials) | **GET** /passport/authed/v1/social/list-accounts | |
|
|
14
|
+
|[**passportAuthUserServicePassportAuthRefreshSessionToken**](#passportauthuserservicepassportauthrefreshsessiontoken) | **POST** /passport/authed/v1/session/refresh-token | |
|
|
15
|
+
|[**passportAuthUserServicePassportAuthResetPassword**](#passportauthuserservicepassportauthresetpassword) | **POST** /passport/authed/v1/password/reset | |
|
|
16
|
+
|[**passportAuthUserServicePassportAuthRevokeOtherSessions**](#passportauthuserservicepassportauthrevokeothersessions) | **POST** /passport/authed/v1/sessions/revoke-other | |
|
|
17
|
+
|[**passportAuthUserServicePassportAuthRevokeSession**](#passportauthuserservicepassportauthrevokesession) | **POST** /passport/authed/v1/session/revoke | |
|
|
18
|
+
|[**passportAuthUserServicePassportAuthRevokeSessions**](#passportauthuserservicepassportauthrevokesessions) | **POST** /passport/authed/v1/sessions/revoke | |
|
|
19
|
+
|[**passportAuthUserServicePassportAuthSendVerificationEmail**](#passportauthuserservicepassportauthsendverificationemail) | **POST** /passport/authed/v1/verification/send-email | |
|
|
20
|
+
|[**passportAuthUserServicePassportAuthSendVerificationPhone**](#passportauthuserservicepassportauthsendverificationphone) | **POST** /passport/authed/v1/verification/send-phone | |
|
|
21
|
+
|[**passportAuthUserServicePassportAuthSocialGetAccessToken**](#passportauthuserservicepassportauthsocialgetaccesstoken) | **POST** /passport/authed/v1/social/get-access-token | |
|
|
22
|
+
|[**passportAuthUserServicePassportAuthSocialRefreshToken**](#passportauthuserservicepassportauthsocialrefreshtoken) | **POST** /passport/authed/v1/social/refresh-token | |
|
|
23
|
+
|[**passportAuthUserServicePassportAuthUnlinkSocial**](#passportauthuserservicepassportauthunlinksocial) | **POST** /passport/authed/v1/social/unlink | |
|
|
24
|
+
|[**passportAuthUserServicePassportAuthUserChangeEmail**](#passportauthuserservicepassportauthuserchangeemail) | **POST** /passport/authed/v1/email/change | |
|
|
25
|
+
|[**passportAuthUserServicePassportAuthUserChangePhone**](#passportauthuserservicepassportauthuserchangephone) | **POST** /passport/authed/v1/phone/change | |
|
|
26
|
+
|[**passportAuthUserServicePassportAuthUserDelete**](#passportauthuserservicepassportauthuserdelete) | **POST** /passport/authed/v1/user/request-delete | |
|
|
27
|
+
|[**passportAuthUserServicePassportAuthUserGetSession**](#passportauthuserservicepassportauthusergetsession) | **GET** /passport/authed/v1/session/get | |
|
|
28
|
+
|[**passportAuthUserServicePassportAuthUserInfoGet**](#passportauthuserservicepassportauthuserinfoget) | **GET** /passport/authed/v1/user/info | |
|
|
31
29
|
|[**passportAuthUserServicePassportAuthUserSignOut**](#passportauthuserservicepassportauthusersignout) | **POST** /passport/authed/v1/sign-out | |
|
|
32
|
-
|[**
|
|
33
|
-
|[**
|
|
34
|
-
|[**
|
|
35
|
-
|[**
|
|
36
|
-
|[**
|
|
37
|
-
|[**
|
|
38
|
-
|
|
39
|
-
# **
|
|
40
|
-
|
|
41
|
-
|
|
30
|
+
|[**passportAuthUserServicePassportAuthUserUpdateInfo**](#passportauthuserservicepassportauthuserupdateinfo) | **POST** /passport/authed/v1/user/update-info | |
|
|
31
|
+
|[**passportAuthUserServicePassportAuthUserUpdatePassport**](#passportauthuserservicepassportauthuserupdatepassport) | **POST** /passport/authed/v1/passport/update | |
|
|
32
|
+
|[**passportAuthUserServicePassportAuthUserVerifyEmail**](#passportauthuserservicepassportauthuserverifyemail) | **POST** /passport/authed/v1/email/verify | |
|
|
33
|
+
|[**passportAuthUserServicePassportAuthUserVerifyPhone**](#passportauthuserservicepassportauthuserverifyphone) | **POST** /passport/authed/v1/phone/verify | |
|
|
34
|
+
|[**passportAuthUserServicePassportSendVerificationEmail**](#passportauthuserservicepassportsendverificationemail) | **POST** /passport/auth/v1/verification/send-email | |
|
|
35
|
+
|[**passportAuthUserServicePassportSendVerificationPhone**](#passportauthuserservicepassportsendverificationphone) | **POST** /passport/auth/v1/verification/send-phone | |
|
|
36
|
+
|[**passportAuthUserServicePassportUserOAuthCallback**](#passportauthuserservicepassportuseroauthcallback) | **GET** /passport/oauth2/{platform}/callback | |
|
|
37
|
+
|[**passportAuthUserServicePassportUserPasswordReset**](#passportauthuserservicepassportuserpasswordreset) | **POST** /passport/auth/v1/password/request-reset | |
|
|
38
|
+
|[**passportAuthUserServicePassportUserSignInEmail**](#passportauthuserservicepassportusersigninemail) | **POST** /passport/auth/v1/sign-in/email | |
|
|
39
|
+
|[**passportAuthUserServicePassportUserSignInPhone**](#passportauthuserservicepassportusersigninphone) | **POST** /passport/auth/v1/sign-in/phone | |
|
|
40
|
+
|[**passportAuthUserServicePassportUserSignInSocial**](#passportauthuserservicepassportusersigninsocial) | **POST** /passport/auth/v1/sign-in/social | |
|
|
41
|
+
|[**passportAuthUserServicePassportUserSignUpEmail**](#passportauthuserservicepassportusersignupemail) | **POST** /passport/auth/v1/sign-up/email | |
|
|
42
|
+
|
|
43
|
+
# **passportAuthUserServicePassportAuthChangePassword**
|
|
44
|
+
> PassportAuthChangePasswordResponse passportAuthUserServicePassportAuthChangePassword(passportAuthChangePasswordRequest)
|
|
45
|
+
|
|
46
|
+
已登录用户修改密码
|
|
42
47
|
|
|
43
48
|
### Example
|
|
44
49
|
|
|
@@ -46,16 +51,16 @@ All URIs are relative to *http://localhost*
|
|
|
46
51
|
import {
|
|
47
52
|
PassportAuthUserServiceApi,
|
|
48
53
|
Configuration,
|
|
49
|
-
|
|
54
|
+
PassportAuthChangePasswordRequest
|
|
50
55
|
} from '@cherryin/api-client';
|
|
51
56
|
|
|
52
57
|
const configuration = new Configuration();
|
|
53
58
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
54
59
|
|
|
55
|
-
let
|
|
60
|
+
let passportAuthChangePasswordRequest: PassportAuthChangePasswordRequest; //
|
|
56
61
|
|
|
57
|
-
const { status, data } = await apiInstance.
|
|
58
|
-
|
|
62
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthChangePassword(
|
|
63
|
+
passportAuthChangePasswordRequest
|
|
59
64
|
);
|
|
60
65
|
```
|
|
61
66
|
|
|
@@ -63,12 +68,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
63
68
|
|
|
64
69
|
|Name | Type | Description | Notes|
|
|
65
70
|
|------------- | ------------- | ------------- | -------------|
|
|
66
|
-
| **
|
|
71
|
+
| **passportAuthChangePasswordRequest** | **PassportAuthChangePasswordRequest**| | |
|
|
67
72
|
|
|
68
73
|
|
|
69
74
|
### Return type
|
|
70
75
|
|
|
71
|
-
**
|
|
76
|
+
**PassportAuthChangePasswordResponse**
|
|
72
77
|
|
|
73
78
|
### Authorization
|
|
74
79
|
|
|
@@ -88,10 +93,10 @@ No authorization required
|
|
|
88
93
|
|
|
89
94
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
90
95
|
|
|
91
|
-
# **
|
|
92
|
-
>
|
|
96
|
+
# **passportAuthUserServicePassportAuthDeleteAll**
|
|
97
|
+
> PassportAuthDeleteAllResponse passportAuthUserServicePassportAuthDeleteAll(passportAuthDeleteAllRequest)
|
|
93
98
|
|
|
94
|
-
|
|
99
|
+
删除通行证及所有关联用户
|
|
95
100
|
|
|
96
101
|
### Example
|
|
97
102
|
|
|
@@ -99,16 +104,16 @@ No authorization required
|
|
|
99
104
|
import {
|
|
100
105
|
PassportAuthUserServiceApi,
|
|
101
106
|
Configuration,
|
|
102
|
-
|
|
107
|
+
PassportAuthDeleteAllRequest
|
|
103
108
|
} from '@cherryin/api-client';
|
|
104
109
|
|
|
105
110
|
const configuration = new Configuration();
|
|
106
111
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
107
112
|
|
|
108
|
-
let
|
|
113
|
+
let passportAuthDeleteAllRequest: PassportAuthDeleteAllRequest; //
|
|
109
114
|
|
|
110
|
-
const { status, data } = await apiInstance.
|
|
111
|
-
|
|
115
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthDeleteAll(
|
|
116
|
+
passportAuthDeleteAllRequest
|
|
112
117
|
);
|
|
113
118
|
```
|
|
114
119
|
|
|
@@ -116,12 +121,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
116
121
|
|
|
117
122
|
|Name | Type | Description | Notes|
|
|
118
123
|
|------------- | ------------- | ------------- | -------------|
|
|
119
|
-
| **
|
|
124
|
+
| **passportAuthDeleteAllRequest** | **PassportAuthDeleteAllRequest**| | |
|
|
120
125
|
|
|
121
126
|
|
|
122
127
|
### Return type
|
|
123
128
|
|
|
124
|
-
**
|
|
129
|
+
**PassportAuthDeleteAllResponse**
|
|
125
130
|
|
|
126
131
|
### Authorization
|
|
127
132
|
|
|
@@ -141,26 +146,26 @@ No authorization required
|
|
|
141
146
|
|
|
142
147
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
143
148
|
|
|
144
|
-
# **
|
|
145
|
-
>
|
|
149
|
+
# **passportAuthUserServicePassportAuthInfoGet**
|
|
150
|
+
> PassportAuthInfoGetResponse passportAuthUserServicePassportAuthInfoGet()
|
|
146
151
|
|
|
152
|
+
获取通行证及用户信息
|
|
147
153
|
|
|
148
154
|
### Example
|
|
149
155
|
|
|
150
156
|
```typescript
|
|
151
157
|
import {
|
|
152
158
|
PassportAuthUserServiceApi,
|
|
153
|
-
Configuration
|
|
154
|
-
PassportAuthUserChangePhoneRequest
|
|
159
|
+
Configuration
|
|
155
160
|
} from '@cherryin/api-client';
|
|
156
161
|
|
|
157
162
|
const configuration = new Configuration();
|
|
158
163
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
159
164
|
|
|
160
|
-
let
|
|
165
|
+
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表, 如果不指定则获取所有应用的用户信息 (optional) (default to undefined)
|
|
161
166
|
|
|
162
|
-
const { status, data } = await apiInstance.
|
|
163
|
-
|
|
167
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthInfoGet(
|
|
168
|
+
appIds
|
|
164
169
|
);
|
|
165
170
|
```
|
|
166
171
|
|
|
@@ -168,12 +173,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
168
173
|
|
|
169
174
|
|Name | Type | Description | Notes|
|
|
170
175
|
|------------- | ------------- | ------------- | -------------|
|
|
171
|
-
| **
|
|
176
|
+
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表, 如果不指定则获取所有应用的用户信息 | (optional) defaults to undefined|
|
|
172
177
|
|
|
173
178
|
|
|
174
179
|
### Return type
|
|
175
180
|
|
|
176
|
-
**
|
|
181
|
+
**PassportAuthInfoGetResponse**
|
|
177
182
|
|
|
178
183
|
### Authorization
|
|
179
184
|
|
|
@@ -181,7 +186,7 @@ No authorization required
|
|
|
181
186
|
|
|
182
187
|
### HTTP request headers
|
|
183
188
|
|
|
184
|
-
- **Content-Type**:
|
|
189
|
+
- **Content-Type**: Not defined
|
|
185
190
|
- **Accept**: application/json
|
|
186
191
|
|
|
187
192
|
|
|
@@ -193,9 +198,10 @@ No authorization required
|
|
|
193
198
|
|
|
194
199
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
195
200
|
|
|
196
|
-
# **
|
|
197
|
-
>
|
|
201
|
+
# **passportAuthUserServicePassportAuthLinkSocial**
|
|
202
|
+
> PassportAuthLinkSocialResponse passportAuthUserServicePassportAuthLinkSocial(passportAuthLinkSocialRequest)
|
|
198
203
|
|
|
204
|
+
已登录用户关联社交账号
|
|
199
205
|
|
|
200
206
|
### Example
|
|
201
207
|
|
|
@@ -203,16 +209,16 @@ No authorization required
|
|
|
203
209
|
import {
|
|
204
210
|
PassportAuthUserServiceApi,
|
|
205
211
|
Configuration,
|
|
206
|
-
|
|
212
|
+
PassportAuthLinkSocialRequest
|
|
207
213
|
} from '@cherryin/api-client';
|
|
208
214
|
|
|
209
215
|
const configuration = new Configuration();
|
|
210
216
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
211
217
|
|
|
212
|
-
let
|
|
218
|
+
let passportAuthLinkSocialRequest: PassportAuthLinkSocialRequest; //
|
|
213
219
|
|
|
214
|
-
const { status, data } = await apiInstance.
|
|
215
|
-
|
|
220
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthLinkSocial(
|
|
221
|
+
passportAuthLinkSocialRequest
|
|
216
222
|
);
|
|
217
223
|
```
|
|
218
224
|
|
|
@@ -220,12 +226,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
220
226
|
|
|
221
227
|
|Name | Type | Description | Notes|
|
|
222
228
|
|------------- | ------------- | ------------- | -------------|
|
|
223
|
-
| **
|
|
229
|
+
| **passportAuthLinkSocialRequest** | **PassportAuthLinkSocialRequest**| | |
|
|
224
230
|
|
|
225
231
|
|
|
226
232
|
### Return type
|
|
227
233
|
|
|
228
|
-
**
|
|
234
|
+
**PassportAuthLinkSocialResponse**
|
|
229
235
|
|
|
230
236
|
### Authorization
|
|
231
237
|
|
|
@@ -245,26 +251,26 @@ No authorization required
|
|
|
245
251
|
|
|
246
252
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
247
253
|
|
|
248
|
-
# **
|
|
249
|
-
>
|
|
254
|
+
# **passportAuthUserServicePassportAuthListMethods**
|
|
255
|
+
> PassportAuthListMethodsResponse passportAuthUserServicePassportAuthListMethods()
|
|
250
256
|
|
|
257
|
+
列出已关联的认证方法(包含 邮箱/社交账号等)
|
|
251
258
|
|
|
252
259
|
### Example
|
|
253
260
|
|
|
254
261
|
```typescript
|
|
255
262
|
import {
|
|
256
263
|
PassportAuthUserServiceApi,
|
|
257
|
-
Configuration
|
|
258
|
-
PassportAuthUserDeleteUserRequest
|
|
264
|
+
Configuration
|
|
259
265
|
} from '@cherryin/api-client';
|
|
260
266
|
|
|
261
267
|
const configuration = new Configuration();
|
|
262
268
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
263
269
|
|
|
264
|
-
let
|
|
270
|
+
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 (optional) (default to undefined)
|
|
265
271
|
|
|
266
|
-
const { status, data } = await apiInstance.
|
|
267
|
-
|
|
272
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthListMethods(
|
|
273
|
+
appIds
|
|
268
274
|
);
|
|
269
275
|
```
|
|
270
276
|
|
|
@@ -272,12 +278,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
272
278
|
|
|
273
279
|
|Name | Type | Description | Notes|
|
|
274
280
|
|------------- | ------------- | ------------- | -------------|
|
|
275
|
-
| **
|
|
281
|
+
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 | (optional) defaults to undefined|
|
|
276
282
|
|
|
277
283
|
|
|
278
284
|
### Return type
|
|
279
285
|
|
|
280
|
-
**
|
|
286
|
+
**PassportAuthListMethodsResponse**
|
|
281
287
|
|
|
282
288
|
### Authorization
|
|
283
289
|
|
|
@@ -285,7 +291,7 @@ No authorization required
|
|
|
285
291
|
|
|
286
292
|
### HTTP request headers
|
|
287
293
|
|
|
288
|
-
- **Content-Type**:
|
|
294
|
+
- **Content-Type**: Not defined
|
|
289
295
|
- **Accept**: application/json
|
|
290
296
|
|
|
291
297
|
|
|
@@ -297,26 +303,26 @@ No authorization required
|
|
|
297
303
|
|
|
298
304
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
299
305
|
|
|
300
|
-
# **
|
|
301
|
-
>
|
|
306
|
+
# **passportAuthUserServicePassportAuthListSessions**
|
|
307
|
+
> PassportAuthListSessionsResponse passportAuthUserServicePassportAuthListSessions()
|
|
302
308
|
|
|
309
|
+
获取当前用户的所有会话列表
|
|
303
310
|
|
|
304
311
|
### Example
|
|
305
312
|
|
|
306
313
|
```typescript
|
|
307
314
|
import {
|
|
308
315
|
PassportAuthUserServiceApi,
|
|
309
|
-
Configuration
|
|
310
|
-
PassportAuthUserGetAccessTokenRequest
|
|
316
|
+
Configuration
|
|
311
317
|
} from '@cherryin/api-client';
|
|
312
318
|
|
|
313
319
|
const configuration = new Configuration();
|
|
314
320
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
315
321
|
|
|
316
|
-
let
|
|
322
|
+
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" (optional) (default to undefined)
|
|
317
323
|
|
|
318
|
-
const { status, data } = await apiInstance.
|
|
319
|
-
|
|
324
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthListSessions(
|
|
325
|
+
appIds
|
|
320
326
|
);
|
|
321
327
|
```
|
|
322
328
|
|
|
@@ -324,12 +330,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
324
330
|
|
|
325
331
|
|Name | Type | Description | Notes|
|
|
326
332
|
|------------- | ------------- | ------------- | -------------|
|
|
327
|
-
| **
|
|
333
|
+
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" | (optional) defaults to undefined|
|
|
328
334
|
|
|
329
335
|
|
|
330
336
|
### Return type
|
|
331
337
|
|
|
332
|
-
**
|
|
338
|
+
**PassportAuthListSessionsResponse**
|
|
333
339
|
|
|
334
340
|
### Authorization
|
|
335
341
|
|
|
@@ -337,7 +343,7 @@ No authorization required
|
|
|
337
343
|
|
|
338
344
|
### HTTP request headers
|
|
339
345
|
|
|
340
|
-
- **Content-Type**:
|
|
346
|
+
- **Content-Type**: Not defined
|
|
341
347
|
- **Accept**: application/json
|
|
342
348
|
|
|
343
349
|
|
|
@@ -349,9 +355,10 @@ No authorization required
|
|
|
349
355
|
|
|
350
356
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
351
357
|
|
|
352
|
-
# **
|
|
353
|
-
>
|
|
358
|
+
# **passportAuthUserServicePassportAuthListSocials**
|
|
359
|
+
> PassportAuthListSocialsResponse passportAuthUserServicePassportAuthListSocials()
|
|
354
360
|
|
|
361
|
+
列出已关联的认证方法(列出社交账号)
|
|
355
362
|
|
|
356
363
|
### Example
|
|
357
364
|
|
|
@@ -364,9 +371,9 @@ import {
|
|
|
364
371
|
const configuration = new Configuration();
|
|
365
372
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
366
373
|
|
|
367
|
-
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 (optional) (default to undefined)
|
|
374
|
+
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" (optional) (default to undefined)
|
|
368
375
|
|
|
369
|
-
const { status, data } = await apiInstance.
|
|
376
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthListSocials(
|
|
370
377
|
appIds
|
|
371
378
|
);
|
|
372
379
|
```
|
|
@@ -375,12 +382,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
375
382
|
|
|
376
383
|
|Name | Type | Description | Notes|
|
|
377
384
|
|------------- | ------------- | ------------- | -------------|
|
|
378
|
-
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 | (optional) defaults to undefined|
|
|
385
|
+
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" | (optional) defaults to undefined|
|
|
379
386
|
|
|
380
387
|
|
|
381
388
|
### Return type
|
|
382
389
|
|
|
383
|
-
**
|
|
390
|
+
**PassportAuthListSocialsResponse**
|
|
384
391
|
|
|
385
392
|
### Authorization
|
|
386
393
|
|
|
@@ -400,31 +407,40 @@ No authorization required
|
|
|
400
407
|
|
|
401
408
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
402
409
|
|
|
403
|
-
# **
|
|
404
|
-
>
|
|
410
|
+
# **passportAuthUserServicePassportAuthRefreshSessionToken**
|
|
411
|
+
> PassportAuthRefreshSessionTokenResponse passportAuthUserServicePassportAuthRefreshSessionToken(passportAuthRefreshSessionTokenRequest)
|
|
405
412
|
|
|
413
|
+
会话 token 刷新
|
|
406
414
|
|
|
407
415
|
### Example
|
|
408
416
|
|
|
409
417
|
```typescript
|
|
410
418
|
import {
|
|
411
419
|
PassportAuthUserServiceApi,
|
|
412
|
-
Configuration
|
|
420
|
+
Configuration,
|
|
421
|
+
PassportAuthRefreshSessionTokenRequest
|
|
413
422
|
} from '@cherryin/api-client';
|
|
414
423
|
|
|
415
424
|
const configuration = new Configuration();
|
|
416
425
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
417
426
|
|
|
418
|
-
|
|
427
|
+
let passportAuthRefreshSessionTokenRequest: PassportAuthRefreshSessionTokenRequest; //
|
|
428
|
+
|
|
429
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthRefreshSessionToken(
|
|
430
|
+
passportAuthRefreshSessionTokenRequest
|
|
431
|
+
);
|
|
419
432
|
```
|
|
420
433
|
|
|
421
434
|
### Parameters
|
|
422
|
-
|
|
435
|
+
|
|
436
|
+
|Name | Type | Description | Notes|
|
|
437
|
+
|------------- | ------------- | ------------- | -------------|
|
|
438
|
+
| **passportAuthRefreshSessionTokenRequest** | **PassportAuthRefreshSessionTokenRequest**| | |
|
|
423
439
|
|
|
424
440
|
|
|
425
441
|
### Return type
|
|
426
442
|
|
|
427
|
-
**
|
|
443
|
+
**PassportAuthRefreshSessionTokenResponse**
|
|
428
444
|
|
|
429
445
|
### Authorization
|
|
430
446
|
|
|
@@ -432,7 +448,7 @@ No authorization required
|
|
|
432
448
|
|
|
433
449
|
### HTTP request headers
|
|
434
450
|
|
|
435
|
-
- **Content-Type**:
|
|
451
|
+
- **Content-Type**: application/json
|
|
436
452
|
- **Accept**: application/json
|
|
437
453
|
|
|
438
454
|
|
|
@@ -444,25 +460,27 @@ No authorization required
|
|
|
444
460
|
|
|
445
461
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
446
462
|
|
|
447
|
-
# **
|
|
448
|
-
>
|
|
463
|
+
# **passportAuthUserServicePassportAuthResetPassword**
|
|
464
|
+
> PassportAuthResetPasswordResponse passportAuthUserServicePassportAuthResetPassword(passportAuthResetPasswordRequest)
|
|
449
465
|
|
|
466
|
+
已登录用户重置密码
|
|
450
467
|
|
|
451
468
|
### Example
|
|
452
469
|
|
|
453
470
|
```typescript
|
|
454
471
|
import {
|
|
455
472
|
PassportAuthUserServiceApi,
|
|
456
|
-
Configuration
|
|
473
|
+
Configuration,
|
|
474
|
+
PassportAuthResetPasswordRequest
|
|
457
475
|
} from '@cherryin/api-client';
|
|
458
476
|
|
|
459
477
|
const configuration = new Configuration();
|
|
460
478
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
461
479
|
|
|
462
|
-
let
|
|
480
|
+
let passportAuthResetPasswordRequest: PassportAuthResetPasswordRequest; //
|
|
463
481
|
|
|
464
|
-
const { status, data } = await apiInstance.
|
|
465
|
-
|
|
482
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthResetPassword(
|
|
483
|
+
passportAuthResetPasswordRequest
|
|
466
484
|
);
|
|
467
485
|
```
|
|
468
486
|
|
|
@@ -470,12 +488,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
470
488
|
|
|
471
489
|
|Name | Type | Description | Notes|
|
|
472
490
|
|------------- | ------------- | ------------- | -------------|
|
|
473
|
-
| **
|
|
491
|
+
| **passportAuthResetPasswordRequest** | **PassportAuthResetPasswordRequest**| | |
|
|
474
492
|
|
|
475
493
|
|
|
476
494
|
### Return type
|
|
477
495
|
|
|
478
|
-
**
|
|
496
|
+
**PassportAuthResetPasswordResponse**
|
|
479
497
|
|
|
480
498
|
### Authorization
|
|
481
499
|
|
|
@@ -483,7 +501,7 @@ No authorization required
|
|
|
483
501
|
|
|
484
502
|
### HTTP request headers
|
|
485
503
|
|
|
486
|
-
- **Content-Type**:
|
|
504
|
+
- **Content-Type**: application/json
|
|
487
505
|
- **Accept**: application/json
|
|
488
506
|
|
|
489
507
|
|
|
@@ -495,9 +513,10 @@ No authorization required
|
|
|
495
513
|
|
|
496
514
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
497
515
|
|
|
498
|
-
# **
|
|
499
|
-
>
|
|
516
|
+
# **passportAuthUserServicePassportAuthRevokeOtherSessions**
|
|
517
|
+
> PassportAuthRevokeOtherSessionsResponse passportAuthUserServicePassportAuthRevokeOtherSessions(passportAuthRevokeOtherSessionsRequest)
|
|
500
518
|
|
|
519
|
+
注销其他会话
|
|
501
520
|
|
|
502
521
|
### Example
|
|
503
522
|
|
|
@@ -505,16 +524,16 @@ No authorization required
|
|
|
505
524
|
import {
|
|
506
525
|
PassportAuthUserServiceApi,
|
|
507
526
|
Configuration,
|
|
508
|
-
|
|
527
|
+
PassportAuthRevokeOtherSessionsRequest
|
|
509
528
|
} from '@cherryin/api-client';
|
|
510
529
|
|
|
511
530
|
const configuration = new Configuration();
|
|
512
531
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
513
532
|
|
|
514
|
-
let
|
|
533
|
+
let passportAuthRevokeOtherSessionsRequest: PassportAuthRevokeOtherSessionsRequest; //
|
|
515
534
|
|
|
516
|
-
const { status, data } = await apiInstance.
|
|
517
|
-
|
|
535
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthRevokeOtherSessions(
|
|
536
|
+
passportAuthRevokeOtherSessionsRequest
|
|
518
537
|
);
|
|
519
538
|
```
|
|
520
539
|
|
|
@@ -522,12 +541,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
522
541
|
|
|
523
542
|
|Name | Type | Description | Notes|
|
|
524
543
|
|------------- | ------------- | ------------- | -------------|
|
|
525
|
-
| **
|
|
544
|
+
| **passportAuthRevokeOtherSessionsRequest** | **PassportAuthRevokeOtherSessionsRequest**| | |
|
|
526
545
|
|
|
527
546
|
|
|
528
547
|
### Return type
|
|
529
548
|
|
|
530
|
-
**
|
|
549
|
+
**PassportAuthRevokeOtherSessionsResponse**
|
|
531
550
|
|
|
532
551
|
### Authorization
|
|
533
552
|
|
|
@@ -547,26 +566,27 @@ No authorization required
|
|
|
547
566
|
|
|
548
567
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
549
568
|
|
|
550
|
-
# **
|
|
551
|
-
>
|
|
569
|
+
# **passportAuthUserServicePassportAuthRevokeSession**
|
|
570
|
+
> PassportAuthRevokeSessionResponse passportAuthUserServicePassportAuthRevokeSession(passportAuthRevokeSessionRequest)
|
|
552
571
|
|
|
553
|
-
|
|
572
|
+
注销指定会话
|
|
554
573
|
|
|
555
574
|
### Example
|
|
556
575
|
|
|
557
576
|
```typescript
|
|
558
577
|
import {
|
|
559
578
|
PassportAuthUserServiceApi,
|
|
560
|
-
Configuration
|
|
579
|
+
Configuration,
|
|
580
|
+
PassportAuthRevokeSessionRequest
|
|
561
581
|
} from '@cherryin/api-client';
|
|
562
582
|
|
|
563
583
|
const configuration = new Configuration();
|
|
564
584
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
565
585
|
|
|
566
|
-
let
|
|
586
|
+
let passportAuthRevokeSessionRequest: PassportAuthRevokeSessionRequest; //
|
|
567
587
|
|
|
568
|
-
const { status, data } = await apiInstance.
|
|
569
|
-
|
|
588
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthRevokeSession(
|
|
589
|
+
passportAuthRevokeSessionRequest
|
|
570
590
|
);
|
|
571
591
|
```
|
|
572
592
|
|
|
@@ -574,12 +594,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
574
594
|
|
|
575
595
|
|Name | Type | Description | Notes|
|
|
576
596
|
|------------- | ------------- | ------------- | -------------|
|
|
577
|
-
| **
|
|
597
|
+
| **passportAuthRevokeSessionRequest** | **PassportAuthRevokeSessionRequest**| | |
|
|
578
598
|
|
|
579
599
|
|
|
580
600
|
### Return type
|
|
581
601
|
|
|
582
|
-
**
|
|
602
|
+
**PassportAuthRevokeSessionResponse**
|
|
583
603
|
|
|
584
604
|
### Authorization
|
|
585
605
|
|
|
@@ -587,7 +607,7 @@ No authorization required
|
|
|
587
607
|
|
|
588
608
|
### HTTP request headers
|
|
589
609
|
|
|
590
|
-
- **Content-Type**:
|
|
610
|
+
- **Content-Type**: application/json
|
|
591
611
|
- **Accept**: application/json
|
|
592
612
|
|
|
593
613
|
|
|
@@ -599,26 +619,27 @@ No authorization required
|
|
|
599
619
|
|
|
600
620
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
601
621
|
|
|
602
|
-
# **
|
|
603
|
-
>
|
|
622
|
+
# **passportAuthUserServicePassportAuthRevokeSessions**
|
|
623
|
+
> PassportAuthRevokeSessionsResponse passportAuthUserServicePassportAuthRevokeSessions(passportAuthRevokeSessionsRequest)
|
|
604
624
|
|
|
605
|
-
|
|
625
|
+
注销所有会话
|
|
606
626
|
|
|
607
627
|
### Example
|
|
608
628
|
|
|
609
629
|
```typescript
|
|
610
630
|
import {
|
|
611
631
|
PassportAuthUserServiceApi,
|
|
612
|
-
Configuration
|
|
632
|
+
Configuration,
|
|
633
|
+
PassportAuthRevokeSessionsRequest
|
|
613
634
|
} from '@cherryin/api-client';
|
|
614
635
|
|
|
615
636
|
const configuration = new Configuration();
|
|
616
637
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
617
638
|
|
|
618
|
-
let
|
|
639
|
+
let passportAuthRevokeSessionsRequest: PassportAuthRevokeSessionsRequest; //
|
|
619
640
|
|
|
620
|
-
const { status, data } = await apiInstance.
|
|
621
|
-
|
|
641
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthRevokeSessions(
|
|
642
|
+
passportAuthRevokeSessionsRequest
|
|
622
643
|
);
|
|
623
644
|
```
|
|
624
645
|
|
|
@@ -626,12 +647,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
626
647
|
|
|
627
648
|
|Name | Type | Description | Notes|
|
|
628
649
|
|------------- | ------------- | ------------- | -------------|
|
|
629
|
-
| **
|
|
650
|
+
| **passportAuthRevokeSessionsRequest** | **PassportAuthRevokeSessionsRequest**| | |
|
|
630
651
|
|
|
631
652
|
|
|
632
653
|
### Return type
|
|
633
654
|
|
|
634
|
-
**
|
|
655
|
+
**PassportAuthRevokeSessionsResponse**
|
|
635
656
|
|
|
636
657
|
### Authorization
|
|
637
658
|
|
|
@@ -639,7 +660,7 @@ No authorization required
|
|
|
639
660
|
|
|
640
661
|
### HTTP request headers
|
|
641
662
|
|
|
642
|
-
- **Content-Type**:
|
|
663
|
+
- **Content-Type**: application/json
|
|
643
664
|
- **Accept**: application/json
|
|
644
665
|
|
|
645
666
|
|
|
@@ -651,31 +672,27 @@ No authorization required
|
|
|
651
672
|
|
|
652
673
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
653
674
|
|
|
654
|
-
# **
|
|
655
|
-
>
|
|
675
|
+
# **passportAuthUserServicePassportAuthSendVerificationEmail**
|
|
676
|
+
> PassportAuthSendVerificationEmailResponse passportAuthUserServicePassportAuthSendVerificationEmail(passportAuthSendVerificationEmailRequest)
|
|
656
677
|
|
|
678
|
+
用户认证后发送验证码
|
|
657
679
|
|
|
658
680
|
### Example
|
|
659
681
|
|
|
660
682
|
```typescript
|
|
661
683
|
import {
|
|
662
684
|
PassportAuthUserServiceApi,
|
|
663
|
-
Configuration
|
|
685
|
+
Configuration,
|
|
686
|
+
PassportAuthSendVerificationEmailRequest
|
|
664
687
|
} from '@cherryin/api-client';
|
|
665
688
|
|
|
666
689
|
const configuration = new Configuration();
|
|
667
690
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
668
691
|
|
|
669
|
-
let
|
|
670
|
-
let appIds: string; //User.AppID, 支持多个应用同时登录,如果对应 App 的账号,无法完成登录 NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" (optional) (default to undefined)
|
|
671
|
-
let code: string; //@gotags: form:\"code\" OAuth 授权码 (optional) (default to undefined)
|
|
672
|
-
let state: string; //@gotags: form:\"state\" CSRF state (optional) (default to undefined)
|
|
692
|
+
let passportAuthSendVerificationEmailRequest: PassportAuthSendVerificationEmailRequest; //
|
|
673
693
|
|
|
674
|
-
const { status, data } = await apiInstance.
|
|
675
|
-
|
|
676
|
-
appIds,
|
|
677
|
-
code,
|
|
678
|
-
state
|
|
694
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthSendVerificationEmail(
|
|
695
|
+
passportAuthSendVerificationEmailRequest
|
|
679
696
|
);
|
|
680
697
|
```
|
|
681
698
|
|
|
@@ -683,15 +700,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
683
700
|
|
|
684
701
|
|Name | Type | Description | Notes|
|
|
685
702
|
|------------- | ------------- | ------------- | -------------|
|
|
686
|
-
| **
|
|
687
|
-
| **appIds** | [**string**] | User.AppID, 支持多个应用同时登录,如果对应 App 的账号,无法完成登录 NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" | (optional) defaults to undefined|
|
|
688
|
-
| **code** | [**string**] | @gotags: form:\"code\" OAuth 授权码 | (optional) defaults to undefined|
|
|
689
|
-
| **state** | [**string**] | @gotags: form:\"state\" CSRF state | (optional) defaults to undefined|
|
|
703
|
+
| **passportAuthSendVerificationEmailRequest** | **PassportAuthSendVerificationEmailRequest**| | |
|
|
690
704
|
|
|
691
705
|
|
|
692
706
|
### Return type
|
|
693
707
|
|
|
694
|
-
**
|
|
708
|
+
**PassportAuthSendVerificationEmailResponse**
|
|
695
709
|
|
|
696
710
|
### Authorization
|
|
697
711
|
|
|
@@ -699,7 +713,7 @@ No authorization required
|
|
|
699
713
|
|
|
700
714
|
### HTTP request headers
|
|
701
715
|
|
|
702
|
-
- **Content-Type**:
|
|
716
|
+
- **Content-Type**: application/json
|
|
703
717
|
- **Accept**: application/json
|
|
704
718
|
|
|
705
719
|
|
|
@@ -711,9 +725,10 @@ No authorization required
|
|
|
711
725
|
|
|
712
726
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
713
727
|
|
|
714
|
-
# **
|
|
715
|
-
>
|
|
728
|
+
# **passportAuthUserServicePassportAuthSendVerificationPhone**
|
|
729
|
+
> PassportAuthSendVerificationPhoneResponse passportAuthUserServicePassportAuthSendVerificationPhone(passportAuthSendVerificationPhoneRequest)
|
|
716
730
|
|
|
731
|
+
用户认证后发送验证码
|
|
717
732
|
|
|
718
733
|
### Example
|
|
719
734
|
|
|
@@ -721,16 +736,16 @@ No authorization required
|
|
|
721
736
|
import {
|
|
722
737
|
PassportAuthUserServiceApi,
|
|
723
738
|
Configuration,
|
|
724
|
-
|
|
739
|
+
PassportAuthSendVerificationPhoneRequest
|
|
725
740
|
} from '@cherryin/api-client';
|
|
726
741
|
|
|
727
742
|
const configuration = new Configuration();
|
|
728
743
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
729
744
|
|
|
730
|
-
let
|
|
745
|
+
let passportAuthSendVerificationPhoneRequest: PassportAuthSendVerificationPhoneRequest; //
|
|
731
746
|
|
|
732
|
-
const { status, data } = await apiInstance.
|
|
733
|
-
|
|
747
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthSendVerificationPhone(
|
|
748
|
+
passportAuthSendVerificationPhoneRequest
|
|
734
749
|
);
|
|
735
750
|
```
|
|
736
751
|
|
|
@@ -738,12 +753,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
738
753
|
|
|
739
754
|
|Name | Type | Description | Notes|
|
|
740
755
|
|------------- | ------------- | ------------- | -------------|
|
|
741
|
-
| **
|
|
756
|
+
| **passportAuthSendVerificationPhoneRequest** | **PassportAuthSendVerificationPhoneRequest**| | |
|
|
742
757
|
|
|
743
758
|
|
|
744
759
|
### Return type
|
|
745
760
|
|
|
746
|
-
**
|
|
761
|
+
**PassportAuthSendVerificationPhoneResponse**
|
|
747
762
|
|
|
748
763
|
### Authorization
|
|
749
764
|
|
|
@@ -763,9 +778,10 @@ No authorization required
|
|
|
763
778
|
|
|
764
779
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
765
780
|
|
|
766
|
-
# **
|
|
767
|
-
>
|
|
781
|
+
# **passportAuthUserServicePassportAuthSocialGetAccessToken**
|
|
782
|
+
> PassportAuthSocialGetAccessTokenResponse passportAuthUserServicePassportAuthSocialGetAccessToken(passportAuthSocialGetAccessTokenRequest)
|
|
768
783
|
|
|
784
|
+
获取社交账号访问令牌
|
|
769
785
|
|
|
770
786
|
### Example
|
|
771
787
|
|
|
@@ -773,16 +789,16 @@ No authorization required
|
|
|
773
789
|
import {
|
|
774
790
|
PassportAuthUserServiceApi,
|
|
775
791
|
Configuration,
|
|
776
|
-
|
|
792
|
+
PassportAuthSocialGetAccessTokenRequest
|
|
777
793
|
} from '@cherryin/api-client';
|
|
778
794
|
|
|
779
795
|
const configuration = new Configuration();
|
|
780
796
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
781
797
|
|
|
782
|
-
let
|
|
798
|
+
let passportAuthSocialGetAccessTokenRequest: PassportAuthSocialGetAccessTokenRequest; //
|
|
783
799
|
|
|
784
|
-
const { status, data } = await apiInstance.
|
|
785
|
-
|
|
800
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthSocialGetAccessToken(
|
|
801
|
+
passportAuthSocialGetAccessTokenRequest
|
|
786
802
|
);
|
|
787
803
|
```
|
|
788
804
|
|
|
@@ -790,12 +806,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
790
806
|
|
|
791
807
|
|Name | Type | Description | Notes|
|
|
792
808
|
|------------- | ------------- | ------------- | -------------|
|
|
793
|
-
| **
|
|
809
|
+
| **passportAuthSocialGetAccessTokenRequest** | **PassportAuthSocialGetAccessTokenRequest**| | |
|
|
794
810
|
|
|
795
811
|
|
|
796
812
|
### Return type
|
|
797
813
|
|
|
798
|
-
**
|
|
814
|
+
**PassportAuthSocialGetAccessTokenResponse**
|
|
799
815
|
|
|
800
816
|
### Authorization
|
|
801
817
|
|
|
@@ -815,9 +831,10 @@ No authorization required
|
|
|
815
831
|
|
|
816
832
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
817
833
|
|
|
818
|
-
# **
|
|
819
|
-
>
|
|
834
|
+
# **passportAuthUserServicePassportAuthSocialRefreshToken**
|
|
835
|
+
> PassportAuthSocialRefreshTokenResponse passportAuthUserServicePassportAuthSocialRefreshToken(passportAuthSocialRefreshTokenRequest)
|
|
820
836
|
|
|
837
|
+
社交账号刷新 Token
|
|
821
838
|
|
|
822
839
|
### Example
|
|
823
840
|
|
|
@@ -825,16 +842,16 @@ No authorization required
|
|
|
825
842
|
import {
|
|
826
843
|
PassportAuthUserServiceApi,
|
|
827
844
|
Configuration,
|
|
828
|
-
|
|
845
|
+
PassportAuthSocialRefreshTokenRequest
|
|
829
846
|
} from '@cherryin/api-client';
|
|
830
847
|
|
|
831
848
|
const configuration = new Configuration();
|
|
832
849
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
833
850
|
|
|
834
|
-
let
|
|
851
|
+
let passportAuthSocialRefreshTokenRequest: PassportAuthSocialRefreshTokenRequest; //
|
|
835
852
|
|
|
836
|
-
const { status, data } = await apiInstance.
|
|
837
|
-
|
|
853
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthSocialRefreshToken(
|
|
854
|
+
passportAuthSocialRefreshTokenRequest
|
|
838
855
|
);
|
|
839
856
|
```
|
|
840
857
|
|
|
@@ -842,12 +859,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
842
859
|
|
|
843
860
|
|Name | Type | Description | Notes|
|
|
844
861
|
|------------- | ------------- | ------------- | -------------|
|
|
845
|
-
| **
|
|
862
|
+
| **passportAuthSocialRefreshTokenRequest** | **PassportAuthSocialRefreshTokenRequest**| | |
|
|
846
863
|
|
|
847
864
|
|
|
848
865
|
### Return type
|
|
849
866
|
|
|
850
|
-
**
|
|
867
|
+
**PassportAuthSocialRefreshTokenResponse**
|
|
851
868
|
|
|
852
869
|
### Authorization
|
|
853
870
|
|
|
@@ -867,9 +884,10 @@ No authorization required
|
|
|
867
884
|
|
|
868
885
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
869
886
|
|
|
870
|
-
# **
|
|
871
|
-
>
|
|
887
|
+
# **passportAuthUserServicePassportAuthUnlinkSocial**
|
|
888
|
+
> PassportAuthUnlinkSocialResponse passportAuthUserServicePassportAuthUnlinkSocial(passportAuthUnlinkSocialRequest)
|
|
872
889
|
|
|
890
|
+
已登录用户取消关联社交账号
|
|
873
891
|
|
|
874
892
|
### Example
|
|
875
893
|
|
|
@@ -877,16 +895,16 @@ No authorization required
|
|
|
877
895
|
import {
|
|
878
896
|
PassportAuthUserServiceApi,
|
|
879
897
|
Configuration,
|
|
880
|
-
|
|
898
|
+
PassportAuthUnlinkSocialRequest
|
|
881
899
|
} from '@cherryin/api-client';
|
|
882
900
|
|
|
883
901
|
const configuration = new Configuration();
|
|
884
902
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
885
903
|
|
|
886
|
-
let
|
|
904
|
+
let passportAuthUnlinkSocialRequest: PassportAuthUnlinkSocialRequest; //
|
|
887
905
|
|
|
888
|
-
const { status, data } = await apiInstance.
|
|
889
|
-
|
|
906
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUnlinkSocial(
|
|
907
|
+
passportAuthUnlinkSocialRequest
|
|
890
908
|
);
|
|
891
909
|
```
|
|
892
910
|
|
|
@@ -894,12 +912,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
894
912
|
|
|
895
913
|
|Name | Type | Description | Notes|
|
|
896
914
|
|------------- | ------------- | ------------- | -------------|
|
|
897
|
-
| **
|
|
915
|
+
| **passportAuthUnlinkSocialRequest** | **PassportAuthUnlinkSocialRequest**| | |
|
|
898
916
|
|
|
899
917
|
|
|
900
918
|
### Return type
|
|
901
919
|
|
|
902
|
-
**
|
|
920
|
+
**PassportAuthUnlinkSocialResponse**
|
|
903
921
|
|
|
904
922
|
### Authorization
|
|
905
923
|
|
|
@@ -919,9 +937,10 @@ No authorization required
|
|
|
919
937
|
|
|
920
938
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
921
939
|
|
|
922
|
-
# **
|
|
923
|
-
>
|
|
940
|
+
# **passportAuthUserServicePassportAuthUserChangeEmail**
|
|
941
|
+
> PassportAuthUserChangeEmailResponse passportAuthUserServicePassportAuthUserChangeEmail(passportAuthUserChangeEmailRequest)
|
|
924
942
|
|
|
943
|
+
已登录用户更换邮箱
|
|
925
944
|
|
|
926
945
|
### Example
|
|
927
946
|
|
|
@@ -929,16 +948,16 @@ No authorization required
|
|
|
929
948
|
import {
|
|
930
949
|
PassportAuthUserServiceApi,
|
|
931
950
|
Configuration,
|
|
932
|
-
|
|
951
|
+
PassportAuthUserChangeEmailRequest
|
|
933
952
|
} from '@cherryin/api-client';
|
|
934
953
|
|
|
935
954
|
const configuration = new Configuration();
|
|
936
955
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
937
956
|
|
|
938
|
-
let
|
|
957
|
+
let passportAuthUserChangeEmailRequest: PassportAuthUserChangeEmailRequest; //
|
|
939
958
|
|
|
940
|
-
const { status, data } = await apiInstance.
|
|
941
|
-
|
|
959
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserChangeEmail(
|
|
960
|
+
passportAuthUserChangeEmailRequest
|
|
942
961
|
);
|
|
943
962
|
```
|
|
944
963
|
|
|
@@ -946,12 +965,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
946
965
|
|
|
947
966
|
|Name | Type | Description | Notes|
|
|
948
967
|
|------------- | ------------- | ------------- | -------------|
|
|
949
|
-
| **
|
|
968
|
+
| **passportAuthUserChangeEmailRequest** | **PassportAuthUserChangeEmailRequest**| | |
|
|
950
969
|
|
|
951
970
|
|
|
952
971
|
### Return type
|
|
953
972
|
|
|
954
|
-
**
|
|
973
|
+
**PassportAuthUserChangeEmailResponse**
|
|
955
974
|
|
|
956
975
|
### Authorization
|
|
957
976
|
|
|
@@ -971,9 +990,10 @@ No authorization required
|
|
|
971
990
|
|
|
972
991
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
973
992
|
|
|
974
|
-
# **
|
|
975
|
-
>
|
|
993
|
+
# **passportAuthUserServicePassportAuthUserChangePhone**
|
|
994
|
+
> PassportAuthUserChangePhoneResponse passportAuthUserServicePassportAuthUserChangePhone(passportAuthUserChangePhoneRequest)
|
|
976
995
|
|
|
996
|
+
已登录用户更换手机号
|
|
977
997
|
|
|
978
998
|
### Example
|
|
979
999
|
|
|
@@ -981,16 +1001,16 @@ No authorization required
|
|
|
981
1001
|
import {
|
|
982
1002
|
PassportAuthUserServiceApi,
|
|
983
1003
|
Configuration,
|
|
984
|
-
|
|
1004
|
+
PassportAuthUserChangePhoneRequest
|
|
985
1005
|
} from '@cherryin/api-client';
|
|
986
1006
|
|
|
987
1007
|
const configuration = new Configuration();
|
|
988
1008
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
989
1009
|
|
|
990
|
-
let
|
|
1010
|
+
let passportAuthUserChangePhoneRequest: PassportAuthUserChangePhoneRequest; //
|
|
991
1011
|
|
|
992
|
-
const { status, data } = await apiInstance.
|
|
993
|
-
|
|
1012
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserChangePhone(
|
|
1013
|
+
passportAuthUserChangePhoneRequest
|
|
994
1014
|
);
|
|
995
1015
|
```
|
|
996
1016
|
|
|
@@ -998,12 +1018,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
998
1018
|
|
|
999
1019
|
|Name | Type | Description | Notes|
|
|
1000
1020
|
|------------- | ------------- | ------------- | -------------|
|
|
1001
|
-
| **
|
|
1021
|
+
| **passportAuthUserChangePhoneRequest** | **PassportAuthUserChangePhoneRequest**| | |
|
|
1002
1022
|
|
|
1003
1023
|
|
|
1004
1024
|
### Return type
|
|
1005
1025
|
|
|
1006
|
-
**
|
|
1026
|
+
**PassportAuthUserChangePhoneResponse**
|
|
1007
1027
|
|
|
1008
1028
|
### Authorization
|
|
1009
1029
|
|
|
@@ -1023,9 +1043,10 @@ No authorization required
|
|
|
1023
1043
|
|
|
1024
1044
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1025
1045
|
|
|
1026
|
-
# **
|
|
1027
|
-
>
|
|
1046
|
+
# **passportAuthUserServicePassportAuthUserDelete**
|
|
1047
|
+
> PassportAuthUserDeleteResponse passportAuthUserServicePassportAuthUserDelete(passportAuthUserDeleteRequest)
|
|
1028
1048
|
|
|
1049
|
+
请求删除用户
|
|
1029
1050
|
|
|
1030
1051
|
### Example
|
|
1031
1052
|
|
|
@@ -1033,16 +1054,16 @@ No authorization required
|
|
|
1033
1054
|
import {
|
|
1034
1055
|
PassportAuthUserServiceApi,
|
|
1035
1056
|
Configuration,
|
|
1036
|
-
|
|
1057
|
+
PassportAuthUserDeleteRequest
|
|
1037
1058
|
} from '@cherryin/api-client';
|
|
1038
1059
|
|
|
1039
1060
|
const configuration = new Configuration();
|
|
1040
1061
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1041
1062
|
|
|
1042
|
-
let
|
|
1063
|
+
let passportAuthUserDeleteRequest: PassportAuthUserDeleteRequest; //
|
|
1043
1064
|
|
|
1044
|
-
const { status, data } = await apiInstance.
|
|
1045
|
-
|
|
1065
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserDelete(
|
|
1066
|
+
passportAuthUserDeleteRequest
|
|
1046
1067
|
);
|
|
1047
1068
|
```
|
|
1048
1069
|
|
|
@@ -1050,12 +1071,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
1050
1071
|
|
|
1051
1072
|
|Name | Type | Description | Notes|
|
|
1052
1073
|
|------------- | ------------- | ------------- | -------------|
|
|
1053
|
-
| **
|
|
1074
|
+
| **passportAuthUserDeleteRequest** | **PassportAuthUserDeleteRequest**| | |
|
|
1054
1075
|
|
|
1055
1076
|
|
|
1056
1077
|
### Return type
|
|
1057
1078
|
|
|
1058
|
-
**
|
|
1079
|
+
**PassportAuthUserDeleteResponse**
|
|
1059
1080
|
|
|
1060
1081
|
### Authorization
|
|
1061
1082
|
|
|
@@ -1075,9 +1096,107 @@ No authorization required
|
|
|
1075
1096
|
|
|
1076
1097
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1077
1098
|
|
|
1078
|
-
# **
|
|
1079
|
-
>
|
|
1099
|
+
# **passportAuthUserServicePassportAuthUserGetSession**
|
|
1100
|
+
> PassportAuthUserGetSessionResponse passportAuthUserServicePassportAuthUserGetSession()
|
|
1080
1101
|
|
|
1102
|
+
获取当前会话信息
|
|
1103
|
+
|
|
1104
|
+
### Example
|
|
1105
|
+
|
|
1106
|
+
```typescript
|
|
1107
|
+
import {
|
|
1108
|
+
PassportAuthUserServiceApi,
|
|
1109
|
+
Configuration
|
|
1110
|
+
} from '@cherryin/api-client';
|
|
1111
|
+
|
|
1112
|
+
const configuration = new Configuration();
|
|
1113
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1114
|
+
|
|
1115
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserGetSession();
|
|
1116
|
+
```
|
|
1117
|
+
|
|
1118
|
+
### Parameters
|
|
1119
|
+
This endpoint does not have any parameters.
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
### Return type
|
|
1123
|
+
|
|
1124
|
+
**PassportAuthUserGetSessionResponse**
|
|
1125
|
+
|
|
1126
|
+
### Authorization
|
|
1127
|
+
|
|
1128
|
+
No authorization required
|
|
1129
|
+
|
|
1130
|
+
### HTTP request headers
|
|
1131
|
+
|
|
1132
|
+
- **Content-Type**: Not defined
|
|
1133
|
+
- **Accept**: application/json
|
|
1134
|
+
|
|
1135
|
+
|
|
1136
|
+
### HTTP response details
|
|
1137
|
+
| Status code | Description | Response headers |
|
|
1138
|
+
|-------------|-------------|------------------|
|
|
1139
|
+
|**200** | OK | - |
|
|
1140
|
+
|**0** | Default error response | - |
|
|
1141
|
+
|
|
1142
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1143
|
+
|
|
1144
|
+
# **passportAuthUserServicePassportAuthUserInfoGet**
|
|
1145
|
+
> PassportAuthUserInfoGetResponse passportAuthUserServicePassportAuthUserInfoGet()
|
|
1146
|
+
|
|
1147
|
+
获取用户信息
|
|
1148
|
+
|
|
1149
|
+
### Example
|
|
1150
|
+
|
|
1151
|
+
```typescript
|
|
1152
|
+
import {
|
|
1153
|
+
PassportAuthUserServiceApi,
|
|
1154
|
+
Configuration
|
|
1155
|
+
} from '@cherryin/api-client';
|
|
1156
|
+
|
|
1157
|
+
const configuration = new Configuration();
|
|
1158
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1159
|
+
|
|
1160
|
+
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 (optional) (default to undefined)
|
|
1161
|
+
|
|
1162
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserInfoGet(
|
|
1163
|
+
appIds
|
|
1164
|
+
);
|
|
1165
|
+
```
|
|
1166
|
+
|
|
1167
|
+
### Parameters
|
|
1168
|
+
|
|
1169
|
+
|Name | Type | Description | Notes|
|
|
1170
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1171
|
+
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 | (optional) defaults to undefined|
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
### Return type
|
|
1175
|
+
|
|
1176
|
+
**PassportAuthUserInfoGetResponse**
|
|
1177
|
+
|
|
1178
|
+
### Authorization
|
|
1179
|
+
|
|
1180
|
+
No authorization required
|
|
1181
|
+
|
|
1182
|
+
### HTTP request headers
|
|
1183
|
+
|
|
1184
|
+
- **Content-Type**: Not defined
|
|
1185
|
+
- **Accept**: application/json
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
### HTTP response details
|
|
1189
|
+
| Status code | Description | Response headers |
|
|
1190
|
+
|-------------|-------------|------------------|
|
|
1191
|
+
|**200** | OK | - |
|
|
1192
|
+
|**0** | Default error response | - |
|
|
1193
|
+
|
|
1194
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1195
|
+
|
|
1196
|
+
# **passportAuthUserServicePassportAuthUserSignOut**
|
|
1197
|
+
> PassportAuthUserSignOutResponse passportAuthUserServicePassportAuthUserSignOut(passportAuthUserSignOutRequest)
|
|
1198
|
+
|
|
1199
|
+
用户登出
|
|
1081
1200
|
|
|
1082
1201
|
### Example
|
|
1083
1202
|
|
|
@@ -1085,16 +1204,16 @@ No authorization required
|
|
|
1085
1204
|
import {
|
|
1086
1205
|
PassportAuthUserServiceApi,
|
|
1087
1206
|
Configuration,
|
|
1088
|
-
|
|
1207
|
+
PassportAuthUserSignOutRequest
|
|
1089
1208
|
} from '@cherryin/api-client';
|
|
1090
1209
|
|
|
1091
1210
|
const configuration = new Configuration();
|
|
1092
1211
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1093
1212
|
|
|
1094
|
-
let
|
|
1213
|
+
let passportAuthUserSignOutRequest: PassportAuthUserSignOutRequest; //
|
|
1095
1214
|
|
|
1096
|
-
const { status, data } = await apiInstance.
|
|
1097
|
-
|
|
1215
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserSignOut(
|
|
1216
|
+
passportAuthUserSignOutRequest
|
|
1098
1217
|
);
|
|
1099
1218
|
```
|
|
1100
1219
|
|
|
@@ -1102,12 +1221,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
1102
1221
|
|
|
1103
1222
|
|Name | Type | Description | Notes|
|
|
1104
1223
|
|------------- | ------------- | ------------- | -------------|
|
|
1105
|
-
| **
|
|
1224
|
+
| **passportAuthUserSignOutRequest** | **PassportAuthUserSignOutRequest**| | |
|
|
1106
1225
|
|
|
1107
1226
|
|
|
1108
1227
|
### Return type
|
|
1109
1228
|
|
|
1110
|
-
**
|
|
1229
|
+
**PassportAuthUserSignOutResponse**
|
|
1111
1230
|
|
|
1112
1231
|
### Authorization
|
|
1113
1232
|
|
|
@@ -1127,9 +1246,10 @@ No authorization required
|
|
|
1127
1246
|
|
|
1128
1247
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1129
1248
|
|
|
1130
|
-
# **
|
|
1131
|
-
>
|
|
1249
|
+
# **passportAuthUserServicePassportAuthUserUpdateInfo**
|
|
1250
|
+
> PassportAuthUserUpdateInfoResponse passportAuthUserServicePassportAuthUserUpdateInfo(passportAuthUserUpdateInfoRequest)
|
|
1132
1251
|
|
|
1252
|
+
更新用户信息
|
|
1133
1253
|
|
|
1134
1254
|
### Example
|
|
1135
1255
|
|
|
@@ -1137,16 +1257,16 @@ No authorization required
|
|
|
1137
1257
|
import {
|
|
1138
1258
|
PassportAuthUserServiceApi,
|
|
1139
1259
|
Configuration,
|
|
1140
|
-
|
|
1260
|
+
PassportAuthUserUpdateInfoRequest
|
|
1141
1261
|
} from '@cherryin/api-client';
|
|
1142
1262
|
|
|
1143
1263
|
const configuration = new Configuration();
|
|
1144
1264
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1145
1265
|
|
|
1146
|
-
let
|
|
1266
|
+
let passportAuthUserUpdateInfoRequest: PassportAuthUserUpdateInfoRequest; //
|
|
1147
1267
|
|
|
1148
|
-
const { status, data } = await apiInstance.
|
|
1149
|
-
|
|
1268
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserUpdateInfo(
|
|
1269
|
+
passportAuthUserUpdateInfoRequest
|
|
1150
1270
|
);
|
|
1151
1271
|
```
|
|
1152
1272
|
|
|
@@ -1154,12 +1274,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
1154
1274
|
|
|
1155
1275
|
|Name | Type | Description | Notes|
|
|
1156
1276
|
|------------- | ------------- | ------------- | -------------|
|
|
1157
|
-
| **
|
|
1277
|
+
| **passportAuthUserUpdateInfoRequest** | **PassportAuthUserUpdateInfoRequest**| | |
|
|
1158
1278
|
|
|
1159
1279
|
|
|
1160
1280
|
### Return type
|
|
1161
1281
|
|
|
1162
|
-
**
|
|
1282
|
+
**PassportAuthUserUpdateInfoResponse**
|
|
1163
1283
|
|
|
1164
1284
|
### Authorization
|
|
1165
1285
|
|
|
@@ -1179,9 +1299,10 @@ No authorization required
|
|
|
1179
1299
|
|
|
1180
1300
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1181
1301
|
|
|
1182
|
-
# **
|
|
1183
|
-
>
|
|
1302
|
+
# **passportAuthUserServicePassportAuthUserUpdatePassport**
|
|
1303
|
+
> PassportAuthUserUpdatePassportResponse passportAuthUserServicePassportAuthUserUpdatePassport(passportAuthUserUpdatePassportRequest)
|
|
1184
1304
|
|
|
1305
|
+
更新通行证信息
|
|
1185
1306
|
|
|
1186
1307
|
### Example
|
|
1187
1308
|
|
|
@@ -1189,16 +1310,16 @@ No authorization required
|
|
|
1189
1310
|
import {
|
|
1190
1311
|
PassportAuthUserServiceApi,
|
|
1191
1312
|
Configuration,
|
|
1192
|
-
|
|
1313
|
+
PassportAuthUserUpdatePassportRequest
|
|
1193
1314
|
} from '@cherryin/api-client';
|
|
1194
1315
|
|
|
1195
1316
|
const configuration = new Configuration();
|
|
1196
1317
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1197
1318
|
|
|
1198
|
-
let
|
|
1319
|
+
let passportAuthUserUpdatePassportRequest: PassportAuthUserUpdatePassportRequest; //
|
|
1199
1320
|
|
|
1200
|
-
const { status, data } = await apiInstance.
|
|
1201
|
-
|
|
1321
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserUpdatePassport(
|
|
1322
|
+
passportAuthUserUpdatePassportRequest
|
|
1202
1323
|
);
|
|
1203
1324
|
```
|
|
1204
1325
|
|
|
@@ -1206,12 +1327,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
1206
1327
|
|
|
1207
1328
|
|Name | Type | Description | Notes|
|
|
1208
1329
|
|------------- | ------------- | ------------- | -------------|
|
|
1209
|
-
| **
|
|
1330
|
+
| **passportAuthUserUpdatePassportRequest** | **PassportAuthUserUpdatePassportRequest**| | |
|
|
1210
1331
|
|
|
1211
1332
|
|
|
1212
1333
|
### Return type
|
|
1213
1334
|
|
|
1214
|
-
**
|
|
1335
|
+
**PassportAuthUserUpdatePassportResponse**
|
|
1215
1336
|
|
|
1216
1337
|
### Authorization
|
|
1217
1338
|
|
|
@@ -1231,9 +1352,10 @@ No authorization required
|
|
|
1231
1352
|
|
|
1232
1353
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1233
1354
|
|
|
1234
|
-
# **
|
|
1235
|
-
>
|
|
1355
|
+
# **passportAuthUserServicePassportAuthUserVerifyEmail**
|
|
1356
|
+
> PassportAuthUserVerifyEmailResponse passportAuthUserServicePassportAuthUserVerifyEmail(passportAuthUserVerifyEmailRequest)
|
|
1236
1357
|
|
|
1358
|
+
已登录用户验证邮箱
|
|
1237
1359
|
|
|
1238
1360
|
### Example
|
|
1239
1361
|
|
|
@@ -1241,16 +1363,16 @@ No authorization required
|
|
|
1241
1363
|
import {
|
|
1242
1364
|
PassportAuthUserServiceApi,
|
|
1243
1365
|
Configuration,
|
|
1244
|
-
|
|
1366
|
+
PassportAuthUserVerifyEmailRequest
|
|
1245
1367
|
} from '@cherryin/api-client';
|
|
1246
1368
|
|
|
1247
1369
|
const configuration = new Configuration();
|
|
1248
1370
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1249
1371
|
|
|
1250
|
-
let
|
|
1372
|
+
let passportAuthUserVerifyEmailRequest: PassportAuthUserVerifyEmailRequest; //
|
|
1251
1373
|
|
|
1252
|
-
const { status, data } = await apiInstance.
|
|
1253
|
-
|
|
1374
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserVerifyEmail(
|
|
1375
|
+
passportAuthUserVerifyEmailRequest
|
|
1254
1376
|
);
|
|
1255
1377
|
```
|
|
1256
1378
|
|
|
@@ -1258,12 +1380,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
1258
1380
|
|
|
1259
1381
|
|Name | Type | Description | Notes|
|
|
1260
1382
|
|------------- | ------------- | ------------- | -------------|
|
|
1261
|
-
| **
|
|
1383
|
+
| **passportAuthUserVerifyEmailRequest** | **PassportAuthUserVerifyEmailRequest**| | |
|
|
1262
1384
|
|
|
1263
1385
|
|
|
1264
1386
|
### Return type
|
|
1265
1387
|
|
|
1266
|
-
**
|
|
1388
|
+
**PassportAuthUserVerifyEmailResponse**
|
|
1267
1389
|
|
|
1268
1390
|
### Authorization
|
|
1269
1391
|
|
|
@@ -1283,9 +1405,10 @@ No authorization required
|
|
|
1283
1405
|
|
|
1284
1406
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1285
1407
|
|
|
1286
|
-
# **
|
|
1287
|
-
>
|
|
1408
|
+
# **passportAuthUserServicePassportAuthUserVerifyPhone**
|
|
1409
|
+
> PassportAuthUserVerifyPhoneResponse passportAuthUserServicePassportAuthUserVerifyPhone(passportAuthUserVerifyPhoneRequest)
|
|
1288
1410
|
|
|
1411
|
+
已登录用户验证手机号
|
|
1289
1412
|
|
|
1290
1413
|
### Example
|
|
1291
1414
|
|
|
@@ -1293,16 +1416,16 @@ No authorization required
|
|
|
1293
1416
|
import {
|
|
1294
1417
|
PassportAuthUserServiceApi,
|
|
1295
1418
|
Configuration,
|
|
1296
|
-
|
|
1419
|
+
PassportAuthUserVerifyPhoneRequest
|
|
1297
1420
|
} from '@cherryin/api-client';
|
|
1298
1421
|
|
|
1299
1422
|
const configuration = new Configuration();
|
|
1300
1423
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1301
1424
|
|
|
1302
|
-
let
|
|
1425
|
+
let passportAuthUserVerifyPhoneRequest: PassportAuthUserVerifyPhoneRequest; //
|
|
1303
1426
|
|
|
1304
|
-
const { status, data } = await apiInstance.
|
|
1305
|
-
|
|
1427
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserVerifyPhone(
|
|
1428
|
+
passportAuthUserVerifyPhoneRequest
|
|
1306
1429
|
);
|
|
1307
1430
|
```
|
|
1308
1431
|
|
|
@@ -1310,12 +1433,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
1310
1433
|
|
|
1311
1434
|
|Name | Type | Description | Notes|
|
|
1312
1435
|
|------------- | ------------- | ------------- | -------------|
|
|
1313
|
-
| **
|
|
1436
|
+
| **passportAuthUserVerifyPhoneRequest** | **PassportAuthUserVerifyPhoneRequest**| | |
|
|
1314
1437
|
|
|
1315
1438
|
|
|
1316
1439
|
### Return type
|
|
1317
1440
|
|
|
1318
|
-
**
|
|
1441
|
+
**PassportAuthUserVerifyPhoneResponse**
|
|
1319
1442
|
|
|
1320
1443
|
### Authorization
|
|
1321
1444
|
|
|
@@ -1335,10 +1458,10 @@ No authorization required
|
|
|
1335
1458
|
|
|
1336
1459
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1337
1460
|
|
|
1338
|
-
# **
|
|
1339
|
-
>
|
|
1461
|
+
# **passportAuthUserServicePassportSendVerificationEmail**
|
|
1462
|
+
> PassportSendVerificationEmailResponse passportAuthUserServicePassportSendVerificationEmail(passportSendVerificationEmailRequest)
|
|
1340
1463
|
|
|
1341
|
-
|
|
1464
|
+
登录/注册流程中发送验证码
|
|
1342
1465
|
|
|
1343
1466
|
### Example
|
|
1344
1467
|
|
|
@@ -1346,16 +1469,16 @@ No authorization required
|
|
|
1346
1469
|
import {
|
|
1347
1470
|
PassportAuthUserServiceApi,
|
|
1348
1471
|
Configuration,
|
|
1349
|
-
|
|
1472
|
+
PassportSendVerificationEmailRequest
|
|
1350
1473
|
} from '@cherryin/api-client';
|
|
1351
1474
|
|
|
1352
1475
|
const configuration = new Configuration();
|
|
1353
1476
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1354
1477
|
|
|
1355
|
-
let
|
|
1478
|
+
let passportSendVerificationEmailRequest: PassportSendVerificationEmailRequest; //
|
|
1356
1479
|
|
|
1357
|
-
const { status, data } = await apiInstance.
|
|
1358
|
-
|
|
1480
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportSendVerificationEmail(
|
|
1481
|
+
passportSendVerificationEmailRequest
|
|
1359
1482
|
);
|
|
1360
1483
|
```
|
|
1361
1484
|
|
|
@@ -1363,12 +1486,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
1363
1486
|
|
|
1364
1487
|
|Name | Type | Description | Notes|
|
|
1365
1488
|
|------------- | ------------- | ------------- | -------------|
|
|
1366
|
-
| **
|
|
1489
|
+
| **passportSendVerificationEmailRequest** | **PassportSendVerificationEmailRequest**| | |
|
|
1367
1490
|
|
|
1368
1491
|
|
|
1369
1492
|
### Return type
|
|
1370
1493
|
|
|
1371
|
-
**
|
|
1494
|
+
**PassportSendVerificationEmailResponse**
|
|
1372
1495
|
|
|
1373
1496
|
### Authorization
|
|
1374
1497
|
|
|
@@ -1388,9 +1511,10 @@ No authorization required
|
|
|
1388
1511
|
|
|
1389
1512
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1390
1513
|
|
|
1391
|
-
# **
|
|
1392
|
-
>
|
|
1514
|
+
# **passportAuthUserServicePassportSendVerificationPhone**
|
|
1515
|
+
> PassportSendVerificationPhoneResponse passportAuthUserServicePassportSendVerificationPhone(passportSendVerificationPhoneRequest)
|
|
1393
1516
|
|
|
1517
|
+
登录/注册流程中发送验证码
|
|
1394
1518
|
|
|
1395
1519
|
### Example
|
|
1396
1520
|
|
|
@@ -1398,16 +1522,16 @@ No authorization required
|
|
|
1398
1522
|
import {
|
|
1399
1523
|
PassportAuthUserServiceApi,
|
|
1400
1524
|
Configuration,
|
|
1401
|
-
|
|
1525
|
+
PassportSendVerificationPhoneRequest
|
|
1402
1526
|
} from '@cherryin/api-client';
|
|
1403
1527
|
|
|
1404
1528
|
const configuration = new Configuration();
|
|
1405
1529
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1406
1530
|
|
|
1407
|
-
let
|
|
1531
|
+
let passportSendVerificationPhoneRequest: PassportSendVerificationPhoneRequest; //
|
|
1408
1532
|
|
|
1409
|
-
const { status, data } = await apiInstance.
|
|
1410
|
-
|
|
1533
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportSendVerificationPhone(
|
|
1534
|
+
passportSendVerificationPhoneRequest
|
|
1411
1535
|
);
|
|
1412
1536
|
```
|
|
1413
1537
|
|
|
@@ -1415,12 +1539,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
1415
1539
|
|
|
1416
1540
|
|Name | Type | Description | Notes|
|
|
1417
1541
|
|------------- | ------------- | ------------- | -------------|
|
|
1418
|
-
| **
|
|
1542
|
+
| **passportSendVerificationPhoneRequest** | **PassportSendVerificationPhoneRequest**| | |
|
|
1419
1543
|
|
|
1420
1544
|
|
|
1421
1545
|
### Return type
|
|
1422
1546
|
|
|
1423
|
-
**
|
|
1547
|
+
**PassportSendVerificationPhoneResponse**
|
|
1424
1548
|
|
|
1425
1549
|
### Authorization
|
|
1426
1550
|
|
|
@@ -1440,9 +1564,71 @@ No authorization required
|
|
|
1440
1564
|
|
|
1441
1565
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1442
1566
|
|
|
1443
|
-
# **
|
|
1444
|
-
>
|
|
1567
|
+
# **passportAuthUserServicePassportUserOAuthCallback**
|
|
1568
|
+
> PassportUserOAuthCallbackResponse passportAuthUserServicePassportUserOAuthCallback()
|
|
1445
1569
|
|
|
1570
|
+
OAuth 回调处理
|
|
1571
|
+
|
|
1572
|
+
### Example
|
|
1573
|
+
|
|
1574
|
+
```typescript
|
|
1575
|
+
import {
|
|
1576
|
+
PassportAuthUserServiceApi,
|
|
1577
|
+
Configuration
|
|
1578
|
+
} from '@cherryin/api-client';
|
|
1579
|
+
|
|
1580
|
+
const configuration = new Configuration();
|
|
1581
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1582
|
+
|
|
1583
|
+
let platform: string; //@gotags: form:\"platform\" google/github (default to undefined)
|
|
1584
|
+
let appIds: string; //User.AppID, 支持多个应用同时登录,如果对应 App 的账号,无法完成登录 NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" (optional) (default to undefined)
|
|
1585
|
+
let code: string; //@gotags: form:\"code\" OAuth 授权码 (optional) (default to undefined)
|
|
1586
|
+
let state: string; //@gotags: form:\"state\" CSRF state (optional) (default to undefined)
|
|
1587
|
+
|
|
1588
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportUserOAuthCallback(
|
|
1589
|
+
platform,
|
|
1590
|
+
appIds,
|
|
1591
|
+
code,
|
|
1592
|
+
state
|
|
1593
|
+
);
|
|
1594
|
+
```
|
|
1595
|
+
|
|
1596
|
+
### Parameters
|
|
1597
|
+
|
|
1598
|
+
|Name | Type | Description | Notes|
|
|
1599
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1600
|
+
| **platform** | [**string**] | @gotags: form:\"platform\" google/github | defaults to undefined|
|
|
1601
|
+
| **appIds** | [**string**] | User.AppID, 支持多个应用同时登录,如果对应 App 的账号,无法完成登录 NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" | (optional) defaults to undefined|
|
|
1602
|
+
| **code** | [**string**] | @gotags: form:\"code\" OAuth 授权码 | (optional) defaults to undefined|
|
|
1603
|
+
| **state** | [**string**] | @gotags: form:\"state\" CSRF state | (optional) defaults to undefined|
|
|
1604
|
+
|
|
1605
|
+
|
|
1606
|
+
### Return type
|
|
1607
|
+
|
|
1608
|
+
**PassportUserOAuthCallbackResponse**
|
|
1609
|
+
|
|
1610
|
+
### Authorization
|
|
1611
|
+
|
|
1612
|
+
No authorization required
|
|
1613
|
+
|
|
1614
|
+
### HTTP request headers
|
|
1615
|
+
|
|
1616
|
+
- **Content-Type**: Not defined
|
|
1617
|
+
- **Accept**: application/json
|
|
1618
|
+
|
|
1619
|
+
|
|
1620
|
+
### HTTP response details
|
|
1621
|
+
| Status code | Description | Response headers |
|
|
1622
|
+
|-------------|-------------|------------------|
|
|
1623
|
+
|**200** | OK | - |
|
|
1624
|
+
|**0** | Default error response | - |
|
|
1625
|
+
|
|
1626
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1627
|
+
|
|
1628
|
+
# **passportAuthUserServicePassportUserPasswordReset**
|
|
1629
|
+
> PassportUserPasswordResetResponse passportAuthUserServicePassportUserPasswordReset(passportUserPasswordResetRequest)
|
|
1630
|
+
|
|
1631
|
+
请求重置密码
|
|
1446
1632
|
|
|
1447
1633
|
### Example
|
|
1448
1634
|
|
|
@@ -1450,16 +1636,16 @@ No authorization required
|
|
|
1450
1636
|
import {
|
|
1451
1637
|
PassportAuthUserServiceApi,
|
|
1452
1638
|
Configuration,
|
|
1453
|
-
|
|
1639
|
+
PassportUserPasswordResetRequest
|
|
1454
1640
|
} from '@cherryin/api-client';
|
|
1455
1641
|
|
|
1456
1642
|
const configuration = new Configuration();
|
|
1457
1643
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1458
1644
|
|
|
1459
|
-
let
|
|
1645
|
+
let passportUserPasswordResetRequest: PassportUserPasswordResetRequest; //
|
|
1460
1646
|
|
|
1461
|
-
const { status, data } = await apiInstance.
|
|
1462
|
-
|
|
1647
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportUserPasswordReset(
|
|
1648
|
+
passportUserPasswordResetRequest
|
|
1463
1649
|
);
|
|
1464
1650
|
```
|
|
1465
1651
|
|
|
@@ -1467,12 +1653,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
1467
1653
|
|
|
1468
1654
|
|Name | Type | Description | Notes|
|
|
1469
1655
|
|------------- | ------------- | ------------- | -------------|
|
|
1470
|
-
| **
|
|
1656
|
+
| **passportUserPasswordResetRequest** | **PassportUserPasswordResetRequest**| | |
|
|
1471
1657
|
|
|
1472
1658
|
|
|
1473
1659
|
### Return type
|
|
1474
1660
|
|
|
1475
|
-
**
|
|
1661
|
+
**PassportUserPasswordResetResponse**
|
|
1476
1662
|
|
|
1477
1663
|
### Authorization
|
|
1478
1664
|
|
|
@@ -1492,9 +1678,10 @@ No authorization required
|
|
|
1492
1678
|
|
|
1493
1679
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1494
1680
|
|
|
1495
|
-
# **
|
|
1496
|
-
>
|
|
1681
|
+
# **passportAuthUserServicePassportUserSignInEmail**
|
|
1682
|
+
> PassportUserSignInEmailResponse passportAuthUserServicePassportUserSignInEmail(passportUserSignInEmailRequest)
|
|
1497
1683
|
|
|
1684
|
+
邮箱登录
|
|
1498
1685
|
|
|
1499
1686
|
### Example
|
|
1500
1687
|
|
|
@@ -1502,16 +1689,16 @@ No authorization required
|
|
|
1502
1689
|
import {
|
|
1503
1690
|
PassportAuthUserServiceApi,
|
|
1504
1691
|
Configuration,
|
|
1505
|
-
|
|
1692
|
+
PassportUserSignInEmailRequest
|
|
1506
1693
|
} from '@cherryin/api-client';
|
|
1507
1694
|
|
|
1508
1695
|
const configuration = new Configuration();
|
|
1509
1696
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1510
1697
|
|
|
1511
|
-
let
|
|
1698
|
+
let passportUserSignInEmailRequest: PassportUserSignInEmailRequest; //
|
|
1512
1699
|
|
|
1513
|
-
const { status, data } = await apiInstance.
|
|
1514
|
-
|
|
1700
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportUserSignInEmail(
|
|
1701
|
+
passportUserSignInEmailRequest
|
|
1515
1702
|
);
|
|
1516
1703
|
```
|
|
1517
1704
|
|
|
@@ -1519,12 +1706,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
1519
1706
|
|
|
1520
1707
|
|Name | Type | Description | Notes|
|
|
1521
1708
|
|------------- | ------------- | ------------- | -------------|
|
|
1522
|
-
| **
|
|
1709
|
+
| **passportUserSignInEmailRequest** | **PassportUserSignInEmailRequest**| | |
|
|
1523
1710
|
|
|
1524
1711
|
|
|
1525
1712
|
### Return type
|
|
1526
1713
|
|
|
1527
|
-
**
|
|
1714
|
+
**PassportUserSignInEmailResponse**
|
|
1528
1715
|
|
|
1529
1716
|
### Authorization
|
|
1530
1717
|
|
|
@@ -1544,31 +1731,27 @@ No authorization required
|
|
|
1544
1731
|
|
|
1545
1732
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1546
1733
|
|
|
1547
|
-
# **
|
|
1548
|
-
>
|
|
1734
|
+
# **passportAuthUserServicePassportUserSignInPhone**
|
|
1735
|
+
> PassportUserSignInPhoneResponse passportAuthUserServicePassportUserSignInPhone(passportUserSignInPhoneRequest)
|
|
1549
1736
|
|
|
1737
|
+
手机登录
|
|
1550
1738
|
|
|
1551
1739
|
### Example
|
|
1552
1740
|
|
|
1553
1741
|
```typescript
|
|
1554
1742
|
import {
|
|
1555
1743
|
PassportAuthUserServiceApi,
|
|
1556
|
-
Configuration
|
|
1744
|
+
Configuration,
|
|
1745
|
+
PassportUserSignInPhoneRequest
|
|
1557
1746
|
} from '@cherryin/api-client';
|
|
1558
1747
|
|
|
1559
1748
|
const configuration = new Configuration();
|
|
1560
1749
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1561
1750
|
|
|
1562
|
-
let
|
|
1563
|
-
let email: string; // (optional) (default to undefined)
|
|
1564
|
-
let authCode: string; // (optional) (default to undefined)
|
|
1565
|
-
let callbackUrl: string; // (optional) (default to undefined)
|
|
1751
|
+
let passportUserSignInPhoneRequest: PassportUserSignInPhoneRequest; //
|
|
1566
1752
|
|
|
1567
|
-
const { status, data } = await apiInstance.
|
|
1568
|
-
|
|
1569
|
-
email,
|
|
1570
|
-
authCode,
|
|
1571
|
-
callbackUrl
|
|
1753
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportUserSignInPhone(
|
|
1754
|
+
passportUserSignInPhoneRequest
|
|
1572
1755
|
);
|
|
1573
1756
|
```
|
|
1574
1757
|
|
|
@@ -1576,15 +1759,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
1576
1759
|
|
|
1577
1760
|
|Name | Type | Description | Notes|
|
|
1578
1761
|
|------------- | ------------- | ------------- | -------------|
|
|
1579
|
-
| **
|
|
1580
|
-
| **email** | [**string**] | | (optional) defaults to undefined|
|
|
1581
|
-
| **authCode** | [**string**] | | (optional) defaults to undefined|
|
|
1582
|
-
| **callbackUrl** | [**string**] | | (optional) defaults to undefined|
|
|
1762
|
+
| **passportUserSignInPhoneRequest** | **PassportUserSignInPhoneRequest**| | |
|
|
1583
1763
|
|
|
1584
1764
|
|
|
1585
1765
|
### Return type
|
|
1586
1766
|
|
|
1587
|
-
**
|
|
1767
|
+
**PassportUserSignInPhoneResponse**
|
|
1588
1768
|
|
|
1589
1769
|
### Authorization
|
|
1590
1770
|
|
|
@@ -1592,7 +1772,7 @@ No authorization required
|
|
|
1592
1772
|
|
|
1593
1773
|
### HTTP request headers
|
|
1594
1774
|
|
|
1595
|
-
- **Content-Type**:
|
|
1775
|
+
- **Content-Type**: application/json
|
|
1596
1776
|
- **Accept**: application/json
|
|
1597
1777
|
|
|
1598
1778
|
|
|
@@ -1604,37 +1784,27 @@ No authorization required
|
|
|
1604
1784
|
|
|
1605
1785
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1606
1786
|
|
|
1607
|
-
# **
|
|
1608
|
-
>
|
|
1787
|
+
# **passportAuthUserServicePassportUserSignInSocial**
|
|
1788
|
+
> PassportUserSignInSocialResponse passportAuthUserServicePassportUserSignInSocial(passportUserSignInSocialRequest)
|
|
1609
1789
|
|
|
1790
|
+
社交登录
|
|
1610
1791
|
|
|
1611
1792
|
### Example
|
|
1612
1793
|
|
|
1613
1794
|
```typescript
|
|
1614
1795
|
import {
|
|
1615
1796
|
PassportAuthUserServiceApi,
|
|
1616
|
-
Configuration
|
|
1797
|
+
Configuration,
|
|
1798
|
+
PassportUserSignInSocialRequest
|
|
1617
1799
|
} from '@cherryin/api-client';
|
|
1618
1800
|
|
|
1619
1801
|
const configuration = new Configuration();
|
|
1620
1802
|
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1621
1803
|
|
|
1622
|
-
let
|
|
1623
|
-
let phoneNumberE164: string; // (optional) (default to undefined)
|
|
1624
|
-
let authCode: string; // (optional) (default to undefined)
|
|
1625
|
-
let callbackUrl: string; // (optional) (default to undefined)
|
|
1626
|
-
let disableSignUp: boolean; //允许注册新用户,开启后默认是通过手机号登录验证通过,没有对应用户时会自动注册新用户 (optional) (default to undefined)
|
|
1627
|
-
let userName: string; //当允许注册新用户时,指定新用户的显示名称 (optional) (default to undefined)
|
|
1628
|
-
let avatarUrl: string; //当允许注册新用户时,指定新用户的头像 (optional) (default to undefined)
|
|
1804
|
+
let passportUserSignInSocialRequest: PassportUserSignInSocialRequest; //
|
|
1629
1805
|
|
|
1630
|
-
const { status, data } = await apiInstance.
|
|
1631
|
-
|
|
1632
|
-
phoneNumberE164,
|
|
1633
|
-
authCode,
|
|
1634
|
-
callbackUrl,
|
|
1635
|
-
disableSignUp,
|
|
1636
|
-
userName,
|
|
1637
|
-
avatarUrl
|
|
1806
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportUserSignInSocial(
|
|
1807
|
+
passportUserSignInSocialRequest
|
|
1638
1808
|
);
|
|
1639
1809
|
```
|
|
1640
1810
|
|
|
@@ -1642,18 +1812,12 @@ const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUs
|
|
|
1642
1812
|
|
|
1643
1813
|
|Name | Type | Description | Notes|
|
|
1644
1814
|
|------------- | ------------- | ------------- | -------------|
|
|
1645
|
-
| **
|
|
1646
|
-
| **phoneNumberE164** | [**string**] | | (optional) defaults to undefined|
|
|
1647
|
-
| **authCode** | [**string**] | | (optional) defaults to undefined|
|
|
1648
|
-
| **callbackUrl** | [**string**] | | (optional) defaults to undefined|
|
|
1649
|
-
| **disableSignUp** | [**boolean**] | 允许注册新用户,开启后默认是通过手机号登录验证通过,没有对应用户时会自动注册新用户 | (optional) defaults to undefined|
|
|
1650
|
-
| **userName** | [**string**] | 当允许注册新用户时,指定新用户的显示名称 | (optional) defaults to undefined|
|
|
1651
|
-
| **avatarUrl** | [**string**] | 当允许注册新用户时,指定新用户的头像 | (optional) defaults to undefined|
|
|
1815
|
+
| **passportUserSignInSocialRequest** | **PassportUserSignInSocialRequest**| | |
|
|
1652
1816
|
|
|
1653
1817
|
|
|
1654
1818
|
### Return type
|
|
1655
1819
|
|
|
1656
|
-
**
|
|
1820
|
+
**PassportUserSignInSocialResponse**
|
|
1657
1821
|
|
|
1658
1822
|
### Authorization
|
|
1659
1823
|
|
|
@@ -1661,7 +1825,60 @@ No authorization required
|
|
|
1661
1825
|
|
|
1662
1826
|
### HTTP request headers
|
|
1663
1827
|
|
|
1664
|
-
- **Content-Type**:
|
|
1828
|
+
- **Content-Type**: application/json
|
|
1829
|
+
- **Accept**: application/json
|
|
1830
|
+
|
|
1831
|
+
|
|
1832
|
+
### HTTP response details
|
|
1833
|
+
| Status code | Description | Response headers |
|
|
1834
|
+
|-------------|-------------|------------------|
|
|
1835
|
+
|**200** | OK | - |
|
|
1836
|
+
|**0** | Default error response | - |
|
|
1837
|
+
|
|
1838
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1839
|
+
|
|
1840
|
+
# **passportAuthUserServicePassportUserSignUpEmail**
|
|
1841
|
+
> PassportUserSignUpEmailResponse passportAuthUserServicePassportUserSignUpEmail(passportUserSignUpEmailRequest)
|
|
1842
|
+
|
|
1843
|
+
邮箱注册
|
|
1844
|
+
|
|
1845
|
+
### Example
|
|
1846
|
+
|
|
1847
|
+
```typescript
|
|
1848
|
+
import {
|
|
1849
|
+
PassportAuthUserServiceApi,
|
|
1850
|
+
Configuration,
|
|
1851
|
+
PassportUserSignUpEmailRequest
|
|
1852
|
+
} from '@cherryin/api-client';
|
|
1853
|
+
|
|
1854
|
+
const configuration = new Configuration();
|
|
1855
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1856
|
+
|
|
1857
|
+
let passportUserSignUpEmailRequest: PassportUserSignUpEmailRequest; //
|
|
1858
|
+
|
|
1859
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportUserSignUpEmail(
|
|
1860
|
+
passportUserSignUpEmailRequest
|
|
1861
|
+
);
|
|
1862
|
+
```
|
|
1863
|
+
|
|
1864
|
+
### Parameters
|
|
1865
|
+
|
|
1866
|
+
|Name | Type | Description | Notes|
|
|
1867
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1868
|
+
| **passportUserSignUpEmailRequest** | **PassportUserSignUpEmailRequest**| | |
|
|
1869
|
+
|
|
1870
|
+
|
|
1871
|
+
### Return type
|
|
1872
|
+
|
|
1873
|
+
**PassportUserSignUpEmailResponse**
|
|
1874
|
+
|
|
1875
|
+
### Authorization
|
|
1876
|
+
|
|
1877
|
+
No authorization required
|
|
1878
|
+
|
|
1879
|
+
### HTTP request headers
|
|
1880
|
+
|
|
1881
|
+
- **Content-Type**: application/json
|
|
1665
1882
|
- **Accept**: application/json
|
|
1666
1883
|
|
|
1667
1884
|
|