@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,1148 @@
|
|
|
1
|
+
# PassportAuthEnterpriseServiceApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseChangePassword**](#passportauthenterpriseservicepassportauthenterprisechangepassword) | **POST** /passport/enterprise/authed/v1/password/change | 已登录用户修改密码|
|
|
8
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseChangePhone**](#passportauthenterpriseservicepassportauthenterprisechangephone) | **POST** /passport/enterprise/authed/v1/phone/change | 已登录用户更换手机号|
|
|
9
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseDelete**](#passportauthenterpriseservicepassportauthenterprisedelete) | **POST** /passport/enterprise/authed/v1/user/request-delete | 请求删除用户|
|
|
10
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseGetSession**](#passportauthenterpriseservicepassportauthenterprisegetsession) | **GET** /passport/enterprise/authed/v1/session/get | 获取当前会话信息|
|
|
11
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseInfoGet**](#passportauthenterpriseservicepassportauthenterpriseinfoget) | **GET** /passport/enterprise/authed/v1/user/info | 获取用户信息|
|
|
12
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseListSessions**](#passportauthenterpriseservicepassportauthenterpriselistsessions) | **GET** /passport/enterprise/authed/v1/sessions/list | 获取当前用户的所有会话列表|
|
|
13
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseMaterialUpload**](#passportauthenterpriseservicepassportauthenterprisematerialupload) | **POST** /passport/enterprise/authed/v1/materials/upload | 上传企业认证材料|
|
|
14
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseMaterialVerifyState**](#passportauthenterpriseservicepassportauthenterprisematerialverifystate) | **POST** /passport/enterprise/authed/v1/materials/verified-state | 获取企业认证材料审核状态|
|
|
15
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseRefreshToken**](#passportauthenterpriseservicepassportauthenterpriserefreshtoken) | **POST** /passport/enterprise/authed/v1/session/refresh-token | 会话 token 刷新|
|
|
16
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseResetPassword**](#passportauthenterpriseservicepassportauthenterpriseresetpassword) | **POST** /passport/enterprise/authed/v1/password/request-reset | 已登录用户重置密码|
|
|
17
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseRevokeOtherSessions**](#passportauthenterpriseservicepassportauthenterpriserevokeothersessions) | **POST** /passport/enterprise/authed/v1/sessions/revoke-other | 注销其他会话|
|
|
18
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseRevokeSession**](#passportauthenterpriseservicepassportauthenterpriserevokesession) | **POST** /passport/enterprise/authed/v1/session/revoke | 注销指定会话|
|
|
19
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseRevokeSessions**](#passportauthenterpriseservicepassportauthenterpriserevokesessions) | **POST** /passport/enterprise/authed/v1/sessions/revoke-all | 注销所有会话|
|
|
20
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseSignOut**](#passportauthenterpriseservicepassportauthenterprisesignout) | **POST** /passport/enterprise/authed/v1/sign-out | 用户登出|
|
|
21
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseUpdateInfo**](#passportauthenterpriseservicepassportauthenterpriseupdateinfo) | **POST** /passport/enterprise/authed/v1/user/update-info | 更新用户信息|
|
|
22
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseVerifyEmail**](#passportauthenterpriseservicepassportauthenterpriseverifyemail) | **POST** /passport/enterprise/auth/v1/password/request-reset | 已登录用户验证邮箱|
|
|
23
|
+
|[**passportAuthEnterpriseServicePassportAuthEnterpriseVerifyPhone**](#passportauthenterpriseservicepassportauthenterpriseverifyphone) | **GET** /passport/enterprise/authed/v1/phone/verify | 已登录用户验证手机号|
|
|
24
|
+
|[**passportAuthEnterpriseServicePassportEnterpriseSendVerificationEmail**](#passportauthenterpriseservicepassportenterprisesendverificationemail) | **POST** /passport/enterprise/auth/v1/verification/send-email | 登录/注册流程中发送验证码|
|
|
25
|
+
|[**passportAuthEnterpriseServicePassportEnterpriseSendVerificationPhone**](#passportauthenterpriseservicepassportenterprisesendverificationphone) | **POST** /passport/enterprise/auth/v1/verification/send-phone | 登录/注册流程中发送验证码|
|
|
26
|
+
|[**passportAuthEnterpriseServicePassportEnterpriseSignInEmail**](#passportauthenterpriseservicepassportenterprisesigninemail) | **POST** /passport/enterprise/auth/v1/sign-in/email | 邮箱登录|
|
|
27
|
+
|[**passportAuthEnterpriseServicePassportEnterpriseSignInPhone**](#passportauthenterpriseservicepassportenterprisesigninphone) | **POST** /passport/enterprise/auth/v1/sign-in/phone | 手机登录|
|
|
28
|
+
|[**passportAuthEnterpriseServicePassportEnterpriseSignUpEmail**](#passportauthenterpriseservicepassportenterprisesignupemail) | **POST** /passport/enterprise/auth/v1/sign-up/email | 邮箱注册|
|
|
29
|
+
|
|
30
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseChangePassword**
|
|
31
|
+
> PassportAuthEnterpriseChangePasswordResponse passportAuthEnterpriseServicePassportAuthEnterpriseChangePassword(body)
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
### Example
|
|
35
|
+
|
|
36
|
+
```typescript
|
|
37
|
+
import {
|
|
38
|
+
PassportAuthEnterpriseServiceApi,
|
|
39
|
+
Configuration,
|
|
40
|
+
PassportAuthEnterpriseChangePasswordRequest
|
|
41
|
+
} from '@cherryin/passport-api-client';
|
|
42
|
+
|
|
43
|
+
const configuration = new Configuration();
|
|
44
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
45
|
+
|
|
46
|
+
let body: PassportAuthEnterpriseChangePasswordRequest; //
|
|
47
|
+
|
|
48
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseChangePassword(
|
|
49
|
+
body
|
|
50
|
+
);
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Parameters
|
|
54
|
+
|
|
55
|
+
|Name | Type | Description | Notes|
|
|
56
|
+
|------------- | ------------- | ------------- | -------------|
|
|
57
|
+
| **body** | **PassportAuthEnterpriseChangePasswordRequest**| | |
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### Return type
|
|
61
|
+
|
|
62
|
+
**PassportAuthEnterpriseChangePasswordResponse**
|
|
63
|
+
|
|
64
|
+
### Authorization
|
|
65
|
+
|
|
66
|
+
No authorization required
|
|
67
|
+
|
|
68
|
+
### HTTP request headers
|
|
69
|
+
|
|
70
|
+
- **Content-Type**: application/json
|
|
71
|
+
- **Accept**: application/json
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
### HTTP response details
|
|
75
|
+
| Status code | Description | Response headers |
|
|
76
|
+
|-------------|-------------|------------------|
|
|
77
|
+
|**200** | A successful response. | - |
|
|
78
|
+
|**0** | An unexpected error response. | - |
|
|
79
|
+
|
|
80
|
+
[[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)
|
|
81
|
+
|
|
82
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseChangePhone**
|
|
83
|
+
> PassportAuthEnterpriseChangePhoneResponse passportAuthEnterpriseServicePassportAuthEnterpriseChangePhone(body)
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
### Example
|
|
87
|
+
|
|
88
|
+
```typescript
|
|
89
|
+
import {
|
|
90
|
+
PassportAuthEnterpriseServiceApi,
|
|
91
|
+
Configuration,
|
|
92
|
+
PassportAuthEnterpriseChangePhoneRequest
|
|
93
|
+
} from '@cherryin/passport-api-client';
|
|
94
|
+
|
|
95
|
+
const configuration = new Configuration();
|
|
96
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
97
|
+
|
|
98
|
+
let body: PassportAuthEnterpriseChangePhoneRequest; //
|
|
99
|
+
|
|
100
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseChangePhone(
|
|
101
|
+
body
|
|
102
|
+
);
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### Parameters
|
|
106
|
+
|
|
107
|
+
|Name | Type | Description | Notes|
|
|
108
|
+
|------------- | ------------- | ------------- | -------------|
|
|
109
|
+
| **body** | **PassportAuthEnterpriseChangePhoneRequest**| | |
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
### Return type
|
|
113
|
+
|
|
114
|
+
**PassportAuthEnterpriseChangePhoneResponse**
|
|
115
|
+
|
|
116
|
+
### Authorization
|
|
117
|
+
|
|
118
|
+
No authorization required
|
|
119
|
+
|
|
120
|
+
### HTTP request headers
|
|
121
|
+
|
|
122
|
+
- **Content-Type**: application/json
|
|
123
|
+
- **Accept**: application/json
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
### HTTP response details
|
|
127
|
+
| Status code | Description | Response headers |
|
|
128
|
+
|-------------|-------------|------------------|
|
|
129
|
+
|**200** | A successful response. | - |
|
|
130
|
+
|**0** | An unexpected error response. | - |
|
|
131
|
+
|
|
132
|
+
[[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)
|
|
133
|
+
|
|
134
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseDelete**
|
|
135
|
+
> PassportAuthEnterpriseDeleteResponse passportAuthEnterpriseServicePassportAuthEnterpriseDelete(body)
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
### Example
|
|
139
|
+
|
|
140
|
+
```typescript
|
|
141
|
+
import {
|
|
142
|
+
PassportAuthEnterpriseServiceApi,
|
|
143
|
+
Configuration,
|
|
144
|
+
PassportAuthEnterpriseDeleteRequest
|
|
145
|
+
} from '@cherryin/passport-api-client';
|
|
146
|
+
|
|
147
|
+
const configuration = new Configuration();
|
|
148
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
149
|
+
|
|
150
|
+
let body: PassportAuthEnterpriseDeleteRequest; //
|
|
151
|
+
|
|
152
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseDelete(
|
|
153
|
+
body
|
|
154
|
+
);
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### Parameters
|
|
158
|
+
|
|
159
|
+
|Name | Type | Description | Notes|
|
|
160
|
+
|------------- | ------------- | ------------- | -------------|
|
|
161
|
+
| **body** | **PassportAuthEnterpriseDeleteRequest**| | |
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
### Return type
|
|
165
|
+
|
|
166
|
+
**PassportAuthEnterpriseDeleteResponse**
|
|
167
|
+
|
|
168
|
+
### Authorization
|
|
169
|
+
|
|
170
|
+
No authorization required
|
|
171
|
+
|
|
172
|
+
### HTTP request headers
|
|
173
|
+
|
|
174
|
+
- **Content-Type**: application/json
|
|
175
|
+
- **Accept**: application/json
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
### HTTP response details
|
|
179
|
+
| Status code | Description | Response headers |
|
|
180
|
+
|-------------|-------------|------------------|
|
|
181
|
+
|**200** | A successful response. | - |
|
|
182
|
+
|**0** | An unexpected error response. | - |
|
|
183
|
+
|
|
184
|
+
[[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)
|
|
185
|
+
|
|
186
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseGetSession**
|
|
187
|
+
> PassportAuthEnterpriseGetSessionResponse passportAuthEnterpriseServicePassportAuthEnterpriseGetSession()
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
### Example
|
|
191
|
+
|
|
192
|
+
```typescript
|
|
193
|
+
import {
|
|
194
|
+
PassportAuthEnterpriseServiceApi,
|
|
195
|
+
Configuration
|
|
196
|
+
} from '@cherryin/passport-api-client';
|
|
197
|
+
|
|
198
|
+
const configuration = new Configuration();
|
|
199
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
200
|
+
|
|
201
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseGetSession();
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
### Parameters
|
|
205
|
+
This endpoint does not have any parameters.
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
### Return type
|
|
209
|
+
|
|
210
|
+
**PassportAuthEnterpriseGetSessionResponse**
|
|
211
|
+
|
|
212
|
+
### Authorization
|
|
213
|
+
|
|
214
|
+
No authorization required
|
|
215
|
+
|
|
216
|
+
### HTTP request headers
|
|
217
|
+
|
|
218
|
+
- **Content-Type**: Not defined
|
|
219
|
+
- **Accept**: application/json
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
### HTTP response details
|
|
223
|
+
| Status code | Description | Response headers |
|
|
224
|
+
|-------------|-------------|------------------|
|
|
225
|
+
|**200** | A successful response. | - |
|
|
226
|
+
|**0** | An unexpected error response. | - |
|
|
227
|
+
|
|
228
|
+
[[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)
|
|
229
|
+
|
|
230
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseInfoGet**
|
|
231
|
+
> PassportAuthEnterpriseInfoGetResponse passportAuthEnterpriseServicePassportAuthEnterpriseInfoGet()
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
### Example
|
|
235
|
+
|
|
236
|
+
```typescript
|
|
237
|
+
import {
|
|
238
|
+
PassportAuthEnterpriseServiceApi,
|
|
239
|
+
Configuration
|
|
240
|
+
} from '@cherryin/passport-api-client';
|
|
241
|
+
|
|
242
|
+
const configuration = new Configuration();
|
|
243
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
244
|
+
|
|
245
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseInfoGet();
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
### Parameters
|
|
249
|
+
This endpoint does not have any parameters.
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
### Return type
|
|
253
|
+
|
|
254
|
+
**PassportAuthEnterpriseInfoGetResponse**
|
|
255
|
+
|
|
256
|
+
### Authorization
|
|
257
|
+
|
|
258
|
+
No authorization required
|
|
259
|
+
|
|
260
|
+
### HTTP request headers
|
|
261
|
+
|
|
262
|
+
- **Content-Type**: Not defined
|
|
263
|
+
- **Accept**: application/json
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
### HTTP response details
|
|
267
|
+
| Status code | Description | Response headers |
|
|
268
|
+
|-------------|-------------|------------------|
|
|
269
|
+
|**200** | A successful response. | - |
|
|
270
|
+
|**0** | An unexpected error response. | - |
|
|
271
|
+
|
|
272
|
+
[[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)
|
|
273
|
+
|
|
274
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseListSessions**
|
|
275
|
+
> PassportAuthEnterpriseListSessionsResponse passportAuthEnterpriseServicePassportAuthEnterpriseListSessions()
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
### Example
|
|
279
|
+
|
|
280
|
+
```typescript
|
|
281
|
+
import {
|
|
282
|
+
PassportAuthEnterpriseServiceApi,
|
|
283
|
+
Configuration
|
|
284
|
+
} from '@cherryin/passport-api-client';
|
|
285
|
+
|
|
286
|
+
const configuration = new Configuration();
|
|
287
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
288
|
+
|
|
289
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseListSessions();
|
|
290
|
+
```
|
|
291
|
+
|
|
292
|
+
### Parameters
|
|
293
|
+
This endpoint does not have any parameters.
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
### Return type
|
|
297
|
+
|
|
298
|
+
**PassportAuthEnterpriseListSessionsResponse**
|
|
299
|
+
|
|
300
|
+
### Authorization
|
|
301
|
+
|
|
302
|
+
No authorization required
|
|
303
|
+
|
|
304
|
+
### HTTP request headers
|
|
305
|
+
|
|
306
|
+
- **Content-Type**: Not defined
|
|
307
|
+
- **Accept**: application/json
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
### HTTP response details
|
|
311
|
+
| Status code | Description | Response headers |
|
|
312
|
+
|-------------|-------------|------------------|
|
|
313
|
+
|**200** | A successful response. | - |
|
|
314
|
+
|**0** | An unexpected error response. | - |
|
|
315
|
+
|
|
316
|
+
[[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)
|
|
317
|
+
|
|
318
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseMaterialUpload**
|
|
319
|
+
> PassportAuthEnterpriseMaterialUploadResponse passportAuthEnterpriseServicePassportAuthEnterpriseMaterialUpload(body)
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
### Example
|
|
323
|
+
|
|
324
|
+
```typescript
|
|
325
|
+
import {
|
|
326
|
+
PassportAuthEnterpriseServiceApi,
|
|
327
|
+
Configuration,
|
|
328
|
+
PassportAuthEnterpriseMaterialUploadRequest
|
|
329
|
+
} from '@cherryin/passport-api-client';
|
|
330
|
+
|
|
331
|
+
const configuration = new Configuration();
|
|
332
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
333
|
+
|
|
334
|
+
let body: PassportAuthEnterpriseMaterialUploadRequest; //
|
|
335
|
+
|
|
336
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseMaterialUpload(
|
|
337
|
+
body
|
|
338
|
+
);
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
### Parameters
|
|
342
|
+
|
|
343
|
+
|Name | Type | Description | Notes|
|
|
344
|
+
|------------- | ------------- | ------------- | -------------|
|
|
345
|
+
| **body** | **PassportAuthEnterpriseMaterialUploadRequest**| | |
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
### Return type
|
|
349
|
+
|
|
350
|
+
**PassportAuthEnterpriseMaterialUploadResponse**
|
|
351
|
+
|
|
352
|
+
### Authorization
|
|
353
|
+
|
|
354
|
+
No authorization required
|
|
355
|
+
|
|
356
|
+
### HTTP request headers
|
|
357
|
+
|
|
358
|
+
- **Content-Type**: application/json
|
|
359
|
+
- **Accept**: application/json
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
### HTTP response details
|
|
363
|
+
| Status code | Description | Response headers |
|
|
364
|
+
|-------------|-------------|------------------|
|
|
365
|
+
|**200** | A successful response. | - |
|
|
366
|
+
|**0** | An unexpected error response. | - |
|
|
367
|
+
|
|
368
|
+
[[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)
|
|
369
|
+
|
|
370
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseMaterialVerifyState**
|
|
371
|
+
> PassportAuthEnterpriseMaterialVerifyStateResponse passportAuthEnterpriseServicePassportAuthEnterpriseMaterialVerifyState(body)
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
### Example
|
|
375
|
+
|
|
376
|
+
```typescript
|
|
377
|
+
import {
|
|
378
|
+
PassportAuthEnterpriseServiceApi,
|
|
379
|
+
Configuration
|
|
380
|
+
} from '@cherryin/passport-api-client';
|
|
381
|
+
|
|
382
|
+
const configuration = new Configuration();
|
|
383
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
384
|
+
|
|
385
|
+
let body: object; //
|
|
386
|
+
|
|
387
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseMaterialVerifyState(
|
|
388
|
+
body
|
|
389
|
+
);
|
|
390
|
+
```
|
|
391
|
+
|
|
392
|
+
### Parameters
|
|
393
|
+
|
|
394
|
+
|Name | Type | Description | Notes|
|
|
395
|
+
|------------- | ------------- | ------------- | -------------|
|
|
396
|
+
| **body** | **object**| | |
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
### Return type
|
|
400
|
+
|
|
401
|
+
**PassportAuthEnterpriseMaterialVerifyStateResponse**
|
|
402
|
+
|
|
403
|
+
### Authorization
|
|
404
|
+
|
|
405
|
+
No authorization required
|
|
406
|
+
|
|
407
|
+
### HTTP request headers
|
|
408
|
+
|
|
409
|
+
- **Content-Type**: application/json
|
|
410
|
+
- **Accept**: application/json
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
### HTTP response details
|
|
414
|
+
| Status code | Description | Response headers |
|
|
415
|
+
|-------------|-------------|------------------|
|
|
416
|
+
|**200** | A successful response. | - |
|
|
417
|
+
|**0** | An unexpected error response. | - |
|
|
418
|
+
|
|
419
|
+
[[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)
|
|
420
|
+
|
|
421
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseRefreshToken**
|
|
422
|
+
> PassportAuthEnterpriseRefreshTokenResponse passportAuthEnterpriseServicePassportAuthEnterpriseRefreshToken(body)
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
### Example
|
|
426
|
+
|
|
427
|
+
```typescript
|
|
428
|
+
import {
|
|
429
|
+
PassportAuthEnterpriseServiceApi,
|
|
430
|
+
Configuration,
|
|
431
|
+
PassportAuthEnterpriseRefreshTokenRequest
|
|
432
|
+
} from '@cherryin/passport-api-client';
|
|
433
|
+
|
|
434
|
+
const configuration = new Configuration();
|
|
435
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
436
|
+
|
|
437
|
+
let body: PassportAuthEnterpriseRefreshTokenRequest; //
|
|
438
|
+
|
|
439
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseRefreshToken(
|
|
440
|
+
body
|
|
441
|
+
);
|
|
442
|
+
```
|
|
443
|
+
|
|
444
|
+
### Parameters
|
|
445
|
+
|
|
446
|
+
|Name | Type | Description | Notes|
|
|
447
|
+
|------------- | ------------- | ------------- | -------------|
|
|
448
|
+
| **body** | **PassportAuthEnterpriseRefreshTokenRequest**| | |
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
### Return type
|
|
452
|
+
|
|
453
|
+
**PassportAuthEnterpriseRefreshTokenResponse**
|
|
454
|
+
|
|
455
|
+
### Authorization
|
|
456
|
+
|
|
457
|
+
No authorization required
|
|
458
|
+
|
|
459
|
+
### HTTP request headers
|
|
460
|
+
|
|
461
|
+
- **Content-Type**: application/json
|
|
462
|
+
- **Accept**: application/json
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
### HTTP response details
|
|
466
|
+
| Status code | Description | Response headers |
|
|
467
|
+
|-------------|-------------|------------------|
|
|
468
|
+
|**200** | A successful response. | - |
|
|
469
|
+
|**0** | An unexpected error response. | - |
|
|
470
|
+
|
|
471
|
+
[[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)
|
|
472
|
+
|
|
473
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseResetPassword**
|
|
474
|
+
> PassportAuthEnterpriseResetPasswordResponse passportAuthEnterpriseServicePassportAuthEnterpriseResetPassword(body)
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
### Example
|
|
478
|
+
|
|
479
|
+
```typescript
|
|
480
|
+
import {
|
|
481
|
+
PassportAuthEnterpriseServiceApi,
|
|
482
|
+
Configuration,
|
|
483
|
+
PassportAuthEnterpriseResetPasswordRequest
|
|
484
|
+
} from '@cherryin/passport-api-client';
|
|
485
|
+
|
|
486
|
+
const configuration = new Configuration();
|
|
487
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
488
|
+
|
|
489
|
+
let body: PassportAuthEnterpriseResetPasswordRequest; //
|
|
490
|
+
|
|
491
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseResetPassword(
|
|
492
|
+
body
|
|
493
|
+
);
|
|
494
|
+
```
|
|
495
|
+
|
|
496
|
+
### Parameters
|
|
497
|
+
|
|
498
|
+
|Name | Type | Description | Notes|
|
|
499
|
+
|------------- | ------------- | ------------- | -------------|
|
|
500
|
+
| **body** | **PassportAuthEnterpriseResetPasswordRequest**| | |
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
### Return type
|
|
504
|
+
|
|
505
|
+
**PassportAuthEnterpriseResetPasswordResponse**
|
|
506
|
+
|
|
507
|
+
### Authorization
|
|
508
|
+
|
|
509
|
+
No authorization required
|
|
510
|
+
|
|
511
|
+
### HTTP request headers
|
|
512
|
+
|
|
513
|
+
- **Content-Type**: application/json
|
|
514
|
+
- **Accept**: application/json
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
### HTTP response details
|
|
518
|
+
| Status code | Description | Response headers |
|
|
519
|
+
|-------------|-------------|------------------|
|
|
520
|
+
|**200** | A successful response. | - |
|
|
521
|
+
|**0** | An unexpected error response. | - |
|
|
522
|
+
|
|
523
|
+
[[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)
|
|
524
|
+
|
|
525
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseRevokeOtherSessions**
|
|
526
|
+
> PassportAuthEnterpriseRevokeOtherSessionsResponse passportAuthEnterpriseServicePassportAuthEnterpriseRevokeOtherSessions(body)
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
### Example
|
|
530
|
+
|
|
531
|
+
```typescript
|
|
532
|
+
import {
|
|
533
|
+
PassportAuthEnterpriseServiceApi,
|
|
534
|
+
Configuration
|
|
535
|
+
} from '@cherryin/passport-api-client';
|
|
536
|
+
|
|
537
|
+
const configuration = new Configuration();
|
|
538
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
539
|
+
|
|
540
|
+
let body: object; //
|
|
541
|
+
|
|
542
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseRevokeOtherSessions(
|
|
543
|
+
body
|
|
544
|
+
);
|
|
545
|
+
```
|
|
546
|
+
|
|
547
|
+
### Parameters
|
|
548
|
+
|
|
549
|
+
|Name | Type | Description | Notes|
|
|
550
|
+
|------------- | ------------- | ------------- | -------------|
|
|
551
|
+
| **body** | **object**| | |
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
### Return type
|
|
555
|
+
|
|
556
|
+
**PassportAuthEnterpriseRevokeOtherSessionsResponse**
|
|
557
|
+
|
|
558
|
+
### Authorization
|
|
559
|
+
|
|
560
|
+
No authorization required
|
|
561
|
+
|
|
562
|
+
### HTTP request headers
|
|
563
|
+
|
|
564
|
+
- **Content-Type**: application/json
|
|
565
|
+
- **Accept**: application/json
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
### HTTP response details
|
|
569
|
+
| Status code | Description | Response headers |
|
|
570
|
+
|-------------|-------------|------------------|
|
|
571
|
+
|**200** | A successful response. | - |
|
|
572
|
+
|**0** | An unexpected error response. | - |
|
|
573
|
+
|
|
574
|
+
[[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)
|
|
575
|
+
|
|
576
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseRevokeSession**
|
|
577
|
+
> PassportAuthEnterpriseRevokeSessionResponse passportAuthEnterpriseServicePassportAuthEnterpriseRevokeSession(body)
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
### Example
|
|
581
|
+
|
|
582
|
+
```typescript
|
|
583
|
+
import {
|
|
584
|
+
PassportAuthEnterpriseServiceApi,
|
|
585
|
+
Configuration,
|
|
586
|
+
PassportAuthEnterpriseRevokeSessionRequest
|
|
587
|
+
} from '@cherryin/passport-api-client';
|
|
588
|
+
|
|
589
|
+
const configuration = new Configuration();
|
|
590
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
591
|
+
|
|
592
|
+
let body: PassportAuthEnterpriseRevokeSessionRequest; //
|
|
593
|
+
|
|
594
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseRevokeSession(
|
|
595
|
+
body
|
|
596
|
+
);
|
|
597
|
+
```
|
|
598
|
+
|
|
599
|
+
### Parameters
|
|
600
|
+
|
|
601
|
+
|Name | Type | Description | Notes|
|
|
602
|
+
|------------- | ------------- | ------------- | -------------|
|
|
603
|
+
| **body** | **PassportAuthEnterpriseRevokeSessionRequest**| | |
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
### Return type
|
|
607
|
+
|
|
608
|
+
**PassportAuthEnterpriseRevokeSessionResponse**
|
|
609
|
+
|
|
610
|
+
### Authorization
|
|
611
|
+
|
|
612
|
+
No authorization required
|
|
613
|
+
|
|
614
|
+
### HTTP request headers
|
|
615
|
+
|
|
616
|
+
- **Content-Type**: application/json
|
|
617
|
+
- **Accept**: application/json
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
### HTTP response details
|
|
621
|
+
| Status code | Description | Response headers |
|
|
622
|
+
|-------------|-------------|------------------|
|
|
623
|
+
|**200** | A successful response. | - |
|
|
624
|
+
|**0** | An unexpected error response. | - |
|
|
625
|
+
|
|
626
|
+
[[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)
|
|
627
|
+
|
|
628
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseRevokeSessions**
|
|
629
|
+
> PassportAuthEnterpriseRevokeSessionsResponse passportAuthEnterpriseServicePassportAuthEnterpriseRevokeSessions(body)
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
### Example
|
|
633
|
+
|
|
634
|
+
```typescript
|
|
635
|
+
import {
|
|
636
|
+
PassportAuthEnterpriseServiceApi,
|
|
637
|
+
Configuration
|
|
638
|
+
} from '@cherryin/passport-api-client';
|
|
639
|
+
|
|
640
|
+
const configuration = new Configuration();
|
|
641
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
642
|
+
|
|
643
|
+
let body: object; //
|
|
644
|
+
|
|
645
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseRevokeSessions(
|
|
646
|
+
body
|
|
647
|
+
);
|
|
648
|
+
```
|
|
649
|
+
|
|
650
|
+
### Parameters
|
|
651
|
+
|
|
652
|
+
|Name | Type | Description | Notes|
|
|
653
|
+
|------------- | ------------- | ------------- | -------------|
|
|
654
|
+
| **body** | **object**| | |
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
### Return type
|
|
658
|
+
|
|
659
|
+
**PassportAuthEnterpriseRevokeSessionsResponse**
|
|
660
|
+
|
|
661
|
+
### Authorization
|
|
662
|
+
|
|
663
|
+
No authorization required
|
|
664
|
+
|
|
665
|
+
### HTTP request headers
|
|
666
|
+
|
|
667
|
+
- **Content-Type**: application/json
|
|
668
|
+
- **Accept**: application/json
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
### HTTP response details
|
|
672
|
+
| Status code | Description | Response headers |
|
|
673
|
+
|-------------|-------------|------------------|
|
|
674
|
+
|**200** | A successful response. | - |
|
|
675
|
+
|**0** | An unexpected error response. | - |
|
|
676
|
+
|
|
677
|
+
[[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)
|
|
678
|
+
|
|
679
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseSignOut**
|
|
680
|
+
> PassportAuthEnterpriseSignOutResponse passportAuthEnterpriseServicePassportAuthEnterpriseSignOut(body)
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
### Example
|
|
684
|
+
|
|
685
|
+
```typescript
|
|
686
|
+
import {
|
|
687
|
+
PassportAuthEnterpriseServiceApi,
|
|
688
|
+
Configuration,
|
|
689
|
+
PassportAuthEnterpriseSignOutRequest
|
|
690
|
+
} from '@cherryin/passport-api-client';
|
|
691
|
+
|
|
692
|
+
const configuration = new Configuration();
|
|
693
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
694
|
+
|
|
695
|
+
let body: PassportAuthEnterpriseSignOutRequest; //
|
|
696
|
+
|
|
697
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseSignOut(
|
|
698
|
+
body
|
|
699
|
+
);
|
|
700
|
+
```
|
|
701
|
+
|
|
702
|
+
### Parameters
|
|
703
|
+
|
|
704
|
+
|Name | Type | Description | Notes|
|
|
705
|
+
|------------- | ------------- | ------------- | -------------|
|
|
706
|
+
| **body** | **PassportAuthEnterpriseSignOutRequest**| | |
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
### Return type
|
|
710
|
+
|
|
711
|
+
**PassportAuthEnterpriseSignOutResponse**
|
|
712
|
+
|
|
713
|
+
### Authorization
|
|
714
|
+
|
|
715
|
+
No authorization required
|
|
716
|
+
|
|
717
|
+
### HTTP request headers
|
|
718
|
+
|
|
719
|
+
- **Content-Type**: application/json
|
|
720
|
+
- **Accept**: application/json
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
### HTTP response details
|
|
724
|
+
| Status code | Description | Response headers |
|
|
725
|
+
|-------------|-------------|------------------|
|
|
726
|
+
|**200** | A successful response. | - |
|
|
727
|
+
|**0** | An unexpected error response. | - |
|
|
728
|
+
|
|
729
|
+
[[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)
|
|
730
|
+
|
|
731
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseUpdateInfo**
|
|
732
|
+
> PassportAuthEnterpriseUpdateInfoResponse passportAuthEnterpriseServicePassportAuthEnterpriseUpdateInfo(body)
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
### Example
|
|
736
|
+
|
|
737
|
+
```typescript
|
|
738
|
+
import {
|
|
739
|
+
PassportAuthEnterpriseServiceApi,
|
|
740
|
+
Configuration,
|
|
741
|
+
PassportAuthEnterpriseUpdateInfoRequest
|
|
742
|
+
} from '@cherryin/passport-api-client';
|
|
743
|
+
|
|
744
|
+
const configuration = new Configuration();
|
|
745
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
746
|
+
|
|
747
|
+
let body: PassportAuthEnterpriseUpdateInfoRequest; //
|
|
748
|
+
|
|
749
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseUpdateInfo(
|
|
750
|
+
body
|
|
751
|
+
);
|
|
752
|
+
```
|
|
753
|
+
|
|
754
|
+
### Parameters
|
|
755
|
+
|
|
756
|
+
|Name | Type | Description | Notes|
|
|
757
|
+
|------------- | ------------- | ------------- | -------------|
|
|
758
|
+
| **body** | **PassportAuthEnterpriseUpdateInfoRequest**| | |
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
### Return type
|
|
762
|
+
|
|
763
|
+
**PassportAuthEnterpriseUpdateInfoResponse**
|
|
764
|
+
|
|
765
|
+
### Authorization
|
|
766
|
+
|
|
767
|
+
No authorization required
|
|
768
|
+
|
|
769
|
+
### HTTP request headers
|
|
770
|
+
|
|
771
|
+
- **Content-Type**: application/json
|
|
772
|
+
- **Accept**: application/json
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
### HTTP response details
|
|
776
|
+
| Status code | Description | Response headers |
|
|
777
|
+
|-------------|-------------|------------------|
|
|
778
|
+
|**200** | A successful response. | - |
|
|
779
|
+
|**0** | An unexpected error response. | - |
|
|
780
|
+
|
|
781
|
+
[[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)
|
|
782
|
+
|
|
783
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseVerifyEmail**
|
|
784
|
+
> PassportAuthEnterpriseVerifyEmailResponse passportAuthEnterpriseServicePassportAuthEnterpriseVerifyEmail(body)
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
### Example
|
|
788
|
+
|
|
789
|
+
```typescript
|
|
790
|
+
import {
|
|
791
|
+
PassportAuthEnterpriseServiceApi,
|
|
792
|
+
Configuration,
|
|
793
|
+
PassportAuthEnterpriseVerifyEmailRequest
|
|
794
|
+
} from '@cherryin/passport-api-client';
|
|
795
|
+
|
|
796
|
+
const configuration = new Configuration();
|
|
797
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
798
|
+
|
|
799
|
+
let body: PassportAuthEnterpriseVerifyEmailRequest; //
|
|
800
|
+
|
|
801
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseVerifyEmail(
|
|
802
|
+
body
|
|
803
|
+
);
|
|
804
|
+
```
|
|
805
|
+
|
|
806
|
+
### Parameters
|
|
807
|
+
|
|
808
|
+
|Name | Type | Description | Notes|
|
|
809
|
+
|------------- | ------------- | ------------- | -------------|
|
|
810
|
+
| **body** | **PassportAuthEnterpriseVerifyEmailRequest**| | |
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
### Return type
|
|
814
|
+
|
|
815
|
+
**PassportAuthEnterpriseVerifyEmailResponse**
|
|
816
|
+
|
|
817
|
+
### Authorization
|
|
818
|
+
|
|
819
|
+
No authorization required
|
|
820
|
+
|
|
821
|
+
### HTTP request headers
|
|
822
|
+
|
|
823
|
+
- **Content-Type**: application/json
|
|
824
|
+
- **Accept**: application/json
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
### HTTP response details
|
|
828
|
+
| Status code | Description | Response headers |
|
|
829
|
+
|-------------|-------------|------------------|
|
|
830
|
+
|**200** | A successful response. | - |
|
|
831
|
+
|**0** | An unexpected error response. | - |
|
|
832
|
+
|
|
833
|
+
[[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)
|
|
834
|
+
|
|
835
|
+
# **passportAuthEnterpriseServicePassportAuthEnterpriseVerifyPhone**
|
|
836
|
+
> PassportAuthEnterpriseVerifyPhoneResponse passportAuthEnterpriseServicePassportAuthEnterpriseVerifyPhone()
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
### Example
|
|
840
|
+
|
|
841
|
+
```typescript
|
|
842
|
+
import {
|
|
843
|
+
PassportAuthEnterpriseServiceApi,
|
|
844
|
+
Configuration
|
|
845
|
+
} from '@cherryin/passport-api-client';
|
|
846
|
+
|
|
847
|
+
const configuration = new Configuration();
|
|
848
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
849
|
+
|
|
850
|
+
let phone: string; // (optional) (default to undefined)
|
|
851
|
+
let verifyCode: string; // (optional) (default to undefined)
|
|
852
|
+
|
|
853
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportAuthEnterpriseVerifyPhone(
|
|
854
|
+
phone,
|
|
855
|
+
verifyCode
|
|
856
|
+
);
|
|
857
|
+
```
|
|
858
|
+
|
|
859
|
+
### Parameters
|
|
860
|
+
|
|
861
|
+
|Name | Type | Description | Notes|
|
|
862
|
+
|------------- | ------------- | ------------- | -------------|
|
|
863
|
+
| **phone** | [**string**] | | (optional) defaults to undefined|
|
|
864
|
+
| **verifyCode** | [**string**] | | (optional) defaults to undefined|
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
### Return type
|
|
868
|
+
|
|
869
|
+
**PassportAuthEnterpriseVerifyPhoneResponse**
|
|
870
|
+
|
|
871
|
+
### Authorization
|
|
872
|
+
|
|
873
|
+
No authorization required
|
|
874
|
+
|
|
875
|
+
### HTTP request headers
|
|
876
|
+
|
|
877
|
+
- **Content-Type**: Not defined
|
|
878
|
+
- **Accept**: application/json
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
### HTTP response details
|
|
882
|
+
| Status code | Description | Response headers |
|
|
883
|
+
|-------------|-------------|------------------|
|
|
884
|
+
|**200** | A successful response. | - |
|
|
885
|
+
|**0** | An unexpected error response. | - |
|
|
886
|
+
|
|
887
|
+
[[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)
|
|
888
|
+
|
|
889
|
+
# **passportAuthEnterpriseServicePassportEnterpriseSendVerificationEmail**
|
|
890
|
+
> PassportEnterpriseSendVerificationEmailResponse passportAuthEnterpriseServicePassportEnterpriseSendVerificationEmail(body)
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
### Example
|
|
894
|
+
|
|
895
|
+
```typescript
|
|
896
|
+
import {
|
|
897
|
+
PassportAuthEnterpriseServiceApi,
|
|
898
|
+
Configuration,
|
|
899
|
+
PassportEnterpriseSendVerificationEmailRequest
|
|
900
|
+
} from '@cherryin/passport-api-client';
|
|
901
|
+
|
|
902
|
+
const configuration = new Configuration();
|
|
903
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
904
|
+
|
|
905
|
+
let body: PassportEnterpriseSendVerificationEmailRequest; //
|
|
906
|
+
|
|
907
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportEnterpriseSendVerificationEmail(
|
|
908
|
+
body
|
|
909
|
+
);
|
|
910
|
+
```
|
|
911
|
+
|
|
912
|
+
### Parameters
|
|
913
|
+
|
|
914
|
+
|Name | Type | Description | Notes|
|
|
915
|
+
|------------- | ------------- | ------------- | -------------|
|
|
916
|
+
| **body** | **PassportEnterpriseSendVerificationEmailRequest**| | |
|
|
917
|
+
|
|
918
|
+
|
|
919
|
+
### Return type
|
|
920
|
+
|
|
921
|
+
**PassportEnterpriseSendVerificationEmailResponse**
|
|
922
|
+
|
|
923
|
+
### Authorization
|
|
924
|
+
|
|
925
|
+
No authorization required
|
|
926
|
+
|
|
927
|
+
### HTTP request headers
|
|
928
|
+
|
|
929
|
+
- **Content-Type**: application/json
|
|
930
|
+
- **Accept**: application/json
|
|
931
|
+
|
|
932
|
+
|
|
933
|
+
### HTTP response details
|
|
934
|
+
| Status code | Description | Response headers |
|
|
935
|
+
|-------------|-------------|------------------|
|
|
936
|
+
|**200** | A successful response. | - |
|
|
937
|
+
|**0** | An unexpected error response. | - |
|
|
938
|
+
|
|
939
|
+
[[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)
|
|
940
|
+
|
|
941
|
+
# **passportAuthEnterpriseServicePassportEnterpriseSendVerificationPhone**
|
|
942
|
+
> PassportEnterpriseSendVerificationPhoneResponse passportAuthEnterpriseServicePassportEnterpriseSendVerificationPhone(body)
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
### Example
|
|
946
|
+
|
|
947
|
+
```typescript
|
|
948
|
+
import {
|
|
949
|
+
PassportAuthEnterpriseServiceApi,
|
|
950
|
+
Configuration,
|
|
951
|
+
PassportEnterpriseSendVerificationPhoneRequest
|
|
952
|
+
} from '@cherryin/passport-api-client';
|
|
953
|
+
|
|
954
|
+
const configuration = new Configuration();
|
|
955
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
956
|
+
|
|
957
|
+
let body: PassportEnterpriseSendVerificationPhoneRequest; //
|
|
958
|
+
|
|
959
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportEnterpriseSendVerificationPhone(
|
|
960
|
+
body
|
|
961
|
+
);
|
|
962
|
+
```
|
|
963
|
+
|
|
964
|
+
### Parameters
|
|
965
|
+
|
|
966
|
+
|Name | Type | Description | Notes|
|
|
967
|
+
|------------- | ------------- | ------------- | -------------|
|
|
968
|
+
| **body** | **PassportEnterpriseSendVerificationPhoneRequest**| | |
|
|
969
|
+
|
|
970
|
+
|
|
971
|
+
### Return type
|
|
972
|
+
|
|
973
|
+
**PassportEnterpriseSendVerificationPhoneResponse**
|
|
974
|
+
|
|
975
|
+
### Authorization
|
|
976
|
+
|
|
977
|
+
No authorization required
|
|
978
|
+
|
|
979
|
+
### HTTP request headers
|
|
980
|
+
|
|
981
|
+
- **Content-Type**: application/json
|
|
982
|
+
- **Accept**: application/json
|
|
983
|
+
|
|
984
|
+
|
|
985
|
+
### HTTP response details
|
|
986
|
+
| Status code | Description | Response headers |
|
|
987
|
+
|-------------|-------------|------------------|
|
|
988
|
+
|**200** | A successful response. | - |
|
|
989
|
+
|**0** | An unexpected error response. | - |
|
|
990
|
+
|
|
991
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
992
|
+
|
|
993
|
+
# **passportAuthEnterpriseServicePassportEnterpriseSignInEmail**
|
|
994
|
+
> PassportEnterpriseSignInEmailResponse passportAuthEnterpriseServicePassportEnterpriseSignInEmail(body)
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
### Example
|
|
998
|
+
|
|
999
|
+
```typescript
|
|
1000
|
+
import {
|
|
1001
|
+
PassportAuthEnterpriseServiceApi,
|
|
1002
|
+
Configuration,
|
|
1003
|
+
PassportEnterpriseSignInEmailRequest
|
|
1004
|
+
} from '@cherryin/passport-api-client';
|
|
1005
|
+
|
|
1006
|
+
const configuration = new Configuration();
|
|
1007
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
1008
|
+
|
|
1009
|
+
let body: PassportEnterpriseSignInEmailRequest; //
|
|
1010
|
+
|
|
1011
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportEnterpriseSignInEmail(
|
|
1012
|
+
body
|
|
1013
|
+
);
|
|
1014
|
+
```
|
|
1015
|
+
|
|
1016
|
+
### Parameters
|
|
1017
|
+
|
|
1018
|
+
|Name | Type | Description | Notes|
|
|
1019
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1020
|
+
| **body** | **PassportEnterpriseSignInEmailRequest**| | |
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
### Return type
|
|
1024
|
+
|
|
1025
|
+
**PassportEnterpriseSignInEmailResponse**
|
|
1026
|
+
|
|
1027
|
+
### Authorization
|
|
1028
|
+
|
|
1029
|
+
No authorization required
|
|
1030
|
+
|
|
1031
|
+
### HTTP request headers
|
|
1032
|
+
|
|
1033
|
+
- **Content-Type**: application/json
|
|
1034
|
+
- **Accept**: application/json
|
|
1035
|
+
|
|
1036
|
+
|
|
1037
|
+
### HTTP response details
|
|
1038
|
+
| Status code | Description | Response headers |
|
|
1039
|
+
|-------------|-------------|------------------|
|
|
1040
|
+
|**200** | A successful response. | - |
|
|
1041
|
+
|**0** | An unexpected error response. | - |
|
|
1042
|
+
|
|
1043
|
+
[[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)
|
|
1044
|
+
|
|
1045
|
+
# **passportAuthEnterpriseServicePassportEnterpriseSignInPhone**
|
|
1046
|
+
> PassportEnterpriseSignInPhoneResponse passportAuthEnterpriseServicePassportEnterpriseSignInPhone(body)
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
### Example
|
|
1050
|
+
|
|
1051
|
+
```typescript
|
|
1052
|
+
import {
|
|
1053
|
+
PassportAuthEnterpriseServiceApi,
|
|
1054
|
+
Configuration,
|
|
1055
|
+
PassportEnterpriseSignInPhoneRequest
|
|
1056
|
+
} from '@cherryin/passport-api-client';
|
|
1057
|
+
|
|
1058
|
+
const configuration = new Configuration();
|
|
1059
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
1060
|
+
|
|
1061
|
+
let body: PassportEnterpriseSignInPhoneRequest; //
|
|
1062
|
+
|
|
1063
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportEnterpriseSignInPhone(
|
|
1064
|
+
body
|
|
1065
|
+
);
|
|
1066
|
+
```
|
|
1067
|
+
|
|
1068
|
+
### Parameters
|
|
1069
|
+
|
|
1070
|
+
|Name | Type | Description | Notes|
|
|
1071
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1072
|
+
| **body** | **PassportEnterpriseSignInPhoneRequest**| | |
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
### Return type
|
|
1076
|
+
|
|
1077
|
+
**PassportEnterpriseSignInPhoneResponse**
|
|
1078
|
+
|
|
1079
|
+
### Authorization
|
|
1080
|
+
|
|
1081
|
+
No authorization required
|
|
1082
|
+
|
|
1083
|
+
### HTTP request headers
|
|
1084
|
+
|
|
1085
|
+
- **Content-Type**: application/json
|
|
1086
|
+
- **Accept**: application/json
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
### HTTP response details
|
|
1090
|
+
| Status code | Description | Response headers |
|
|
1091
|
+
|-------------|-------------|------------------|
|
|
1092
|
+
|**200** | A successful response. | - |
|
|
1093
|
+
|**0** | An unexpected error response. | - |
|
|
1094
|
+
|
|
1095
|
+
[[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)
|
|
1096
|
+
|
|
1097
|
+
# **passportAuthEnterpriseServicePassportEnterpriseSignUpEmail**
|
|
1098
|
+
> PassportEnterpriseSignUpEmailResponse passportAuthEnterpriseServicePassportEnterpriseSignUpEmail(body)
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
### Example
|
|
1102
|
+
|
|
1103
|
+
```typescript
|
|
1104
|
+
import {
|
|
1105
|
+
PassportAuthEnterpriseServiceApi,
|
|
1106
|
+
Configuration,
|
|
1107
|
+
PassportEnterpriseSignUpEmailRequest
|
|
1108
|
+
} from '@cherryin/passport-api-client';
|
|
1109
|
+
|
|
1110
|
+
const configuration = new Configuration();
|
|
1111
|
+
const apiInstance = new PassportAuthEnterpriseServiceApi(configuration);
|
|
1112
|
+
|
|
1113
|
+
let body: PassportEnterpriseSignUpEmailRequest; //
|
|
1114
|
+
|
|
1115
|
+
const { status, data } = await apiInstance.passportAuthEnterpriseServicePassportEnterpriseSignUpEmail(
|
|
1116
|
+
body
|
|
1117
|
+
);
|
|
1118
|
+
```
|
|
1119
|
+
|
|
1120
|
+
### Parameters
|
|
1121
|
+
|
|
1122
|
+
|Name | Type | Description | Notes|
|
|
1123
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1124
|
+
| **body** | **PassportEnterpriseSignUpEmailRequest**| | |
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
### Return type
|
|
1128
|
+
|
|
1129
|
+
**PassportEnterpriseSignUpEmailResponse**
|
|
1130
|
+
|
|
1131
|
+
### Authorization
|
|
1132
|
+
|
|
1133
|
+
No authorization required
|
|
1134
|
+
|
|
1135
|
+
### HTTP request headers
|
|
1136
|
+
|
|
1137
|
+
- **Content-Type**: application/json
|
|
1138
|
+
- **Accept**: application/json
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
### HTTP response details
|
|
1142
|
+
| Status code | Description | Response headers |
|
|
1143
|
+
|-------------|-------------|------------------|
|
|
1144
|
+
|**200** | A successful response. | - |
|
|
1145
|
+
|**0** | An unexpected error response. | - |
|
|
1146
|
+
|
|
1147
|
+
[[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)
|
|
1148
|
+
|