@cherryin/passport-api-client 0.1.0
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 +202 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +336 -0
- package/api.ts +8354 -0
- package/base.ts +62 -0
- package/common.ts +113 -0
- package/configuration.ts +121 -0
- package/dist/api.d.ts +4798 -0
- package/dist/api.js +6070 -0
- package/dist/base.d.ts +42 -0
- package/dist/base.js +46 -0
- package/dist/common.d.ts +28 -0
- package/dist/common.js +124 -0
- package/dist/configuration.d.ts +98 -0
- package/dist/configuration.js +44 -0
- package/dist/esm/api.d.ts +4798 -0
- package/dist/esm/api.js +6043 -0
- package/dist/esm/base.d.ts +42 -0
- package/dist/esm/base.js +41 -0
- package/dist/esm/common.d.ts +28 -0
- package/dist/esm/common.js +112 -0
- package/dist/esm/configuration.d.ts +98 -0
- package/dist/esm/configuration.js +40 -0
- package/dist/esm/index.d.ts +13 -0
- package/dist/esm/index.js +15 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +31 -0
- 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/Any.md +20 -0
- package/docs/AuthAdminSession.md +38 -0
- package/docs/AuthAdminUser.md +32 -0
- package/docs/AuthEnterpriseMaterials.md +32 -0
- package/docs/AuthEnterpriseSession.md +36 -0
- package/docs/AuthEnterpriseUser.md +36 -0
- package/docs/AuthIdToken.md +28 -0
- package/docs/AuthPassport.md +34 -0
- package/docs/AuthUser.md +38 -0
- package/docs/AuthUserMethod.md +38 -0
- package/docs/AuthUserSession.md +40 -0
- package/docs/PassportAdminPasswordForgetRequest.md +22 -0
- package/docs/PassportAdminPasswordForgetResponse.md +22 -0
- package/docs/PassportAdminPasswordResetRequest.md +28 -0
- package/docs/PassportAdminPasswordResetResponse.md +26 -0
- package/docs/PassportAdminPasswordResetTokenVerifyRequest.md +20 -0
- package/docs/PassportAdminPasswordResetTokenVerifyResponse.md +26 -0
- package/docs/PassportAdminSendVerificationEmailRequest.md +26 -0
- package/docs/PassportAdminSendVerificationEmailResponse.md +22 -0
- package/docs/PassportAdminSignInEmailRequest.md +28 -0
- package/docs/PassportAdminSignInEmailResponse.md +26 -0
- package/docs/PassportAdminTokenAuthRequest.md +20 -0
- package/docs/PassportAdminTokenAuthResponse.md +28 -0
- package/docs/PassportAuthAdminChangePasswordRequest.md +24 -0
- package/docs/PassportAuthAdminChangePasswordResponse.md +26 -0
- package/docs/PassportAuthAdminEnterpriseMaterialListResponse.md +28 -0
- package/docs/PassportAuthAdminEnterpriseMaterialReviewRequest.md +22 -0
- package/docs/PassportAuthAdminEnterpriseMaterialReviewResponse.md +22 -0
- package/docs/PassportAuthAdminGetInfoResponse.md +24 -0
- package/docs/PassportAuthAdminGetSessionResponse.md +26 -0
- package/docs/PassportAuthAdminListSessionsResponse.md +24 -0
- 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/PassportAuthAdminPassportModifyInfoResponse.md +24 -0
- package/docs/PassportAuthAdminRPCServiceApi.md +60 -0
- package/docs/PassportAuthAdminResetPasswordRequest.md +20 -0
- package/docs/PassportAuthAdminResetPasswordResponse.md +22 -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 +1267 -0
- package/docs/PassportAuthAdminSignOutResponse.md +22 -0
- package/docs/PassportAuthAdminUpdateInfoRequest.md +22 -0
- package/docs/PassportAuthAdminUpdateInfoResponse.md +24 -0
- package/docs/PassportAuthAdminUserDisableRequest.md +26 -0
- package/docs/PassportAuthAdminUserDisableResponse.md +22 -0
- 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/PassportAuthAdminUserModifyPermissionResponse.md +24 -0
- package/docs/PassportAuthChangePasswordRequest.md +26 -0
- package/docs/PassportAuthChangePasswordResponse.md +26 -0
- package/docs/PassportAuthDeleteAllRequest.md +28 -0
- 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/PassportAuthEnterpriseInfoGetResponse.md +24 -0
- package/docs/PassportAuthEnterpriseListSessionsResponse.md +24 -0
- package/docs/PassportAuthEnterpriseMaterialUploadRequest.md +26 -0
- package/docs/PassportAuthEnterpriseMaterialUploadResponse.md +22 -0
- package/docs/PassportAuthEnterpriseMaterialVerifyStateResponse.md +24 -0
- package/docs/PassportAuthEnterpriseRPCServiceApi.md +60 -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/PassportAuthEnterpriseRevokeOtherSessionsResponse.md +22 -0
- package/docs/PassportAuthEnterpriseRevokeSessionRequest.md +20 -0
- package/docs/PassportAuthEnterpriseRevokeSessionResponse.md +22 -0
- package/docs/PassportAuthEnterpriseRevokeSessionsResponse.md +22 -0
- package/docs/PassportAuthEnterpriseServiceApi.md +1148 -0
- package/docs/PassportAuthEnterpriseSignOutRequest.md +20 -0
- package/docs/PassportAuthEnterpriseSignOutResponse.md +22 -0
- package/docs/PassportAuthEnterpriseUpdateInfoRequest.md +22 -0
- package/docs/PassportAuthEnterpriseUpdateInfoResponse.md +24 -0
- package/docs/PassportAuthEnterpriseVerifyEmailRequest.md +24 -0
- package/docs/PassportAuthEnterpriseVerifyEmailResponse.md +22 -0
- package/docs/PassportAuthEnterpriseVerifyPhoneResponse.md +22 -0
- package/docs/PassportAuthInfoGetResponse.md +26 -0
- package/docs/PassportAuthLinkSocialRequest.md +32 -0
- package/docs/PassportAuthLinkSocialResponse.md +26 -0
- package/docs/PassportAuthListMethodsResponse.md +24 -0
- package/docs/PassportAuthListSessionsResponse.md +24 -0
- package/docs/PassportAuthListSocialsResponse.md +24 -0
- package/docs/PassportAuthRefreshSessionTokenRequest.md +20 -0
- package/docs/PassportAuthRefreshSessionTokenResponse.md +24 -0
- package/docs/PassportAuthResetPasswordRequest.md +24 -0
- package/docs/PassportAuthResetPasswordResponse.md +22 -0
- package/docs/PassportAuthRevokeOtherSessionsRequest.md +20 -0
- package/docs/PassportAuthRevokeOtherSessionsResponse.md +24 -0
- package/docs/PassportAuthRevokeSessionRequest.md +20 -0
- package/docs/PassportAuthRevokeSessionResponse.md +22 -0
- package/docs/PassportAuthRevokeSessionsRequest.md +20 -0
- 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/PassportAuthSocialGetAccessTokenRequest.md +24 -0
- package/docs/PassportAuthSocialGetAccessTokenResponse.md +34 -0
- package/docs/PassportAuthSocialRefreshTokenRequest.md +24 -0
- package/docs/PassportAuthSocialRefreshTokenResponse.md +34 -0
- package/docs/PassportAuthUnlinkSocialRequest.md +24 -0
- package/docs/PassportAuthUnlinkSocialResponse.md +22 -0
- package/docs/PassportAuthUserChangeEmailRequest.md +24 -0
- package/docs/PassportAuthUserChangeEmailResponse.md +24 -0
- package/docs/PassportAuthUserChangePhoneRequest.md +26 -0
- package/docs/PassportAuthUserChangePhoneResponse.md +24 -0
- package/docs/PassportAuthUserDeleteRequest.md +30 -0
- package/docs/PassportAuthUserDeleteResponse.md +22 -0
- package/docs/PassportAuthUserGetSessionResponse.md +24 -0
- package/docs/PassportAuthUserInfoGetResponse.md +24 -0
- package/docs/PassportAuthUserRPCServiceApi.md +219 -0
- package/docs/PassportAuthUserServiceApi.md +1963 -0
- package/docs/PassportAuthUserSignOutRequest.md +22 -0
- package/docs/PassportAuthUserSignOutResponse.md +22 -0
- package/docs/PassportAuthUserUpdateInfoRequest.md +28 -0
- package/docs/PassportAuthUserUpdateInfoResponse.md +24 -0
- package/docs/PassportAuthUserUpdatePassportRequest.md +22 -0
- package/docs/PassportAuthUserUpdatePassportResponse.md +24 -0
- package/docs/PassportAuthUserVerifyEmailRequest.md +26 -0
- package/docs/PassportAuthUserVerifyEmailResponse.md +22 -0
- package/docs/PassportAuthUserVerifyPhoneRequest.md +24 -0
- package/docs/PassportAuthUserVerifyPhoneResponse.md +22 -0
- package/docs/PassportEnterprisePasswordResetRequest.md +24 -0
- package/docs/PassportEnterprisePasswordResetResponse.md +26 -0
- 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 +30 -0
- package/docs/PassportEnterpriseTokenAuthRequest.md +20 -0
- package/docs/PassportEnterpriseTokenAuthResponse.md +28 -0
- package/docs/PassportSendVerificationEmailRequest.md +26 -0
- package/docs/PassportSendVerificationEmailResponse.md +22 -0
- package/docs/PassportSendVerificationPhoneRequest.md +26 -0
- package/docs/PassportSendVerificationPhoneResponse.md +22 -0
- package/docs/PassportUserInfoBatchGetRequest.md +24 -0
- package/docs/PassportUserInfoBatchGetResponse.md +24 -0
- package/docs/PassportUserInfoGetRequest.md +24 -0
- package/docs/PassportUserInfoGetResponse.md +24 -0
- package/docs/PassportUserOAuthCallbackResponse.md +36 -0
- package/docs/PassportUserPasswordForgetRequest.md +24 -0
- package/docs/PassportUserPasswordForgetResponse.md +22 -0
- package/docs/PassportUserPasswordResetRequest.md +30 -0
- package/docs/PassportUserPasswordResetResponse.md +26 -0
- package/docs/PassportUserPasswordResetTokenVerifyRequest.md +22 -0
- package/docs/PassportUserPasswordResetTokenVerifyResponse.md +26 -0
- package/docs/PassportUserSignInEmailRequest.md +32 -0
- package/docs/PassportUserSignInEmailResponse.md +32 -0
- package/docs/PassportUserSignInPhoneRequest.md +26 -0
- package/docs/PassportUserSignInPhoneResponse.md +28 -0
- package/docs/PassportUserSignInSocialRequest.md +32 -0
- package/docs/PassportUserSignInSocialResponse.md +32 -0
- package/docs/PassportUserSignUpEmailRequest.md +36 -0
- package/docs/PassportUserSignUpEmailResponse.md +32 -0
- package/docs/PassportUserTokenAuthRequest.md +20 -0
- package/docs/PassportUserTokenAuthResponse.md +28 -0
- package/docs/PassportUserUpdateInfoRequest.md +30 -0
- package/docs/PassportUserUpdateInfoResponse.md +22 -0
- package/docs/Status.md +24 -0
- package/docs/UserBasic.md +42 -0
- package/docs/UserExtendInfo.md +20 -0
- package/docs/UserInfo.md +28 -0
- package/docs/UserInfoQueryOptions.md +28 -0
- package/docs/UserPaymentInfo.md +20 -0
- package/docs/UserPreferences.md +22 -0
- package/docs/UserSettings.md +20 -0
- package/git_push.sh +57 -0
- package/index.ts +18 -0
- package/package.json +36 -0
- package/tsconfig.esm.json +7 -0
- package/tsconfig.json +18 -0
|
@@ -0,0 +1,1963 @@
|
|
|
1
|
+
# PassportAuthUserServiceApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
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 | 会话 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 | 社交账号刷新 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 | 获取用户信息|
|
|
29
|
+
|[**passportAuthUserServicePassportAuthUserSignOut**](#passportauthuserservicepassportauthusersignout) | **POST** /passport/authed/v1/sign-out | 用户登出|
|
|
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 | OAuth 回调处理|
|
|
37
|
+
|[**passportAuthUserServicePassportUserPasswordForget**](#passportauthuserservicepassportuserpasswordforget) | **POST** /passport/auth/v1/password/forget | 未登录 - 用户遗忘密码请求重置|
|
|
38
|
+
|[**passportAuthUserServicePassportUserPasswordReset**](#passportauthuserservicepassportuserpasswordreset) | **POST** /passport/auth/v1/password/reset | 未登录 - 用户重置密码|
|
|
39
|
+
|[**passportAuthUserServicePassportUserPasswordResetTokenVerify**](#passportauthuserservicepassportuserpasswordresettokenverify) | **POST** /passport/auth/v1/password/reset-token | 未登录 - 验证重置密码请求 token|
|
|
40
|
+
|[**passportAuthUserServicePassportUserSignInEmail**](#passportauthuserservicepassportusersigninemail) | **POST** /passport/auth/v1/sign-in/email | 邮箱登录|
|
|
41
|
+
|[**passportAuthUserServicePassportUserSignInPhone**](#passportauthuserservicepassportusersigninphone) | **POST** /passport/auth/v1/sign-in/phone | 手机登录|
|
|
42
|
+
|[**passportAuthUserServicePassportUserSignInSocial**](#passportauthuserservicepassportusersigninsocial) | **POST** /passport/auth/v1/sign-in/social | 社交登录|
|
|
43
|
+
|[**passportAuthUserServicePassportUserSignUpEmail**](#passportauthuserservicepassportusersignupemail) | **POST** /passport/auth/v1/sign-up/email | 邮箱注册|
|
|
44
|
+
|
|
45
|
+
# **passportAuthUserServicePassportAuthChangePassword**
|
|
46
|
+
> PassportAuthChangePasswordResponse passportAuthUserServicePassportAuthChangePassword(body)
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
### Example
|
|
50
|
+
|
|
51
|
+
```typescript
|
|
52
|
+
import {
|
|
53
|
+
PassportAuthUserServiceApi,
|
|
54
|
+
Configuration,
|
|
55
|
+
PassportAuthChangePasswordRequest
|
|
56
|
+
} from '@cherryin/passport-api-client';
|
|
57
|
+
|
|
58
|
+
const configuration = new Configuration();
|
|
59
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
60
|
+
|
|
61
|
+
let body: PassportAuthChangePasswordRequest; //
|
|
62
|
+
|
|
63
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthChangePassword(
|
|
64
|
+
body
|
|
65
|
+
);
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
### Parameters
|
|
69
|
+
|
|
70
|
+
|Name | Type | Description | Notes|
|
|
71
|
+
|------------- | ------------- | ------------- | -------------|
|
|
72
|
+
| **body** | **PassportAuthChangePasswordRequest**| | |
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
### Return type
|
|
76
|
+
|
|
77
|
+
**PassportAuthChangePasswordResponse**
|
|
78
|
+
|
|
79
|
+
### Authorization
|
|
80
|
+
|
|
81
|
+
No authorization required
|
|
82
|
+
|
|
83
|
+
### HTTP request headers
|
|
84
|
+
|
|
85
|
+
- **Content-Type**: application/json
|
|
86
|
+
- **Accept**: application/json
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
### HTTP response details
|
|
90
|
+
| Status code | Description | Response headers |
|
|
91
|
+
|-------------|-------------|------------------|
|
|
92
|
+
|**200** | A successful response. | - |
|
|
93
|
+
|**0** | An unexpected error response. | - |
|
|
94
|
+
|
|
95
|
+
[[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)
|
|
96
|
+
|
|
97
|
+
# **passportAuthUserServicePassportAuthDeleteAll**
|
|
98
|
+
> PassportAuthDeleteAllResponse passportAuthUserServicePassportAuthDeleteAll(body)
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
### Example
|
|
102
|
+
|
|
103
|
+
```typescript
|
|
104
|
+
import {
|
|
105
|
+
PassportAuthUserServiceApi,
|
|
106
|
+
Configuration,
|
|
107
|
+
PassportAuthDeleteAllRequest
|
|
108
|
+
} from '@cherryin/passport-api-client';
|
|
109
|
+
|
|
110
|
+
const configuration = new Configuration();
|
|
111
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
112
|
+
|
|
113
|
+
let body: PassportAuthDeleteAllRequest; //
|
|
114
|
+
|
|
115
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthDeleteAll(
|
|
116
|
+
body
|
|
117
|
+
);
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### Parameters
|
|
121
|
+
|
|
122
|
+
|Name | Type | Description | Notes|
|
|
123
|
+
|------------- | ------------- | ------------- | -------------|
|
|
124
|
+
| **body** | **PassportAuthDeleteAllRequest**| | |
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
### Return type
|
|
128
|
+
|
|
129
|
+
**PassportAuthDeleteAllResponse**
|
|
130
|
+
|
|
131
|
+
### Authorization
|
|
132
|
+
|
|
133
|
+
No authorization required
|
|
134
|
+
|
|
135
|
+
### HTTP request headers
|
|
136
|
+
|
|
137
|
+
- **Content-Type**: application/json
|
|
138
|
+
- **Accept**: application/json
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
### HTTP response details
|
|
142
|
+
| Status code | Description | Response headers |
|
|
143
|
+
|-------------|-------------|------------------|
|
|
144
|
+
|**200** | A successful response. | - |
|
|
145
|
+
|**0** | An unexpected error response. | - |
|
|
146
|
+
|
|
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)
|
|
148
|
+
|
|
149
|
+
# **passportAuthUserServicePassportAuthInfoGet**
|
|
150
|
+
> PassportAuthInfoGetResponse passportAuthUserServicePassportAuthInfoGet()
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
### Example
|
|
154
|
+
|
|
155
|
+
```typescript
|
|
156
|
+
import {
|
|
157
|
+
PassportAuthUserServiceApi,
|
|
158
|
+
Configuration
|
|
159
|
+
} from '@cherryin/passport-api-client';
|
|
160
|
+
|
|
161
|
+
const configuration = new Configuration();
|
|
162
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
163
|
+
|
|
164
|
+
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表, 如果不指定则获取所有应用的用户信息 (optional) (default to undefined)
|
|
165
|
+
|
|
166
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthInfoGet(
|
|
167
|
+
appIds
|
|
168
|
+
);
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### Parameters
|
|
172
|
+
|
|
173
|
+
|Name | Type | Description | Notes|
|
|
174
|
+
|------------- | ------------- | ------------- | -------------|
|
|
175
|
+
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表, 如果不指定则获取所有应用的用户信息 | (optional) defaults to undefined|
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
### Return type
|
|
179
|
+
|
|
180
|
+
**PassportAuthInfoGetResponse**
|
|
181
|
+
|
|
182
|
+
### Authorization
|
|
183
|
+
|
|
184
|
+
No authorization required
|
|
185
|
+
|
|
186
|
+
### HTTP request headers
|
|
187
|
+
|
|
188
|
+
- **Content-Type**: Not defined
|
|
189
|
+
- **Accept**: application/json
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
### HTTP response details
|
|
193
|
+
| Status code | Description | Response headers |
|
|
194
|
+
|-------------|-------------|------------------|
|
|
195
|
+
|**200** | A successful response. | - |
|
|
196
|
+
|**0** | An unexpected error response. | - |
|
|
197
|
+
|
|
198
|
+
[[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)
|
|
199
|
+
|
|
200
|
+
# **passportAuthUserServicePassportAuthLinkSocial**
|
|
201
|
+
> PassportAuthLinkSocialResponse passportAuthUserServicePassportAuthLinkSocial(body)
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
### Example
|
|
205
|
+
|
|
206
|
+
```typescript
|
|
207
|
+
import {
|
|
208
|
+
PassportAuthUserServiceApi,
|
|
209
|
+
Configuration,
|
|
210
|
+
PassportAuthLinkSocialRequest
|
|
211
|
+
} from '@cherryin/passport-api-client';
|
|
212
|
+
|
|
213
|
+
const configuration = new Configuration();
|
|
214
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
215
|
+
|
|
216
|
+
let body: PassportAuthLinkSocialRequest; //
|
|
217
|
+
|
|
218
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthLinkSocial(
|
|
219
|
+
body
|
|
220
|
+
);
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### Parameters
|
|
224
|
+
|
|
225
|
+
|Name | Type | Description | Notes|
|
|
226
|
+
|------------- | ------------- | ------------- | -------------|
|
|
227
|
+
| **body** | **PassportAuthLinkSocialRequest**| | |
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
### Return type
|
|
231
|
+
|
|
232
|
+
**PassportAuthLinkSocialResponse**
|
|
233
|
+
|
|
234
|
+
### Authorization
|
|
235
|
+
|
|
236
|
+
No authorization required
|
|
237
|
+
|
|
238
|
+
### HTTP request headers
|
|
239
|
+
|
|
240
|
+
- **Content-Type**: application/json
|
|
241
|
+
- **Accept**: application/json
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
### HTTP response details
|
|
245
|
+
| Status code | Description | Response headers |
|
|
246
|
+
|-------------|-------------|------------------|
|
|
247
|
+
|**200** | A successful response. | - |
|
|
248
|
+
|**0** | An unexpected error response. | - |
|
|
249
|
+
|
|
250
|
+
[[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)
|
|
251
|
+
|
|
252
|
+
# **passportAuthUserServicePassportAuthListMethods**
|
|
253
|
+
> PassportAuthListMethodsResponse passportAuthUserServicePassportAuthListMethods()
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
### Example
|
|
257
|
+
|
|
258
|
+
```typescript
|
|
259
|
+
import {
|
|
260
|
+
PassportAuthUserServiceApi,
|
|
261
|
+
Configuration
|
|
262
|
+
} from '@cherryin/passport-api-client';
|
|
263
|
+
|
|
264
|
+
const configuration = new Configuration();
|
|
265
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
266
|
+
|
|
267
|
+
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 (optional) (default to undefined)
|
|
268
|
+
|
|
269
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthListMethods(
|
|
270
|
+
appIds
|
|
271
|
+
);
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
### Parameters
|
|
275
|
+
|
|
276
|
+
|Name | Type | Description | Notes|
|
|
277
|
+
|------------- | ------------- | ------------- | -------------|
|
|
278
|
+
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 | (optional) defaults to undefined|
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
### Return type
|
|
282
|
+
|
|
283
|
+
**PassportAuthListMethodsResponse**
|
|
284
|
+
|
|
285
|
+
### Authorization
|
|
286
|
+
|
|
287
|
+
No authorization required
|
|
288
|
+
|
|
289
|
+
### HTTP request headers
|
|
290
|
+
|
|
291
|
+
- **Content-Type**: Not defined
|
|
292
|
+
- **Accept**: application/json
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
### HTTP response details
|
|
296
|
+
| Status code | Description | Response headers |
|
|
297
|
+
|-------------|-------------|------------------|
|
|
298
|
+
|**200** | A successful response. | - |
|
|
299
|
+
|**0** | An unexpected error response. | - |
|
|
300
|
+
|
|
301
|
+
[[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)
|
|
302
|
+
|
|
303
|
+
# **passportAuthUserServicePassportAuthListSessions**
|
|
304
|
+
> PassportAuthListSessionsResponse passportAuthUserServicePassportAuthListSessions()
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
### Example
|
|
308
|
+
|
|
309
|
+
```typescript
|
|
310
|
+
import {
|
|
311
|
+
PassportAuthUserServiceApi,
|
|
312
|
+
Configuration
|
|
313
|
+
} from '@cherryin/passport-api-client';
|
|
314
|
+
|
|
315
|
+
const configuration = new Configuration();
|
|
316
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
317
|
+
|
|
318
|
+
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" (optional) (default to undefined)
|
|
319
|
+
|
|
320
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthListSessions(
|
|
321
|
+
appIds
|
|
322
|
+
);
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
### Parameters
|
|
326
|
+
|
|
327
|
+
|Name | Type | Description | Notes|
|
|
328
|
+
|------------- | ------------- | ------------- | -------------|
|
|
329
|
+
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" | (optional) defaults to undefined|
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
### Return type
|
|
333
|
+
|
|
334
|
+
**PassportAuthListSessionsResponse**
|
|
335
|
+
|
|
336
|
+
### Authorization
|
|
337
|
+
|
|
338
|
+
No authorization required
|
|
339
|
+
|
|
340
|
+
### HTTP request headers
|
|
341
|
+
|
|
342
|
+
- **Content-Type**: Not defined
|
|
343
|
+
- **Accept**: application/json
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
### HTTP response details
|
|
347
|
+
| Status code | Description | Response headers |
|
|
348
|
+
|-------------|-------------|------------------|
|
|
349
|
+
|**200** | A successful response. | - |
|
|
350
|
+
|**0** | An unexpected error response. | - |
|
|
351
|
+
|
|
352
|
+
[[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)
|
|
353
|
+
|
|
354
|
+
# **passportAuthUserServicePassportAuthListSocials**
|
|
355
|
+
> PassportAuthListSocialsResponse passportAuthUserServicePassportAuthListSocials()
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
### Example
|
|
359
|
+
|
|
360
|
+
```typescript
|
|
361
|
+
import {
|
|
362
|
+
PassportAuthUserServiceApi,
|
|
363
|
+
Configuration
|
|
364
|
+
} from '@cherryin/passport-api-client';
|
|
365
|
+
|
|
366
|
+
const configuration = new Configuration();
|
|
367
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
368
|
+
|
|
369
|
+
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" (optional) (default to undefined)
|
|
370
|
+
|
|
371
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthListSocials(
|
|
372
|
+
appIds
|
|
373
|
+
);
|
|
374
|
+
```
|
|
375
|
+
|
|
376
|
+
### Parameters
|
|
377
|
+
|
|
378
|
+
|Name | Type | Description | Notes|
|
|
379
|
+
|------------- | ------------- | ------------- | -------------|
|
|
380
|
+
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" | (optional) defaults to undefined|
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
### Return type
|
|
384
|
+
|
|
385
|
+
**PassportAuthListSocialsResponse**
|
|
386
|
+
|
|
387
|
+
### Authorization
|
|
388
|
+
|
|
389
|
+
No authorization required
|
|
390
|
+
|
|
391
|
+
### HTTP request headers
|
|
392
|
+
|
|
393
|
+
- **Content-Type**: Not defined
|
|
394
|
+
- **Accept**: application/json
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
### HTTP response details
|
|
398
|
+
| Status code | Description | Response headers |
|
|
399
|
+
|-------------|-------------|------------------|
|
|
400
|
+
|**200** | A successful response. | - |
|
|
401
|
+
|**0** | An unexpected error response. | - |
|
|
402
|
+
|
|
403
|
+
[[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)
|
|
404
|
+
|
|
405
|
+
# **passportAuthUserServicePassportAuthRefreshSessionToken**
|
|
406
|
+
> PassportAuthRefreshSessionTokenResponse passportAuthUserServicePassportAuthRefreshSessionToken(body)
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
### Example
|
|
410
|
+
|
|
411
|
+
```typescript
|
|
412
|
+
import {
|
|
413
|
+
PassportAuthUserServiceApi,
|
|
414
|
+
Configuration,
|
|
415
|
+
PassportAuthRefreshSessionTokenRequest
|
|
416
|
+
} from '@cherryin/passport-api-client';
|
|
417
|
+
|
|
418
|
+
const configuration = new Configuration();
|
|
419
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
420
|
+
|
|
421
|
+
let body: PassportAuthRefreshSessionTokenRequest; //
|
|
422
|
+
|
|
423
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthRefreshSessionToken(
|
|
424
|
+
body
|
|
425
|
+
);
|
|
426
|
+
```
|
|
427
|
+
|
|
428
|
+
### Parameters
|
|
429
|
+
|
|
430
|
+
|Name | Type | Description | Notes|
|
|
431
|
+
|------------- | ------------- | ------------- | -------------|
|
|
432
|
+
| **body** | **PassportAuthRefreshSessionTokenRequest**| | |
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
### Return type
|
|
436
|
+
|
|
437
|
+
**PassportAuthRefreshSessionTokenResponse**
|
|
438
|
+
|
|
439
|
+
### Authorization
|
|
440
|
+
|
|
441
|
+
No authorization required
|
|
442
|
+
|
|
443
|
+
### HTTP request headers
|
|
444
|
+
|
|
445
|
+
- **Content-Type**: application/json
|
|
446
|
+
- **Accept**: application/json
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
### HTTP response details
|
|
450
|
+
| Status code | Description | Response headers |
|
|
451
|
+
|-------------|-------------|------------------|
|
|
452
|
+
|**200** | A successful response. | - |
|
|
453
|
+
|**0** | An unexpected error response. | - |
|
|
454
|
+
|
|
455
|
+
[[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)
|
|
456
|
+
|
|
457
|
+
# **passportAuthUserServicePassportAuthResetPassword**
|
|
458
|
+
> PassportAuthResetPasswordResponse passportAuthUserServicePassportAuthResetPassword(body)
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
### Example
|
|
462
|
+
|
|
463
|
+
```typescript
|
|
464
|
+
import {
|
|
465
|
+
PassportAuthUserServiceApi,
|
|
466
|
+
Configuration,
|
|
467
|
+
PassportAuthResetPasswordRequest
|
|
468
|
+
} from '@cherryin/passport-api-client';
|
|
469
|
+
|
|
470
|
+
const configuration = new Configuration();
|
|
471
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
472
|
+
|
|
473
|
+
let body: PassportAuthResetPasswordRequest; //
|
|
474
|
+
|
|
475
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthResetPassword(
|
|
476
|
+
body
|
|
477
|
+
);
|
|
478
|
+
```
|
|
479
|
+
|
|
480
|
+
### Parameters
|
|
481
|
+
|
|
482
|
+
|Name | Type | Description | Notes|
|
|
483
|
+
|------------- | ------------- | ------------- | -------------|
|
|
484
|
+
| **body** | **PassportAuthResetPasswordRequest**| | |
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
### Return type
|
|
488
|
+
|
|
489
|
+
**PassportAuthResetPasswordResponse**
|
|
490
|
+
|
|
491
|
+
### Authorization
|
|
492
|
+
|
|
493
|
+
No authorization required
|
|
494
|
+
|
|
495
|
+
### HTTP request headers
|
|
496
|
+
|
|
497
|
+
- **Content-Type**: application/json
|
|
498
|
+
- **Accept**: application/json
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
### HTTP response details
|
|
502
|
+
| Status code | Description | Response headers |
|
|
503
|
+
|-------------|-------------|------------------|
|
|
504
|
+
|**200** | A successful response. | - |
|
|
505
|
+
|**0** | An unexpected error response. | - |
|
|
506
|
+
|
|
507
|
+
[[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)
|
|
508
|
+
|
|
509
|
+
# **passportAuthUserServicePassportAuthRevokeOtherSessions**
|
|
510
|
+
> PassportAuthRevokeOtherSessionsResponse passportAuthUserServicePassportAuthRevokeOtherSessions(body)
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
### Example
|
|
514
|
+
|
|
515
|
+
```typescript
|
|
516
|
+
import {
|
|
517
|
+
PassportAuthUserServiceApi,
|
|
518
|
+
Configuration,
|
|
519
|
+
PassportAuthRevokeOtherSessionsRequest
|
|
520
|
+
} from '@cherryin/passport-api-client';
|
|
521
|
+
|
|
522
|
+
const configuration = new Configuration();
|
|
523
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
524
|
+
|
|
525
|
+
let body: PassportAuthRevokeOtherSessionsRequest; //
|
|
526
|
+
|
|
527
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthRevokeOtherSessions(
|
|
528
|
+
body
|
|
529
|
+
);
|
|
530
|
+
```
|
|
531
|
+
|
|
532
|
+
### Parameters
|
|
533
|
+
|
|
534
|
+
|Name | Type | Description | Notes|
|
|
535
|
+
|------------- | ------------- | ------------- | -------------|
|
|
536
|
+
| **body** | **PassportAuthRevokeOtherSessionsRequest**| | |
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
### Return type
|
|
540
|
+
|
|
541
|
+
**PassportAuthRevokeOtherSessionsResponse**
|
|
542
|
+
|
|
543
|
+
### Authorization
|
|
544
|
+
|
|
545
|
+
No authorization required
|
|
546
|
+
|
|
547
|
+
### HTTP request headers
|
|
548
|
+
|
|
549
|
+
- **Content-Type**: application/json
|
|
550
|
+
- **Accept**: application/json
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
### HTTP response details
|
|
554
|
+
| Status code | Description | Response headers |
|
|
555
|
+
|-------------|-------------|------------------|
|
|
556
|
+
|**200** | A successful response. | - |
|
|
557
|
+
|**0** | An unexpected error response. | - |
|
|
558
|
+
|
|
559
|
+
[[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)
|
|
560
|
+
|
|
561
|
+
# **passportAuthUserServicePassportAuthRevokeSession**
|
|
562
|
+
> PassportAuthRevokeSessionResponse passportAuthUserServicePassportAuthRevokeSession(body)
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
### Example
|
|
566
|
+
|
|
567
|
+
```typescript
|
|
568
|
+
import {
|
|
569
|
+
PassportAuthUserServiceApi,
|
|
570
|
+
Configuration,
|
|
571
|
+
PassportAuthRevokeSessionRequest
|
|
572
|
+
} from '@cherryin/passport-api-client';
|
|
573
|
+
|
|
574
|
+
const configuration = new Configuration();
|
|
575
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
576
|
+
|
|
577
|
+
let body: PassportAuthRevokeSessionRequest; //
|
|
578
|
+
|
|
579
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthRevokeSession(
|
|
580
|
+
body
|
|
581
|
+
);
|
|
582
|
+
```
|
|
583
|
+
|
|
584
|
+
### Parameters
|
|
585
|
+
|
|
586
|
+
|Name | Type | Description | Notes|
|
|
587
|
+
|------------- | ------------- | ------------- | -------------|
|
|
588
|
+
| **body** | **PassportAuthRevokeSessionRequest**| | |
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
### Return type
|
|
592
|
+
|
|
593
|
+
**PassportAuthRevokeSessionResponse**
|
|
594
|
+
|
|
595
|
+
### Authorization
|
|
596
|
+
|
|
597
|
+
No authorization required
|
|
598
|
+
|
|
599
|
+
### HTTP request headers
|
|
600
|
+
|
|
601
|
+
- **Content-Type**: application/json
|
|
602
|
+
- **Accept**: application/json
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
### HTTP response details
|
|
606
|
+
| Status code | Description | Response headers |
|
|
607
|
+
|-------------|-------------|------------------|
|
|
608
|
+
|**200** | A successful response. | - |
|
|
609
|
+
|**0** | An unexpected error response. | - |
|
|
610
|
+
|
|
611
|
+
[[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)
|
|
612
|
+
|
|
613
|
+
# **passportAuthUserServicePassportAuthRevokeSessions**
|
|
614
|
+
> PassportAuthRevokeSessionsResponse passportAuthUserServicePassportAuthRevokeSessions(body)
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
### Example
|
|
618
|
+
|
|
619
|
+
```typescript
|
|
620
|
+
import {
|
|
621
|
+
PassportAuthUserServiceApi,
|
|
622
|
+
Configuration,
|
|
623
|
+
PassportAuthRevokeSessionsRequest
|
|
624
|
+
} from '@cherryin/passport-api-client';
|
|
625
|
+
|
|
626
|
+
const configuration = new Configuration();
|
|
627
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
628
|
+
|
|
629
|
+
let body: PassportAuthRevokeSessionsRequest; //
|
|
630
|
+
|
|
631
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthRevokeSessions(
|
|
632
|
+
body
|
|
633
|
+
);
|
|
634
|
+
```
|
|
635
|
+
|
|
636
|
+
### Parameters
|
|
637
|
+
|
|
638
|
+
|Name | Type | Description | Notes|
|
|
639
|
+
|------------- | ------------- | ------------- | -------------|
|
|
640
|
+
| **body** | **PassportAuthRevokeSessionsRequest**| | |
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
### Return type
|
|
644
|
+
|
|
645
|
+
**PassportAuthRevokeSessionsResponse**
|
|
646
|
+
|
|
647
|
+
### Authorization
|
|
648
|
+
|
|
649
|
+
No authorization required
|
|
650
|
+
|
|
651
|
+
### HTTP request headers
|
|
652
|
+
|
|
653
|
+
- **Content-Type**: application/json
|
|
654
|
+
- **Accept**: application/json
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
### HTTP response details
|
|
658
|
+
| Status code | Description | Response headers |
|
|
659
|
+
|-------------|-------------|------------------|
|
|
660
|
+
|**200** | A successful response. | - |
|
|
661
|
+
|**0** | An unexpected error response. | - |
|
|
662
|
+
|
|
663
|
+
[[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)
|
|
664
|
+
|
|
665
|
+
# **passportAuthUserServicePassportAuthSendVerificationEmail**
|
|
666
|
+
> PassportAuthSendVerificationEmailResponse passportAuthUserServicePassportAuthSendVerificationEmail(body)
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
### Example
|
|
670
|
+
|
|
671
|
+
```typescript
|
|
672
|
+
import {
|
|
673
|
+
PassportAuthUserServiceApi,
|
|
674
|
+
Configuration,
|
|
675
|
+
PassportAuthSendVerificationEmailRequest
|
|
676
|
+
} from '@cherryin/passport-api-client';
|
|
677
|
+
|
|
678
|
+
const configuration = new Configuration();
|
|
679
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
680
|
+
|
|
681
|
+
let body: PassportAuthSendVerificationEmailRequest; //
|
|
682
|
+
|
|
683
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthSendVerificationEmail(
|
|
684
|
+
body
|
|
685
|
+
);
|
|
686
|
+
```
|
|
687
|
+
|
|
688
|
+
### Parameters
|
|
689
|
+
|
|
690
|
+
|Name | Type | Description | Notes|
|
|
691
|
+
|------------- | ------------- | ------------- | -------------|
|
|
692
|
+
| **body** | **PassportAuthSendVerificationEmailRequest**| | |
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
### Return type
|
|
696
|
+
|
|
697
|
+
**PassportAuthSendVerificationEmailResponse**
|
|
698
|
+
|
|
699
|
+
### Authorization
|
|
700
|
+
|
|
701
|
+
No authorization required
|
|
702
|
+
|
|
703
|
+
### HTTP request headers
|
|
704
|
+
|
|
705
|
+
- **Content-Type**: application/json
|
|
706
|
+
- **Accept**: application/json
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
### HTTP response details
|
|
710
|
+
| Status code | Description | Response headers |
|
|
711
|
+
|-------------|-------------|------------------|
|
|
712
|
+
|**200** | A successful response. | - |
|
|
713
|
+
|**0** | An unexpected error response. | - |
|
|
714
|
+
|
|
715
|
+
[[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)
|
|
716
|
+
|
|
717
|
+
# **passportAuthUserServicePassportAuthSendVerificationPhone**
|
|
718
|
+
> PassportAuthSendVerificationPhoneResponse passportAuthUserServicePassportAuthSendVerificationPhone(body)
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
### Example
|
|
722
|
+
|
|
723
|
+
```typescript
|
|
724
|
+
import {
|
|
725
|
+
PassportAuthUserServiceApi,
|
|
726
|
+
Configuration,
|
|
727
|
+
PassportAuthSendVerificationPhoneRequest
|
|
728
|
+
} from '@cherryin/passport-api-client';
|
|
729
|
+
|
|
730
|
+
const configuration = new Configuration();
|
|
731
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
732
|
+
|
|
733
|
+
let body: PassportAuthSendVerificationPhoneRequest; //
|
|
734
|
+
|
|
735
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthSendVerificationPhone(
|
|
736
|
+
body
|
|
737
|
+
);
|
|
738
|
+
```
|
|
739
|
+
|
|
740
|
+
### Parameters
|
|
741
|
+
|
|
742
|
+
|Name | Type | Description | Notes|
|
|
743
|
+
|------------- | ------------- | ------------- | -------------|
|
|
744
|
+
| **body** | **PassportAuthSendVerificationPhoneRequest**| | |
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
### Return type
|
|
748
|
+
|
|
749
|
+
**PassportAuthSendVerificationPhoneResponse**
|
|
750
|
+
|
|
751
|
+
### Authorization
|
|
752
|
+
|
|
753
|
+
No authorization required
|
|
754
|
+
|
|
755
|
+
### HTTP request headers
|
|
756
|
+
|
|
757
|
+
- **Content-Type**: application/json
|
|
758
|
+
- **Accept**: application/json
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
### HTTP response details
|
|
762
|
+
| Status code | Description | Response headers |
|
|
763
|
+
|-------------|-------------|------------------|
|
|
764
|
+
|**200** | A successful response. | - |
|
|
765
|
+
|**0** | An unexpected error response. | - |
|
|
766
|
+
|
|
767
|
+
[[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)
|
|
768
|
+
|
|
769
|
+
# **passportAuthUserServicePassportAuthSocialGetAccessToken**
|
|
770
|
+
> PassportAuthSocialGetAccessTokenResponse passportAuthUserServicePassportAuthSocialGetAccessToken(body)
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
### Example
|
|
774
|
+
|
|
775
|
+
```typescript
|
|
776
|
+
import {
|
|
777
|
+
PassportAuthUserServiceApi,
|
|
778
|
+
Configuration,
|
|
779
|
+
PassportAuthSocialGetAccessTokenRequest
|
|
780
|
+
} from '@cherryin/passport-api-client';
|
|
781
|
+
|
|
782
|
+
const configuration = new Configuration();
|
|
783
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
784
|
+
|
|
785
|
+
let body: PassportAuthSocialGetAccessTokenRequest; //
|
|
786
|
+
|
|
787
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthSocialGetAccessToken(
|
|
788
|
+
body
|
|
789
|
+
);
|
|
790
|
+
```
|
|
791
|
+
|
|
792
|
+
### Parameters
|
|
793
|
+
|
|
794
|
+
|Name | Type | Description | Notes|
|
|
795
|
+
|------------- | ------------- | ------------- | -------------|
|
|
796
|
+
| **body** | **PassportAuthSocialGetAccessTokenRequest**| | |
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
### Return type
|
|
800
|
+
|
|
801
|
+
**PassportAuthSocialGetAccessTokenResponse**
|
|
802
|
+
|
|
803
|
+
### Authorization
|
|
804
|
+
|
|
805
|
+
No authorization required
|
|
806
|
+
|
|
807
|
+
### HTTP request headers
|
|
808
|
+
|
|
809
|
+
- **Content-Type**: application/json
|
|
810
|
+
- **Accept**: application/json
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
### HTTP response details
|
|
814
|
+
| Status code | Description | Response headers |
|
|
815
|
+
|-------------|-------------|------------------|
|
|
816
|
+
|**200** | A successful response. | - |
|
|
817
|
+
|**0** | An unexpected error response. | - |
|
|
818
|
+
|
|
819
|
+
[[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)
|
|
820
|
+
|
|
821
|
+
# **passportAuthUserServicePassportAuthSocialRefreshToken**
|
|
822
|
+
> PassportAuthSocialRefreshTokenResponse passportAuthUserServicePassportAuthSocialRefreshToken(body)
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
### Example
|
|
826
|
+
|
|
827
|
+
```typescript
|
|
828
|
+
import {
|
|
829
|
+
PassportAuthUserServiceApi,
|
|
830
|
+
Configuration,
|
|
831
|
+
PassportAuthSocialRefreshTokenRequest
|
|
832
|
+
} from '@cherryin/passport-api-client';
|
|
833
|
+
|
|
834
|
+
const configuration = new Configuration();
|
|
835
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
836
|
+
|
|
837
|
+
let body: PassportAuthSocialRefreshTokenRequest; //
|
|
838
|
+
|
|
839
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthSocialRefreshToken(
|
|
840
|
+
body
|
|
841
|
+
);
|
|
842
|
+
```
|
|
843
|
+
|
|
844
|
+
### Parameters
|
|
845
|
+
|
|
846
|
+
|Name | Type | Description | Notes|
|
|
847
|
+
|------------- | ------------- | ------------- | -------------|
|
|
848
|
+
| **body** | **PassportAuthSocialRefreshTokenRequest**| | |
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
### Return type
|
|
852
|
+
|
|
853
|
+
**PassportAuthSocialRefreshTokenResponse**
|
|
854
|
+
|
|
855
|
+
### Authorization
|
|
856
|
+
|
|
857
|
+
No authorization required
|
|
858
|
+
|
|
859
|
+
### HTTP request headers
|
|
860
|
+
|
|
861
|
+
- **Content-Type**: application/json
|
|
862
|
+
- **Accept**: application/json
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
### HTTP response details
|
|
866
|
+
| Status code | Description | Response headers |
|
|
867
|
+
|-------------|-------------|------------------|
|
|
868
|
+
|**200** | A successful response. | - |
|
|
869
|
+
|**0** | An unexpected error response. | - |
|
|
870
|
+
|
|
871
|
+
[[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)
|
|
872
|
+
|
|
873
|
+
# **passportAuthUserServicePassportAuthUnlinkSocial**
|
|
874
|
+
> PassportAuthUnlinkSocialResponse passportAuthUserServicePassportAuthUnlinkSocial(body)
|
|
875
|
+
|
|
876
|
+
|
|
877
|
+
### Example
|
|
878
|
+
|
|
879
|
+
```typescript
|
|
880
|
+
import {
|
|
881
|
+
PassportAuthUserServiceApi,
|
|
882
|
+
Configuration,
|
|
883
|
+
PassportAuthUnlinkSocialRequest
|
|
884
|
+
} from '@cherryin/passport-api-client';
|
|
885
|
+
|
|
886
|
+
const configuration = new Configuration();
|
|
887
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
888
|
+
|
|
889
|
+
let body: PassportAuthUnlinkSocialRequest; //
|
|
890
|
+
|
|
891
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUnlinkSocial(
|
|
892
|
+
body
|
|
893
|
+
);
|
|
894
|
+
```
|
|
895
|
+
|
|
896
|
+
### Parameters
|
|
897
|
+
|
|
898
|
+
|Name | Type | Description | Notes|
|
|
899
|
+
|------------- | ------------- | ------------- | -------------|
|
|
900
|
+
| **body** | **PassportAuthUnlinkSocialRequest**| | |
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
### Return type
|
|
904
|
+
|
|
905
|
+
**PassportAuthUnlinkSocialResponse**
|
|
906
|
+
|
|
907
|
+
### Authorization
|
|
908
|
+
|
|
909
|
+
No authorization required
|
|
910
|
+
|
|
911
|
+
### HTTP request headers
|
|
912
|
+
|
|
913
|
+
- **Content-Type**: application/json
|
|
914
|
+
- **Accept**: application/json
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
### HTTP response details
|
|
918
|
+
| Status code | Description | Response headers |
|
|
919
|
+
|-------------|-------------|------------------|
|
|
920
|
+
|**200** | A successful response. | - |
|
|
921
|
+
|**0** | An unexpected error response. | - |
|
|
922
|
+
|
|
923
|
+
[[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)
|
|
924
|
+
|
|
925
|
+
# **passportAuthUserServicePassportAuthUserChangeEmail**
|
|
926
|
+
> PassportAuthUserChangeEmailResponse passportAuthUserServicePassportAuthUserChangeEmail(body)
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
### Example
|
|
930
|
+
|
|
931
|
+
```typescript
|
|
932
|
+
import {
|
|
933
|
+
PassportAuthUserServiceApi,
|
|
934
|
+
Configuration,
|
|
935
|
+
PassportAuthUserChangeEmailRequest
|
|
936
|
+
} from '@cherryin/passport-api-client';
|
|
937
|
+
|
|
938
|
+
const configuration = new Configuration();
|
|
939
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
940
|
+
|
|
941
|
+
let body: PassportAuthUserChangeEmailRequest; //
|
|
942
|
+
|
|
943
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserChangeEmail(
|
|
944
|
+
body
|
|
945
|
+
);
|
|
946
|
+
```
|
|
947
|
+
|
|
948
|
+
### Parameters
|
|
949
|
+
|
|
950
|
+
|Name | Type | Description | Notes|
|
|
951
|
+
|------------- | ------------- | ------------- | -------------|
|
|
952
|
+
| **body** | **PassportAuthUserChangeEmailRequest**| | |
|
|
953
|
+
|
|
954
|
+
|
|
955
|
+
### Return type
|
|
956
|
+
|
|
957
|
+
**PassportAuthUserChangeEmailResponse**
|
|
958
|
+
|
|
959
|
+
### Authorization
|
|
960
|
+
|
|
961
|
+
No authorization required
|
|
962
|
+
|
|
963
|
+
### HTTP request headers
|
|
964
|
+
|
|
965
|
+
- **Content-Type**: application/json
|
|
966
|
+
- **Accept**: application/json
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
### HTTP response details
|
|
970
|
+
| Status code | Description | Response headers |
|
|
971
|
+
|-------------|-------------|------------------|
|
|
972
|
+
|**200** | A successful response. | - |
|
|
973
|
+
|**0** | An unexpected error response. | - |
|
|
974
|
+
|
|
975
|
+
[[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)
|
|
976
|
+
|
|
977
|
+
# **passportAuthUserServicePassportAuthUserChangePhone**
|
|
978
|
+
> PassportAuthUserChangePhoneResponse passportAuthUserServicePassportAuthUserChangePhone(body)
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
### Example
|
|
982
|
+
|
|
983
|
+
```typescript
|
|
984
|
+
import {
|
|
985
|
+
PassportAuthUserServiceApi,
|
|
986
|
+
Configuration,
|
|
987
|
+
PassportAuthUserChangePhoneRequest
|
|
988
|
+
} from '@cherryin/passport-api-client';
|
|
989
|
+
|
|
990
|
+
const configuration = new Configuration();
|
|
991
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
992
|
+
|
|
993
|
+
let body: PassportAuthUserChangePhoneRequest; //
|
|
994
|
+
|
|
995
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserChangePhone(
|
|
996
|
+
body
|
|
997
|
+
);
|
|
998
|
+
```
|
|
999
|
+
|
|
1000
|
+
### Parameters
|
|
1001
|
+
|
|
1002
|
+
|Name | Type | Description | Notes|
|
|
1003
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1004
|
+
| **body** | **PassportAuthUserChangePhoneRequest**| | |
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
### Return type
|
|
1008
|
+
|
|
1009
|
+
**PassportAuthUserChangePhoneResponse**
|
|
1010
|
+
|
|
1011
|
+
### Authorization
|
|
1012
|
+
|
|
1013
|
+
No authorization required
|
|
1014
|
+
|
|
1015
|
+
### HTTP request headers
|
|
1016
|
+
|
|
1017
|
+
- **Content-Type**: application/json
|
|
1018
|
+
- **Accept**: application/json
|
|
1019
|
+
|
|
1020
|
+
|
|
1021
|
+
### HTTP response details
|
|
1022
|
+
| Status code | Description | Response headers |
|
|
1023
|
+
|-------------|-------------|------------------|
|
|
1024
|
+
|**200** | A successful response. | - |
|
|
1025
|
+
|**0** | An unexpected error response. | - |
|
|
1026
|
+
|
|
1027
|
+
[[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)
|
|
1028
|
+
|
|
1029
|
+
# **passportAuthUserServicePassportAuthUserDelete**
|
|
1030
|
+
> PassportAuthUserDeleteResponse passportAuthUserServicePassportAuthUserDelete(body)
|
|
1031
|
+
|
|
1032
|
+
|
|
1033
|
+
### Example
|
|
1034
|
+
|
|
1035
|
+
```typescript
|
|
1036
|
+
import {
|
|
1037
|
+
PassportAuthUserServiceApi,
|
|
1038
|
+
Configuration,
|
|
1039
|
+
PassportAuthUserDeleteRequest
|
|
1040
|
+
} from '@cherryin/passport-api-client';
|
|
1041
|
+
|
|
1042
|
+
const configuration = new Configuration();
|
|
1043
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1044
|
+
|
|
1045
|
+
let body: PassportAuthUserDeleteRequest; //
|
|
1046
|
+
|
|
1047
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserDelete(
|
|
1048
|
+
body
|
|
1049
|
+
);
|
|
1050
|
+
```
|
|
1051
|
+
|
|
1052
|
+
### Parameters
|
|
1053
|
+
|
|
1054
|
+
|Name | Type | Description | Notes|
|
|
1055
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1056
|
+
| **body** | **PassportAuthUserDeleteRequest**| | |
|
|
1057
|
+
|
|
1058
|
+
|
|
1059
|
+
### Return type
|
|
1060
|
+
|
|
1061
|
+
**PassportAuthUserDeleteResponse**
|
|
1062
|
+
|
|
1063
|
+
### Authorization
|
|
1064
|
+
|
|
1065
|
+
No authorization required
|
|
1066
|
+
|
|
1067
|
+
### HTTP request headers
|
|
1068
|
+
|
|
1069
|
+
- **Content-Type**: application/json
|
|
1070
|
+
- **Accept**: application/json
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
### HTTP response details
|
|
1074
|
+
| Status code | Description | Response headers |
|
|
1075
|
+
|-------------|-------------|------------------|
|
|
1076
|
+
|**200** | A successful response. | - |
|
|
1077
|
+
|**0** | An unexpected error response. | - |
|
|
1078
|
+
|
|
1079
|
+
[[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)
|
|
1080
|
+
|
|
1081
|
+
# **passportAuthUserServicePassportAuthUserGetSession**
|
|
1082
|
+
> PassportAuthUserGetSessionResponse passportAuthUserServicePassportAuthUserGetSession()
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
### Example
|
|
1086
|
+
|
|
1087
|
+
```typescript
|
|
1088
|
+
import {
|
|
1089
|
+
PassportAuthUserServiceApi,
|
|
1090
|
+
Configuration
|
|
1091
|
+
} from '@cherryin/passport-api-client';
|
|
1092
|
+
|
|
1093
|
+
const configuration = new Configuration();
|
|
1094
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1095
|
+
|
|
1096
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserGetSession();
|
|
1097
|
+
```
|
|
1098
|
+
|
|
1099
|
+
### Parameters
|
|
1100
|
+
This endpoint does not have any parameters.
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
### Return type
|
|
1104
|
+
|
|
1105
|
+
**PassportAuthUserGetSessionResponse**
|
|
1106
|
+
|
|
1107
|
+
### Authorization
|
|
1108
|
+
|
|
1109
|
+
No authorization required
|
|
1110
|
+
|
|
1111
|
+
### HTTP request headers
|
|
1112
|
+
|
|
1113
|
+
- **Content-Type**: Not defined
|
|
1114
|
+
- **Accept**: application/json
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
### HTTP response details
|
|
1118
|
+
| Status code | Description | Response headers |
|
|
1119
|
+
|-------------|-------------|------------------|
|
|
1120
|
+
|**200** | A successful response. | - |
|
|
1121
|
+
|**0** | An unexpected error response. | - |
|
|
1122
|
+
|
|
1123
|
+
[[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)
|
|
1124
|
+
|
|
1125
|
+
# **passportAuthUserServicePassportAuthUserInfoGet**
|
|
1126
|
+
> PassportAuthUserInfoGetResponse passportAuthUserServicePassportAuthUserInfoGet()
|
|
1127
|
+
|
|
1128
|
+
|
|
1129
|
+
### Example
|
|
1130
|
+
|
|
1131
|
+
```typescript
|
|
1132
|
+
import {
|
|
1133
|
+
PassportAuthUserServiceApi,
|
|
1134
|
+
Configuration
|
|
1135
|
+
} from '@cherryin/passport-api-client';
|
|
1136
|
+
|
|
1137
|
+
const configuration = new Configuration();
|
|
1138
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1139
|
+
|
|
1140
|
+
let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 (optional) (default to undefined)
|
|
1141
|
+
|
|
1142
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserInfoGet(
|
|
1143
|
+
appIds
|
|
1144
|
+
);
|
|
1145
|
+
```
|
|
1146
|
+
|
|
1147
|
+
### Parameters
|
|
1148
|
+
|
|
1149
|
+
|Name | Type | Description | Notes|
|
|
1150
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1151
|
+
| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 | (optional) defaults to undefined|
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
### Return type
|
|
1155
|
+
|
|
1156
|
+
**PassportAuthUserInfoGetResponse**
|
|
1157
|
+
|
|
1158
|
+
### Authorization
|
|
1159
|
+
|
|
1160
|
+
No authorization required
|
|
1161
|
+
|
|
1162
|
+
### HTTP request headers
|
|
1163
|
+
|
|
1164
|
+
- **Content-Type**: Not defined
|
|
1165
|
+
- **Accept**: application/json
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
### HTTP response details
|
|
1169
|
+
| Status code | Description | Response headers |
|
|
1170
|
+
|-------------|-------------|------------------|
|
|
1171
|
+
|**200** | A successful response. | - |
|
|
1172
|
+
|**0** | An unexpected error response. | - |
|
|
1173
|
+
|
|
1174
|
+
[[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)
|
|
1175
|
+
|
|
1176
|
+
# **passportAuthUserServicePassportAuthUserSignOut**
|
|
1177
|
+
> PassportAuthUserSignOutResponse passportAuthUserServicePassportAuthUserSignOut(body)
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
### Example
|
|
1181
|
+
|
|
1182
|
+
```typescript
|
|
1183
|
+
import {
|
|
1184
|
+
PassportAuthUserServiceApi,
|
|
1185
|
+
Configuration,
|
|
1186
|
+
PassportAuthUserSignOutRequest
|
|
1187
|
+
} from '@cherryin/passport-api-client';
|
|
1188
|
+
|
|
1189
|
+
const configuration = new Configuration();
|
|
1190
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1191
|
+
|
|
1192
|
+
let body: PassportAuthUserSignOutRequest; //
|
|
1193
|
+
|
|
1194
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserSignOut(
|
|
1195
|
+
body
|
|
1196
|
+
);
|
|
1197
|
+
```
|
|
1198
|
+
|
|
1199
|
+
### Parameters
|
|
1200
|
+
|
|
1201
|
+
|Name | Type | Description | Notes|
|
|
1202
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1203
|
+
| **body** | **PassportAuthUserSignOutRequest**| | |
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
### Return type
|
|
1207
|
+
|
|
1208
|
+
**PassportAuthUserSignOutResponse**
|
|
1209
|
+
|
|
1210
|
+
### Authorization
|
|
1211
|
+
|
|
1212
|
+
No authorization required
|
|
1213
|
+
|
|
1214
|
+
### HTTP request headers
|
|
1215
|
+
|
|
1216
|
+
- **Content-Type**: application/json
|
|
1217
|
+
- **Accept**: application/json
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
### HTTP response details
|
|
1221
|
+
| Status code | Description | Response headers |
|
|
1222
|
+
|-------------|-------------|------------------|
|
|
1223
|
+
|**200** | A successful response. | - |
|
|
1224
|
+
|**0** | An unexpected error response. | - |
|
|
1225
|
+
|
|
1226
|
+
[[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)
|
|
1227
|
+
|
|
1228
|
+
# **passportAuthUserServicePassportAuthUserUpdateInfo**
|
|
1229
|
+
> PassportAuthUserUpdateInfoResponse passportAuthUserServicePassportAuthUserUpdateInfo(body)
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
### Example
|
|
1233
|
+
|
|
1234
|
+
```typescript
|
|
1235
|
+
import {
|
|
1236
|
+
PassportAuthUserServiceApi,
|
|
1237
|
+
Configuration,
|
|
1238
|
+
PassportAuthUserUpdateInfoRequest
|
|
1239
|
+
} from '@cherryin/passport-api-client';
|
|
1240
|
+
|
|
1241
|
+
const configuration = new Configuration();
|
|
1242
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1243
|
+
|
|
1244
|
+
let body: PassportAuthUserUpdateInfoRequest; //
|
|
1245
|
+
|
|
1246
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserUpdateInfo(
|
|
1247
|
+
body
|
|
1248
|
+
);
|
|
1249
|
+
```
|
|
1250
|
+
|
|
1251
|
+
### Parameters
|
|
1252
|
+
|
|
1253
|
+
|Name | Type | Description | Notes|
|
|
1254
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1255
|
+
| **body** | **PassportAuthUserUpdateInfoRequest**| | |
|
|
1256
|
+
|
|
1257
|
+
|
|
1258
|
+
### Return type
|
|
1259
|
+
|
|
1260
|
+
**PassportAuthUserUpdateInfoResponse**
|
|
1261
|
+
|
|
1262
|
+
### Authorization
|
|
1263
|
+
|
|
1264
|
+
No authorization required
|
|
1265
|
+
|
|
1266
|
+
### HTTP request headers
|
|
1267
|
+
|
|
1268
|
+
- **Content-Type**: application/json
|
|
1269
|
+
- **Accept**: application/json
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
### HTTP response details
|
|
1273
|
+
| Status code | Description | Response headers |
|
|
1274
|
+
|-------------|-------------|------------------|
|
|
1275
|
+
|**200** | A successful response. | - |
|
|
1276
|
+
|**0** | An unexpected error response. | - |
|
|
1277
|
+
|
|
1278
|
+
[[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)
|
|
1279
|
+
|
|
1280
|
+
# **passportAuthUserServicePassportAuthUserUpdatePassport**
|
|
1281
|
+
> PassportAuthUserUpdatePassportResponse passportAuthUserServicePassportAuthUserUpdatePassport(body)
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
### Example
|
|
1285
|
+
|
|
1286
|
+
```typescript
|
|
1287
|
+
import {
|
|
1288
|
+
PassportAuthUserServiceApi,
|
|
1289
|
+
Configuration,
|
|
1290
|
+
PassportAuthUserUpdatePassportRequest
|
|
1291
|
+
} from '@cherryin/passport-api-client';
|
|
1292
|
+
|
|
1293
|
+
const configuration = new Configuration();
|
|
1294
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1295
|
+
|
|
1296
|
+
let body: PassportAuthUserUpdatePassportRequest; //
|
|
1297
|
+
|
|
1298
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserUpdatePassport(
|
|
1299
|
+
body
|
|
1300
|
+
);
|
|
1301
|
+
```
|
|
1302
|
+
|
|
1303
|
+
### Parameters
|
|
1304
|
+
|
|
1305
|
+
|Name | Type | Description | Notes|
|
|
1306
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1307
|
+
| **body** | **PassportAuthUserUpdatePassportRequest**| | |
|
|
1308
|
+
|
|
1309
|
+
|
|
1310
|
+
### Return type
|
|
1311
|
+
|
|
1312
|
+
**PassportAuthUserUpdatePassportResponse**
|
|
1313
|
+
|
|
1314
|
+
### Authorization
|
|
1315
|
+
|
|
1316
|
+
No authorization required
|
|
1317
|
+
|
|
1318
|
+
### HTTP request headers
|
|
1319
|
+
|
|
1320
|
+
- **Content-Type**: application/json
|
|
1321
|
+
- **Accept**: application/json
|
|
1322
|
+
|
|
1323
|
+
|
|
1324
|
+
### HTTP response details
|
|
1325
|
+
| Status code | Description | Response headers |
|
|
1326
|
+
|-------------|-------------|------------------|
|
|
1327
|
+
|**200** | A successful response. | - |
|
|
1328
|
+
|**0** | An unexpected error response. | - |
|
|
1329
|
+
|
|
1330
|
+
[[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)
|
|
1331
|
+
|
|
1332
|
+
# **passportAuthUserServicePassportAuthUserVerifyEmail**
|
|
1333
|
+
> PassportAuthUserVerifyEmailResponse passportAuthUserServicePassportAuthUserVerifyEmail(body)
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
### Example
|
|
1337
|
+
|
|
1338
|
+
```typescript
|
|
1339
|
+
import {
|
|
1340
|
+
PassportAuthUserServiceApi,
|
|
1341
|
+
Configuration,
|
|
1342
|
+
PassportAuthUserVerifyEmailRequest
|
|
1343
|
+
} from '@cherryin/passport-api-client';
|
|
1344
|
+
|
|
1345
|
+
const configuration = new Configuration();
|
|
1346
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1347
|
+
|
|
1348
|
+
let body: PassportAuthUserVerifyEmailRequest; //
|
|
1349
|
+
|
|
1350
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserVerifyEmail(
|
|
1351
|
+
body
|
|
1352
|
+
);
|
|
1353
|
+
```
|
|
1354
|
+
|
|
1355
|
+
### Parameters
|
|
1356
|
+
|
|
1357
|
+
|Name | Type | Description | Notes|
|
|
1358
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1359
|
+
| **body** | **PassportAuthUserVerifyEmailRequest**| | |
|
|
1360
|
+
|
|
1361
|
+
|
|
1362
|
+
### Return type
|
|
1363
|
+
|
|
1364
|
+
**PassportAuthUserVerifyEmailResponse**
|
|
1365
|
+
|
|
1366
|
+
### Authorization
|
|
1367
|
+
|
|
1368
|
+
No authorization required
|
|
1369
|
+
|
|
1370
|
+
### HTTP request headers
|
|
1371
|
+
|
|
1372
|
+
- **Content-Type**: application/json
|
|
1373
|
+
- **Accept**: application/json
|
|
1374
|
+
|
|
1375
|
+
|
|
1376
|
+
### HTTP response details
|
|
1377
|
+
| Status code | Description | Response headers |
|
|
1378
|
+
|-------------|-------------|------------------|
|
|
1379
|
+
|**200** | A successful response. | - |
|
|
1380
|
+
|**0** | An unexpected error response. | - |
|
|
1381
|
+
|
|
1382
|
+
[[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)
|
|
1383
|
+
|
|
1384
|
+
# **passportAuthUserServicePassportAuthUserVerifyPhone**
|
|
1385
|
+
> PassportAuthUserVerifyPhoneResponse passportAuthUserServicePassportAuthUserVerifyPhone(body)
|
|
1386
|
+
|
|
1387
|
+
|
|
1388
|
+
### Example
|
|
1389
|
+
|
|
1390
|
+
```typescript
|
|
1391
|
+
import {
|
|
1392
|
+
PassportAuthUserServiceApi,
|
|
1393
|
+
Configuration,
|
|
1394
|
+
PassportAuthUserVerifyPhoneRequest
|
|
1395
|
+
} from '@cherryin/passport-api-client';
|
|
1396
|
+
|
|
1397
|
+
const configuration = new Configuration();
|
|
1398
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1399
|
+
|
|
1400
|
+
let body: PassportAuthUserVerifyPhoneRequest; //
|
|
1401
|
+
|
|
1402
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserVerifyPhone(
|
|
1403
|
+
body
|
|
1404
|
+
);
|
|
1405
|
+
```
|
|
1406
|
+
|
|
1407
|
+
### Parameters
|
|
1408
|
+
|
|
1409
|
+
|Name | Type | Description | Notes|
|
|
1410
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1411
|
+
| **body** | **PassportAuthUserVerifyPhoneRequest**| | |
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
### Return type
|
|
1415
|
+
|
|
1416
|
+
**PassportAuthUserVerifyPhoneResponse**
|
|
1417
|
+
|
|
1418
|
+
### Authorization
|
|
1419
|
+
|
|
1420
|
+
No authorization required
|
|
1421
|
+
|
|
1422
|
+
### HTTP request headers
|
|
1423
|
+
|
|
1424
|
+
- **Content-Type**: application/json
|
|
1425
|
+
- **Accept**: application/json
|
|
1426
|
+
|
|
1427
|
+
|
|
1428
|
+
### HTTP response details
|
|
1429
|
+
| Status code | Description | Response headers |
|
|
1430
|
+
|-------------|-------------|------------------|
|
|
1431
|
+
|**200** | A successful response. | - |
|
|
1432
|
+
|**0** | An unexpected error response. | - |
|
|
1433
|
+
|
|
1434
|
+
[[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)
|
|
1435
|
+
|
|
1436
|
+
# **passportAuthUserServicePassportSendVerificationEmail**
|
|
1437
|
+
> PassportSendVerificationEmailResponse passportAuthUserServicePassportSendVerificationEmail(body)
|
|
1438
|
+
|
|
1439
|
+
|
|
1440
|
+
### Example
|
|
1441
|
+
|
|
1442
|
+
```typescript
|
|
1443
|
+
import {
|
|
1444
|
+
PassportAuthUserServiceApi,
|
|
1445
|
+
Configuration,
|
|
1446
|
+
PassportSendVerificationEmailRequest
|
|
1447
|
+
} from '@cherryin/passport-api-client';
|
|
1448
|
+
|
|
1449
|
+
const configuration = new Configuration();
|
|
1450
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1451
|
+
|
|
1452
|
+
let body: PassportSendVerificationEmailRequest; //
|
|
1453
|
+
|
|
1454
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportSendVerificationEmail(
|
|
1455
|
+
body
|
|
1456
|
+
);
|
|
1457
|
+
```
|
|
1458
|
+
|
|
1459
|
+
### Parameters
|
|
1460
|
+
|
|
1461
|
+
|Name | Type | Description | Notes|
|
|
1462
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1463
|
+
| **body** | **PassportSendVerificationEmailRequest**| | |
|
|
1464
|
+
|
|
1465
|
+
|
|
1466
|
+
### Return type
|
|
1467
|
+
|
|
1468
|
+
**PassportSendVerificationEmailResponse**
|
|
1469
|
+
|
|
1470
|
+
### Authorization
|
|
1471
|
+
|
|
1472
|
+
No authorization required
|
|
1473
|
+
|
|
1474
|
+
### HTTP request headers
|
|
1475
|
+
|
|
1476
|
+
- **Content-Type**: application/json
|
|
1477
|
+
- **Accept**: application/json
|
|
1478
|
+
|
|
1479
|
+
|
|
1480
|
+
### HTTP response details
|
|
1481
|
+
| Status code | Description | Response headers |
|
|
1482
|
+
|-------------|-------------|------------------|
|
|
1483
|
+
|**200** | A successful response. | - |
|
|
1484
|
+
|**0** | An unexpected error response. | - |
|
|
1485
|
+
|
|
1486
|
+
[[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)
|
|
1487
|
+
|
|
1488
|
+
# **passportAuthUserServicePassportSendVerificationPhone**
|
|
1489
|
+
> PassportSendVerificationPhoneResponse passportAuthUserServicePassportSendVerificationPhone(body)
|
|
1490
|
+
|
|
1491
|
+
|
|
1492
|
+
### Example
|
|
1493
|
+
|
|
1494
|
+
```typescript
|
|
1495
|
+
import {
|
|
1496
|
+
PassportAuthUserServiceApi,
|
|
1497
|
+
Configuration,
|
|
1498
|
+
PassportSendVerificationPhoneRequest
|
|
1499
|
+
} from '@cherryin/passport-api-client';
|
|
1500
|
+
|
|
1501
|
+
const configuration = new Configuration();
|
|
1502
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1503
|
+
|
|
1504
|
+
let body: PassportSendVerificationPhoneRequest; //
|
|
1505
|
+
|
|
1506
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportSendVerificationPhone(
|
|
1507
|
+
body
|
|
1508
|
+
);
|
|
1509
|
+
```
|
|
1510
|
+
|
|
1511
|
+
### Parameters
|
|
1512
|
+
|
|
1513
|
+
|Name | Type | Description | Notes|
|
|
1514
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1515
|
+
| **body** | **PassportSendVerificationPhoneRequest**| | |
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
### Return type
|
|
1519
|
+
|
|
1520
|
+
**PassportSendVerificationPhoneResponse**
|
|
1521
|
+
|
|
1522
|
+
### Authorization
|
|
1523
|
+
|
|
1524
|
+
No authorization required
|
|
1525
|
+
|
|
1526
|
+
### HTTP request headers
|
|
1527
|
+
|
|
1528
|
+
- **Content-Type**: application/json
|
|
1529
|
+
- **Accept**: application/json
|
|
1530
|
+
|
|
1531
|
+
|
|
1532
|
+
### HTTP response details
|
|
1533
|
+
| Status code | Description | Response headers |
|
|
1534
|
+
|-------------|-------------|------------------|
|
|
1535
|
+
|**200** | A successful response. | - |
|
|
1536
|
+
|**0** | An unexpected error response. | - |
|
|
1537
|
+
|
|
1538
|
+
[[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)
|
|
1539
|
+
|
|
1540
|
+
# **passportAuthUserServicePassportUserOAuthCallback**
|
|
1541
|
+
> PassportUserOAuthCallbackResponse passportAuthUserServicePassportUserOAuthCallback()
|
|
1542
|
+
|
|
1543
|
+
|
|
1544
|
+
### Example
|
|
1545
|
+
|
|
1546
|
+
```typescript
|
|
1547
|
+
import {
|
|
1548
|
+
PassportAuthUserServiceApi,
|
|
1549
|
+
Configuration
|
|
1550
|
+
} from '@cherryin/passport-api-client';
|
|
1551
|
+
|
|
1552
|
+
const configuration = new Configuration();
|
|
1553
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1554
|
+
|
|
1555
|
+
let platform: string; //@gotags: form:\"platform\" google/github (default to undefined)
|
|
1556
|
+
let appIds: string; //User.AppID, 支持多个应用同时登录,如果对应 App 的账号,无法完成登录 NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" (optional) (default to undefined)
|
|
1557
|
+
let code: string; //@gotags: form:\"code\" OAuth 授权码 (optional) (default to undefined)
|
|
1558
|
+
let state: string; //@gotags: form:\"state\" CSRF state (optional) (default to undefined)
|
|
1559
|
+
|
|
1560
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportUserOAuthCallback(
|
|
1561
|
+
platform,
|
|
1562
|
+
appIds,
|
|
1563
|
+
code,
|
|
1564
|
+
state
|
|
1565
|
+
);
|
|
1566
|
+
```
|
|
1567
|
+
|
|
1568
|
+
### Parameters
|
|
1569
|
+
|
|
1570
|
+
|Name | Type | Description | Notes|
|
|
1571
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1572
|
+
| **platform** | [**string**] | @gotags: form:\"platform\" google/github | defaults to undefined|
|
|
1573
|
+
| **appIds** | [**string**] | User.AppID, 支持多个应用同时登录,如果对应 App 的账号,无法完成登录 NOTE: app_ids 是 \':\' 分隔的字符串列表 @gotags: form:\"app_ids\" | (optional) defaults to undefined|
|
|
1574
|
+
| **code** | [**string**] | @gotags: form:\"code\" OAuth 授权码 | (optional) defaults to undefined|
|
|
1575
|
+
| **state** | [**string**] | @gotags: form:\"state\" CSRF state | (optional) defaults to undefined|
|
|
1576
|
+
|
|
1577
|
+
|
|
1578
|
+
### Return type
|
|
1579
|
+
|
|
1580
|
+
**PassportUserOAuthCallbackResponse**
|
|
1581
|
+
|
|
1582
|
+
### Authorization
|
|
1583
|
+
|
|
1584
|
+
No authorization required
|
|
1585
|
+
|
|
1586
|
+
### HTTP request headers
|
|
1587
|
+
|
|
1588
|
+
- **Content-Type**: Not defined
|
|
1589
|
+
- **Accept**: application/json
|
|
1590
|
+
|
|
1591
|
+
|
|
1592
|
+
### HTTP response details
|
|
1593
|
+
| Status code | Description | Response headers |
|
|
1594
|
+
|-------------|-------------|------------------|
|
|
1595
|
+
|**200** | A successful response. | - |
|
|
1596
|
+
|**0** | An unexpected error response. | - |
|
|
1597
|
+
|
|
1598
|
+
[[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)
|
|
1599
|
+
|
|
1600
|
+
# **passportAuthUserServicePassportUserPasswordForget**
|
|
1601
|
+
> PassportUserPasswordForgetResponse passportAuthUserServicePassportUserPasswordForget(body)
|
|
1602
|
+
|
|
1603
|
+
|
|
1604
|
+
### Example
|
|
1605
|
+
|
|
1606
|
+
```typescript
|
|
1607
|
+
import {
|
|
1608
|
+
PassportAuthUserServiceApi,
|
|
1609
|
+
Configuration,
|
|
1610
|
+
PassportUserPasswordForgetRequest
|
|
1611
|
+
} from '@cherryin/passport-api-client';
|
|
1612
|
+
|
|
1613
|
+
const configuration = new Configuration();
|
|
1614
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1615
|
+
|
|
1616
|
+
let body: PassportUserPasswordForgetRequest; //
|
|
1617
|
+
|
|
1618
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportUserPasswordForget(
|
|
1619
|
+
body
|
|
1620
|
+
);
|
|
1621
|
+
```
|
|
1622
|
+
|
|
1623
|
+
### Parameters
|
|
1624
|
+
|
|
1625
|
+
|Name | Type | Description | Notes|
|
|
1626
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1627
|
+
| **body** | **PassportUserPasswordForgetRequest**| | |
|
|
1628
|
+
|
|
1629
|
+
|
|
1630
|
+
### Return type
|
|
1631
|
+
|
|
1632
|
+
**PassportUserPasswordForgetResponse**
|
|
1633
|
+
|
|
1634
|
+
### Authorization
|
|
1635
|
+
|
|
1636
|
+
No authorization required
|
|
1637
|
+
|
|
1638
|
+
### HTTP request headers
|
|
1639
|
+
|
|
1640
|
+
- **Content-Type**: application/json
|
|
1641
|
+
- **Accept**: application/json
|
|
1642
|
+
|
|
1643
|
+
|
|
1644
|
+
### HTTP response details
|
|
1645
|
+
| Status code | Description | Response headers |
|
|
1646
|
+
|-------------|-------------|------------------|
|
|
1647
|
+
|**200** | A successful response. | - |
|
|
1648
|
+
|**0** | An unexpected error response. | - |
|
|
1649
|
+
|
|
1650
|
+
[[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)
|
|
1651
|
+
|
|
1652
|
+
# **passportAuthUserServicePassportUserPasswordReset**
|
|
1653
|
+
> PassportUserPasswordResetResponse passportAuthUserServicePassportUserPasswordReset(body)
|
|
1654
|
+
|
|
1655
|
+
|
|
1656
|
+
### Example
|
|
1657
|
+
|
|
1658
|
+
```typescript
|
|
1659
|
+
import {
|
|
1660
|
+
PassportAuthUserServiceApi,
|
|
1661
|
+
Configuration,
|
|
1662
|
+
PassportUserPasswordResetRequest
|
|
1663
|
+
} from '@cherryin/passport-api-client';
|
|
1664
|
+
|
|
1665
|
+
const configuration = new Configuration();
|
|
1666
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1667
|
+
|
|
1668
|
+
let body: PassportUserPasswordResetRequest; //
|
|
1669
|
+
|
|
1670
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportUserPasswordReset(
|
|
1671
|
+
body
|
|
1672
|
+
);
|
|
1673
|
+
```
|
|
1674
|
+
|
|
1675
|
+
### Parameters
|
|
1676
|
+
|
|
1677
|
+
|Name | Type | Description | Notes|
|
|
1678
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1679
|
+
| **body** | **PassportUserPasswordResetRequest**| | |
|
|
1680
|
+
|
|
1681
|
+
|
|
1682
|
+
### Return type
|
|
1683
|
+
|
|
1684
|
+
**PassportUserPasswordResetResponse**
|
|
1685
|
+
|
|
1686
|
+
### Authorization
|
|
1687
|
+
|
|
1688
|
+
No authorization required
|
|
1689
|
+
|
|
1690
|
+
### HTTP request headers
|
|
1691
|
+
|
|
1692
|
+
- **Content-Type**: application/json
|
|
1693
|
+
- **Accept**: application/json
|
|
1694
|
+
|
|
1695
|
+
|
|
1696
|
+
### HTTP response details
|
|
1697
|
+
| Status code | Description | Response headers |
|
|
1698
|
+
|-------------|-------------|------------------|
|
|
1699
|
+
|**200** | A successful response. | - |
|
|
1700
|
+
|**0** | An unexpected error response. | - |
|
|
1701
|
+
|
|
1702
|
+
[[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)
|
|
1703
|
+
|
|
1704
|
+
# **passportAuthUserServicePassportUserPasswordResetTokenVerify**
|
|
1705
|
+
> PassportUserPasswordResetTokenVerifyResponse passportAuthUserServicePassportUserPasswordResetTokenVerify(body)
|
|
1706
|
+
|
|
1707
|
+
|
|
1708
|
+
### Example
|
|
1709
|
+
|
|
1710
|
+
```typescript
|
|
1711
|
+
import {
|
|
1712
|
+
PassportAuthUserServiceApi,
|
|
1713
|
+
Configuration,
|
|
1714
|
+
PassportUserPasswordResetTokenVerifyRequest
|
|
1715
|
+
} from '@cherryin/passport-api-client';
|
|
1716
|
+
|
|
1717
|
+
const configuration = new Configuration();
|
|
1718
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1719
|
+
|
|
1720
|
+
let body: PassportUserPasswordResetTokenVerifyRequest; //
|
|
1721
|
+
|
|
1722
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportUserPasswordResetTokenVerify(
|
|
1723
|
+
body
|
|
1724
|
+
);
|
|
1725
|
+
```
|
|
1726
|
+
|
|
1727
|
+
### Parameters
|
|
1728
|
+
|
|
1729
|
+
|Name | Type | Description | Notes|
|
|
1730
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1731
|
+
| **body** | **PassportUserPasswordResetTokenVerifyRequest**| | |
|
|
1732
|
+
|
|
1733
|
+
|
|
1734
|
+
### Return type
|
|
1735
|
+
|
|
1736
|
+
**PassportUserPasswordResetTokenVerifyResponse**
|
|
1737
|
+
|
|
1738
|
+
### Authorization
|
|
1739
|
+
|
|
1740
|
+
No authorization required
|
|
1741
|
+
|
|
1742
|
+
### HTTP request headers
|
|
1743
|
+
|
|
1744
|
+
- **Content-Type**: application/json
|
|
1745
|
+
- **Accept**: application/json
|
|
1746
|
+
|
|
1747
|
+
|
|
1748
|
+
### HTTP response details
|
|
1749
|
+
| Status code | Description | Response headers |
|
|
1750
|
+
|-------------|-------------|------------------|
|
|
1751
|
+
|**200** | A successful response. | - |
|
|
1752
|
+
|**0** | An unexpected error response. | - |
|
|
1753
|
+
|
|
1754
|
+
[[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)
|
|
1755
|
+
|
|
1756
|
+
# **passportAuthUserServicePassportUserSignInEmail**
|
|
1757
|
+
> PassportUserSignInEmailResponse passportAuthUserServicePassportUserSignInEmail(body)
|
|
1758
|
+
|
|
1759
|
+
|
|
1760
|
+
### Example
|
|
1761
|
+
|
|
1762
|
+
```typescript
|
|
1763
|
+
import {
|
|
1764
|
+
PassportAuthUserServiceApi,
|
|
1765
|
+
Configuration,
|
|
1766
|
+
PassportUserSignInEmailRequest
|
|
1767
|
+
} from '@cherryin/passport-api-client';
|
|
1768
|
+
|
|
1769
|
+
const configuration = new Configuration();
|
|
1770
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1771
|
+
|
|
1772
|
+
let body: PassportUserSignInEmailRequest; //
|
|
1773
|
+
|
|
1774
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportUserSignInEmail(
|
|
1775
|
+
body
|
|
1776
|
+
);
|
|
1777
|
+
```
|
|
1778
|
+
|
|
1779
|
+
### Parameters
|
|
1780
|
+
|
|
1781
|
+
|Name | Type | Description | Notes|
|
|
1782
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1783
|
+
| **body** | **PassportUserSignInEmailRequest**| | |
|
|
1784
|
+
|
|
1785
|
+
|
|
1786
|
+
### Return type
|
|
1787
|
+
|
|
1788
|
+
**PassportUserSignInEmailResponse**
|
|
1789
|
+
|
|
1790
|
+
### Authorization
|
|
1791
|
+
|
|
1792
|
+
No authorization required
|
|
1793
|
+
|
|
1794
|
+
### HTTP request headers
|
|
1795
|
+
|
|
1796
|
+
- **Content-Type**: application/json
|
|
1797
|
+
- **Accept**: application/json
|
|
1798
|
+
|
|
1799
|
+
|
|
1800
|
+
### HTTP response details
|
|
1801
|
+
| Status code | Description | Response headers |
|
|
1802
|
+
|-------------|-------------|------------------|
|
|
1803
|
+
|**200** | A successful response. | - |
|
|
1804
|
+
|**0** | An unexpected error response. | - |
|
|
1805
|
+
|
|
1806
|
+
[[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)
|
|
1807
|
+
|
|
1808
|
+
# **passportAuthUserServicePassportUserSignInPhone**
|
|
1809
|
+
> PassportUserSignInPhoneResponse passportAuthUserServicePassportUserSignInPhone(body)
|
|
1810
|
+
|
|
1811
|
+
|
|
1812
|
+
### Example
|
|
1813
|
+
|
|
1814
|
+
```typescript
|
|
1815
|
+
import {
|
|
1816
|
+
PassportAuthUserServiceApi,
|
|
1817
|
+
Configuration,
|
|
1818
|
+
PassportUserSignInPhoneRequest
|
|
1819
|
+
} from '@cherryin/passport-api-client';
|
|
1820
|
+
|
|
1821
|
+
const configuration = new Configuration();
|
|
1822
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1823
|
+
|
|
1824
|
+
let body: PassportUserSignInPhoneRequest; //
|
|
1825
|
+
|
|
1826
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportUserSignInPhone(
|
|
1827
|
+
body
|
|
1828
|
+
);
|
|
1829
|
+
```
|
|
1830
|
+
|
|
1831
|
+
### Parameters
|
|
1832
|
+
|
|
1833
|
+
|Name | Type | Description | Notes|
|
|
1834
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1835
|
+
| **body** | **PassportUserSignInPhoneRequest**| | |
|
|
1836
|
+
|
|
1837
|
+
|
|
1838
|
+
### Return type
|
|
1839
|
+
|
|
1840
|
+
**PassportUserSignInPhoneResponse**
|
|
1841
|
+
|
|
1842
|
+
### Authorization
|
|
1843
|
+
|
|
1844
|
+
No authorization required
|
|
1845
|
+
|
|
1846
|
+
### HTTP request headers
|
|
1847
|
+
|
|
1848
|
+
- **Content-Type**: application/json
|
|
1849
|
+
- **Accept**: application/json
|
|
1850
|
+
|
|
1851
|
+
|
|
1852
|
+
### HTTP response details
|
|
1853
|
+
| Status code | Description | Response headers |
|
|
1854
|
+
|-------------|-------------|------------------|
|
|
1855
|
+
|**200** | A successful response. | - |
|
|
1856
|
+
|**0** | An unexpected error response. | - |
|
|
1857
|
+
|
|
1858
|
+
[[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)
|
|
1859
|
+
|
|
1860
|
+
# **passportAuthUserServicePassportUserSignInSocial**
|
|
1861
|
+
> PassportUserSignInSocialResponse passportAuthUserServicePassportUserSignInSocial(body)
|
|
1862
|
+
|
|
1863
|
+
|
|
1864
|
+
### Example
|
|
1865
|
+
|
|
1866
|
+
```typescript
|
|
1867
|
+
import {
|
|
1868
|
+
PassportAuthUserServiceApi,
|
|
1869
|
+
Configuration,
|
|
1870
|
+
PassportUserSignInSocialRequest
|
|
1871
|
+
} from '@cherryin/passport-api-client';
|
|
1872
|
+
|
|
1873
|
+
const configuration = new Configuration();
|
|
1874
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1875
|
+
|
|
1876
|
+
let body: PassportUserSignInSocialRequest; //
|
|
1877
|
+
|
|
1878
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportUserSignInSocial(
|
|
1879
|
+
body
|
|
1880
|
+
);
|
|
1881
|
+
```
|
|
1882
|
+
|
|
1883
|
+
### Parameters
|
|
1884
|
+
|
|
1885
|
+
|Name | Type | Description | Notes|
|
|
1886
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1887
|
+
| **body** | **PassportUserSignInSocialRequest**| | |
|
|
1888
|
+
|
|
1889
|
+
|
|
1890
|
+
### Return type
|
|
1891
|
+
|
|
1892
|
+
**PassportUserSignInSocialResponse**
|
|
1893
|
+
|
|
1894
|
+
### Authorization
|
|
1895
|
+
|
|
1896
|
+
No authorization required
|
|
1897
|
+
|
|
1898
|
+
### HTTP request headers
|
|
1899
|
+
|
|
1900
|
+
- **Content-Type**: application/json
|
|
1901
|
+
- **Accept**: application/json
|
|
1902
|
+
|
|
1903
|
+
|
|
1904
|
+
### HTTP response details
|
|
1905
|
+
| Status code | Description | Response headers |
|
|
1906
|
+
|-------------|-------------|------------------|
|
|
1907
|
+
|**200** | A successful response. | - |
|
|
1908
|
+
|**0** | An unexpected error response. | - |
|
|
1909
|
+
|
|
1910
|
+
[[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)
|
|
1911
|
+
|
|
1912
|
+
# **passportAuthUserServicePassportUserSignUpEmail**
|
|
1913
|
+
> PassportUserSignUpEmailResponse passportAuthUserServicePassportUserSignUpEmail(body)
|
|
1914
|
+
|
|
1915
|
+
|
|
1916
|
+
### Example
|
|
1917
|
+
|
|
1918
|
+
```typescript
|
|
1919
|
+
import {
|
|
1920
|
+
PassportAuthUserServiceApi,
|
|
1921
|
+
Configuration,
|
|
1922
|
+
PassportUserSignUpEmailRequest
|
|
1923
|
+
} from '@cherryin/passport-api-client';
|
|
1924
|
+
|
|
1925
|
+
const configuration = new Configuration();
|
|
1926
|
+
const apiInstance = new PassportAuthUserServiceApi(configuration);
|
|
1927
|
+
|
|
1928
|
+
let body: PassportUserSignUpEmailRequest; //
|
|
1929
|
+
|
|
1930
|
+
const { status, data } = await apiInstance.passportAuthUserServicePassportUserSignUpEmail(
|
|
1931
|
+
body
|
|
1932
|
+
);
|
|
1933
|
+
```
|
|
1934
|
+
|
|
1935
|
+
### Parameters
|
|
1936
|
+
|
|
1937
|
+
|Name | Type | Description | Notes|
|
|
1938
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1939
|
+
| **body** | **PassportUserSignUpEmailRequest**| | |
|
|
1940
|
+
|
|
1941
|
+
|
|
1942
|
+
### Return type
|
|
1943
|
+
|
|
1944
|
+
**PassportUserSignUpEmailResponse**
|
|
1945
|
+
|
|
1946
|
+
### Authorization
|
|
1947
|
+
|
|
1948
|
+
No authorization required
|
|
1949
|
+
|
|
1950
|
+
### HTTP request headers
|
|
1951
|
+
|
|
1952
|
+
- **Content-Type**: application/json
|
|
1953
|
+
- **Accept**: application/json
|
|
1954
|
+
|
|
1955
|
+
|
|
1956
|
+
### HTTP response details
|
|
1957
|
+
| Status code | Description | Response headers |
|
|
1958
|
+
|-------------|-------------|------------------|
|
|
1959
|
+
|**200** | A successful response. | - |
|
|
1960
|
+
|**0** | An unexpected error response. | - |
|
|
1961
|
+
|
|
1962
|
+
[[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)
|
|
1963
|
+
|