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

20 KiB
Raw Blame History

// Filename: /Users/liur/work/api-sdk-gen/openapi-generator/src/main/resources/Java/libraries/okhttp-gson/README.mustache

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

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:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<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:

  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:

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 instruction and execute the following Java code:


// 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 GET /v1/applications 查询应用列表
AppApi create POST /v1/applications 创建应用
AppApi createAccount POST /v1/applications/{id}/accounts 创建应用子账号
AppApi createIDP POST /v1/applications/{id}/idp 创建应用认证源
AppApi createMFA POST /v1/applications/{id}/mfa 启用应用多因素认证配置
AppApi createSecrets POST /v1/applications/{id}/secrets 刷新应用安全码
AppApi delete DELETE /v1/applications/{id} 删除应用
AppApi deleteAccount DELETE /v1/applications/{app_id}/accounts/{id} 删除应用子账号
AppApi deleteIDPConfig DELETE /v1/applications/{app_id}/idp/{config_id} 删除应用认证源
AppApi deleteMFA DELETE /v1/applications/{app_id}/mfa/{config_id} 禁用应用多因素认证配置
AppApi disable POST /v1/applications/{id}/disable 禁用应用
AppApi disableAccount POST /v1/applications/{app_id}/accounts/{id}/disable 禁用应用子账号
AppApi disableProtocol POST /v1/applications/{app_id}/protocols/{protocol_type}/disable 禁用应用认证协议
AppApi disableSSO POST /v1/applications/{id}/sso/disable 禁用应用单点登录
AppApi enable POST /v1/applications/{id}/enable 启用应用
AppApi enableAccount POST /v1/applications/{app_id}/accounts/{id}/enable 启用应用子账号
AppApi enableProtocol POST /v1/applications/{app_id}/protocols/{protocol_type}/enable 启用应用认证协议
AppApi enableSSO POST /v1/applications/{id}/sso/enable 启用应用单点登录
AppApi get GET /v1/applications/{id} 按 ID 查询应用
AppApi getAccount GET /v1/applications/{app_id}/accounts/{id} 按 ID 查询应用子账号
AppApi getAccounts GET /v1/application-accounts 查询应用子账号列表
AppApi getAccountsByApp GET /v1/applications/{app_id}/accounts 按 APP ID 查询应用子账号列表
AppApi getByDomain GET /v1/application 按条件查询应用
AppApi getConfig GET /v1/applications/{id}/configs 查询应用配置信息
AppApi getProtocol GET /v1/applications/{app_id}/protocols/{protocol_type} 查询应用认证协议
AppApi getProtocols GET /v1/applications/{id}/protocols 查询应用认证协议列表
AppApi getTemplate GET /v1/application-templates 查询应用模板列表
AppApi modify PATCH /v1/applications/{id} 更新应用基本信息
AppApi modifyAccount PUT /v1/applications/{app_id}/accounts/{id} 更新应用子账号
AppApi modifyConfig PATCH /v1/applications/{id}/configs 更新应用配置
AppApi modifyProtocol PUT /v1/applications/{app_id}/protocols/{protocol_type} 更新应用认证协议
OrganizationApi createNode POST /v1/tree-nodes 创建节点
OrganizationApi createOrganization POST /v1/core-objects 创建组织关系
OrganizationApi deleteMembers DELETE /v1/tree-users 从节点移除用户
OrganizationApi deleteNode DELETE /v1/tree-nodes/{id} 删除节点
OrganizationApi deleteOrganization DELETE /v1/core-objects/{id} 删除组织关系
OrganizationApi getChildrenNodes GET /v1/tree-nodes/{id}/children 获取子节点列表
OrganizationApi getMembers GET /v1/tree-users 获取与用户关联的组织关系列表
OrganizationApi getNode GET /v1/tree-nodes/{id} 查询节点信息
OrganizationApi getNodeMembers GET /v1/tree-nodes/{id}/tree-users 获取成员信息列表
OrganizationApi getNodeParent GET /v1/tree-nodes/{id}/parent 查询父节点
OrganizationApi getNodes GET /v1/tree-nodes 查询节点信息列表
OrganizationApi getOrganization GET /v1/core-objects/{id} 获取组织关系基本信息
OrganizationApi getOrganizations GET /v1/core-objects 获取组织关系列表
OrganizationApi updateMember PATCH /v1/tree-users/{id} 更新用户节点
OrganizationApi updateNode PATCH /v1/tree-nodes/{id} 编辑节点
OrganizationApi updateOrganization PATCH /v1/core-objects/{id} 修改组织关系基本信息
PermissionApi authorizeApplications POST /v1/batch/authz-apps 授权应用
PermissionApi createAuthUnitRules POST /v1/batch/auth-unit-rules 批量创建授权规则
PermissionApi createResource POST /v1/resources 创建资源
PermissionApi createResourceSet POST /v1/resource-sets 创建资源集合
PermissionApi createResourceSetMember POST /v1/resource-sets/{id}/members 创建资源集合成员
PermissionApi deleteAuthUnitRules DELETE /v1/batch/auth-unit-rules 批量删除授权规则
PermissionApi deleteResources DELETE /v1/batch/resources 删除资源
PermissionApi getAuthUnit GET /v1/auth-units/{id} 按 ID 查询授权单元
PermissionApi getAuthUnits GET /v1/auth-units 获取授权单元列表
PermissionApi getAuthUnitsRules GET /v1/auth-units/{rid}/rules 查询授权单元下的授权规则列表
PermissionApi getPrivileges GET /v1/privileges 获取权限列表
PermissionApi getResource GET /v1/resources/{id} 按 ID 查询资源
PermissionApi getResourceMember GET /v1/resource-sets/{sid}/members/{mid} 按 ID 查询资源集合成员
PermissionApi getResourceMembers GET /v1/resource-sets/{sid}/members 查询资源集合成员列表
PermissionApi getResourceSet GET /v1/resource-sets/{id} 按 ID 查询资源集合
PermissionApi getResourceSets GET /v1/resource-sets 查询资源集合列表
PermissionApi getResources GET /v1/resources 查询资源列表
PermissionApi listAuthorizedApplications GET /v1/authz-apps 查询已授权应用列表
PermissionApi modifyAuthUnit PUT /v1/auth-units/{rid}/rules/{tid} 更新授权规则
PermissionApi modifyResource PUT /v1/resources/{id} 更新资源
PermissionApi modifyResourceSet PUT /v1/resource-sets/{id} 更新资源集合
PermissionApi modifyResourceSetMember PUT /v1/resource-sets/{sid}/members/{mid} 更新资源集合成员
PermissionApi queryAuthUnitsRules GET /v1/auth-unit-rules 查询授权规则列表
StorageApi deleteBucket DELETE /v1/buckets/{bucket} 删除 Bucket
StorageApi deleteObject DELETE /v1/buckets/{bucket}/objects/{key} 删除 Object
StorageApi getBucket GET /v1/buckets/{bucket} 获取 Bucket 详情
StorageApi getBuckets GET /v1/buckets 获取 Bucket 列表
StorageApi getObject GET /v1/buckets/{bucket}/objects/{key} 获取 Object 详情
StorageApi getObjects GET /v1/buckets/{bucket}/objects 获取 Object 列表
StorageApi saveObject POST /v1/buckets/{bucket}/objects 创建 Object
UserApi callList GET /v1/users 查询用户列表
UserApi create POST /v1/users 创建用户
UserApi createStoreCredential POST /v1/user-stored-credentials 创建用户存储凭证
UserApi delete DELETE /v1/users/{id} 删除用户
UserApi get GET /v1/users/{id} 查询用户详情
UserApi getStoredCredentials GET /v1/user-stored-credentials 查询用户存储凭证列表
UserApi modify PATCH /v1/users/{id} 编辑用户

Documentation for Models

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