Java client library to interact with various IBM Cloud Platform Service APIs.
- Overview
- Prerequisites
- Installation
- Using the SDK
- Questions
- Issues
- Open source @ IBM
- Contributing
- License
The IBM Cloud Platform Services Java SDK allows developers to programmatically interact with the following IBM Cloud services:
| Service Name | Artifact Coordinates |
|---|---|
| Case Management | com.ibm.cloud:case-management:0.36.0 |
| Catalog Management | com.ibm.cloud:catalog-management:0.36.0 |
| Context Based Restrictions | com.ibm.cloud:context-based-restrictions:0.36.0 |
| Enterprise Billing Units | com.ibm.cloud:enterprise-billing-units:0.36.0 |
| Enterprise Management | com.ibm.cloud:enterprise-management:0.36.0 |
| Enterprise Usage Reports | com.ibm.cloud:enterprise-usage-reports:0.36.0 |
| Global Catalog | com.ibm.cloud:global-catalog:0.36.0 |
| Global Search | com.ibm.cloud:global-search:0.36.0 |
| Global Tagging | com.ibm.cloud:global-tagging:0.36.0 |
| IAM Access Groups | com.ibm.cloud:iam-access-groups:0.36.0 |
| IAM Identity Service | com.ibm.cloud:iam-identity:0.36.0 |
| IAM Policy Management | com.ibm.cloud:iam-policy-management:0.36.0 |
| IBM Cloud Shell | com.ibm.cloud:ibm-cloud-shell:0.36.0 |
| Open Service Broker | com.ibm.cloud:open-service-broker:0.36.0 |
| Resource Controller | com.ibm.cloud:resource-controller:0.36.0 |
| Resource Manager | com.ibm.cloud:resource-manager:0.36.0 |
| Usage Metering | com.ibm.cloud:usage-metering:0.36.0 |
| Usage Reports | com.ibm.cloud:usage-reports:0.36.0 |
| User Management | com.ibm.cloud:user-management:0.36.0 |
The following services have been relocated to a different SDK project. Please consult the documentation for each service to determine the new location:
| Service Name | Artifact Coordinates |
|---|---|
| Configuration Governance | com.ibm.cloud:configuration-governance:0.36.0 |
| Posture Management | com.ibm.cloud:posture_management:0.36.0 |
- An IBM Cloud account.
- An IAM API key to allow the SDK to access your account. Create one here.
- Java 8 or above.
The current version of this SDK is: 0.36.0
Each service's artifact coordinates are listed in the table above.
The project artifacts are published on the public Maven Central artifact repository. This is the default public repository used by maven when searching for dependencies. To use this repository within a gradle build, please see this link.
To use a particular service in your application, define a dependency that contains the artifact coordinates (group id, artifact id and version) for the service. Here are examples for maven and gradle:
<dependency>
<groupId>com.ibm.cloud</groupId>
<artifactId>case-management</artifactId>
<version>0.36.0</version>
</dependency>compile 'com.ibm.cloud:case-management:0.36.0'For general SDK usage information, please see this link
If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow.
If you encounter an issue with the project, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible that someone has already reported the problem.
Find more open source projects on the IBM Github Page
See CONTRIBUTING.
The IBM Cloud Platform Services Java SDK is released under the Apache 2.0 license. The license's full text can be found in LICENSE.