idmesh
/
idmesh-api-sdk-java
6
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity
idmesh-api-sdk-java/README.md

340 lines
20 KiB
Markdown
Raw Permalink Blame History

# idmesh-api-sdk-java
IDMesh-Dev
- API version: 1.0.0
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
## Requirements
Building the API client library requires:
1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)
## Installation
To install the API client library to your local Maven repository, simply execute:
```shell
mvn clean install
```
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
```shell
mvn clean deploy
```
Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
### Maven users
Add this dependency to your project's POM:
```xml
<dependency>
<groupId>com.idmesh</groupId>
<artifactId>idmesh-api-sdk-java</artifactId>
<version>1.0.0</version>
<scope>compile</scope>
</dependency>
```
### Gradle users
Add this dependency to your project's build file:
```groovy
repositories {
mavenCentral() // Needed if the 'idmesh-api-sdk-java' jar has been published to maven central.
mavenLocal() // Needed if the 'idmesh-api-sdk-java' jar has been published to the local maven repo.
}
dependencies {
implementation "com.idmesh:idmesh-api-sdk-java:1.0.0"
}
```
### Others
At first generate the JAR by executing:
```shell
mvn clean package
```
Then manually install the following JARs:
* `target/idmesh-api-sdk-java-1.0.0.jar`
* `target/lib/*.jar`
## Getting Started
Please follow the [installation](#installation) instruction and execute the following Java code:
```java
// Import classes:
import com.idmesh.ApiClient;
import com.idmesh.ApiException;
import com.idmesh.Configuration;
import com.idmesh.models.*;
import com.idmesh.api.AppApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = new ApiClient("basePath", "ak", "sk");
AppApi apiInstance = new AppApi(defaultClient);
String name = "name_example"; // String | 应用名称
String type = ""; // String | 应用类型
String pageSort = "time_created[desc]"; // String | 排序，格式：字段名[顺序]
String types = "1,2"; // String | 应用类型列表，逗号分隔
try {
List200Response1 result = apiInstance.callList()
.name(name)
.type(type)
.pageSort(pageSort)
.types(types)
.execute();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AppApi#callList");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AppApi* | [**callList**](docs/AppApi.md#callList) | **GET** /v1/applications | 查询应用列表
*AppApi* | [**create**](docs/AppApi.md#create) | **POST** /v1/applications | 创建应用
*AppApi* | [**createAccount**](docs/AppApi.md#createAccount) | **POST** /v1/applications/{id}/accounts | 创建应用子账号
*AppApi* | [**createIDP**](docs/AppApi.md#createIDP) | **POST** /v1/applications/{id}/idp | 创建应用认证源
*AppApi* | [**createMFA**](docs/AppApi.md#createMFA) | **POST** /v1/applications/{id}/mfa | 启用应用多因素认证配置
*AppApi* | [**createSecrets**](docs/AppApi.md#createSecrets) | **POST** /v1/applications/{id}/secrets | 刷新应用安全码
*AppApi* | [**delete**](docs/AppApi.md#delete) | **DELETE** /v1/applications/{id} | 删除应用
*AppApi* | [**deleteAccount**](docs/AppApi.md#deleteAccount) | **DELETE** /v1/applications/{app_id}/accounts/{id} | 删除应用子账号
*AppApi* | [**deleteIDPConfig**](docs/AppApi.md#deleteIDPConfig) | **DELETE** /v1/applications/{app_id}/idp/{config_id} | 删除应用认证源
*AppApi* | [**deleteMFA**](docs/AppApi.md#deleteMFA) | **DELETE** /v1/applications/{app_id}/mfa/{config_id} | 禁用应用多因素认证配置
*AppApi* | [**disable**](docs/AppApi.md#disable) | **POST** /v1/applications/{id}/disable | 禁用应用
*AppApi* | [**disableAccount**](docs/AppApi.md#disableAccount) | **POST** /v1/applications/{app_id}/accounts/{id}/disable | 禁用应用子账号
*AppApi* | [**disableProtocol**](docs/AppApi.md#disableProtocol) | **POST** /v1/applications/{app_id}/protocols/{protocol_type}/disable | 禁用应用认证协议
*AppApi* | [**disableSSO**](docs/AppApi.md#disableSSO) | **POST** /v1/applications/{id}/sso/disable | 禁用应用单点登录
*AppApi* | [**enable**](docs/AppApi.md#enable) | **POST** /v1/applications/{id}/enable | 启用应用
*AppApi* | [**enableAccount**](docs/AppApi.md#enableAccount) | **POST** /v1/applications/{app_id}/accounts/{id}/enable | 启用应用子账号
*AppApi* | [**enableProtocol**](docs/AppApi.md#enableProtocol) | **POST** /v1/applications/{app_id}/protocols/{protocol_type}/enable | 启用应用认证协议
*AppApi* | [**enableSSO**](docs/AppApi.md#enableSSO) | **POST** /v1/applications/{id}/sso/enable | 启用应用单点登录
*AppApi* | [**get**](docs/AppApi.md#get) | **GET** /v1/applications/{id} | 按 ID 查询应用
*AppApi* | [**getAccount**](docs/AppApi.md#getAccount) | **GET** /v1/applications/{app_id}/accounts/{id} | 按 ID 查询应用子账号
*AppApi* | [**getAccounts**](docs/AppApi.md#getAccounts) | **GET** /v1/application-accounts | 查询应用子账号列表
*AppApi* | [**getAccountsByApp**](docs/AppApi.md#getAccountsByApp) | **GET** /v1/applications/{app_id}/accounts | 按 APP ID 查询应用子账号列表
*AppApi* | [**getByDomain**](docs/AppApi.md#getByDomain) | **GET** /v1/application | 按条件查询应用
*AppApi* | [**getConfig**](docs/AppApi.md#getConfig) | **GET** /v1/applications/{id}/configs | 查询应用配置信息
*AppApi* | [**getProtocol**](docs/AppApi.md#getProtocol) | **GET** /v1/applications/{app_id}/protocols/{protocol_type} | 查询应用认证协议
*AppApi* | [**getProtocols**](docs/AppApi.md#getProtocols) | **GET** /v1/applications/{id}/protocols | 查询应用认证协议列表
*AppApi* | [**getTemplate**](docs/AppApi.md#getTemplate) | **GET** /v1/application-templates | 查询应用模板列表
*AppApi* | [**modify**](docs/AppApi.md#modify) | **PATCH** /v1/applications/{id} | 更新应用基本信息
*AppApi* | [**modifyAccount**](docs/AppApi.md#modifyAccount) | **PUT** /v1/applications/{app_id}/accounts/{id} | 更新应用子账号
*AppApi* | [**modifyConfig**](docs/AppApi.md#modifyConfig) | **PATCH** /v1/applications/{id}/configs | 更新应用配置
*AppApi* | [**modifyProtocol**](docs/AppApi.md#modifyProtocol) | **PUT** /v1/applications/{app_id}/protocols/{protocol_type} | 更新应用认证协议
*OrganizationApi* | [**createNode**](docs/OrganizationApi.md#createNode) | **POST** /v1/tree-nodes | 创建节点
*OrganizationApi* | [**createOrganization**](docs/OrganizationApi.md#createOrganization) | **POST** /v1/core-objects | 创建组织关系
*OrganizationApi* | [**deleteMembers**](docs/OrganizationApi.md#deleteMembers) | **DELETE** /v1/tree-users | 从节点移除用户
*OrganizationApi* | [**deleteNode**](docs/OrganizationApi.md#deleteNode) | **DELETE** /v1/tree-nodes/{id} | 删除节点
*OrganizationApi* | [**deleteOrganization**](docs/OrganizationApi.md#deleteOrganization) | **DELETE** /v1/core-objects/{id} | 删除组织关系
*OrganizationApi* | [**getChildrenNodes**](docs/OrganizationApi.md#getChildrenNodes) | **GET** /v1/tree-nodes/{id}/children | 获取子节点列表
*OrganizationApi* | [**getMembers**](docs/OrganizationApi.md#getMembers) | **GET** /v1/tree-users | 获取与用户关联的组织关系列表
*OrganizationApi* | [**getNode**](docs/OrganizationApi.md#getNode) | **GET** /v1/tree-nodes/{id} | 查询节点信息
*OrganizationApi* | [**getNodeMembers**](docs/OrganizationApi.md#getNodeMembers) | **GET** /v1/tree-nodes/{id}/tree-users | 获取成员信息列表
*OrganizationApi* | [**getNodeParent**](docs/OrganizationApi.md#getNodeParent) | **GET** /v1/tree-nodes/{id}/parent | 查询父节点
*OrganizationApi* | [**getNodes**](docs/OrganizationApi.md#getNodes) | **GET** /v1/tree-nodes | 查询节点信息列表
*OrganizationApi* | [**getOrganization**](docs/OrganizationApi.md#getOrganization) | **GET** /v1/core-objects/{id} | 获取组织关系基本信息
*OrganizationApi* | [**getOrganizations**](docs/OrganizationApi.md#getOrganizations) | **GET** /v1/core-objects | 获取组织关系列表
*OrganizationApi* | [**updateMember**](docs/OrganizationApi.md#updateMember) | **PATCH** /v1/tree-users/{id} | 更新用户节点
*OrganizationApi* | [**updateNode**](docs/OrganizationApi.md#updateNode) | **PATCH** /v1/tree-nodes/{id} | 编辑节点
*OrganizationApi* | [**updateOrganization**](docs/OrganizationApi.md#updateOrganization) | **PATCH** /v1/core-objects/{id} | 修改组织关系基本信息
*PermissionApi* | [**authorizeApplications**](docs/PermissionApi.md#authorizeApplications) | **POST** /v1/batch/authz-apps | 授权应用
*PermissionApi* | [**createAuthUnitRules**](docs/PermissionApi.md#createAuthUnitRules) | **POST** /v1/batch/auth-unit-rules | 批量创建授权规则
*PermissionApi* | [**createResource**](docs/PermissionApi.md#createResource) | **POST** /v1/resources | 创建资源
*PermissionApi* | [**createResourceSet**](docs/PermissionApi.md#createResourceSet) | **POST** /v1/resource-sets | 创建资源集合
*PermissionApi* | [**createResourceSetMember**](docs/PermissionApi.md#createResourceSetMember) | **POST** /v1/resource-sets/{id}/members | 创建资源集合成员
*PermissionApi* | [**deleteAuthUnitRules**](docs/PermissionApi.md#deleteAuthUnitRules) | **DELETE** /v1/batch/auth-unit-rules | 批量删除授权规则
*PermissionApi* | [**deleteResources**](docs/PermissionApi.md#deleteResources) | **DELETE** /v1/batch/resources | 删除资源
*PermissionApi* | [**getAuthUnit**](docs/PermissionApi.md#getAuthUnit) | **GET** /v1/auth-units/{id} | 按 ID 查询授权单元
*PermissionApi* | [**getAuthUnits**](docs/PermissionApi.md#getAuthUnits) | **GET** /v1/auth-units | 获取授权单元列表
*PermissionApi* | [**getAuthUnitsRules**](docs/PermissionApi.md#getAuthUnitsRules) | **GET** /v1/auth-units/{rid}/rules | 查询授权单元下的授权规则列表
*PermissionApi* | [**getPrivileges**](docs/PermissionApi.md#getPrivileges) | **GET** /v1/privileges | 获取权限列表
*PermissionApi* | [**getResource**](docs/PermissionApi.md#getResource) | **GET** /v1/resources/{id} | 按 ID 查询资源
*PermissionApi* | [**getResourceMember**](docs/PermissionApi.md#getResourceMember) | **GET** /v1/resource-sets/{sid}/members/{mid} | 按 ID 查询资源集合成员
*PermissionApi* | [**getResourceMembers**](docs/PermissionApi.md#getResourceMembers) | **GET** /v1/resource-sets/{sid}/members | 查询资源集合成员列表
*PermissionApi* | [**getResourceSet**](docs/PermissionApi.md#getResourceSet) | **GET** /v1/resource-sets/{id} | 按 ID 查询资源集合
*PermissionApi* | [**getResourceSets**](docs/PermissionApi.md#getResourceSets) | **GET** /v1/resource-sets | 查询资源集合列表
*PermissionApi* | [**getResources**](docs/PermissionApi.md#getResources) | **GET** /v1/resources | 查询资源列表
*PermissionApi* | [**listAuthorizedApplications**](docs/PermissionApi.md#listAuthorizedApplications) | **GET** /v1/authz-apps | 查询已授权应用列表
*PermissionApi* | [**modifyAuthUnit**](docs/PermissionApi.md#modifyAuthUnit) | **PUT** /v1/auth-units/{rid}/rules/{tid} | 更新授权规则
*PermissionApi* | [**modifyResource**](docs/PermissionApi.md#modifyResource) | **PUT** /v1/resources/{id} | 更新资源
*PermissionApi* | [**modifyResourceSet**](docs/PermissionApi.md#modifyResourceSet) | **PUT** /v1/resource-sets/{id} | 更新资源集合
*PermissionApi* | [**modifyResourceSetMember**](docs/PermissionApi.md#modifyResourceSetMember) | **PUT** /v1/resource-sets/{sid}/members/{mid} | 更新资源集合成员
*PermissionApi* | [**queryAuthUnitsRules**](docs/PermissionApi.md#queryAuthUnitsRules) | **GET** /v1/auth-unit-rules | 查询授权规则列表
*StorageApi* | [**deleteBucket**](docs/StorageApi.md#deleteBucket) | **DELETE** /v1/buckets/{bucket} | 删除 Bucket
*StorageApi* | [**deleteObject**](docs/StorageApi.md#deleteObject) | **DELETE** /v1/buckets/{bucket}/objects/{key} | 删除 Object
*StorageApi* | [**getBucket**](docs/StorageApi.md#getBucket) | **GET** /v1/buckets/{bucket} | 获取 Bucket 详情
*StorageApi* | [**getBuckets**](docs/StorageApi.md#getBuckets) | **GET** /v1/buckets | 获取 Bucket 列表
*StorageApi* | [**getObject**](docs/StorageApi.md#getObject) | **GET** /v1/buckets/{bucket}/objects/{key} | 获取 Object 详情
*StorageApi* | [**getObjects**](docs/StorageApi.md#getObjects) | **GET** /v1/buckets/{bucket}/objects | 获取 Object 列表
*StorageApi* | [**saveObject**](docs/StorageApi.md#saveObject) | **POST** /v1/buckets/{bucket}/objects | 创建 Object
*UserApi* | [**callList**](docs/UserApi.md#callList) | **GET** /v1/users | 查询用户列表
*UserApi* | [**create**](docs/UserApi.md#create) | **POST** /v1/users | 创建用户
*UserApi* | [**createStoreCredential**](docs/UserApi.md#createStoreCredential) | **POST** /v1/user-stored-credentials | 创建用户存储凭证
*UserApi* | [**delete**](docs/UserApi.md#delete) | **DELETE** /v1/users/{id} | 删除用户
*UserApi* | [**get**](docs/UserApi.md#get) | **GET** /v1/users/{id} | 查询用户详情
*UserApi* | [**getStoredCredentials**](docs/UserApi.md#getStoredCredentials) | **GET** /v1/user-stored-credentials | 查询用户存储凭证列表
*UserApi* | [**modify**](docs/UserApi.md#modify) | **PATCH** /v1/users/{id} | 编辑用户
## Documentation for Models
- [App](docs/App.md)
- [AppConfig](docs/AppConfig.md)
- [AppConfigAllowedIdProvider](docs/AppConfigAllowedIdProvider.md)
- [AppDetail](docs/AppDetail.md)
- [AppSubAccount](docs/AppSubAccount.md)
- [Au](docs/Au.md)
- [AuResourceSet](docs/AuResourceSet.md)
- [AuthRuleArg](docs/AuthRuleArg.md)
- [AuthUnit](docs/AuthUnit.md)
- [AuthUnitResouce](docs/AuthUnitResouce.md)
- [AuthUnitResourceSet](docs/AuthUnitResourceSet.md)
- [AuthorizeApplicationsRequest](docs/AuthorizeApplicationsRequest.md)
- [AuthzApp](docs/AuthzApp.md)
- [Bucket](docs/Bucket.md)
- [CoreObject](docs/CoreObject.md)
- [Create200Response](docs/Create200Response.md)
- [CreateAccountRequest](docs/CreateAccountRequest.md)
- [CreateNodeRequest](docs/CreateNodeRequest.md)
- [CreateOrganization200Response](docs/CreateOrganization200Response.md)
- [CreateOrganizationRequest](docs/CreateOrganizationRequest.md)
- [CreateRequest](docs/CreateRequest.md)
- [CreateRequest1](docs/CreateRequest1.md)
- [CreateRequest1ConfigProp](docs/CreateRequest1ConfigProp.md)
- [CreateRequest1ConfigPropAccessPolicy](docs/CreateRequest1ConfigPropAccessPolicy.md)
- [CreateRequest1ConfigPropAllowedLoginMethod](docs/CreateRequest1ConfigPropAllowedLoginMethod.md)
- [CreateRequest1ConfigPropAllowedSocialLoginProvider](docs/CreateRequest1ConfigPropAllowedSocialLoginProvider.md)
- [CreateRequest1ProtocolProp](docs/CreateRequest1ProtocolProp.md)
- [CreateRequest1ProtocolPropResponseAttrInner](docs/CreateRequest1ProtocolPropResponseAttrInner.md)
- [CreateSecrets200Response](docs/CreateSecrets200Response.md)
- [CreateSecrets200ResponseData](docs/CreateSecrets200ResponseData.md)
- [CreateStoreCredential200Response](docs/CreateStoreCredential200Response.md)
- [CreateStoreCredentialRequest](docs/CreateStoreCredentialRequest.md)
- [CronJob](docs/CronJob.md)
- [Delete200Response](docs/Delete200Response.md)
- [Delete200Response1](docs/Delete200Response1.md)
- [DeleteAuthUnitRulesRequest](docs/DeleteAuthUnitRulesRequest.md)
- [DeleteMembersRequest](docs/DeleteMembersRequest.md)
- [DeleteNode200Response](docs/DeleteNode200Response.md)
- [DeleteOrganization200Response](docs/DeleteOrganization200Response.md)
- [DeleteResourcesRequest](docs/DeleteResourcesRequest.md)
- [Disable200Response](docs/Disable200Response.md)
- [EmptyObject](docs/EmptyObject.md)
- [EmptyObject1](docs/EmptyObject1.md)
- [EmptyObject10](docs/EmptyObject10.md)
- [EmptyObject11](docs/EmptyObject11.md)
- [EmptyObject12](docs/EmptyObject12.md)
- [EmptyObject12ResourceActionsInner](docs/EmptyObject12ResourceActionsInner.md)
- [EmptyObject13](docs/EmptyObject13.md)
- [EmptyObject2](docs/EmptyObject2.md)
- [EmptyObject3](docs/EmptyObject3.md)
- [EmptyObject3ActionsInner](docs/EmptyObject3ActionsInner.md)
- [EmptyObject4](docs/EmptyObject4.md)
- [EmptyObject4Application](docs/EmptyObject4Application.md)
- [EmptyObject4Resource](docs/EmptyObject4Resource.md)
- [EmptyObject4ResourceSet](docs/EmptyObject4ResourceSet.md)
- [EmptyObject5](docs/EmptyObject5.md)
- [EmptyObject5ActionsInner](docs/EmptyObject5ActionsInner.md)
- [EmptyObject6](docs/EmptyObject6.md)
- [EmptyObject7](docs/EmptyObject7.md)
- [EmptyObject8](docs/EmptyObject8.md)
- [EmptyObject9](docs/EmptyObject9.md)
- [Enable200Response](docs/Enable200Response.md)
- [Get200Response](docs/Get200Response.md)
- [Get400Response](docs/Get400Response.md)
- [GetAccountsByApp200Response](docs/GetAccountsByApp200Response.md)
- [GetAuthUnits200Response](docs/GetAuthUnits200Response.md)
- [GetConfig200Response](docs/GetConfig200Response.md)
- [GetConfig200ResponseMfaConfig](docs/GetConfig200ResponseMfaConfig.md)
- [GetMembers200ResponseInner](docs/GetMembers200ResponseInner.md)
- [GetNodeMembers200Response](docs/GetNodeMembers200Response.md)
- [GetNodeMembers200ResponseDataInner](docs/GetNodeMembers200ResponseDataInner.md)
- [GetNodeMembers200ResponseDataInnerNodeInfoInner](docs/GetNodeMembers200ResponseDataInnerNodeInfoInner.md)
- [GetOrganization200ResponseInner](docs/GetOrganization200ResponseInner.md)
- [GetOrganizations200ResponseInner](docs/GetOrganizations200ResponseInner.md)
- [GetPrivileges200Response](docs/GetPrivileges200Response.md)
- [GetResource200Response](docs/GetResource200Response.md)
- [GetResourceMembers200Response](docs/GetResourceMembers200Response.md)
- [GetResourceSets200Response](docs/GetResourceSets200Response.md)
- [GetResources200Response](docs/GetResources200Response.md)
- [GetStoredCredentials200Response](docs/GetStoredCredentials200Response.md)
- [GetTemplate200Response](docs/GetTemplate200Response.md)
- [GetTemplate200ResponseDataInner](docs/GetTemplate200ResponseDataInner.md)
- [GetTemplate200ResponseDataInnerConfigProp](docs/GetTemplate200ResponseDataInnerConfigProp.md)
- [GetTemplate200ResponseDataInnerProtocolProp](docs/GetTemplate200ResponseDataInnerProtocolProp.md)
- [IdentityObj](docs/IdentityObj.md)
- [Injection](docs/Injection.md)
- [Job](docs/Job.md)
- [List200Response](docs/List200Response.md)
- [List200Response1](docs/List200Response1.md)
- [List200Response1DataInner](docs/List200Response1DataInner.md)
- [List200Response1DataInnerAllowedProviderIdInner](docs/List200Response1DataInnerAllowedProviderIdInner.md)
- [List200ResponseDataInner](docs/List200ResponseDataInner.md)
- [MFA](docs/MFA.md)
- [ModelObject](docs/ModelObject.md)
- [Modify200Response](docs/Modify200Response.md)
- [Modify200Response1](docs/Modify200Response1.md)
- [ModifyAccountRequest](docs/ModifyAccountRequest.md)
- [ModifyConfigRequest](docs/ModifyConfigRequest.md)
- [ModifyRequest](docs/ModifyRequest.md)
- [ModifyRequest1](docs/ModifyRequest1.md)
- [NullInner](docs/NullInner.md)
- [Privilege](docs/Privilege.md)
- [Resource](docs/Resource.md)
- [ResourceSet](docs/ResourceSet.md)
- [ResourceSetMember](docs/ResourceSetMember.md)
- [ResourceSetMemberResourceActions](docs/ResourceSetMemberResourceActions.md)
- [SaveObjectRequest](docs/SaveObjectRequest.md)
- [TreeNode](docs/TreeNode.md)
- [TreeUser](docs/TreeUser.md)
- [UpdateMemberRequest](docs/UpdateMemberRequest.md)
- [UpdateNode200Response](docs/UpdateNode200Response.md)
- [UpdateNodeRequest](docs/UpdateNodeRequest.md)
- [UpdateOrganizationRequest](docs/UpdateOrganizationRequest.md)
<a id="documentation-for-authorization"></a>
## Documentation for Authorization
Endpoints do not require authorization.
## Recommendation
It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
## Author
Reference in New Issue View Git Blame Copy Permalink