@cherryin/api-client 0.0.7 → 0.0.9
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 +86 -0
- package/README.md +130 -2
- package/api.ts +4492 -319
- package/dist/api.d.ts +2411 -73
- package/dist/api.js +2970 -6
- package/dist/esm/api.d.ts +2411 -73
- package/dist/esm/api.js +2956 -4
- package/docs/AuthAdminUser.md +33 -0
- package/docs/AuthIdToken.md +29 -0
- package/docs/AuthPassport.md +35 -0
- package/docs/AuthUser.md +39 -0
- package/docs/AuthUserMethod.md +39 -0
- package/docs/AuthUserSession.md +37 -0
- package/docs/PassportAuthAdminChangePasswordRequest.md +24 -0
- package/docs/PassportAuthAdminChangePasswordResponse.md +26 -0
- package/docs/PassportAuthAdminGetSessionResponse.md +26 -0
- package/docs/PassportAuthAdminListSessionsResponse.md +24 -0
- package/docs/PassportAuthAdminRevokeOtherSessionsResponse.md +22 -0
- package/docs/PassportAuthAdminRevokeSessionRequest.md +20 -0
- package/docs/PassportAuthAdminRevokeSessionResponse.md +22 -0
- package/docs/PassportAuthAdminRevokeSessionsResponse.md +22 -0
- package/docs/PassportAuthAdminServiceApi.md +469 -0
- package/docs/PassportAuthAdminSignInEmailRequest.md +26 -0
- package/docs/PassportAuthAdminSignInEmailResponse.md +26 -0
- package/docs/PassportAuthAdminSignOutResponse.md +22 -0
- package/docs/PassportAuthAdminUpdateUserRequest.md +22 -0
- package/docs/PassportAuthAdminUpdateUserResponse.md +24 -0
- package/docs/PassportAuthUserChangeEmailRequest.md +24 -0
- package/docs/PassportAuthUserChangeEmailResponse.md +24 -0
- package/docs/PassportAuthUserChangePasswordRequest.md +26 -0
- package/docs/PassportAuthUserChangePasswordResponse.md +26 -0
- package/docs/PassportAuthUserChangePhoneRequest.md +26 -0
- package/docs/PassportAuthUserChangePhoneResponse.md +24 -0
- package/docs/PassportAuthUserDeletePassportRequest.md +22 -0
- package/docs/PassportAuthUserDeletePassportResponse.md +24 -0
- package/docs/PassportAuthUserDeleteUserRequest.md +24 -0
- package/docs/PassportAuthUserDeleteUserResponse.md +24 -0
- package/docs/PassportAuthUserGetAccessTokenRequest.md +24 -0
- package/docs/PassportAuthUserGetAccessTokenResponse.md +34 -0
- package/docs/PassportAuthUserGetAccountInfoResponse.md +24 -0
- package/docs/PassportAuthUserGetPassportInfoResponse.md +26 -0
- package/docs/PassportAuthUserGetSessionResponse.md +24 -0
- package/docs/PassportAuthUserLinkSocialRequest.md +32 -0
- package/docs/PassportAuthUserLinkSocialResponse.md +26 -0
- package/docs/PassportAuthUserListAccountsResponse.md +24 -0
- package/docs/PassportAuthUserListMethodsResponse.md +24 -0
- package/docs/PassportAuthUserListSessionsResponse.md +24 -0
- package/docs/PassportAuthUserOAuthCallbackResponse.md +36 -0
- package/docs/PassportAuthUserRefreshTokenRequest.md +24 -0
- package/docs/PassportAuthUserRefreshTokenResponse.md +34 -0
- package/docs/PassportAuthUserRequestPasswordResetRequest.md +24 -0
- package/docs/PassportAuthUserRequestPasswordResetResponse.md +22 -0
- package/docs/PassportAuthUserResetPasswordRequest.md +24 -0
- package/docs/PassportAuthUserResetPasswordResponse.md +22 -0
- package/docs/PassportAuthUserRevokeOtherSessionsRequest.md +20 -0
- package/docs/PassportAuthUserRevokeOtherSessionsResponse.md +24 -0
- package/docs/PassportAuthUserRevokeSessionRequest.md +20 -0
- package/docs/PassportAuthUserRevokeSessionResponse.md +22 -0
- package/docs/PassportAuthUserRevokeSessionsRequest.md +20 -0
- package/docs/PassportAuthUserRevokeSessionsResponse.md +22 -0
- package/docs/PassportAuthUserSendVerificationEmailRequest.md +26 -0
- package/docs/PassportAuthUserSendVerificationEmailResponse.md +22 -0
- package/docs/PassportAuthUserServiceApi.md +1675 -0
- package/docs/PassportAuthUserSignInEmailRequest.md +28 -0
- package/docs/PassportAuthUserSignInEmailResponse.md +32 -0
- package/docs/PassportAuthUserSignInPhoneRequest.md +24 -0
- package/docs/PassportAuthUserSignInPhoneResponse.md +28 -0
- package/docs/PassportAuthUserSignInSocialRequest.md +32 -0
- package/docs/PassportAuthUserSignInSocialResponse.md +32 -0
- package/docs/PassportAuthUserSignOutRequest.md +22 -0
- package/docs/PassportAuthUserSignOutResponse.md +24 -0
- package/docs/PassportAuthUserSignUpEmailRequest.md +34 -0
- package/docs/PassportAuthUserSignUpEmailResponse.md +30 -0
- package/docs/PassportAuthUserUnlinkAccountRequest.md +24 -0
- package/docs/PassportAuthUserUnlinkAccountResponse.md +22 -0
- package/docs/PassportAuthUserUpdatePassportRequest.md +22 -0
- package/docs/PassportAuthUserUpdatePassportResponse.md +24 -0
- package/docs/PassportAuthUserUpdateUserRequest.md +24 -0
- package/docs/PassportAuthUserUpdateUserResponse.md +24 -0
- package/docs/PassportAuthUserVerifyEmailResponse.md +24 -0
- package/docs/PassportAuthUserVerifyPhoneResponse.md +24 -0
- package/docs/ProviderAdminServiceApi.md +1 -1
- package/docs/QRCodeAdminServiceApi.md +286 -0
- package/docs/QRCodeCreateRequest.md +37 -0
- package/docs/QRCodeCreateResponse.md +25 -0
- package/docs/QRCodeDeleteResponse.md +23 -0
- package/docs/QRCodeGetResponse.md +25 -0
- package/docs/QRCodeHistoryItem.md +29 -0
- package/docs/QRCodeInfo.md +59 -0
- package/docs/QRCodeListResponse.md +27 -0
- package/docs/QRCodeSnapshot.md +37 -0
- package/docs/QRCodeUpdateRequest.md +39 -0
- package/docs/QRCodeUpdateResponse.md +25 -0
- package/docs/QRCodeWithHistory.md +23 -0
- package/package.json +1 -1
|
@@ -0,0 +1,1675 @@
|
|
|
1
|
+
# PassportAuthUserServiceApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**passportAuthUserServicePassportAuthUserChangeEmail**](#passportauthuserservicepassportauthuserchangeemail) | **POST** /passport/authed/v1/change-email | |
|
|
8
|
+
|[**passportAuthUserServicePassportAuthUserChangePassword**](#passportauthuserservicepassportauthuserchangepassword) | **POST** /passport/authed/v1/change-password | |
|
|
9
|
+
|[**passportAuthUserServicePassportAuthUserChangePhone**](#passportauthuserservicepassportauthuserchangephone) | **POST** /passport/authed/v1/change-phone | |
|
|
10
|
+
|[**passportAuthUserServicePassportAuthUserDeletePassport**](#passportauthuserservicepassportauthuserdeletepassport) | **POST** /passport/authed/v1/delete-passport | |
|
|
11
|
+
|[**passportAuthUserServicePassportAuthUserDeleteUser**](#passportauthuserservicepassportauthuserdeleteuser) | **POST** /passport/authed/v1/delete-user | |
|
|
12
|
+
|[**passportAuthUserServicePassportAuthUserGetAccessToken**](#passportauthuserservicepassportauthusergetaccesstoken) | **POST** /passport/authed/v1/social/get-access-token | |
|
|
13
|
+
|[**passportAuthUserServicePassportAuthUserGetAccountInfo**](#passportauthuserservicepassportauthusergetaccountinfo) | **GET** /passport/authed/v1/account-info | |
|
|
14
|
+
|[**passportAuthUserServicePassportAuthUserGetPassportInfo**](#passportauthuserservicepassportauthusergetpassportinfo) | **GET** /passport/authed/v1/passport-info | |
|
|
15
|
+
|[**passportAuthUserServicePassportAuthUserGetSession**](#passportauthuserservicepassportauthusergetsession) | **GET** /passport/authed/v1/get-session | |
|
|
16
|
+
|[**passportAuthUserServicePassportAuthUserLinkSocial**](#passportauthuserservicepassportauthuserlinksocial) | **POST** /passport/authed/v1/link-social | |
|
|
17
|
+
|[**passportAuthUserServicePassportAuthUserListMethods**](#passportauthuserservicepassportauthuserlistmethods) | **GET** /passport/authed/v1/list-auth-methods | |
|
|
18
|
+
|[**passportAuthUserServicePassportAuthUserListSessions**](#passportauthuserservicepassportauthuserlistsessions) | **GET** /passport/authed/v1/list-sessions | |
|
|
19
|
+
|[**passportAuthUserServicePassportAuthUserOAuthCallback**](#passportauthuserservicepassportauthuseroauthcallback) | **GET** /passport/oauth2/{platform}/callback | |
|
|
20
|
+
|[**passportAuthUserServicePassportAuthUserRefreshToken**](#passportauthuserservicepassportauthuserrefreshtoken) | **POST** /passport/authed/v1/social/refresh-token | |
|
|
21
|
+
|[**passportAuthUserServicePassportAuthUserRequestPasswordReset**](#passportauthuserservicepassportauthuserrequestpasswordreset) | **POST** /passport/authed/v1/request-password-reset | |
|
|
22
|
+
|[**passportAuthUserServicePassportAuthUserResetPassword**](#passportauthuserservicepassportauthuserresetpassword) | **POST** /passport/authed/v1/reset-password | |
|
|
23
|
+
|[**passportAuthUserServicePassportAuthUserRevokeOtherSessions**](#passportauthuserservicepassportauthuserrevokeothersessions) | **POST** /passport/authed/v1/revoke-other-sessions | |
|
|
24
|
+
|[**passportAuthUserServicePassportAuthUserRevokeSession**](#passportauthuserservicepassportauthuserrevokesession) | **POST** /passport/authed/v1/revoke-session | |
|
|
25
|
+
|[**passportAuthUserServicePassportAuthUserRevokeSessions**](#passportauthuserservicepassportauthuserrevokesessions) | **POST** /passport/authed/v1/revoke-sessions | |
|
|
26
|
+
|[**passportAuthUserServicePassportAuthUserSendVerificationEmail**](#passportauthuserservicepassportauthusersendverificationemail) | **POST** /passport/authed/v1/send-verification-email | |
|
|
27
|
+
|[**passportAuthUserServicePassportAuthUserSendVerificationPhone**](#passportauthuserservicepassportauthusersendverificationphone) | **POST** /passport/authed/v1/send-verification-phone | |
|
|
28
|
+
|[**passportAuthUserServicePassportAuthUserSignInEmail**](#passportauthuserservicepassportauthusersigninemail) | **POST** /passport/auth/v1/sign-in/email | |
|
|
29
|
+
|[**passportAuthUserServicePassportAuthUserSignInPhone**](#passportauthuserservicepassportauthusersigninphone) | **POST** /passport/auth/v1/sign-in/phone | |
|
|
30
|
+
|[**passportAuthUserServicePassportAuthUserSignInSocial**](#passportauthuserservicepassportauthusersigninsocial) | **POST** /passport/auth/v1/sign-in/social | |
|
|
31
|
+
|[**passportAuthUserServicePassportAuthUserSignOut**](#passportauthuserservicepassportauthusersignout) | **POST** /passport/authed/v1/sign-out | |
|
|
32
|
+
|[**passportAuthUserServicePassportAuthUserSignUpEmail**](#passportauthuserservicepassportauthusersignupemail) | **POST** /passport/auth/v1/sign-up/email | |
|
|
33
|
+
|[**passportAuthUserServicePassportAuthUserUnlinkAccount**](#passportauthuserservicepassportauthuserunlinkaccount) | **POST** /passport/authed/v1/unlink-account | |
|
|
34
|
+
|[**passportAuthUserServicePassportAuthUserUpdatePassport**](#passportauthuserservicepassportauthuserupdatepassport) | **POST** /passport/authed/v1/update-passport | |
|
|
35
|
+
|[**passportAuthUserServicePassportAuthUserUpdateUser**](#passportauthuserservicepassportauthuserupdateuser) | **POST** /passport/authed/v1/update-user | |
|
|
36
|
+
|[**passportAuthUserServicePassportAuthUserVerifyEmail**](#passportauthuserservicepassportauthuserverifyemail) | **GET** /passport/authed/v1/verify-email | |
|
|
37
|
+
|[**passportAuthUserServicePassportAuthUserVerifyPhone**](#passportauthuserservicepassportauthuserverifyphone) | **GET** /passport/authed/v1/verify-phone | |
|
|
38
|
+
|
|
39
|
+
# **passportAuthUserServicePassportAuthUserChangeEmail**
|
|
40
|
+
> PassportAuthUserChangeEmailResponse passportAuthUserServicePassportAuthUserChangeEmail(passportAuthUserChangeEmailRequest)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
### Example
|
|
44
|
+
|
|
45
|
+
```typescript
|
|
46
|
+
import {
|
|
47
|
+
PassportAuthUserServiceApi,
|
|
48
|
+
Configuration,
|
|
49
|
+
PassportAuthUserChangeEmailRequest
|
|
50
|
+
} from '@cherryin/api-client';
|
|
51
|
+
|
|
52
|
+
const configuration = new Configuration();
|
|
53
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
54
|
+
|
|
55
|
+
let passportAuthUserChangeEmailRequest: PassportAuthUserChangeEmailRequest; //
|
|
56
|
+
|
|
57
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserChangeEmail(
|
|
58
|
+
passportAuthUserChangeEmailRequest
|
|
59
|
+
);
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Parameters
|
|
63
|
+
|
|
64
|
+
|Name | Type | Description | Notes|
|
|
65
|
+
|------------- | ------------- | ------------- | -------------|
|
|
66
|
+
| **passportAuthUserChangeEmailRequest** | **PassportAuthUserChangeEmailRequest**| | |
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
### Return type
|
|
70
|
+
|
|
71
|
+
**PassportAuthUserChangeEmailResponse**
|
|
72
|
+
|
|
73
|
+
### Authorization
|
|
74
|
+
|
|
75
|
+
No authorization required
|
|
76
|
+
|
|
77
|
+
### HTTP request headers
|
|
78
|
+
|
|
79
|
+
- **Content-Type**: application/json
|
|
80
|
+
- **Accept**: application/json
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
### HTTP response details
|
|
84
|
+
| Status code | Description | Response headers |
|
|
85
|
+
|-------------|-------------|------------------|
|
|
86
|
+
|**200** | OK | - |
|
|
87
|
+
|**0** | Default error response | - |
|
|
88
|
+
|
|
89
|
+
[[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
|
+
|
|
91
|
+
# **passportAuthUserServicePassportAuthUserChangePassword**
|
|
92
|
+
> PassportAuthUserChangePasswordResponse passportAuthUserServicePassportAuthUserChangePassword(passportAuthUserChangePasswordRequest)
|
|
93
|
+
|
|
94
|
+
============ 密码管理 ============
|
|
95
|
+
|
|
96
|
+
### Example
|
|
97
|
+
|
|
98
|
+
```typescript
|
|
99
|
+
import {
|
|
100
|
+
PassportAuthUserServiceApi,
|
|
101
|
+
Configuration,
|
|
102
|
+
PassportAuthUserChangePasswordRequest
|
|
103
|
+
} from '@cherryin/api-client';
|
|
104
|
+
|
|
105
|
+
const configuration = new Configuration();
|
|
106
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
107
|
+
|
|
108
|
+
let passportAuthUserChangePasswordRequest: PassportAuthUserChangePasswordRequest; //
|
|
109
|
+
|
|
110
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserChangePassword(
|
|
111
|
+
passportAuthUserChangePasswordRequest
|
|
112
|
+
);
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Parameters
|
|
116
|
+
|
|
117
|
+
|Name | Type | Description | Notes|
|
|
118
|
+
|------------- | ------------- | ------------- | -------------|
|
|
119
|
+
| **passportAuthUserChangePasswordRequest** | **PassportAuthUserChangePasswordRequest**| | |
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
### Return type
|
|
123
|
+
|
|
124
|
+
**PassportAuthUserChangePasswordResponse**
|
|
125
|
+
|
|
126
|
+
### Authorization
|
|
127
|
+
|
|
128
|
+
No authorization required
|
|
129
|
+
|
|
130
|
+
### HTTP request headers
|
|
131
|
+
|
|
132
|
+
- **Content-Type**: application/json
|
|
133
|
+
- **Accept**: application/json
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
### HTTP response details
|
|
137
|
+
| Status code | Description | Response headers |
|
|
138
|
+
|-------------|-------------|------------------|
|
|
139
|
+
|**200** | OK | - |
|
|
140
|
+
|**0** | Default error response | - |
|
|
141
|
+
|
|
142
|
+
[[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
|
+
|
|
144
|
+
# **passportAuthUserServicePassportAuthUserChangePhone**
|
|
145
|
+
> PassportAuthUserChangePhoneResponse passportAuthUserServicePassportAuthUserChangePhone(passportAuthUserChangePhoneRequest)
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
### Example
|
|
149
|
+
|
|
150
|
+
```typescript
|
|
151
|
+
import {
|
|
152
|
+
PassportAuthUserServiceApi,
|
|
153
|
+
Configuration,
|
|
154
|
+
PassportAuthUserChangePhoneRequest
|
|
155
|
+
} from '@cherryin/api-client';
|
|
156
|
+
|
|
157
|
+
const configuration = new Configuration();
|
|
158
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
159
|
+
|
|
160
|
+
let passportAuthUserChangePhoneRequest: PassportAuthUserChangePhoneRequest; //
|
|
161
|
+
|
|
162
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserChangePhone(
|
|
163
|
+
passportAuthUserChangePhoneRequest
|
|
164
|
+
);
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
### Parameters
|
|
168
|
+
|
|
169
|
+
|Name | Type | Description | Notes|
|
|
170
|
+
|------------- | ------------- | ------------- | -------------|
|
|
171
|
+
| **passportAuthUserChangePhoneRequest** | **PassportAuthUserChangePhoneRequest**| | |
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
### Return type
|
|
175
|
+
|
|
176
|
+
**PassportAuthUserChangePhoneResponse**
|
|
177
|
+
|
|
178
|
+
### Authorization
|
|
179
|
+
|
|
180
|
+
No authorization required
|
|
181
|
+
|
|
182
|
+
### HTTP request headers
|
|
183
|
+
|
|
184
|
+
- **Content-Type**: application/json
|
|
185
|
+
- **Accept**: application/json
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
### HTTP response details
|
|
189
|
+
| Status code | Description | Response headers |
|
|
190
|
+
|-------------|-------------|------------------|
|
|
191
|
+
|**200** | OK | - |
|
|
192
|
+
|**0** | Default error response | - |
|
|
193
|
+
|
|
194
|
+
[[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
|
+
|
|
196
|
+
# **passportAuthUserServicePassportAuthUserDeletePassport**
|
|
197
|
+
> PassportAuthUserDeletePassportResponse passportAuthUserServicePassportAuthUserDeletePassport(passportAuthUserDeletePassportRequest)
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
### Example
|
|
201
|
+
|
|
202
|
+
```typescript
|
|
203
|
+
import {
|
|
204
|
+
PassportAuthUserServiceApi,
|
|
205
|
+
Configuration,
|
|
206
|
+
PassportAuthUserDeletePassportRequest
|
|
207
|
+
} from '@cherryin/api-client';
|
|
208
|
+
|
|
209
|
+
const configuration = new Configuration();
|
|
210
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
211
|
+
|
|
212
|
+
let passportAuthUserDeletePassportRequest: PassportAuthUserDeletePassportRequest; //
|
|
213
|
+
|
|
214
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserDeletePassport(
|
|
215
|
+
passportAuthUserDeletePassportRequest
|
|
216
|
+
);
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
### Parameters
|
|
220
|
+
|
|
221
|
+
|Name | Type | Description | Notes|
|
|
222
|
+
|------------- | ------------- | ------------- | -------------|
|
|
223
|
+
| **passportAuthUserDeletePassportRequest** | **PassportAuthUserDeletePassportRequest**| | |
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
### Return type
|
|
227
|
+
|
|
228
|
+
**PassportAuthUserDeletePassportResponse**
|
|
229
|
+
|
|
230
|
+
### Authorization
|
|
231
|
+
|
|
232
|
+
No authorization required
|
|
233
|
+
|
|
234
|
+
### HTTP request headers
|
|
235
|
+
|
|
236
|
+
- **Content-Type**: application/json
|
|
237
|
+
- **Accept**: application/json
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
### HTTP response details
|
|
241
|
+
| Status code | Description | Response headers |
|
|
242
|
+
|-------------|-------------|------------------|
|
|
243
|
+
|**200** | OK | - |
|
|
244
|
+
|**0** | Default error response | - |
|
|
245
|
+
|
|
246
|
+
[[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
|
+
|
|
248
|
+
# **passportAuthUserServicePassportAuthUserDeleteUser**
|
|
249
|
+
> PassportAuthUserDeleteUserResponse passportAuthUserServicePassportAuthUserDeleteUser(passportAuthUserDeleteUserRequest)
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
### Example
|
|
253
|
+
|
|
254
|
+
```typescript
|
|
255
|
+
import {
|
|
256
|
+
PassportAuthUserServiceApi,
|
|
257
|
+
Configuration,
|
|
258
|
+
PassportAuthUserDeleteUserRequest
|
|
259
|
+
} from '@cherryin/api-client';
|
|
260
|
+
|
|
261
|
+
const configuration = new Configuration();
|
|
262
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
263
|
+
|
|
264
|
+
let passportAuthUserDeleteUserRequest: PassportAuthUserDeleteUserRequest; //
|
|
265
|
+
|
|
266
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserDeleteUser(
|
|
267
|
+
passportAuthUserDeleteUserRequest
|
|
268
|
+
);
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
### Parameters
|
|
272
|
+
|
|
273
|
+
|Name | Type | Description | Notes|
|
|
274
|
+
|------------- | ------------- | ------------- | -------------|
|
|
275
|
+
| **passportAuthUserDeleteUserRequest** | **PassportAuthUserDeleteUserRequest**| | |
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
### Return type
|
|
279
|
+
|
|
280
|
+
**PassportAuthUserDeleteUserResponse**
|
|
281
|
+
|
|
282
|
+
### Authorization
|
|
283
|
+
|
|
284
|
+
No authorization required
|
|
285
|
+
|
|
286
|
+
### HTTP request headers
|
|
287
|
+
|
|
288
|
+
- **Content-Type**: application/json
|
|
289
|
+
- **Accept**: application/json
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
### HTTP response details
|
|
293
|
+
| Status code | Description | Response headers |
|
|
294
|
+
|-------------|-------------|------------------|
|
|
295
|
+
|**200** | OK | - |
|
|
296
|
+
|**0** | Default error response | - |
|
|
297
|
+
|
|
298
|
+
[[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
|
+
|
|
300
|
+
# **passportAuthUserServicePassportAuthUserGetAccessToken**
|
|
301
|
+
> PassportAuthUserGetAccessTokenResponse passportAuthUserServicePassportAuthUserGetAccessToken(passportAuthUserGetAccessTokenRequest)
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
### Example
|
|
305
|
+
|
|
306
|
+
```typescript
|
|
307
|
+
import {
|
|
308
|
+
PassportAuthUserServiceApi,
|
|
309
|
+
Configuration,
|
|
310
|
+
PassportAuthUserGetAccessTokenRequest
|
|
311
|
+
} from '@cherryin/api-client';
|
|
312
|
+
|
|
313
|
+
const configuration = new Configuration();
|
|
314
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
315
|
+
|
|
316
|
+
let passportAuthUserGetAccessTokenRequest: PassportAuthUserGetAccessTokenRequest; //
|
|
317
|
+
|
|
318
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserGetAccessToken(
|
|
319
|
+
passportAuthUserGetAccessTokenRequest
|
|
320
|
+
);
|
|
321
|
+
```
|
|
322
|
+
|
|
323
|
+
### Parameters
|
|
324
|
+
|
|
325
|
+
|Name | Type | Description | Notes|
|
|
326
|
+
|------------- | ------------- | ------------- | -------------|
|
|
327
|
+
| **passportAuthUserGetAccessTokenRequest** | **PassportAuthUserGetAccessTokenRequest**| | |
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
### Return type
|
|
331
|
+
|
|
332
|
+
**PassportAuthUserGetAccessTokenResponse**
|
|
333
|
+
|
|
334
|
+
### Authorization
|
|
335
|
+
|
|
336
|
+
No authorization required
|
|
337
|
+
|
|
338
|
+
### HTTP request headers
|
|
339
|
+
|
|
340
|
+
- **Content-Type**: application/json
|
|
341
|
+
- **Accept**: application/json
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
### HTTP response details
|
|
345
|
+
| Status code | Description | Response headers |
|
|
346
|
+
|-------------|-------------|------------------|
|
|
347
|
+
|**200** | OK | - |
|
|
348
|
+
|**0** | Default error response | - |
|
|
349
|
+
|
|
350
|
+
[[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
|
+
|
|
352
|
+
# **passportAuthUserServicePassportAuthUserGetAccountInfo**
|
|
353
|
+
> PassportAuthUserGetAccountInfoResponse passportAuthUserServicePassportAuthUserGetAccountInfo()
|
|
354
|
+
|
|
355
|
+
|
|
356
|
+
### Example
|
|
357
|
+
|
|
358
|
+
```typescript
|
|
359
|
+
import {
|
|
360
|
+
PassportAuthUserServiceApi,
|
|
361
|
+
Configuration
|
|
362
|
+
} from '@cherryin/api-client';
|
|
363
|
+
|
|
364
|
+
const configuration = new Configuration();
|
|
365
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
366
|
+
|
|
367
|
+
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 (optional) (default to undefined)
|
|
368
|
+
|
|
369
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserGetAccountInfo(
|
|
370
|
+
appIds
|
|
371
|
+
);
|
|
372
|
+
```
|
|
373
|
+
|
|
374
|
+
### Parameters
|
|
375
|
+
|
|
376
|
+
|Name | Type | Description | Notes|
|
|
377
|
+
|------------- | ------------- | ------------- | -------------|
|
|
378
|
+
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 | (optional) defaults to undefined|
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
### Return type
|
|
382
|
+
|
|
383
|
+
**PassportAuthUserGetAccountInfoResponse**
|
|
384
|
+
|
|
385
|
+
### Authorization
|
|
386
|
+
|
|
387
|
+
No authorization required
|
|
388
|
+
|
|
389
|
+
### HTTP request headers
|
|
390
|
+
|
|
391
|
+
- **Content-Type**: Not defined
|
|
392
|
+
- **Accept**: application/json
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
### HTTP response details
|
|
396
|
+
| Status code | Description | Response headers |
|
|
397
|
+
|-------------|-------------|------------------|
|
|
398
|
+
|**200** | OK | - |
|
|
399
|
+
|**0** | Default error response | - |
|
|
400
|
+
|
|
401
|
+
[[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
|
+
|
|
403
|
+
# **passportAuthUserServicePassportAuthUserGetPassportInfo**
|
|
404
|
+
> PassportAuthUserGetPassportInfoResponse passportAuthUserServicePassportAuthUserGetPassportInfo()
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
### Example
|
|
408
|
+
|
|
409
|
+
```typescript
|
|
410
|
+
import {
|
|
411
|
+
PassportAuthUserServiceApi,
|
|
412
|
+
Configuration
|
|
413
|
+
} from '@cherryin/api-client';
|
|
414
|
+
|
|
415
|
+
const configuration = new Configuration();
|
|
416
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
417
|
+
|
|
418
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserGetPassportInfo();
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
### Parameters
|
|
422
|
+
This endpoint does not have any parameters.
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
### Return type
|
|
426
|
+
|
|
427
|
+
**PassportAuthUserGetPassportInfoResponse**
|
|
428
|
+
|
|
429
|
+
### Authorization
|
|
430
|
+
|
|
431
|
+
No authorization required
|
|
432
|
+
|
|
433
|
+
### HTTP request headers
|
|
434
|
+
|
|
435
|
+
- **Content-Type**: Not defined
|
|
436
|
+
- **Accept**: application/json
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
### HTTP response details
|
|
440
|
+
| Status code | Description | Response headers |
|
|
441
|
+
|-------------|-------------|------------------|
|
|
442
|
+
|**200** | OK | - |
|
|
443
|
+
|**0** | Default error response | - |
|
|
444
|
+
|
|
445
|
+
[[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
|
+
|
|
447
|
+
# **passportAuthUserServicePassportAuthUserGetSession**
|
|
448
|
+
> PassportAuthUserGetSessionResponse passportAuthUserServicePassportAuthUserGetSession()
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
### Example
|
|
452
|
+
|
|
453
|
+
```typescript
|
|
454
|
+
import {
|
|
455
|
+
PassportAuthUserServiceApi,
|
|
456
|
+
Configuration
|
|
457
|
+
} from '@cherryin/api-client';
|
|
458
|
+
|
|
459
|
+
const configuration = new Configuration();
|
|
460
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
461
|
+
|
|
462
|
+
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 必须指定 app_ids,否则无法获取对应应用的会话信息 (optional) (default to undefined)
|
|
463
|
+
|
|
464
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserGetSession(
|
|
465
|
+
appIds
|
|
466
|
+
);
|
|
467
|
+
```
|
|
468
|
+
|
|
469
|
+
### Parameters
|
|
470
|
+
|
|
471
|
+
|Name | Type | Description | Notes|
|
|
472
|
+
|------------- | ------------- | ------------- | -------------|
|
|
473
|
+
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 必须指定 app_ids,否则无法获取对应应用的会话信息 | (optional) defaults to undefined|
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
### Return type
|
|
477
|
+
|
|
478
|
+
**PassportAuthUserGetSessionResponse**
|
|
479
|
+
|
|
480
|
+
### Authorization
|
|
481
|
+
|
|
482
|
+
No authorization required
|
|
483
|
+
|
|
484
|
+
### HTTP request headers
|
|
485
|
+
|
|
486
|
+
- **Content-Type**: Not defined
|
|
487
|
+
- **Accept**: application/json
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
### HTTP response details
|
|
491
|
+
| Status code | Description | Response headers |
|
|
492
|
+
|-------------|-------------|------------------|
|
|
493
|
+
|**200** | OK | - |
|
|
494
|
+
|**0** | Default error response | - |
|
|
495
|
+
|
|
496
|
+
[[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
|
+
|
|
498
|
+
# **passportAuthUserServicePassportAuthUserLinkSocial**
|
|
499
|
+
> PassportAuthUserLinkSocialResponse passportAuthUserServicePassportAuthUserLinkSocial(passportAuthUserLinkSocialRequest)
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
### Example
|
|
503
|
+
|
|
504
|
+
```typescript
|
|
505
|
+
import {
|
|
506
|
+
PassportAuthUserServiceApi,
|
|
507
|
+
Configuration,
|
|
508
|
+
PassportAuthUserLinkSocialRequest
|
|
509
|
+
} from '@cherryin/api-client';
|
|
510
|
+
|
|
511
|
+
const configuration = new Configuration();
|
|
512
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
513
|
+
|
|
514
|
+
let passportAuthUserLinkSocialRequest: PassportAuthUserLinkSocialRequest; //
|
|
515
|
+
|
|
516
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserLinkSocial(
|
|
517
|
+
passportAuthUserLinkSocialRequest
|
|
518
|
+
);
|
|
519
|
+
```
|
|
520
|
+
|
|
521
|
+
### Parameters
|
|
522
|
+
|
|
523
|
+
|Name | Type | Description | Notes|
|
|
524
|
+
|------------- | ------------- | ------------- | -------------|
|
|
525
|
+
| **passportAuthUserLinkSocialRequest** | **PassportAuthUserLinkSocialRequest**| | |
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
### Return type
|
|
529
|
+
|
|
530
|
+
**PassportAuthUserLinkSocialResponse**
|
|
531
|
+
|
|
532
|
+
### Authorization
|
|
533
|
+
|
|
534
|
+
No authorization required
|
|
535
|
+
|
|
536
|
+
### HTTP request headers
|
|
537
|
+
|
|
538
|
+
- **Content-Type**: application/json
|
|
539
|
+
- **Accept**: application/json
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
### HTTP response details
|
|
543
|
+
| Status code | Description | Response headers |
|
|
544
|
+
|-------------|-------------|------------------|
|
|
545
|
+
|**200** | OK | - |
|
|
546
|
+
|**0** | Default error response | - |
|
|
547
|
+
|
|
548
|
+
[[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
|
+
|
|
550
|
+
# **passportAuthUserServicePassportAuthUserListMethods**
|
|
551
|
+
> PassportAuthUserListMethodsResponse passportAuthUserServicePassportAuthUserListMethods()
|
|
552
|
+
|
|
553
|
+
列出已关联的认证方法(包含 邮箱/社交账号等)
|
|
554
|
+
|
|
555
|
+
### Example
|
|
556
|
+
|
|
557
|
+
```typescript
|
|
558
|
+
import {
|
|
559
|
+
PassportAuthUserServiceApi,
|
|
560
|
+
Configuration
|
|
561
|
+
} from '@cherryin/api-client';
|
|
562
|
+
|
|
563
|
+
const configuration = new Configuration();
|
|
564
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
565
|
+
|
|
566
|
+
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 (optional) (default to undefined)
|
|
567
|
+
|
|
568
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserListMethods(
|
|
569
|
+
appIds
|
|
570
|
+
);
|
|
571
|
+
```
|
|
572
|
+
|
|
573
|
+
### Parameters
|
|
574
|
+
|
|
575
|
+
|Name | Type | Description | Notes|
|
|
576
|
+
|------------- | ------------- | ------------- | -------------|
|
|
577
|
+
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 | (optional) defaults to undefined|
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
### Return type
|
|
581
|
+
|
|
582
|
+
**PassportAuthUserListMethodsResponse**
|
|
583
|
+
|
|
584
|
+
### Authorization
|
|
585
|
+
|
|
586
|
+
No authorization required
|
|
587
|
+
|
|
588
|
+
### HTTP request headers
|
|
589
|
+
|
|
590
|
+
- **Content-Type**: Not defined
|
|
591
|
+
- **Accept**: application/json
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
### HTTP response details
|
|
595
|
+
| Status code | Description | Response headers |
|
|
596
|
+
|-------------|-------------|------------------|
|
|
597
|
+
|**200** | OK | - |
|
|
598
|
+
|**0** | Default error response | - |
|
|
599
|
+
|
|
600
|
+
[[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
|
+
|
|
602
|
+
# **passportAuthUserServicePassportAuthUserListSessions**
|
|
603
|
+
> PassportAuthUserListSessionsResponse passportAuthUserServicePassportAuthUserListSessions()
|
|
604
|
+
|
|
605
|
+
============ 会话管理 ============
|
|
606
|
+
|
|
607
|
+
### Example
|
|
608
|
+
|
|
609
|
+
```typescript
|
|
610
|
+
import {
|
|
611
|
+
PassportAuthUserServiceApi,
|
|
612
|
+
Configuration
|
|
613
|
+
} from '@cherryin/api-client';
|
|
614
|
+
|
|
615
|
+
const configuration = new Configuration();
|
|
616
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
617
|
+
|
|
618
|
+
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" (optional) (default to undefined)
|
|
619
|
+
|
|
620
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserListSessions(
|
|
621
|
+
appIds
|
|
622
|
+
);
|
|
623
|
+
```
|
|
624
|
+
|
|
625
|
+
### Parameters
|
|
626
|
+
|
|
627
|
+
|Name | Type | Description | Notes|
|
|
628
|
+
|------------- | ------------- | ------------- | -------------|
|
|
629
|
+
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" | (optional) defaults to undefined|
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
### Return type
|
|
633
|
+
|
|
634
|
+
**PassportAuthUserListSessionsResponse**
|
|
635
|
+
|
|
636
|
+
### Authorization
|
|
637
|
+
|
|
638
|
+
No authorization required
|
|
639
|
+
|
|
640
|
+
### HTTP request headers
|
|
641
|
+
|
|
642
|
+
- **Content-Type**: Not defined
|
|
643
|
+
- **Accept**: application/json
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
### HTTP response details
|
|
647
|
+
| Status code | Description | Response headers |
|
|
648
|
+
|-------------|-------------|------------------|
|
|
649
|
+
|**200** | OK | - |
|
|
650
|
+
|**0** | Default error response | - |
|
|
651
|
+
|
|
652
|
+
[[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
|
+
|
|
654
|
+
# **passportAuthUserServicePassportAuthUserOAuthCallback**
|
|
655
|
+
> PassportAuthUserOAuthCallbackResponse passportAuthUserServicePassportAuthUserOAuthCallback()
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
### Example
|
|
659
|
+
|
|
660
|
+
```typescript
|
|
661
|
+
import {
|
|
662
|
+
PassportAuthUserServiceApi,
|
|
663
|
+
Configuration
|
|
664
|
+
} from '@cherryin/api-client';
|
|
665
|
+
|
|
666
|
+
const configuration = new Configuration();
|
|
667
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
668
|
+
|
|
669
|
+
let platform: string; //@gotags: form:\"platform\" google/github (default to undefined)
|
|
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)
|
|
673
|
+
|
|
674
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserOAuthCallback(
|
|
675
|
+
platform,
|
|
676
|
+
appIds,
|
|
677
|
+
code,
|
|
678
|
+
state
|
|
679
|
+
);
|
|
680
|
+
```
|
|
681
|
+
|
|
682
|
+
### Parameters
|
|
683
|
+
|
|
684
|
+
|Name | Type | Description | Notes|
|
|
685
|
+
|------------- | ------------- | ------------- | -------------|
|
|
686
|
+
| **platform** | [**string**] | @gotags: form:\"platform\" google/github | defaults to undefined|
|
|
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|
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
### Return type
|
|
693
|
+
|
|
694
|
+
**PassportAuthUserOAuthCallbackResponse**
|
|
695
|
+
|
|
696
|
+
### Authorization
|
|
697
|
+
|
|
698
|
+
No authorization required
|
|
699
|
+
|
|
700
|
+
### HTTP request headers
|
|
701
|
+
|
|
702
|
+
- **Content-Type**: Not defined
|
|
703
|
+
- **Accept**: application/json
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
### HTTP response details
|
|
707
|
+
| Status code | Description | Response headers |
|
|
708
|
+
|-------------|-------------|------------------|
|
|
709
|
+
|**200** | OK | - |
|
|
710
|
+
|**0** | Default error response | - |
|
|
711
|
+
|
|
712
|
+
[[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
|
+
|
|
714
|
+
# **passportAuthUserServicePassportAuthUserRefreshToken**
|
|
715
|
+
> PassportAuthUserRefreshTokenResponse passportAuthUserServicePassportAuthUserRefreshToken(passportAuthUserRefreshTokenRequest)
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
### Example
|
|
719
|
+
|
|
720
|
+
```typescript
|
|
721
|
+
import {
|
|
722
|
+
PassportAuthUserServiceApi,
|
|
723
|
+
Configuration,
|
|
724
|
+
PassportAuthUserRefreshTokenRequest
|
|
725
|
+
} from '@cherryin/api-client';
|
|
726
|
+
|
|
727
|
+
const configuration = new Configuration();
|
|
728
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
729
|
+
|
|
730
|
+
let passportAuthUserRefreshTokenRequest: PassportAuthUserRefreshTokenRequest; //
|
|
731
|
+
|
|
732
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserRefreshToken(
|
|
733
|
+
passportAuthUserRefreshTokenRequest
|
|
734
|
+
);
|
|
735
|
+
```
|
|
736
|
+
|
|
737
|
+
### Parameters
|
|
738
|
+
|
|
739
|
+
|Name | Type | Description | Notes|
|
|
740
|
+
|------------- | ------------- | ------------- | -------------|
|
|
741
|
+
| **passportAuthUserRefreshTokenRequest** | **PassportAuthUserRefreshTokenRequest**| | |
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
### Return type
|
|
745
|
+
|
|
746
|
+
**PassportAuthUserRefreshTokenResponse**
|
|
747
|
+
|
|
748
|
+
### Authorization
|
|
749
|
+
|
|
750
|
+
No authorization required
|
|
751
|
+
|
|
752
|
+
### HTTP request headers
|
|
753
|
+
|
|
754
|
+
- **Content-Type**: application/json
|
|
755
|
+
- **Accept**: application/json
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
### HTTP response details
|
|
759
|
+
| Status code | Description | Response headers |
|
|
760
|
+
|-------------|-------------|------------------|
|
|
761
|
+
|**200** | OK | - |
|
|
762
|
+
|**0** | Default error response | - |
|
|
763
|
+
|
|
764
|
+
[[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
|
+
|
|
766
|
+
# **passportAuthUserServicePassportAuthUserRequestPasswordReset**
|
|
767
|
+
> PassportAuthUserRequestPasswordResetResponse passportAuthUserServicePassportAuthUserRequestPasswordReset(passportAuthUserRequestPasswordResetRequest)
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
### Example
|
|
771
|
+
|
|
772
|
+
```typescript
|
|
773
|
+
import {
|
|
774
|
+
PassportAuthUserServiceApi,
|
|
775
|
+
Configuration,
|
|
776
|
+
PassportAuthUserRequestPasswordResetRequest
|
|
777
|
+
} from '@cherryin/api-client';
|
|
778
|
+
|
|
779
|
+
const configuration = new Configuration();
|
|
780
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
781
|
+
|
|
782
|
+
let passportAuthUserRequestPasswordResetRequest: PassportAuthUserRequestPasswordResetRequest; //
|
|
783
|
+
|
|
784
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserRequestPasswordReset(
|
|
785
|
+
passportAuthUserRequestPasswordResetRequest
|
|
786
|
+
);
|
|
787
|
+
```
|
|
788
|
+
|
|
789
|
+
### Parameters
|
|
790
|
+
|
|
791
|
+
|Name | Type | Description | Notes|
|
|
792
|
+
|------------- | ------------- | ------------- | -------------|
|
|
793
|
+
| **passportAuthUserRequestPasswordResetRequest** | **PassportAuthUserRequestPasswordResetRequest**| | |
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
### Return type
|
|
797
|
+
|
|
798
|
+
**PassportAuthUserRequestPasswordResetResponse**
|
|
799
|
+
|
|
800
|
+
### Authorization
|
|
801
|
+
|
|
802
|
+
No authorization required
|
|
803
|
+
|
|
804
|
+
### HTTP request headers
|
|
805
|
+
|
|
806
|
+
- **Content-Type**: application/json
|
|
807
|
+
- **Accept**: application/json
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
### HTTP response details
|
|
811
|
+
| Status code | Description | Response headers |
|
|
812
|
+
|-------------|-------------|------------------|
|
|
813
|
+
|**200** | OK | - |
|
|
814
|
+
|**0** | Default error response | - |
|
|
815
|
+
|
|
816
|
+
[[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
|
+
|
|
818
|
+
# **passportAuthUserServicePassportAuthUserResetPassword**
|
|
819
|
+
> PassportAuthUserResetPasswordResponse passportAuthUserServicePassportAuthUserResetPassword(passportAuthUserResetPasswordRequest)
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
### Example
|
|
823
|
+
|
|
824
|
+
```typescript
|
|
825
|
+
import {
|
|
826
|
+
PassportAuthUserServiceApi,
|
|
827
|
+
Configuration,
|
|
828
|
+
PassportAuthUserResetPasswordRequest
|
|
829
|
+
} from '@cherryin/api-client';
|
|
830
|
+
|
|
831
|
+
const configuration = new Configuration();
|
|
832
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
833
|
+
|
|
834
|
+
let passportAuthUserResetPasswordRequest: PassportAuthUserResetPasswordRequest; //
|
|
835
|
+
|
|
836
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserResetPassword(
|
|
837
|
+
passportAuthUserResetPasswordRequest
|
|
838
|
+
);
|
|
839
|
+
```
|
|
840
|
+
|
|
841
|
+
### Parameters
|
|
842
|
+
|
|
843
|
+
|Name | Type | Description | Notes|
|
|
844
|
+
|------------- | ------------- | ------------- | -------------|
|
|
845
|
+
| **passportAuthUserResetPasswordRequest** | **PassportAuthUserResetPasswordRequest**| | |
|
|
846
|
+
|
|
847
|
+
|
|
848
|
+
### Return type
|
|
849
|
+
|
|
850
|
+
**PassportAuthUserResetPasswordResponse**
|
|
851
|
+
|
|
852
|
+
### Authorization
|
|
853
|
+
|
|
854
|
+
No authorization required
|
|
855
|
+
|
|
856
|
+
### HTTP request headers
|
|
857
|
+
|
|
858
|
+
- **Content-Type**: application/json
|
|
859
|
+
- **Accept**: application/json
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
### HTTP response details
|
|
863
|
+
| Status code | Description | Response headers |
|
|
864
|
+
|-------------|-------------|------------------|
|
|
865
|
+
|**200** | OK | - |
|
|
866
|
+
|**0** | Default error response | - |
|
|
867
|
+
|
|
868
|
+
[[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
|
+
|
|
870
|
+
# **passportAuthUserServicePassportAuthUserRevokeOtherSessions**
|
|
871
|
+
> PassportAuthUserRevokeOtherSessionsResponse passportAuthUserServicePassportAuthUserRevokeOtherSessions(passportAuthUserRevokeOtherSessionsRequest)
|
|
872
|
+
|
|
873
|
+
|
|
874
|
+
### Example
|
|
875
|
+
|
|
876
|
+
```typescript
|
|
877
|
+
import {
|
|
878
|
+
PassportAuthUserServiceApi,
|
|
879
|
+
Configuration,
|
|
880
|
+
PassportAuthUserRevokeOtherSessionsRequest
|
|
881
|
+
} from '@cherryin/api-client';
|
|
882
|
+
|
|
883
|
+
const configuration = new Configuration();
|
|
884
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
885
|
+
|
|
886
|
+
let passportAuthUserRevokeOtherSessionsRequest: PassportAuthUserRevokeOtherSessionsRequest; //
|
|
887
|
+
|
|
888
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserRevokeOtherSessions(
|
|
889
|
+
passportAuthUserRevokeOtherSessionsRequest
|
|
890
|
+
);
|
|
891
|
+
```
|
|
892
|
+
|
|
893
|
+
### Parameters
|
|
894
|
+
|
|
895
|
+
|Name | Type | Description | Notes|
|
|
896
|
+
|------------- | ------------- | ------------- | -------------|
|
|
897
|
+
| **passportAuthUserRevokeOtherSessionsRequest** | **PassportAuthUserRevokeOtherSessionsRequest**| | |
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
### Return type
|
|
901
|
+
|
|
902
|
+
**PassportAuthUserRevokeOtherSessionsResponse**
|
|
903
|
+
|
|
904
|
+
### Authorization
|
|
905
|
+
|
|
906
|
+
No authorization required
|
|
907
|
+
|
|
908
|
+
### HTTP request headers
|
|
909
|
+
|
|
910
|
+
- **Content-Type**: application/json
|
|
911
|
+
- **Accept**: application/json
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
### HTTP response details
|
|
915
|
+
| Status code | Description | Response headers |
|
|
916
|
+
|-------------|-------------|------------------|
|
|
917
|
+
|**200** | OK | - |
|
|
918
|
+
|**0** | Default error response | - |
|
|
919
|
+
|
|
920
|
+
[[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
|
+
|
|
922
|
+
# **passportAuthUserServicePassportAuthUserRevokeSession**
|
|
923
|
+
> PassportAuthUserRevokeSessionResponse passportAuthUserServicePassportAuthUserRevokeSession(passportAuthUserRevokeSessionRequest)
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
### Example
|
|
927
|
+
|
|
928
|
+
```typescript
|
|
929
|
+
import {
|
|
930
|
+
PassportAuthUserServiceApi,
|
|
931
|
+
Configuration,
|
|
932
|
+
PassportAuthUserRevokeSessionRequest
|
|
933
|
+
} from '@cherryin/api-client';
|
|
934
|
+
|
|
935
|
+
const configuration = new Configuration();
|
|
936
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
937
|
+
|
|
938
|
+
let passportAuthUserRevokeSessionRequest: PassportAuthUserRevokeSessionRequest; //
|
|
939
|
+
|
|
940
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserRevokeSession(
|
|
941
|
+
passportAuthUserRevokeSessionRequest
|
|
942
|
+
);
|
|
943
|
+
```
|
|
944
|
+
|
|
945
|
+
### Parameters
|
|
946
|
+
|
|
947
|
+
|Name | Type | Description | Notes|
|
|
948
|
+
|------------- | ------------- | ------------- | -------------|
|
|
949
|
+
| **passportAuthUserRevokeSessionRequest** | **PassportAuthUserRevokeSessionRequest**| | |
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
### Return type
|
|
953
|
+
|
|
954
|
+
**PassportAuthUserRevokeSessionResponse**
|
|
955
|
+
|
|
956
|
+
### Authorization
|
|
957
|
+
|
|
958
|
+
No authorization required
|
|
959
|
+
|
|
960
|
+
### HTTP request headers
|
|
961
|
+
|
|
962
|
+
- **Content-Type**: application/json
|
|
963
|
+
- **Accept**: application/json
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
### HTTP response details
|
|
967
|
+
| Status code | Description | Response headers |
|
|
968
|
+
|-------------|-------------|------------------|
|
|
969
|
+
|**200** | OK | - |
|
|
970
|
+
|**0** | Default error response | - |
|
|
971
|
+
|
|
972
|
+
[[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
|
+
|
|
974
|
+
# **passportAuthUserServicePassportAuthUserRevokeSessions**
|
|
975
|
+
> PassportAuthUserRevokeSessionsResponse passportAuthUserServicePassportAuthUserRevokeSessions(passportAuthUserRevokeSessionsRequest)
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
### Example
|
|
979
|
+
|
|
980
|
+
```typescript
|
|
981
|
+
import {
|
|
982
|
+
PassportAuthUserServiceApi,
|
|
983
|
+
Configuration,
|
|
984
|
+
PassportAuthUserRevokeSessionsRequest
|
|
985
|
+
} from '@cherryin/api-client';
|
|
986
|
+
|
|
987
|
+
const configuration = new Configuration();
|
|
988
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
989
|
+
|
|
990
|
+
let passportAuthUserRevokeSessionsRequest: PassportAuthUserRevokeSessionsRequest; //
|
|
991
|
+
|
|
992
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserRevokeSessions(
|
|
993
|
+
passportAuthUserRevokeSessionsRequest
|
|
994
|
+
);
|
|
995
|
+
```
|
|
996
|
+
|
|
997
|
+
### Parameters
|
|
998
|
+
|
|
999
|
+
|Name | Type | Description | Notes|
|
|
1000
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1001
|
+
| **passportAuthUserRevokeSessionsRequest** | **PassportAuthUserRevokeSessionsRequest**| | |
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
### Return type
|
|
1005
|
+
|
|
1006
|
+
**PassportAuthUserRevokeSessionsResponse**
|
|
1007
|
+
|
|
1008
|
+
### Authorization
|
|
1009
|
+
|
|
1010
|
+
No authorization required
|
|
1011
|
+
|
|
1012
|
+
### HTTP request headers
|
|
1013
|
+
|
|
1014
|
+
- **Content-Type**: application/json
|
|
1015
|
+
- **Accept**: application/json
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
### HTTP response details
|
|
1019
|
+
| Status code | Description | Response headers |
|
|
1020
|
+
|-------------|-------------|------------------|
|
|
1021
|
+
|**200** | OK | - |
|
|
1022
|
+
|**0** | Default error response | - |
|
|
1023
|
+
|
|
1024
|
+
[[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
|
+
|
|
1026
|
+
# **passportAuthUserServicePassportAuthUserSendVerificationEmail**
|
|
1027
|
+
> PassportAuthUserSendVerificationEmailResponse passportAuthUserServicePassportAuthUserSendVerificationEmail(passportAuthUserSendVerificationEmailRequest)
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
### Example
|
|
1031
|
+
|
|
1032
|
+
```typescript
|
|
1033
|
+
import {
|
|
1034
|
+
PassportAuthUserServiceApi,
|
|
1035
|
+
Configuration,
|
|
1036
|
+
PassportAuthUserSendVerificationEmailRequest
|
|
1037
|
+
} from '@cherryin/api-client';
|
|
1038
|
+
|
|
1039
|
+
const configuration = new Configuration();
|
|
1040
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1041
|
+
|
|
1042
|
+
let passportAuthUserSendVerificationEmailRequest: PassportAuthUserSendVerificationEmailRequest; //
|
|
1043
|
+
|
|
1044
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserSendVerificationEmail(
|
|
1045
|
+
passportAuthUserSendVerificationEmailRequest
|
|
1046
|
+
);
|
|
1047
|
+
```
|
|
1048
|
+
|
|
1049
|
+
### Parameters
|
|
1050
|
+
|
|
1051
|
+
|Name | Type | Description | Notes|
|
|
1052
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1053
|
+
| **passportAuthUserSendVerificationEmailRequest** | **PassportAuthUserSendVerificationEmailRequest**| | |
|
|
1054
|
+
|
|
1055
|
+
|
|
1056
|
+
### Return type
|
|
1057
|
+
|
|
1058
|
+
**PassportAuthUserSendVerificationEmailResponse**
|
|
1059
|
+
|
|
1060
|
+
### Authorization
|
|
1061
|
+
|
|
1062
|
+
No authorization required
|
|
1063
|
+
|
|
1064
|
+
### HTTP request headers
|
|
1065
|
+
|
|
1066
|
+
- **Content-Type**: application/json
|
|
1067
|
+
- **Accept**: application/json
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
### HTTP response details
|
|
1071
|
+
| Status code | Description | Response headers |
|
|
1072
|
+
|-------------|-------------|------------------|
|
|
1073
|
+
|**200** | OK | - |
|
|
1074
|
+
|**0** | Default error response | - |
|
|
1075
|
+
|
|
1076
|
+
[[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
|
+
|
|
1078
|
+
# **passportAuthUserServicePassportAuthUserSendVerificationPhone**
|
|
1079
|
+
> PassportAuthUserSendVerificationEmailResponse passportAuthUserServicePassportAuthUserSendVerificationPhone(passportAuthUserSendVerificationEmailRequest)
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
### Example
|
|
1083
|
+
|
|
1084
|
+
```typescript
|
|
1085
|
+
import {
|
|
1086
|
+
PassportAuthUserServiceApi,
|
|
1087
|
+
Configuration,
|
|
1088
|
+
PassportAuthUserSendVerificationEmailRequest
|
|
1089
|
+
} from '@cherryin/api-client';
|
|
1090
|
+
|
|
1091
|
+
const configuration = new Configuration();
|
|
1092
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1093
|
+
|
|
1094
|
+
let passportAuthUserSendVerificationEmailRequest: PassportAuthUserSendVerificationEmailRequest; //
|
|
1095
|
+
|
|
1096
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserSendVerificationPhone(
|
|
1097
|
+
passportAuthUserSendVerificationEmailRequest
|
|
1098
|
+
);
|
|
1099
|
+
```
|
|
1100
|
+
|
|
1101
|
+
### Parameters
|
|
1102
|
+
|
|
1103
|
+
|Name | Type | Description | Notes|
|
|
1104
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1105
|
+
| **passportAuthUserSendVerificationEmailRequest** | **PassportAuthUserSendVerificationEmailRequest**| | |
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
### Return type
|
|
1109
|
+
|
|
1110
|
+
**PassportAuthUserSendVerificationEmailResponse**
|
|
1111
|
+
|
|
1112
|
+
### Authorization
|
|
1113
|
+
|
|
1114
|
+
No authorization required
|
|
1115
|
+
|
|
1116
|
+
### HTTP request headers
|
|
1117
|
+
|
|
1118
|
+
- **Content-Type**: application/json
|
|
1119
|
+
- **Accept**: application/json
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
### HTTP response details
|
|
1123
|
+
| Status code | Description | Response headers |
|
|
1124
|
+
|-------------|-------------|------------------|
|
|
1125
|
+
|**200** | OK | - |
|
|
1126
|
+
|**0** | Default error response | - |
|
|
1127
|
+
|
|
1128
|
+
[[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
|
+
|
|
1130
|
+
# **passportAuthUserServicePassportAuthUserSignInEmail**
|
|
1131
|
+
> PassportAuthUserSignInEmailResponse passportAuthUserServicePassportAuthUserSignInEmail(passportAuthUserSignInEmailRequest)
|
|
1132
|
+
|
|
1133
|
+
|
|
1134
|
+
### Example
|
|
1135
|
+
|
|
1136
|
+
```typescript
|
|
1137
|
+
import {
|
|
1138
|
+
PassportAuthUserServiceApi,
|
|
1139
|
+
Configuration,
|
|
1140
|
+
PassportAuthUserSignInEmailRequest
|
|
1141
|
+
} from '@cherryin/api-client';
|
|
1142
|
+
|
|
1143
|
+
const configuration = new Configuration();
|
|
1144
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1145
|
+
|
|
1146
|
+
let passportAuthUserSignInEmailRequest: PassportAuthUserSignInEmailRequest; //
|
|
1147
|
+
|
|
1148
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserSignInEmail(
|
|
1149
|
+
passportAuthUserSignInEmailRequest
|
|
1150
|
+
);
|
|
1151
|
+
```
|
|
1152
|
+
|
|
1153
|
+
### Parameters
|
|
1154
|
+
|
|
1155
|
+
|Name | Type | Description | Notes|
|
|
1156
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1157
|
+
| **passportAuthUserSignInEmailRequest** | **PassportAuthUserSignInEmailRequest**| | |
|
|
1158
|
+
|
|
1159
|
+
|
|
1160
|
+
### Return type
|
|
1161
|
+
|
|
1162
|
+
**PassportAuthUserSignInEmailResponse**
|
|
1163
|
+
|
|
1164
|
+
### Authorization
|
|
1165
|
+
|
|
1166
|
+
No authorization required
|
|
1167
|
+
|
|
1168
|
+
### HTTP request headers
|
|
1169
|
+
|
|
1170
|
+
- **Content-Type**: application/json
|
|
1171
|
+
- **Accept**: application/json
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
### HTTP response details
|
|
1175
|
+
| Status code | Description | Response headers |
|
|
1176
|
+
|-------------|-------------|------------------|
|
|
1177
|
+
|**200** | OK | - |
|
|
1178
|
+
|**0** | Default error response | - |
|
|
1179
|
+
|
|
1180
|
+
[[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
|
+
|
|
1182
|
+
# **passportAuthUserServicePassportAuthUserSignInPhone**
|
|
1183
|
+
> PassportAuthUserSignInPhoneResponse passportAuthUserServicePassportAuthUserSignInPhone(passportAuthUserSignInPhoneRequest)
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
### Example
|
|
1187
|
+
|
|
1188
|
+
```typescript
|
|
1189
|
+
import {
|
|
1190
|
+
PassportAuthUserServiceApi,
|
|
1191
|
+
Configuration,
|
|
1192
|
+
PassportAuthUserSignInPhoneRequest
|
|
1193
|
+
} from '@cherryin/api-client';
|
|
1194
|
+
|
|
1195
|
+
const configuration = new Configuration();
|
|
1196
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1197
|
+
|
|
1198
|
+
let passportAuthUserSignInPhoneRequest: PassportAuthUserSignInPhoneRequest; //
|
|
1199
|
+
|
|
1200
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserSignInPhone(
|
|
1201
|
+
passportAuthUserSignInPhoneRequest
|
|
1202
|
+
);
|
|
1203
|
+
```
|
|
1204
|
+
|
|
1205
|
+
### Parameters
|
|
1206
|
+
|
|
1207
|
+
|Name | Type | Description | Notes|
|
|
1208
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1209
|
+
| **passportAuthUserSignInPhoneRequest** | **PassportAuthUserSignInPhoneRequest**| | |
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
### Return type
|
|
1213
|
+
|
|
1214
|
+
**PassportAuthUserSignInPhoneResponse**
|
|
1215
|
+
|
|
1216
|
+
### Authorization
|
|
1217
|
+
|
|
1218
|
+
No authorization required
|
|
1219
|
+
|
|
1220
|
+
### HTTP request headers
|
|
1221
|
+
|
|
1222
|
+
- **Content-Type**: application/json
|
|
1223
|
+
- **Accept**: application/json
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
### HTTP response details
|
|
1227
|
+
| Status code | Description | Response headers |
|
|
1228
|
+
|-------------|-------------|------------------|
|
|
1229
|
+
|**200** | OK | - |
|
|
1230
|
+
|**0** | Default error response | - |
|
|
1231
|
+
|
|
1232
|
+
[[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
|
+
|
|
1234
|
+
# **passportAuthUserServicePassportAuthUserSignInSocial**
|
|
1235
|
+
> PassportAuthUserSignInSocialResponse passportAuthUserServicePassportAuthUserSignInSocial(passportAuthUserSignInSocialRequest)
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
### Example
|
|
1239
|
+
|
|
1240
|
+
```typescript
|
|
1241
|
+
import {
|
|
1242
|
+
PassportAuthUserServiceApi,
|
|
1243
|
+
Configuration,
|
|
1244
|
+
PassportAuthUserSignInSocialRequest
|
|
1245
|
+
} from '@cherryin/api-client';
|
|
1246
|
+
|
|
1247
|
+
const configuration = new Configuration();
|
|
1248
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1249
|
+
|
|
1250
|
+
let passportAuthUserSignInSocialRequest: PassportAuthUserSignInSocialRequest; //
|
|
1251
|
+
|
|
1252
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserSignInSocial(
|
|
1253
|
+
passportAuthUserSignInSocialRequest
|
|
1254
|
+
);
|
|
1255
|
+
```
|
|
1256
|
+
|
|
1257
|
+
### Parameters
|
|
1258
|
+
|
|
1259
|
+
|Name | Type | Description | Notes|
|
|
1260
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1261
|
+
| **passportAuthUserSignInSocialRequest** | **PassportAuthUserSignInSocialRequest**| | |
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
### Return type
|
|
1265
|
+
|
|
1266
|
+
**PassportAuthUserSignInSocialResponse**
|
|
1267
|
+
|
|
1268
|
+
### Authorization
|
|
1269
|
+
|
|
1270
|
+
No authorization required
|
|
1271
|
+
|
|
1272
|
+
### HTTP request headers
|
|
1273
|
+
|
|
1274
|
+
- **Content-Type**: application/json
|
|
1275
|
+
- **Accept**: application/json
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
### HTTP response details
|
|
1279
|
+
| Status code | Description | Response headers |
|
|
1280
|
+
|-------------|-------------|------------------|
|
|
1281
|
+
|**200** | OK | - |
|
|
1282
|
+
|**0** | Default error response | - |
|
|
1283
|
+
|
|
1284
|
+
[[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
|
+
|
|
1286
|
+
# **passportAuthUserServicePassportAuthUserSignOut**
|
|
1287
|
+
> PassportAuthUserSignOutResponse passportAuthUserServicePassportAuthUserSignOut(passportAuthUserSignOutRequest)
|
|
1288
|
+
|
|
1289
|
+
|
|
1290
|
+
### Example
|
|
1291
|
+
|
|
1292
|
+
```typescript
|
|
1293
|
+
import {
|
|
1294
|
+
PassportAuthUserServiceApi,
|
|
1295
|
+
Configuration,
|
|
1296
|
+
PassportAuthUserSignOutRequest
|
|
1297
|
+
} from '@cherryin/api-client';
|
|
1298
|
+
|
|
1299
|
+
const configuration = new Configuration();
|
|
1300
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1301
|
+
|
|
1302
|
+
let passportAuthUserSignOutRequest: PassportAuthUserSignOutRequest; //
|
|
1303
|
+
|
|
1304
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserSignOut(
|
|
1305
|
+
passportAuthUserSignOutRequest
|
|
1306
|
+
);
|
|
1307
|
+
```
|
|
1308
|
+
|
|
1309
|
+
### Parameters
|
|
1310
|
+
|
|
1311
|
+
|Name | Type | Description | Notes|
|
|
1312
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1313
|
+
| **passportAuthUserSignOutRequest** | **PassportAuthUserSignOutRequest**| | |
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
### Return type
|
|
1317
|
+
|
|
1318
|
+
**PassportAuthUserSignOutResponse**
|
|
1319
|
+
|
|
1320
|
+
### Authorization
|
|
1321
|
+
|
|
1322
|
+
No authorization required
|
|
1323
|
+
|
|
1324
|
+
### HTTP request headers
|
|
1325
|
+
|
|
1326
|
+
- **Content-Type**: application/json
|
|
1327
|
+
- **Accept**: application/json
|
|
1328
|
+
|
|
1329
|
+
|
|
1330
|
+
### HTTP response details
|
|
1331
|
+
| Status code | Description | Response headers |
|
|
1332
|
+
|-------------|-------------|------------------|
|
|
1333
|
+
|**200** | OK | - |
|
|
1334
|
+
|**0** | Default error response | - |
|
|
1335
|
+
|
|
1336
|
+
[[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
|
+
|
|
1338
|
+
# **passportAuthUserServicePassportAuthUserSignUpEmail**
|
|
1339
|
+
> PassportAuthUserSignUpEmailResponse passportAuthUserServicePassportAuthUserSignUpEmail(passportAuthUserSignUpEmailRequest)
|
|
1340
|
+
|
|
1341
|
+
============ 认证 ============
|
|
1342
|
+
|
|
1343
|
+
### Example
|
|
1344
|
+
|
|
1345
|
+
```typescript
|
|
1346
|
+
import {
|
|
1347
|
+
PassportAuthUserServiceApi,
|
|
1348
|
+
Configuration,
|
|
1349
|
+
PassportAuthUserSignUpEmailRequest
|
|
1350
|
+
} from '@cherryin/api-client';
|
|
1351
|
+
|
|
1352
|
+
const configuration = new Configuration();
|
|
1353
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1354
|
+
|
|
1355
|
+
let passportAuthUserSignUpEmailRequest: PassportAuthUserSignUpEmailRequest; //
|
|
1356
|
+
|
|
1357
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserSignUpEmail(
|
|
1358
|
+
passportAuthUserSignUpEmailRequest
|
|
1359
|
+
);
|
|
1360
|
+
```
|
|
1361
|
+
|
|
1362
|
+
### Parameters
|
|
1363
|
+
|
|
1364
|
+
|Name | Type | Description | Notes|
|
|
1365
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1366
|
+
| **passportAuthUserSignUpEmailRequest** | **PassportAuthUserSignUpEmailRequest**| | |
|
|
1367
|
+
|
|
1368
|
+
|
|
1369
|
+
### Return type
|
|
1370
|
+
|
|
1371
|
+
**PassportAuthUserSignUpEmailResponse**
|
|
1372
|
+
|
|
1373
|
+
### Authorization
|
|
1374
|
+
|
|
1375
|
+
No authorization required
|
|
1376
|
+
|
|
1377
|
+
### HTTP request headers
|
|
1378
|
+
|
|
1379
|
+
- **Content-Type**: application/json
|
|
1380
|
+
- **Accept**: application/json
|
|
1381
|
+
|
|
1382
|
+
|
|
1383
|
+
### HTTP response details
|
|
1384
|
+
| Status code | Description | Response headers |
|
|
1385
|
+
|-------------|-------------|------------------|
|
|
1386
|
+
|**200** | OK | - |
|
|
1387
|
+
|**0** | Default error response | - |
|
|
1388
|
+
|
|
1389
|
+
[[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
|
+
|
|
1391
|
+
# **passportAuthUserServicePassportAuthUserUnlinkAccount**
|
|
1392
|
+
> PassportAuthUserUnlinkAccountResponse passportAuthUserServicePassportAuthUserUnlinkAccount(passportAuthUserUnlinkAccountRequest)
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
### Example
|
|
1396
|
+
|
|
1397
|
+
```typescript
|
|
1398
|
+
import {
|
|
1399
|
+
PassportAuthUserServiceApi,
|
|
1400
|
+
Configuration,
|
|
1401
|
+
PassportAuthUserUnlinkAccountRequest
|
|
1402
|
+
} from '@cherryin/api-client';
|
|
1403
|
+
|
|
1404
|
+
const configuration = new Configuration();
|
|
1405
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1406
|
+
|
|
1407
|
+
let passportAuthUserUnlinkAccountRequest: PassportAuthUserUnlinkAccountRequest; //
|
|
1408
|
+
|
|
1409
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserUnlinkAccount(
|
|
1410
|
+
passportAuthUserUnlinkAccountRequest
|
|
1411
|
+
);
|
|
1412
|
+
```
|
|
1413
|
+
|
|
1414
|
+
### Parameters
|
|
1415
|
+
|
|
1416
|
+
|Name | Type | Description | Notes|
|
|
1417
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1418
|
+
| **passportAuthUserUnlinkAccountRequest** | **PassportAuthUserUnlinkAccountRequest**| | |
|
|
1419
|
+
|
|
1420
|
+
|
|
1421
|
+
### Return type
|
|
1422
|
+
|
|
1423
|
+
**PassportAuthUserUnlinkAccountResponse**
|
|
1424
|
+
|
|
1425
|
+
### Authorization
|
|
1426
|
+
|
|
1427
|
+
No authorization required
|
|
1428
|
+
|
|
1429
|
+
### HTTP request headers
|
|
1430
|
+
|
|
1431
|
+
- **Content-Type**: application/json
|
|
1432
|
+
- **Accept**: application/json
|
|
1433
|
+
|
|
1434
|
+
|
|
1435
|
+
### HTTP response details
|
|
1436
|
+
| Status code | Description | Response headers |
|
|
1437
|
+
|-------------|-------------|------------------|
|
|
1438
|
+
|**200** | OK | - |
|
|
1439
|
+
|**0** | Default error response | - |
|
|
1440
|
+
|
|
1441
|
+
[[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
|
+
|
|
1443
|
+
# **passportAuthUserServicePassportAuthUserUpdatePassport**
|
|
1444
|
+
> PassportAuthUserUpdatePassportResponse passportAuthUserServicePassportAuthUserUpdatePassport(passportAuthUserUpdatePassportRequest)
|
|
1445
|
+
|
|
1446
|
+
|
|
1447
|
+
### Example
|
|
1448
|
+
|
|
1449
|
+
```typescript
|
|
1450
|
+
import {
|
|
1451
|
+
PassportAuthUserServiceApi,
|
|
1452
|
+
Configuration,
|
|
1453
|
+
PassportAuthUserUpdatePassportRequest
|
|
1454
|
+
} from '@cherryin/api-client';
|
|
1455
|
+
|
|
1456
|
+
const configuration = new Configuration();
|
|
1457
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1458
|
+
|
|
1459
|
+
let passportAuthUserUpdatePassportRequest: PassportAuthUserUpdatePassportRequest; //
|
|
1460
|
+
|
|
1461
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserUpdatePassport(
|
|
1462
|
+
passportAuthUserUpdatePassportRequest
|
|
1463
|
+
);
|
|
1464
|
+
```
|
|
1465
|
+
|
|
1466
|
+
### Parameters
|
|
1467
|
+
|
|
1468
|
+
|Name | Type | Description | Notes|
|
|
1469
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1470
|
+
| **passportAuthUserUpdatePassportRequest** | **PassportAuthUserUpdatePassportRequest**| | |
|
|
1471
|
+
|
|
1472
|
+
|
|
1473
|
+
### Return type
|
|
1474
|
+
|
|
1475
|
+
**PassportAuthUserUpdatePassportResponse**
|
|
1476
|
+
|
|
1477
|
+
### Authorization
|
|
1478
|
+
|
|
1479
|
+
No authorization required
|
|
1480
|
+
|
|
1481
|
+
### HTTP request headers
|
|
1482
|
+
|
|
1483
|
+
- **Content-Type**: application/json
|
|
1484
|
+
- **Accept**: application/json
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
### HTTP response details
|
|
1488
|
+
| Status code | Description | Response headers |
|
|
1489
|
+
|-------------|-------------|------------------|
|
|
1490
|
+
|**200** | OK | - |
|
|
1491
|
+
|**0** | Default error response | - |
|
|
1492
|
+
|
|
1493
|
+
[[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
|
+
|
|
1495
|
+
# **passportAuthUserServicePassportAuthUserUpdateUser**
|
|
1496
|
+
> PassportAuthUserUpdateUserResponse passportAuthUserServicePassportAuthUserUpdateUser(passportAuthUserUpdateUserRequest)
|
|
1497
|
+
|
|
1498
|
+
|
|
1499
|
+
### Example
|
|
1500
|
+
|
|
1501
|
+
```typescript
|
|
1502
|
+
import {
|
|
1503
|
+
PassportAuthUserServiceApi,
|
|
1504
|
+
Configuration,
|
|
1505
|
+
PassportAuthUserUpdateUserRequest
|
|
1506
|
+
} from '@cherryin/api-client';
|
|
1507
|
+
|
|
1508
|
+
const configuration = new Configuration();
|
|
1509
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1510
|
+
|
|
1511
|
+
let passportAuthUserUpdateUserRequest: PassportAuthUserUpdateUserRequest; //
|
|
1512
|
+
|
|
1513
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserUpdateUser(
|
|
1514
|
+
passportAuthUserUpdateUserRequest
|
|
1515
|
+
);
|
|
1516
|
+
```
|
|
1517
|
+
|
|
1518
|
+
### Parameters
|
|
1519
|
+
|
|
1520
|
+
|Name | Type | Description | Notes|
|
|
1521
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1522
|
+
| **passportAuthUserUpdateUserRequest** | **PassportAuthUserUpdateUserRequest**| | |
|
|
1523
|
+
|
|
1524
|
+
|
|
1525
|
+
### Return type
|
|
1526
|
+
|
|
1527
|
+
**PassportAuthUserUpdateUserResponse**
|
|
1528
|
+
|
|
1529
|
+
### Authorization
|
|
1530
|
+
|
|
1531
|
+
No authorization required
|
|
1532
|
+
|
|
1533
|
+
### HTTP request headers
|
|
1534
|
+
|
|
1535
|
+
- **Content-Type**: application/json
|
|
1536
|
+
- **Accept**: application/json
|
|
1537
|
+
|
|
1538
|
+
|
|
1539
|
+
### HTTP response details
|
|
1540
|
+
| Status code | Description | Response headers |
|
|
1541
|
+
|-------------|-------------|------------------|
|
|
1542
|
+
|**200** | OK | - |
|
|
1543
|
+
|**0** | Default error response | - |
|
|
1544
|
+
|
|
1545
|
+
[[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
|
+
|
|
1547
|
+
# **passportAuthUserServicePassportAuthUserVerifyEmail**
|
|
1548
|
+
> PassportAuthUserVerifyEmailResponse passportAuthUserServicePassportAuthUserVerifyEmail()
|
|
1549
|
+
|
|
1550
|
+
|
|
1551
|
+
### Example
|
|
1552
|
+
|
|
1553
|
+
```typescript
|
|
1554
|
+
import {
|
|
1555
|
+
PassportAuthUserServiceApi,
|
|
1556
|
+
Configuration
|
|
1557
|
+
} from '@cherryin/api-client';
|
|
1558
|
+
|
|
1559
|
+
const configuration = new Configuration();
|
|
1560
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1561
|
+
|
|
1562
|
+
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 (optional) (default to undefined)
|
|
1563
|
+
let email: string; // (optional) (default to undefined)
|
|
1564
|
+
let authCode: string; // (optional) (default to undefined)
|
|
1565
|
+
let callbackUrl: string; // (optional) (default to undefined)
|
|
1566
|
+
|
|
1567
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserVerifyEmail(
|
|
1568
|
+
appIds,
|
|
1569
|
+
email,
|
|
1570
|
+
authCode,
|
|
1571
|
+
callbackUrl
|
|
1572
|
+
);
|
|
1573
|
+
```
|
|
1574
|
+
|
|
1575
|
+
### Parameters
|
|
1576
|
+
|
|
1577
|
+
|Name | Type | Description | Notes|
|
|
1578
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1579
|
+
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 | (optional) defaults to undefined|
|
|
1580
|
+
| **email** | [**string**] | | (optional) defaults to undefined|
|
|
1581
|
+
| **authCode** | [**string**] | | (optional) defaults to undefined|
|
|
1582
|
+
| **callbackUrl** | [**string**] | | (optional) defaults to undefined|
|
|
1583
|
+
|
|
1584
|
+
|
|
1585
|
+
### Return type
|
|
1586
|
+
|
|
1587
|
+
**PassportAuthUserVerifyEmailResponse**
|
|
1588
|
+
|
|
1589
|
+
### Authorization
|
|
1590
|
+
|
|
1591
|
+
No authorization required
|
|
1592
|
+
|
|
1593
|
+
### HTTP request headers
|
|
1594
|
+
|
|
1595
|
+
- **Content-Type**: Not defined
|
|
1596
|
+
- **Accept**: application/json
|
|
1597
|
+
|
|
1598
|
+
|
|
1599
|
+
### HTTP response details
|
|
1600
|
+
| Status code | Description | Response headers |
|
|
1601
|
+
|-------------|-------------|------------------|
|
|
1602
|
+
|**200** | OK | - |
|
|
1603
|
+
|**0** | Default error response | - |
|
|
1604
|
+
|
|
1605
|
+
[[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
|
+
|
|
1607
|
+
# **passportAuthUserServicePassportAuthUserVerifyPhone**
|
|
1608
|
+
> PassportAuthUserVerifyPhoneResponse passportAuthUserServicePassportAuthUserVerifyPhone()
|
|
1609
|
+
|
|
1610
|
+
|
|
1611
|
+
### Example
|
|
1612
|
+
|
|
1613
|
+
```typescript
|
|
1614
|
+
import {
|
|
1615
|
+
PassportAuthUserServiceApi,
|
|
1616
|
+
Configuration
|
|
1617
|
+
} from '@cherryin/api-client';
|
|
1618
|
+
|
|
1619
|
+
const configuration = new Configuration();
|
|
1620
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1621
|
+
|
|
1622
|
+
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 (optional) (default to undefined)
|
|
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)
|
|
1629
|
+
|
|
1630
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserVerifyPhone(
|
|
1631
|
+
appIds,
|
|
1632
|
+
phoneNumberE164,
|
|
1633
|
+
authCode,
|
|
1634
|
+
callbackUrl,
|
|
1635
|
+
disableSignUp,
|
|
1636
|
+
userName,
|
|
1637
|
+
avatarUrl
|
|
1638
|
+
);
|
|
1639
|
+
```
|
|
1640
|
+
|
|
1641
|
+
### Parameters
|
|
1642
|
+
|
|
1643
|
+
|Name | Type | Description | Notes|
|
|
1644
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1645
|
+
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 | (optional) defaults to undefined|
|
|
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|
|
|
1652
|
+
|
|
1653
|
+
|
|
1654
|
+
### Return type
|
|
1655
|
+
|
|
1656
|
+
**PassportAuthUserVerifyPhoneResponse**
|
|
1657
|
+
|
|
1658
|
+
### Authorization
|
|
1659
|
+
|
|
1660
|
+
No authorization required
|
|
1661
|
+
|
|
1662
|
+
### HTTP request headers
|
|
1663
|
+
|
|
1664
|
+
- **Content-Type**: Not defined
|
|
1665
|
+
- **Accept**: application/json
|
|
1666
|
+
|
|
1667
|
+
|
|
1668
|
+
### HTTP response details
|
|
1669
|
+
| Status code | Description | Response headers |
|
|
1670
|
+
|-------------|-------------|------------------|
|
|
1671
|
+
|**200** | OK | - |
|
|
1672
|
+
|**0** | Default error response | - |
|
|
1673
|
+
|
|
1674
|
+
[[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)
|
|
1675
|
+
|