@cherryin/api-client 0.0.8 → 0.0.10

package/docs/PassportAuthUserServiceApi.md

@@ -0,0 +1,1892 @@
+# PassportAuthUserServiceApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**passportAuthUserServicePassportAuthChangePassword**](#passportauthuserservicepassportauthchangepassword) | **POST** /passport/authed/v1/password/change | |
+|[**passportAuthUserServicePassportAuthDeleteAll**](#passportauthuserservicepassportauthdeleteall) | **POST** /passport/authed/v1/passport/request-delete | |
+|[**passportAuthUserServicePassportAuthInfoGet**](#passportauthuserservicepassportauthinfoget) | **GET** /passport/authed/v1/passport/info | |
+|[**passportAuthUserServicePassportAuthLinkSocial**](#passportauthuserservicepassportauthlinksocial) | **POST** /passport/authed/v1/social/link | |
+|[**passportAuthUserServicePassportAuthListMethods**](#passportauthuserservicepassportauthlistmethods) | **GET** /passport/authed/v1/passport/list-auth-methods | |
+|[**passportAuthUserServicePassportAuthListSessions**](#passportauthuserservicepassportauthlistsessions) | **GET** /passport/authed/v1/sessions/list | |
+|[**passportAuthUserServicePassportAuthListSocials**](#passportauthuserservicepassportauthlistsocials) | **GET** /passport/authed/v1/social/list-accounts | |
+|[**passportAuthUserServicePassportAuthRefreshSessionToken**](#passportauthuserservicepassportauthrefreshsessiontoken) | **POST** /passport/authed/v1/session/refresh-token | |
+|[**passportAuthUserServicePassportAuthResetPassword**](#passportauthuserservicepassportauthresetpassword) | **POST** /passport/authed/v1/password/reset | |
+|[**passportAuthUserServicePassportAuthRevokeOtherSessions**](#passportauthuserservicepassportauthrevokeothersessions) | **POST** /passport/authed/v1/sessions/revoke-other | |
+|[**passportAuthUserServicePassportAuthRevokeSession**](#passportauthuserservicepassportauthrevokesession) | **POST** /passport/authed/v1/session/revoke | |
+|[**passportAuthUserServicePassportAuthRevokeSessions**](#passportauthuserservicepassportauthrevokesessions) | **POST** /passport/authed/v1/sessions/revoke | |
+|[**passportAuthUserServicePassportAuthSendVerificationEmail**](#passportauthuserservicepassportauthsendverificationemail) | **POST** /passport/authed/v1/verification/send-email | |
+|[**passportAuthUserServicePassportAuthSendVerificationPhone**](#passportauthuserservicepassportauthsendverificationphone) | **POST** /passport/authed/v1/verification/send-phone | |
+|[**passportAuthUserServicePassportAuthSocialGetAccessToken**](#passportauthuserservicepassportauthsocialgetaccesstoken) | **POST** /passport/authed/v1/social/get-access-token | |
+|[**passportAuthUserServicePassportAuthSocialRefreshToken**](#passportauthuserservicepassportauthsocialrefreshtoken) | **POST** /passport/authed/v1/social/refresh-token | |
+|[**passportAuthUserServicePassportAuthUnlinkSocial**](#passportauthuserservicepassportauthunlinksocial) | **POST** /passport/authed/v1/social/unlink | |
+|[**passportAuthUserServicePassportAuthUserChangeEmail**](#passportauthuserservicepassportauthuserchangeemail) | **POST** /passport/authed/v1/email/change | |
+|[**passportAuthUserServicePassportAuthUserChangePhone**](#passportauthuserservicepassportauthuserchangephone) | **POST** /passport/authed/v1/phone/change | |
+|[**passportAuthUserServicePassportAuthUserDelete**](#passportauthuserservicepassportauthuserdelete) | **POST** /passport/authed/v1/user/request-delete | |
+|[**passportAuthUserServicePassportAuthUserGetSession**](#passportauthuserservicepassportauthusergetsession) | **GET** /passport/authed/v1/session/get | |
+|[**passportAuthUserServicePassportAuthUserInfoGet**](#passportauthuserservicepassportauthuserinfoget) | **GET** /passport/authed/v1/user/info | |
+|[**passportAuthUserServicePassportAuthUserSignOut**](#passportauthuserservicepassportauthusersignout) | **POST** /passport/authed/v1/sign-out | |
+|[**passportAuthUserServicePassportAuthUserUpdateInfo**](#passportauthuserservicepassportauthuserupdateinfo) | **POST** /passport/authed/v1/user/update-info | |
+|[**passportAuthUserServicePassportAuthUserUpdatePassport**](#passportauthuserservicepassportauthuserupdatepassport) | **POST** /passport/authed/v1/passport/update | |
+|[**passportAuthUserServicePassportAuthUserVerifyEmail**](#passportauthuserservicepassportauthuserverifyemail) | **POST** /passport/authed/v1/email/verify | |
+|[**passportAuthUserServicePassportAuthUserVerifyPhone**](#passportauthuserservicepassportauthuserverifyphone) | **POST** /passport/authed/v1/phone/verify | |
+|[**passportAuthUserServicePassportSendVerificationEmail**](#passportauthuserservicepassportsendverificationemail) | **POST** /passport/auth/v1/verification/send-email | |
+|[**passportAuthUserServicePassportSendVerificationPhone**](#passportauthuserservicepassportsendverificationphone) | **POST** /passport/auth/v1/verification/send-phone | |
+|[**passportAuthUserServicePassportUserOAuthCallback**](#passportauthuserservicepassportuseroauthcallback) | **GET** /passport/oauth2/{platform}/callback | |
+|[**passportAuthUserServicePassportUserPasswordReset**](#passportauthuserservicepassportuserpasswordreset) | **POST** /passport/auth/v1/password/request-reset | |
+|[**passportAuthUserServicePassportUserSignInEmail**](#passportauthuserservicepassportusersigninemail) | **POST** /passport/auth/v1/sign-in/email | |
+|[**passportAuthUserServicePassportUserSignInPhone**](#passportauthuserservicepassportusersigninphone) | **POST** /passport/auth/v1/sign-in/phone | |
+|[**passportAuthUserServicePassportUserSignInSocial**](#passportauthuserservicepassportusersigninsocial) | **POST** /passport/auth/v1/sign-in/social | |
+|[**passportAuthUserServicePassportUserSignUpEmail**](#passportauthuserservicepassportusersignupemail) | **POST** /passport/auth/v1/sign-up/email | |
+
+# **passportAuthUserServicePassportAuthChangePassword**
+> PassportAuthChangePasswordResponse passportAuthUserServicePassportAuthChangePassword(passportAuthChangePasswordRequest)
+
+已登录用户修改密码
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthChangePasswordRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthChangePasswordRequest: PassportAuthChangePasswordRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthChangePassword(
+    passportAuthChangePasswordRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthChangePasswordRequest** | **PassportAuthChangePasswordRequest**|  | |
+
+
+### Return type
+
+**PassportAuthChangePasswordResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthDeleteAll**
+> PassportAuthDeleteAllResponse passportAuthUserServicePassportAuthDeleteAll(passportAuthDeleteAllRequest)
+
+删除通行证及所有关联用户
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthDeleteAllRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthDeleteAllRequest: PassportAuthDeleteAllRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthDeleteAll(
+    passportAuthDeleteAllRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthDeleteAllRequest** | **PassportAuthDeleteAllRequest**|  | |
+
+
+### Return type
+
+**PassportAuthDeleteAllResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthInfoGet**
+> PassportAuthInfoGetResponse passportAuthUserServicePassportAuthInfoGet()
+
+获取通行证及用户信息
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表, 如果不指定则获取所有应用的用户信息 (optional) (default to undefined)
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthInfoGet(
+    appIds
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表, 如果不指定则获取所有应用的用户信息 | (optional) defaults to undefined|
+
+
+### Return type
+
+**PassportAuthInfoGetResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthLinkSocial**
+> PassportAuthLinkSocialResponse passportAuthUserServicePassportAuthLinkSocial(passportAuthLinkSocialRequest)
+
+已登录用户关联社交账号
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthLinkSocialRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthLinkSocialRequest: PassportAuthLinkSocialRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthLinkSocial(
+    passportAuthLinkSocialRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthLinkSocialRequest** | **PassportAuthLinkSocialRequest**|  | |
+
+
+### Return type
+
+**PassportAuthLinkSocialResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthListMethods**
+> PassportAuthListMethodsResponse passportAuthUserServicePassportAuthListMethods()
+
+列出已关联的认证方法(包含 邮箱/社交账号等)
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 (optional) (default to undefined)
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthListMethods(
+    appIds
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 | (optional) defaults to undefined|
+
+
+### Return type
+
+**PassportAuthListMethodsResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthListSessions**
+> PassportAuthListSessionsResponse passportAuthUserServicePassportAuthListSessions()
+
+获取当前用户的所有会话列表
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表  @gotags: form:\"app_ids\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthListSessions(
+    appIds
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表  @gotags: form:\"app_ids\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**PassportAuthListSessionsResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthListSocials**
+> PassportAuthListSocialsResponse passportAuthUserServicePassportAuthListSocials()
+
+列出已关联的认证方法(列出社交账号)
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表  @gotags: form:\"app_ids\" (optional) (default to undefined)
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthListSocials(
+    appIds
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表  @gotags: form:\"app_ids\" | (optional) defaults to undefined|
+
+
+### Return type
+
+**PassportAuthListSocialsResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthRefreshSessionToken**
+> PassportAuthRefreshSessionTokenResponse passportAuthUserServicePassportAuthRefreshSessionToken(passportAuthRefreshSessionTokenRequest)
+
+会话 token 刷新
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthRefreshSessionTokenRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthRefreshSessionTokenRequest: PassportAuthRefreshSessionTokenRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthRefreshSessionToken(
+    passportAuthRefreshSessionTokenRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthRefreshSessionTokenRequest** | **PassportAuthRefreshSessionTokenRequest**|  | |
+
+
+### Return type
+
+**PassportAuthRefreshSessionTokenResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthResetPassword**
+> PassportAuthResetPasswordResponse passportAuthUserServicePassportAuthResetPassword(passportAuthResetPasswordRequest)
+
+已登录用户重置密码
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthResetPasswordRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthResetPasswordRequest: PassportAuthResetPasswordRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthResetPassword(
+    passportAuthResetPasswordRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthResetPasswordRequest** | **PassportAuthResetPasswordRequest**|  | |
+
+
+### Return type
+
+**PassportAuthResetPasswordResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthRevokeOtherSessions**
+> PassportAuthRevokeOtherSessionsResponse passportAuthUserServicePassportAuthRevokeOtherSessions(passportAuthRevokeOtherSessionsRequest)
+
+注销其他会话
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthRevokeOtherSessionsRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthRevokeOtherSessionsRequest: PassportAuthRevokeOtherSessionsRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthRevokeOtherSessions(
+    passportAuthRevokeOtherSessionsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthRevokeOtherSessionsRequest** | **PassportAuthRevokeOtherSessionsRequest**|  | |
+
+
+### Return type
+
+**PassportAuthRevokeOtherSessionsResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthRevokeSession**
+> PassportAuthRevokeSessionResponse passportAuthUserServicePassportAuthRevokeSession(passportAuthRevokeSessionRequest)
+
+注销指定会话
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthRevokeSessionRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthRevokeSessionRequest: PassportAuthRevokeSessionRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthRevokeSession(
+    passportAuthRevokeSessionRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthRevokeSessionRequest** | **PassportAuthRevokeSessionRequest**|  | |
+
+
+### Return type
+
+**PassportAuthRevokeSessionResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthRevokeSessions**
+> PassportAuthRevokeSessionsResponse passportAuthUserServicePassportAuthRevokeSessions(passportAuthRevokeSessionsRequest)
+
+注销所有会话
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthRevokeSessionsRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthRevokeSessionsRequest: PassportAuthRevokeSessionsRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthRevokeSessions(
+    passportAuthRevokeSessionsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthRevokeSessionsRequest** | **PassportAuthRevokeSessionsRequest**|  | |
+
+
+### Return type
+
+**PassportAuthRevokeSessionsResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthSendVerificationEmail**
+> PassportAuthSendVerificationEmailResponse passportAuthUserServicePassportAuthSendVerificationEmail(passportAuthSendVerificationEmailRequest)
+
+用户认证后发送验证码
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthSendVerificationEmailRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthSendVerificationEmailRequest: PassportAuthSendVerificationEmailRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthSendVerificationEmail(
+    passportAuthSendVerificationEmailRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthSendVerificationEmailRequest** | **PassportAuthSendVerificationEmailRequest**|  | |
+
+
+### Return type
+
+**PassportAuthSendVerificationEmailResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthSendVerificationPhone**
+> PassportAuthSendVerificationPhoneResponse passportAuthUserServicePassportAuthSendVerificationPhone(passportAuthSendVerificationPhoneRequest)
+
+用户认证后发送验证码
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthSendVerificationPhoneRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthSendVerificationPhoneRequest: PassportAuthSendVerificationPhoneRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthSendVerificationPhone(
+    passportAuthSendVerificationPhoneRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthSendVerificationPhoneRequest** | **PassportAuthSendVerificationPhoneRequest**|  | |
+
+
+### Return type
+
+**PassportAuthSendVerificationPhoneResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthSocialGetAccessToken**
+> PassportAuthSocialGetAccessTokenResponse passportAuthUserServicePassportAuthSocialGetAccessToken(passportAuthSocialGetAccessTokenRequest)
+
+获取社交账号访问令牌
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthSocialGetAccessTokenRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthSocialGetAccessTokenRequest: PassportAuthSocialGetAccessTokenRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthSocialGetAccessToken(
+    passportAuthSocialGetAccessTokenRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthSocialGetAccessTokenRequest** | **PassportAuthSocialGetAccessTokenRequest**|  | |
+
+
+### Return type
+
+**PassportAuthSocialGetAccessTokenResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthSocialRefreshToken**
+> PassportAuthSocialRefreshTokenResponse passportAuthUserServicePassportAuthSocialRefreshToken(passportAuthSocialRefreshTokenRequest)
+
+社交账号刷新 Token
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthSocialRefreshTokenRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthSocialRefreshTokenRequest: PassportAuthSocialRefreshTokenRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthSocialRefreshToken(
+    passportAuthSocialRefreshTokenRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthSocialRefreshTokenRequest** | **PassportAuthSocialRefreshTokenRequest**|  | |
+
+
+### Return type
+
+**PassportAuthSocialRefreshTokenResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthUnlinkSocial**
+> PassportAuthUnlinkSocialResponse passportAuthUserServicePassportAuthUnlinkSocial(passportAuthUnlinkSocialRequest)
+
+已登录用户取消关联社交账号
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthUnlinkSocialRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthUnlinkSocialRequest: PassportAuthUnlinkSocialRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUnlinkSocial(
+    passportAuthUnlinkSocialRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthUnlinkSocialRequest** | **PassportAuthUnlinkSocialRequest**|  | |
+
+
+### Return type
+
+**PassportAuthUnlinkSocialResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthUserChangeEmail**
+> PassportAuthUserChangeEmailResponse passportAuthUserServicePassportAuthUserChangeEmail(passportAuthUserChangeEmailRequest)
+
+已登录用户更换邮箱
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthUserChangeEmailRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthUserChangeEmailRequest: PassportAuthUserChangeEmailRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserChangeEmail(
+    passportAuthUserChangeEmailRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthUserChangeEmailRequest** | **PassportAuthUserChangeEmailRequest**|  | |
+
+
+### Return type
+
+**PassportAuthUserChangeEmailResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthUserChangePhone**
+> PassportAuthUserChangePhoneResponse passportAuthUserServicePassportAuthUserChangePhone(passportAuthUserChangePhoneRequest)
+
+已登录用户更换手机号
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthUserChangePhoneRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthUserChangePhoneRequest: PassportAuthUserChangePhoneRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserChangePhone(
+    passportAuthUserChangePhoneRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthUserChangePhoneRequest** | **PassportAuthUserChangePhoneRequest**|  | |
+
+
+### Return type
+
+**PassportAuthUserChangePhoneResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthUserDelete**
+> PassportAuthUserDeleteResponse passportAuthUserServicePassportAuthUserDelete(passportAuthUserDeleteRequest)
+
+请求删除用户
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthUserDeleteRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthUserDeleteRequest: PassportAuthUserDeleteRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserDelete(
+    passportAuthUserDeleteRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthUserDeleteRequest** | **PassportAuthUserDeleteRequest**|  | |
+
+
+### Return type
+
+**PassportAuthUserDeleteResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthUserGetSession**
+> PassportAuthUserGetSessionResponse passportAuthUserServicePassportAuthUserGetSession()
+
+获取当前会话信息
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserGetSession();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**PassportAuthUserGetSessionResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthUserInfoGet**
+> PassportAuthUserInfoGetResponse passportAuthUserServicePassportAuthUserInfoGet()
+
+获取用户信息
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let appIds: string; //NOTE: app_ids 是 \':\' 分隔的字符串列表 (optional) (default to undefined)
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserInfoGet(
+    appIds
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **appIds** | [**string**] | NOTE: app_ids 是 \':\' 分隔的字符串列表 | (optional) defaults to undefined|
+
+
+### Return type
+
+**PassportAuthUserInfoGetResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthUserSignOut**
+> PassportAuthUserSignOutResponse passportAuthUserServicePassportAuthUserSignOut(passportAuthUserSignOutRequest)
+
+用户登出
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthUserSignOutRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthUserSignOutRequest: PassportAuthUserSignOutRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserSignOut(
+    passportAuthUserSignOutRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthUserSignOutRequest** | **PassportAuthUserSignOutRequest**|  | |
+
+
+### Return type
+
+**PassportAuthUserSignOutResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthUserUpdateInfo**
+> PassportAuthUserUpdateInfoResponse passportAuthUserServicePassportAuthUserUpdateInfo(passportAuthUserUpdateInfoRequest)
+
+更新用户信息
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthUserUpdateInfoRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthUserUpdateInfoRequest: PassportAuthUserUpdateInfoRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserUpdateInfo(
+    passportAuthUserUpdateInfoRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthUserUpdateInfoRequest** | **PassportAuthUserUpdateInfoRequest**|  | |
+
+
+### Return type
+
+**PassportAuthUserUpdateInfoResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthUserUpdatePassport**
+> PassportAuthUserUpdatePassportResponse passportAuthUserServicePassportAuthUserUpdatePassport(passportAuthUserUpdatePassportRequest)
+
+更新通行证信息
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthUserUpdatePassportRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthUserUpdatePassportRequest: PassportAuthUserUpdatePassportRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserUpdatePassport(
+    passportAuthUserUpdatePassportRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthUserUpdatePassportRequest** | **PassportAuthUserUpdatePassportRequest**|  | |
+
+
+### Return type
+
+**PassportAuthUserUpdatePassportResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthUserVerifyEmail**
+> PassportAuthUserVerifyEmailResponse passportAuthUserServicePassportAuthUserVerifyEmail(passportAuthUserVerifyEmailRequest)
+
+已登录用户验证邮箱
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthUserVerifyEmailRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthUserVerifyEmailRequest: PassportAuthUserVerifyEmailRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserVerifyEmail(
+    passportAuthUserVerifyEmailRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthUserVerifyEmailRequest** | **PassportAuthUserVerifyEmailRequest**|  | |
+
+
+### Return type
+
+**PassportAuthUserVerifyEmailResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportAuthUserVerifyPhone**
+> PassportAuthUserVerifyPhoneResponse passportAuthUserServicePassportAuthUserVerifyPhone(passportAuthUserVerifyPhoneRequest)
+
+已登录用户验证手机号
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportAuthUserVerifyPhoneRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportAuthUserVerifyPhoneRequest: PassportAuthUserVerifyPhoneRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportAuthUserVerifyPhone(
+    passportAuthUserVerifyPhoneRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportAuthUserVerifyPhoneRequest** | **PassportAuthUserVerifyPhoneRequest**|  | |
+
+
+### Return type
+
+**PassportAuthUserVerifyPhoneResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportSendVerificationEmail**
+> PassportSendVerificationEmailResponse passportAuthUserServicePassportSendVerificationEmail(passportSendVerificationEmailRequest)
+
+登录/注册流程中发送验证码
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportSendVerificationEmailRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportSendVerificationEmailRequest: PassportSendVerificationEmailRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportSendVerificationEmail(
+    passportSendVerificationEmailRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportSendVerificationEmailRequest** | **PassportSendVerificationEmailRequest**|  | |
+
+
+### Return type
+
+**PassportSendVerificationEmailResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportSendVerificationPhone**
+> PassportSendVerificationPhoneResponse passportAuthUserServicePassportSendVerificationPhone(passportSendVerificationPhoneRequest)
+
+登录/注册流程中发送验证码
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportSendVerificationPhoneRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportSendVerificationPhoneRequest: PassportSendVerificationPhoneRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportSendVerificationPhone(
+    passportSendVerificationPhoneRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportSendVerificationPhoneRequest** | **PassportSendVerificationPhoneRequest**|  | |
+
+
+### Return type
+
+**PassportSendVerificationPhoneResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportUserOAuthCallback**
+> PassportUserOAuthCallbackResponse passportAuthUserServicePassportUserOAuthCallback()
+
+OAuth 回调处理
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let platform: string; //@gotags: form:\"platform\"  google/github (default to undefined)
+let appIds: string; //User.AppID, 支持多个应用同时登录，如果对应 App 的账号，无法完成登录  NOTE: app_ids 是 \':\' 分隔的字符串列表  @gotags: form:\"app_ids\" (optional) (default to undefined)
+let code: string; //@gotags: form:\"code\"  OAuth 授权码 (optional) (default to undefined)
+let state: string; //@gotags: form:\"state\"  CSRF state (optional) (default to undefined)
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportUserOAuthCallback(
+    platform,
+    appIds,
+    code,
+    state
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **platform** | [**string**] | @gotags: form:\"platform\"  google/github | defaults to undefined|
+| **appIds** | [**string**] | User.AppID, 支持多个应用同时登录，如果对应 App 的账号，无法完成登录  NOTE: app_ids 是 \':\' 分隔的字符串列表  @gotags: form:\"app_ids\" | (optional) defaults to undefined|
+| **code** | [**string**] | @gotags: form:\"code\"  OAuth 授权码 | (optional) defaults to undefined|
+| **state** | [**string**] | @gotags: form:\"state\"  CSRF state | (optional) defaults to undefined|
+
+
+### Return type
+
+**PassportUserOAuthCallbackResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportUserPasswordReset**
+> PassportUserPasswordResetResponse passportAuthUserServicePassportUserPasswordReset(passportUserPasswordResetRequest)
+
+请求重置密码
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportUserPasswordResetRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportUserPasswordResetRequest: PassportUserPasswordResetRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportUserPasswordReset(
+    passportUserPasswordResetRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportUserPasswordResetRequest** | **PassportUserPasswordResetRequest**|  | |
+
+
+### Return type
+
+**PassportUserPasswordResetResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportUserSignInEmail**
+> PassportUserSignInEmailResponse passportAuthUserServicePassportUserSignInEmail(passportUserSignInEmailRequest)
+
+邮箱登录
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportUserSignInEmailRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportUserSignInEmailRequest: PassportUserSignInEmailRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportUserSignInEmail(
+    passportUserSignInEmailRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportUserSignInEmailRequest** | **PassportUserSignInEmailRequest**|  | |
+
+
+### Return type
+
+**PassportUserSignInEmailResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportUserSignInPhone**
+> PassportUserSignInPhoneResponse passportAuthUserServicePassportUserSignInPhone(passportUserSignInPhoneRequest)
+
+手机登录
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportUserSignInPhoneRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportUserSignInPhoneRequest: PassportUserSignInPhoneRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportUserSignInPhone(
+    passportUserSignInPhoneRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportUserSignInPhoneRequest** | **PassportUserSignInPhoneRequest**|  | |
+
+
+### Return type
+
+**PassportUserSignInPhoneResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportUserSignInSocial**
+> PassportUserSignInSocialResponse passportAuthUserServicePassportUserSignInSocial(passportUserSignInSocialRequest)
+
+社交登录
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportUserSignInSocialRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportUserSignInSocialRequest: PassportUserSignInSocialRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportUserSignInSocial(
+    passportUserSignInSocialRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportUserSignInSocialRequest** | **PassportUserSignInSocialRequest**|  | |
+
+
+### Return type
+
+**PassportUserSignInSocialResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+
+# **passportAuthUserServicePassportUserSignUpEmail**
+> PassportUserSignUpEmailResponse passportAuthUserServicePassportUserSignUpEmail(passportUserSignUpEmailRequest)
+
+邮箱注册
+
+### Example
+
+```typescript
+import {
+    PassportAuthUserServiceApi,
+    Configuration,
+    PassportUserSignUpEmailRequest
+} from '@cherryin/api-client';
+
+const configuration = new Configuration();
+const apiInstance = new PassportAuthUserServiceApi(configuration);
+
+let passportUserSignUpEmailRequest: PassportUserSignUpEmailRequest; //
+
+const { status, data } = await apiInstance.passportAuthUserServicePassportUserSignUpEmail(
+    passportUserSignUpEmailRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **passportUserSignUpEmailRequest** | **PassportUserSignUpEmailRequest**|  | |
+
+
+### Return type
+
+**PassportUserSignUpEmailResponse**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+|**0** | Default error response |  -  |
+
+[[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)
+