Developer-friendly & type-safe Java SDK specifically catered to leverage openapi API.
Important
This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.
Conduct an audit: The Auditor API lets audit firms conduct audits from a tool outside of Vanta. Unlock data syncing with Vanta through this API.
JDK 11 or later is required.
The samples below show how a published SDK artifact is used:
Gradle:
implementation 'com.vanta:vanta-auditor-api:0.1.1'Maven:
<dependency>
<groupId>com.vanta</groupId>
<artifactId>vanta-auditor-api</artifactId>
<version>0.1.1</version>
</dependency>After cloning the git repository to your file system you can build the SDK artifact from source to the build directory by running ./gradlew build on *nix systems or gradlew.bat on Windows systems.
If you wish to build from source and publish the SDK artifact to your local Maven repository (on your filesystem) then use the following command (after cloning the git repo locally):
On *nix:
./gradlew publishToMavenLocal -Pskip.signingOn Windows:
gradlew.bat publishToMavenLocal -Pskip.signingpackage hello.world;
import com.vanta.vanta_auditor_api.Vanta;
import com.vanta.vanta_auditor_api.models.operations.ListAuditsResponse;
import java.lang.Exception;
import java.time.OffsetDateTime;
public class Application {
public static void main(String[] args) throws Exception {
Vanta sdk = Vanta.builder()
.bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
.build();
ListAuditsResponse res = sdk.audits().list()
.pageSize(10)
.pageCursor("<value>")
.changedSinceDate(OffsetDateTime.parse("2025-04-22T08:39:55.981Z"))
.call();
if (res.paginatedResponseAudit().isPresent()) {
// handle response
}
}
}This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
bearerAuth |
http | HTTP Bearer |
To authenticate with the API the bearerAuth parameter must be set when initializing the SDK client instance. For example:
package hello.world;
import com.vanta.vanta_auditor_api.Vanta;
import com.vanta.vanta_auditor_api.models.operations.ListAuditsResponse;
import java.lang.Exception;
import java.time.OffsetDateTime;
public class Application {
public static void main(String[] args) throws Exception {
Vanta sdk = Vanta.builder()
.bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
.build();
ListAuditsResponse res = sdk.audits().list()
.pageSize(10)
.pageCursor("<value>")
.changedSinceDate(OffsetDateTime.parse("2025-04-22T08:39:55.981Z"))
.call();
if (res.paginatedResponseAudit().isPresent()) {
// handle response
}
}
}Available methods
- create - Create an auditor
- list - List audits
- listEvidenceUrls - List audit evidence url
- listEvidence - List audit evidence
- listComments - List audit comments
- listControls - List audit controls
- createCommentForEvidence - Create a comment for audit evidence
- updateEvidence - Update audit evidence
- createCustomEvidenceRequest - Create a custom evidence request for an audit
- createCustomControl - Create a custom control for an audit
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
By default, an API error will throw a models/errors/APIException exception. When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the list method throws the following exceptions:
| Error Type | Status Code | Content Type |
|---|---|---|
| models/errors/APIException | 4XX, 5XX | */* |
package hello.world;
import com.vanta.vanta_auditor_api.Vanta;
import com.vanta.vanta_auditor_api.models.operations.ListAuditsResponse;
import java.lang.Exception;
import java.time.OffsetDateTime;
public class Application {
public static void main(String[] args) throws Exception {
Vanta sdk = Vanta.builder()
.bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
.build();
ListAuditsResponse res = sdk.audits().list()
.pageSize(10)
.pageCursor("<value>")
.changedSinceDate(OffsetDateTime.parse("2025-04-22T08:39:55.981Z"))
.call();
if (res.paginatedResponseAudit().isPresent()) {
// handle response
}
}
}The default server can also be overridden globally using the .serverURL(String serverUrl) builder method when initializing the SDK client instance. For example:
package hello.world;
import com.vanta.vanta_auditor_api.Vanta;
import com.vanta.vanta_auditor_api.models.operations.ListAuditsResponse;
import java.lang.Exception;
import java.time.OffsetDateTime;
public class Application {
public static void main(String[] args) throws Exception {
Vanta sdk = Vanta.builder()
.serverURL("https://api.vanta.com/v1")
.bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
.build();
ListAuditsResponse res = sdk.audits().list()
.pageSize(10)
.pageCursor("<value>")
.changedSinceDate(OffsetDateTime.parse("2025-04-22T08:39:55.981Z"))
.call();
if (res.paginatedResponseAudit().isPresent()) {
// handle response
}
}
}This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.