520 lines
16 KiB
Markdown
520 lines
16 KiB
Markdown
// Filename: /Users/liur/work/api-sdk-gen/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/api_doc.mustache
|
||
# UserApi
|
||
|
||
All URIs are relative to *http://localhost*
|
||
|
||
| Method | HTTP request | Description |
|
||
|------------- | ------------- | -------------|
|
||
| [**callList**](UserApi.md#callList) | **GET** /v1/users | 查询用户列表 |
|
||
| [**create**](UserApi.md#create) | **POST** /v1/users | 创建用户 |
|
||
| [**createStoreCredential**](UserApi.md#createStoreCredential) | **POST** /v1/user-stored-credentials | 创建用户存储凭证 |
|
||
| [**delete**](UserApi.md#delete) | **DELETE** /v1/users/{id} | 删除用户 |
|
||
| [**get**](UserApi.md#get) | **GET** /v1/users/{id} | 查询用户详情 |
|
||
| [**getStoredCredentials**](UserApi.md#getStoredCredentials) | **GET** /v1/user-stored-credentials | 查询用户存储凭证列表 |
|
||
| [**modify**](UserApi.md#modify) | **PATCH** /v1/users/{id} | 编辑用户 |
|
||
|
||
|
||
<a id="callList"></a>
|
||
# **callList**
|
||
> List200Response callList().pageSize(pageSize).pageNum(pageNum).searchType(searchType).keyword(keyword).timeModifiedFrom(timeModifiedFrom).timeModifiedTo(timeModifiedTo).execute();
|
||
|
||
查询用户列表
|
||
|
||
|
||
|
||
### Example
|
||
```java
|
||
// Import classes:
|
||
import com.idmesh.ApiClient;
|
||
import com.idmesh.ApiException;
|
||
import com.idmesh.Configuration;
|
||
import com.idmesh.models.*;
|
||
import com.idmesh.api.UserApi;
|
||
|
||
public class Example {
|
||
public static void main(String[] args) {
|
||
ApiClient defaultClient = new ApiClient("basePath", "ak", "sk");
|
||
|
||
UserApi apiInstance = new UserApi(defaultClient);
|
||
Integer pageSize = 10; // Integer |
|
||
Integer pageNum = 1; // Integer |
|
||
String searchType = ""; // String | 默认按用户基础字段搜索；当值为：generic时，全文检索
|
||
String keyword = ""; // String | 检索值
|
||
String timeModifiedFrom = "timeModifiedFrom_example"; // String | 开始时间
|
||
String timeModifiedTo = "timeModifiedTo_example"; // String | 结束时间
|
||
try {
|
||
List200Response result = apiInstance.callList()
|
||
.pageSize(pageSize)
|
||
.pageNum(pageNum)
|
||
.searchType(searchType)
|
||
.keyword(keyword)
|
||
.timeModifiedFrom(timeModifiedFrom)
|
||
.timeModifiedTo(timeModifiedTo)
|
||
.execute();
|
||
System.out.println(result);
|
||
} catch (ApiException e) {
|
||
System.err.println("Exception when calling UserApi#callList");
|
||
System.err.println("Status code: " + e.getCode());
|
||
System.err.println("Reason: " + e.getResponseBody());
|
||
System.err.println("Response headers: " + e.getResponseHeaders());
|
||
e.printStackTrace();
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
### Parameters
|
||
|
||
| Name | Type | Description | Notes |
|
||
|------------- | ------------- | ------------- | -------------|
|
||
| **pageSize** | **Integer**| | [optional] |
|
||
| **pageNum** | **Integer**| | [optional] |
|
||
| **searchType** | **String**| 默认按用户基础字段搜索；当值为：generic时，全文检索 | [optional] |
|
||
| **keyword** | **String**| 检索值 | [optional] |
|
||
| **timeModifiedFrom** | **String**| 开始时间 | [optional] |
|
||
| **timeModifiedTo** | **String**| 结束时间 | [optional] |
|
||
|
||
### Return type
|
||
|
||
[**List200Response**](List200Response.md)
|
||
|
||
### Authorization
|
||
|
||
No authorization required
|
||
|
||
### HTTP request headers
|
||
|
||
- **Content-Type**: Not defined
|
||
- **Accept**: application/json
|
||
|
||
### HTTP response details
|
||
| Status code | Description | Response headers |
|
||
|-------------|-------------|------------------|
|
||
| **200** | 成功 | - |
|
||
| **400** | 参数错误 | - |
|
||
|
||
<a id="create"></a>
|
||
# **create**
|
||
> Modify200Response create(contentType).createRequest(createRequest).execute();
|
||
|
||
创建用户
|
||
|
||
|
||
|
||
### Example
|
||
```java
|
||
// Import classes:
|
||
import com.idmesh.ApiClient;
|
||
import com.idmesh.ApiException;
|
||
import com.idmesh.Configuration;
|
||
import com.idmesh.models.*;
|
||
import com.idmesh.api.UserApi;
|
||
|
||
public class Example {
|
||
public static void main(String[] args) {
|
||
ApiClient defaultClient = new ApiClient("basePath", "ak", "sk");
|
||
|
||
UserApi apiInstance = new UserApi(defaultClient);
|
||
String contentType = "application/json"; // String |
|
||
CreateRequest createRequest = new CreateRequest(); // CreateRequest |
|
||
try {
|
||
Modify200Response result = apiInstance.create(contentType)
|
||
.createRequest(createRequest)
|
||
.execute();
|
||
System.out.println(result);
|
||
} catch (ApiException e) {
|
||
System.err.println("Exception when calling UserApi#create");
|
||
System.err.println("Status code: " + e.getCode());
|
||
System.err.println("Reason: " + e.getResponseBody());
|
||
System.err.println("Response headers: " + e.getResponseHeaders());
|
||
e.printStackTrace();
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
### Parameters
|
||
|
||
| Name | Type | Description | Notes |
|
||
|------------- | ------------- | ------------- | -------------|
|
||
| **contentType** | **String**| | |
|
||
| **createRequest** | [**CreateRequest**](CreateRequest.md)| | [optional] |
|
||
|
||
### Return type
|
||
|
||
[**Modify200Response**](Modify200Response.md)
|
||
|
||
### Authorization
|
||
|
||
No authorization required
|
||
|
||
### HTTP request headers
|
||
|
||
- **Content-Type**: application/json
|
||
- **Accept**: application/json
|
||
|
||
### HTTP response details
|
||
| Status code | Description | Response headers |
|
||
|-------------|-------------|------------------|
|
||
| **200** | 成功 | - |
|
||
| **400** | 参数错误 | - |
|
||
|
||
<a id="createStoreCredential"></a>
|
||
# **createStoreCredential**
|
||
> CreateStoreCredential200Response createStoreCredential(contentType).createStoreCredentialRequest(createStoreCredentialRequest).execute();
|
||
|
||
创建用户存储凭证
|
||
|
||
|
||
|
||
### Example
|
||
```java
|
||
// Import classes:
|
||
import com.idmesh.ApiClient;
|
||
import com.idmesh.ApiException;
|
||
import com.idmesh.Configuration;
|
||
import com.idmesh.models.*;
|
||
import com.idmesh.api.UserApi;
|
||
|
||
public class Example {
|
||
public static void main(String[] args) {
|
||
ApiClient defaultClient = new ApiClient("basePath", "ak", "sk");
|
||
|
||
UserApi apiInstance = new UserApi(defaultClient);
|
||
String contentType = "application/json"; // String |
|
||
CreateStoreCredentialRequest createStoreCredentialRequest = new CreateStoreCredentialRequest(); // CreateStoreCredentialRequest |
|
||
try {
|
||
CreateStoreCredential200Response result = apiInstance.createStoreCredential(contentType)
|
||
.createStoreCredentialRequest(createStoreCredentialRequest)
|
||
.execute();
|
||
System.out.println(result);
|
||
} catch (ApiException e) {
|
||
System.err.println("Exception when calling UserApi#createStoreCredential");
|
||
System.err.println("Status code: " + e.getCode());
|
||
System.err.println("Reason: " + e.getResponseBody());
|
||
System.err.println("Response headers: " + e.getResponseHeaders());
|
||
e.printStackTrace();
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
### Parameters
|
||
|
||
| Name | Type | Description | Notes |
|
||
|------------- | ------------- | ------------- | -------------|
|
||
| **contentType** | **String**| | |
|
||
| **createStoreCredentialRequest** | [**CreateStoreCredentialRequest**](CreateStoreCredentialRequest.md)| | [optional] |
|
||
|
||
### Return type
|
||
|
||
[**CreateStoreCredential200Response**](CreateStoreCredential200Response.md)
|
||
|
||
### Authorization
|
||
|
||
No authorization required
|
||
|
||
### HTTP request headers
|
||
|
||
- **Content-Type**: application/json
|
||
- **Accept**: application/json
|
||
|
||
### HTTP response details
|
||
| Status code | Description | Response headers |
|
||
|-------------|-------------|------------------|
|
||
| **200** | 成功 | - |
|
||
| **400** | 参数错误 | - |
|
||
|
||
<a id="delete"></a>
|
||
# **delete**
|
||
> Delete200Response delete(id, contentType).execute();
|
||
|
||
删除用户
|
||
|
||
|
||
|
||
### Example
|
||
```java
|
||
// Import classes:
|
||
import com.idmesh.ApiClient;
|
||
import com.idmesh.ApiException;
|
||
import com.idmesh.Configuration;
|
||
import com.idmesh.models.*;
|
||
import com.idmesh.api.UserApi;
|
||
|
||
public class Example {
|
||
public static void main(String[] args) {
|
||
ApiClient defaultClient = new ApiClient("basePath", "ak", "sk");
|
||
|
||
UserApi apiInstance = new UserApi(defaultClient);
|
||
String id = "id_example"; // String |
|
||
String contentType = "application/x-www-form-urlencoded"; // String |
|
||
try {
|
||
Delete200Response result = apiInstance.delete(id, contentType)
|
||
.execute();
|
||
System.out.println(result);
|
||
} catch (ApiException e) {
|
||
System.err.println("Exception when calling UserApi#delete");
|
||
System.err.println("Status code: " + e.getCode());
|
||
System.err.println("Reason: " + e.getResponseBody());
|
||
System.err.println("Response headers: " + e.getResponseHeaders());
|
||
e.printStackTrace();
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
### Parameters
|
||
|
||
| Name | Type | Description | Notes |
|
||
|------------- | ------------- | ------------- | -------------|
|
||
| **id** | **String**| | |
|
||
| **contentType** | **String**| | |
|
||
|
||
### Return type
|
||
|
||
[**Delete200Response**](Delete200Response.md)
|
||
|
||
### Authorization
|
||
|
||
No authorization required
|
||
|
||
### HTTP request headers
|
||
|
||
- **Content-Type**: Not defined
|
||
- **Accept**: application/json
|
||
|
||
### HTTP response details
|
||
| Status code | Description | Response headers |
|
||
|-------------|-------------|------------------|
|
||
| **200** | 成功 | - |
|
||
| **400** | 参数错误 | - |
|
||
|
||
<a id="get"></a>
|
||
# **get**
|
||
> Get200Response get(id).execute();
|
||
|
||
查询用户详情
|
||
|
||
|
||
|
||
### Example
|
||
```java
|
||
// Import classes:
|
||
import com.idmesh.ApiClient;
|
||
import com.idmesh.ApiException;
|
||
import com.idmesh.Configuration;
|
||
import com.idmesh.models.*;
|
||
import com.idmesh.api.UserApi;
|
||
|
||
public class Example {
|
||
public static void main(String[] args) {
|
||
ApiClient defaultClient = new ApiClient("basePath", "ak", "sk");
|
||
|
||
UserApi apiInstance = new UserApi(defaultClient);
|
||
String id = "id_example"; // String |
|
||
try {
|
||
Get200Response result = apiInstance.get(id)
|
||
.execute();
|
||
System.out.println(result);
|
||
} catch (ApiException e) {
|
||
System.err.println("Exception when calling UserApi#get");
|
||
System.err.println("Status code: " + e.getCode());
|
||
System.err.println("Reason: " + e.getResponseBody());
|
||
System.err.println("Response headers: " + e.getResponseHeaders());
|
||
e.printStackTrace();
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
### Parameters
|
||
|
||
| Name | Type | Description | Notes |
|
||
|------------- | ------------- | ------------- | -------------|
|
||
| **id** | **String**| | |
|
||
|
||
### Return type
|
||
|
||
[**Get200Response**](Get200Response.md)
|
||
|
||
### Authorization
|
||
|
||
No authorization required
|
||
|
||
### HTTP request headers
|
||
|
||
- **Content-Type**: Not defined
|
||
- **Accept**: application/json
|
||
|
||
### HTTP response details
|
||
| Status code | Description | Response headers |
|
||
|-------------|-------------|------------------|
|
||
| **200** | 成功 | - |
|
||
| **400** | 参数错误 | - |
|
||
|
||
<a id="getStoredCredentials"></a>
|
||
# **getStoredCredentials**
|
||
> GetStoredCredentials200Response getStoredCredentials(contentType).userId(userId).providerCode(providerCode).idpConfigId(idpConfigId).id1(id1).id2(id2).metadata(metadata).status(status).username(username).displayName(displayName).pageSize(pageSize).pageNum(pageNum).execute();
|
||
|
||
查询用户存储凭证列表
|
||
|
||
|
||
|
||
### Example
|
||
```java
|
||
// Import classes:
|
||
import com.idmesh.ApiClient;
|
||
import com.idmesh.ApiException;
|
||
import com.idmesh.Configuration;
|
||
import com.idmesh.models.*;
|
||
import com.idmesh.api.UserApi;
|
||
|
||
public class Example {
|
||
public static void main(String[] args) {
|
||
ApiClient defaultClient = new ApiClient("basePath", "ak", "sk");
|
||
|
||
UserApi apiInstance = new UserApi(defaultClient);
|
||
String contentType = "application/x-www-form-urlencoded"; // String |
|
||
BigDecimal userId = new BigDecimal(""); // BigDecimal | 用户id标识
|
||
String providerCode = ""; // String | 社会化登录提供者的code
|
||
BigDecimal idpConfigId = new BigDecimal(""); // BigDecimal | 社会化登录配置的ID
|
||
String id1 = ""; // String | 社会化身份标识1，约定此字段保存用户唯一标识，如openid
|
||
String id2 = ""; // String | 社会化身份标识2，如unionid
|
||
String metadata = ""; // String | 更多社会化身份标识
|
||
String status = ""; // String | 状态
|
||
String username = "username_example"; // String | 用户名
|
||
String displayName = "displayName_example"; // String | 显示名
|
||
Integer pageSize = ; // Integer |
|
||
Integer pageNum = ; // Integer |
|
||
try {
|
||
GetStoredCredentials200Response result = apiInstance.getStoredCredentials(contentType)
|
||
.userId(userId)
|
||
.providerCode(providerCode)
|
||
.idpConfigId(idpConfigId)
|
||
.id1(id1)
|
||
.id2(id2)
|
||
.metadata(metadata)
|
||
.status(status)
|
||
.username(username)
|
||
.displayName(displayName)
|
||
.pageSize(pageSize)
|
||
.pageNum(pageNum)
|
||
.execute();
|
||
System.out.println(result);
|
||
} catch (ApiException e) {
|
||
System.err.println("Exception when calling UserApi#getStoredCredentials");
|
||
System.err.println("Status code: " + e.getCode());
|
||
System.err.println("Reason: " + e.getResponseBody());
|
||
System.err.println("Response headers: " + e.getResponseHeaders());
|
||
e.printStackTrace();
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
### Parameters
|
||
|
||
| Name | Type | Description | Notes |
|
||
|------------- | ------------- | ------------- | -------------|
|
||
| **contentType** | **String**| | |
|
||
| **userId** | **BigDecimal**| 用户id标识 | [optional] |
|
||
| **providerCode** | **String**| 社会化登录提供者的code | [optional] |
|
||
| **idpConfigId** | **BigDecimal**| 社会化登录配置的ID | [optional] |
|
||
| **id1** | **String**| 社会化身份标识1，约定此字段保存用户唯一标识，如openid | [optional] |
|
||
| **id2** | **String**| 社会化身份标识2，如unionid | [optional] |
|
||
| **metadata** | **String**| 更多社会化身份标识 | [optional] |
|
||
| **status** | **String**| 状态 | [optional] |
|
||
| **username** | **String**| 用户名 | [optional] |
|
||
| **displayName** | **String**| 显示名 | [optional] |
|
||
| **pageSize** | **Integer**| | [optional] |
|
||
| **pageNum** | **Integer**| | [optional] |
|
||
|
||
### Return type
|
||
|
||
[**GetStoredCredentials200Response**](GetStoredCredentials200Response.md)
|
||
|
||
### Authorization
|
||
|
||
No authorization required
|
||
|
||
### HTTP request headers
|
||
|
||
- **Content-Type**: Not defined
|
||
- **Accept**: application/json
|
||
|
||
### HTTP response details
|
||
| Status code | Description | Response headers |
|
||
|-------------|-------------|------------------|
|
||
| **200** | 成功 | - |
|
||
| **400** | 参数错误 | - |
|
||
|
||
<a id="modify"></a>
|
||
# **modify**
|
||
> Modify200Response modify(id, contentType).modifyRequest(modifyRequest).execute();
|
||
|
||
编辑用户
|
||
|
||
|
||
|
||
### Example
|
||
```java
|
||
// Import classes:
|
||
import com.idmesh.ApiClient;
|
||
import com.idmesh.ApiException;
|
||
import com.idmesh.Configuration;
|
||
import com.idmesh.models.*;
|
||
import com.idmesh.api.UserApi;
|
||
|
||
public class Example {
|
||
public static void main(String[] args) {
|
||
ApiClient defaultClient = new ApiClient("basePath", "ak", "sk");
|
||
|
||
UserApi apiInstance = new UserApi(defaultClient);
|
||
String id = "id_example"; // String |
|
||
String contentType = "application/json"; // String |
|
||
ModifyRequest modifyRequest = new ModifyRequest(); // ModifyRequest |
|
||
try {
|
||
Modify200Response result = apiInstance.modify(id, contentType)
|
||
.modifyRequest(modifyRequest)
|
||
.execute();
|
||
System.out.println(result);
|
||
} catch (ApiException e) {
|
||
System.err.println("Exception when calling UserApi#modify");
|
||
System.err.println("Status code: " + e.getCode());
|
||
System.err.println("Reason: " + e.getResponseBody());
|
||
System.err.println("Response headers: " + e.getResponseHeaders());
|
||
e.printStackTrace();
|
||
}
|
||
}
|
||
}
|
||
```
|
||
|
||
### Parameters
|
||
|
||
| Name | Type | Description | Notes |
|
||
|------------- | ------------- | ------------- | -------------|
|
||
| **id** | **String**| | |
|
||
| **contentType** | **String**| | |
|
||
| **modifyRequest** | [**ModifyRequest**](ModifyRequest.md)| | [optional] |
|
||
|
||
### Return type
|
||
|
||
[**Modify200Response**](Modify200Response.md)
|
||
|
||
### Authorization
|
||
|
||
No authorization required
|
||
|
||
### HTTP request headers
|
||
|
||
- **Content-Type**: application/json
|
||
- **Accept**: application/json
|
||
|
||
### HTTP response details
|
||
| Status code | Description | Response headers |
|
||
|-------------|-------------|------------------|
|
||
| **200** | 成功 | - |
|
||
| **400** | 参数错误 | - |
|
||
|