---
title: "Infisical Java SDK"
sidebarTitle: "Java"
icon: "java"
---

If you're working with Java, the official [Infisical Java SDK](https://github.com/Infisical/sdk/tree/main/languages/java) package is the easiest way to fetch and work with secrets for your application.

- [Maven Package](https://github.com/Infisical/sdk/packages/2019741)
- [Github Repository](https://github.com/Infisical/sdk/tree/main/languages/java)

## Basic Usage

```java
package com.example.app;

import com.infisical.sdk.InfisicalClient;
import com.infisical.sdk.schema.*;

public class Example {
    public static void main(String[] args) {
       
        // Create the authentication settings for the client
        ClientSettings settings = new ClientSettings();
        AuthenticationOptions authOptions = new AuthenticationOptions();
        UniversalAuthMethod authMethod = new UniversalAuthMethod();

        authMethod.setClientID("YOUR_IDENTITY_ID");
        authMethod.setClientSecret("YOUR_CLIENT_SECRET");

        authOptions.setUniversalAuth(authMethod);
        settings.setAuth(authOptions);

        // Create a new Infisical Client
        InfisicalClient client = new InfisicalClient(settings);

        // Create the options for fetching the secret
        GetSecretOptions options = new GetSecretOptions();
        options.setSecretName("TEST");
        options.setEnvironment("dev");
        options.setProjectID("PROJECT_ID");

        // Fetch the sercret with the provided options
        GetSecretResponseSecret secret = client.getSecret(options);

        // Print the value
        System.out.println(secret.getSecretValue());

        // Important to avoid memory leaks!
        // If you intend to use the client throughout your entire application, you can omit this line.
        client.close();
    }
}
```

This example demonstrates how to use the Infisical Java SDK in a Java application. The application retrieves a secret named `TEST` from the `dev` environment of the `PROJECT_ID` project.

<Warning>
    We do not recommend hardcoding your [Machine Identity Tokens](/platform/identities/overview). Setting it as an environment variable would be best.
</Warning>

# Installation

The Infisical Java SDK is hosted on the GitHub Packages Apache Maven registry. Because of this you need to configure your environment properly so it's able to pull dependencies from the GitHub registry. Please check [this guide from GitHub](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry) on how to achieve this.

Our package is [located here](https://github.com/Infisical/sdk/packages/2019741). Please follow the installation guide on the page.

# Configuration

Import the SDK and create a client instance with your [Machine Identity](/platform/identities/universal-auth).

```java
import com.infisical.sdk.InfisicalClient;
import com.infisical.sdk.schema.*;

public class App {
    public static void main(String[] args) {
        // Create the authentication settings for the client
        ClientSettings settings = new ClientSettings();
        AuthenticationOptions authOptions = new AuthenticationOptions();
        UniversalAuthMethod authMethod = new UniversalAuthMethod();

        authMethod.setClientID("YOUR_IDENTITY_ID");
        authMethod.setClientSecret("YOUR_CLIENT_SECRET");

        authOptions.setUniversalAuth(authMethod);
        settings.setAuth(authOptions);

        // Create a new Infisical Client
        InfisicalClient client = new InfisicalClient(settings); // Your client!
    }
}
```

### ClientSettings methods

<ParamField query="options" type="object">
    <Expandable title="properties">
        <ParamField query="setClientID()" type="string" deprecated optional>
            Your machine identity client ID.

            **This field is deprecated and will be removed in future versions.** Please use the `setAuth()` method on the client settings instead.
        </ParamField>
          <ParamField query="setClientSecret()" deprecated type="string" optional>
            Your machine identity client secret.

            **This field is deprecated and will be removed in future versions.** Please use the `setAuth()` method on the client settings instead.
        </ParamField>

         <ParamField query="setAccessToken()" deprecatedtype="string" optional>
            An access token obtained from the machine identity login endpoint.

            **This field is deprecated and will be removed in future versions.** Please use the `setAuth()` method on the client settings instead.
        </ParamField>

        <ParamField query="setCacheTTL()" type="number" default="300" optional>
            Time-to-live (in seconds) for refreshing cached secrets.
            If manually set to 0, caching will be disabled, this is not recommended.
        </ParamField>

        <ParamField query="setSiteURL()" type="string" default="https://app.infisical.com" optional>
            Your self-hosted absolute site URL including the protocol (e.g. `https://app.infisical.com`)
        </ParamField>

        <ParamField query="setAuth()" type="AuthenticationOptions">
          The authentication object to use for the client. This is required unless you're using environment variables.
      </ParamField>
    </Expandable>

</ParamField>

### Authentication

The SDK supports a variety of authentication methods. The most common authentication method is Universal Auth, which uses a client ID and client secret to authenticate.

#### Universal Auth

**Using environment variables**
- `INFISICAL_UNIVERSAL_AUTH_CLIENT_ID` - Your machine identity client ID.
- `INFISICAL_UNIVERSAL_AUTH_CLIENT_SECRET` - Your machine identity client secret.

**Using the SDK directly**
```java
  ClientSettings settings = new ClientSettings();
  AuthenticationOptions authOptions = new AuthenticationOptions();
  UniversalAuthMethod authMethod = new UniversalAuthMethod();

  authMethod.setClientID("YOUR_IDENTITY_ID");
  authMethod.setClientSecret("YOUR_CLIENT_SECRET");

  authOptions.setUniversalAuth(authMethod);
  settings.setAuth(authOptions);

  InfisicalClient client = new InfisicalClient(settings);
```

#### GCP ID Token Auth
<Info>
  Please note that this authentication method will only work if you're running your application on Google Cloud Platform.
  Please [read more](/documentation/platform/identities/gcp-auth) about this authentication method.
</Info>

**Using environment variables**
- `INFISICAL_GCP_AUTH_IDENTITY_ID` - Your Infisical Machine Identity ID.

**Using the SDK directly**
```java
  ClientSettings settings = new ClientSettings();
  AuthenticationOptions authOptions = new AuthenticationOptions();
  GCPIDTokenAuthMethod authMethod = new GCPIDTokenAuthMethod();

  authMethod.setIdentityID("YOUR_MACHINE_IDENTITY_ID");

  authOptions.setGcpIDToken(authMethod);
  settings.setAuth(authOptions);

  InfisicalClient client = new InfisicalClient(settings);
```

#### GCP IAM Auth

**Using environment variables**
- `INFISICAL_GCP_IAM_AUTH_IDENTITY_ID` - Your Infisical Machine Identity ID.
- `INFISICAL_GCP_IAM_SERVICE_ACCOUNT_KEY_FILE_PATH` - The path to your GCP service account key file.

**Using the SDK directly**
```java
  ClientSettings settings = new ClientSettings();
  AuthenticationOptions authOptions = new AuthenticationOptions();
  GCPIamAuthMethod authMethod = new GCPIamAuthMethod();

  authMethod.setIdentityID("YOUR_MACHINE_IDENTITY_ID");
  authMethod.setServiceAccountKeyFilePath("./path/to/your/service-account-key.json");

  authOptions.setGcpIam(authMethod);
  settings.setAuth(authOptions);

  InfisicalClient client = new InfisicalClient(settings);
```

#### AWS IAM Auth
<Info>
  Please note that this authentication method will only work if you're running your application on AWS.
  Please [read more](/documentation/platform/identities/aws-auth) about this authentication method.
</Info>

**Using environment variables**
- `INFISICAL_AWS_IAM_AUTH_IDENTITY_ID` - Your Infisical Machine Identity ID.

**Using the SDK directly**
```java
  ClientSettings settings = new ClientSettings();
  AuthenticationOptions authOptions = new AuthenticationOptions();
  AWSIamAuthMethod authMethod = new AWSIamAuthMethod();

  authMethod.setIdentityID("YOUR_MACHINE_IDENTITY_ID");

  authOptions.setAwsIam(authMethod);
  settings.setAuth(authOptions);

  InfisicalClient client = new InfisicalClient(settings);
```

#### Azure Auth
<Info>
  Please note that this authentication method will only work if you're running your application on Azure.
  Please [read more](/documentation/platform/identities/azure-auth) about this authentication method.
</Info>

**Using environment variables**
- `INFISICAL_AZURE_AUTH_IDENTITY_ID` - Your Infisical Machine Identity ID.

**Using the SDK directly**
```java
  ClientSettings settings = new ClientSettings();
  AuthenticationOptions authOptions = new AuthenticationOptions();
  AzureAuthMethod authMethod = new AzureAuthMethod();
  
  authMethod.setIdentityID("YOUR_IDENTITY_ID");

  authOptions.setAzure(authMethod);
  settings.setAuth(authOptions);

  InfisicalClient client = new InfisicalClient(settings);
```

#### Kubernetes Auth
<Info>
  Please note that this authentication method will only work if you're running your application on Kubernetes.
  Please [read more](/documentation/platform/identities/kubernetes-auth) about this authentication method.
</Info>

**Using environment variables**
- `INFISICAL_KUBERNETES_IDENTITY_ID` - Your Infisical Machine Identity ID.
- `INFISICAL_KUBERNETES_SERVICE_ACCOUNT_TOKEN_PATH_ENV_NAME` - The environment variable name that contains the path to the service account token. This is optional and will default to `/var/run/secrets/kubernetes.io/serviceaccount/token`.

**Using the SDK directly**
```java
  ClientSettings settings = new ClientSettings();
  AuthenticationOptions authOptions = new AuthenticationOptions();
  KubernetesAuthMethod authMethod = new KubernetesAuthMethod();

  authMethod.setIdentityID("YOUR_IDENTITY_ID");
  authMethod.setServiceAccountTokenPath("/var/run/secrets/kubernetes.io/serviceaccount/token"); // Optional

  authOptions.setKubernetes(authMethod);
  settings.setAuth(authOptions);

  InfisicalClient client = new InfisicalClient(settings);
```


### Caching

To reduce the number of API requests, the SDK temporarily stores secrets it retrieves. By default, a secret remains cached for 5 minutes after it's first fetched. Each time it's fetched again, this 5-minute timer resets. You can adjust this caching duration by setting the "cacheTTL" option when creating the client.

## Working with Secrets

### client.listSecrets(options)

```java
ListSecretsOptions options = new ListSecretsOptions();
options.setEnvironment("dev");
options.setProjectID("PROJECT_ID");
options.setPath("/foo/bar");
options.setIncludeImports(false);
options.setRecursive(false);
options.setExpandSecretReferences(true);

SecretElement[] secrets = client.listSecrets(options);
```

Retrieve all secrets within the Infisical project and environment that client is connected to

#### Methods

<ParamField query="Parameters" type="object">
    <Expandable title="properties">
        <ParamField query="setEnvironment()" type="string" required>
            The slug name (dev, prod, etc) of the environment from where secrets should be fetched from.
        </ParamField>

        <ParamField query="setProjectID()" type="string">
            The project ID where the secret lives in.
        </ParamField>

         <ParamField query="setPath()" type="string" optional>
            The path from where secrets should be fetched from.
        </ParamField>

        <ParamField query="setAttachToProcessEnv()" type="boolean" default="false" optional>
             Whether or not to set the fetched secrets to the process environment. If true, you can access the secrets like so `System.getenv("SECRET_NAME")`.
        </ParamField>

        <ParamField query="setIncludeImports()" type="boolean" default="false" optional>
             Whether or not to include imported secrets from the current path. Read about [secret import](/documentation/platform/secret-reference)
        </ParamField>

         <ParamField query="setRecursive()" type="boolean" default="false" optional>
            Whether or not to fetch secrets recursively from the specified path. Please note that there's a 20-depth limit for recursive fetching.
        </ParamField>

        <ParamField query="setExpandSecretReferences()" type="boolean" default="true" optional>
            Whether or not to expand secret references in the fetched secrets. Read about [secret reference](/documentation/platform/secret-reference)
        </ParamField>
    </Expandable>

</ParamField>

### client.getSecret(options)

```java
GetSecretOptions options = new GetSecretOptions();
options.setSecretName("TEST");
options.setEnvironment("dev");
options.setProjectID("PROJECT_ID");

GetSecretResponseSecret secret = client.getSecret(options);

String secretValue = secret.getSecretValue();
```

Retrieve a secret from Infisical.

By default, `getSecret()` fetches and returns a shared secret.

#### Methods

<ParamField query="Parameters" type="object" optional>
    <Expandable title="properties">
        <ParamField query="setSecretName()" type="string" required>
            The key of the secret to retrieve.
        </ParamField>
        <ParamField query="setProjectID()" type="string" required>
            The project ID where the secret lives in.
        </ParamField>
        <ParamField query="setEnvironment()" type="string" required>
            The slug name (dev, prod, etc) of the environment from where secrets should be fetched from.
        </ParamField>
        <ParamField query="setPath()" type="string" optional>
            The path from where secret should be fetched from.
        </ParamField>
        <ParamField query="setType()" type="string" optional>
            The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "shared".
        </ParamField>
    </Expandable>
</ParamField>

### client.createSecret(options)

```java
CreateSecretOptions createOptions = new CreateSecretOptions();
createOptions.setSecretName("NEW_SECRET");
createOptions.setEnvironment("dev");
createOptions.setProjectID("PROJECT_ID");
createOptions.setSecretValue("SOME SECRET VALUE");
createOptions.setPath("/"); // Default
createOptions.setType("shared"); // Default

CreateSecretResponseSecret newSecret = client.createSecret(createOptions);
```

Create a new secret in Infisical.

#### Methods

<ParamField query="Parameters" type="object" optional>
    <Expandable title="properties">
        <ParamField query="setSecretName()" type="string" required>
            The key of the secret to create.
        </ParamField>
        <ParamField query="setSecretValue()" type="string" required>
            The value of the secret.
        </ParamField>
        <ParamField query="setProjectID()" type="string" required>
            The project ID where the secret lives in.
        </ParamField>
        <ParamField query="setEnvironment()" type="string" required>
            The slug name (dev, prod, etc) of the environment from where secrets should be fetched from.
        </ParamField>
        <ParamField query="setPath()" type="string" optional>
            The path from where secret should be created.
        </ParamField>
        <ParamField query="setType()" type="string" optional>
            The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "shared".
        </ParamField>
    </Expandable>
</ParamField>

### client.updateSecret(options)

```java
UpdateSecretOptions options = new UpdateSecretOptions();

options.setSecretName("SECRET_TO_UPDATE");
options.setSecretValue("NEW SECRET VALUE");
options.setEnvironment("dev");
options.setProjectID("PROJECT_ID");
options.setPath("/"); // Default
options.setType("shared"); // Default

UpdateSecretResponseSecret updatedSecret = client.updateSecret(options);
```

Update an existing secret in Infisical.

#### Methods

<ParamField query="Parameters" type="object" optional>
    <Expandable title="properties">
        <ParamField query="setSecretName()" type="string" required>
            The key of the secret to update.
        </ParamField>
        <ParamField query="setSecretValue()" type="string" required>
            The new value of the secret.
        </ParamField>
        <ParamField query="setProjectID()" type="string" required>
            The project ID where the secret lives in.
        </ParamField>
        <ParamField query="setEnvironment()" type="string" required>
            The slug name (dev, prod, etc) of the environment from where secrets should be fetched from.
        </ParamField>
        <ParamField query="setPath()" type="string" optional>
            The path from where secret should be updated.
        </ParamField>
        <ParamField query="setType()" type="string" optional>
            The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "shared".
        </ParamField>
    </Expandable>
</ParamField>

### client.deleteSecret(options)

```java
DeleteSecretOptions options = new DeleteSecretOptions();

options.setSecretName("SECRET_TO_DELETE");
options.setEnvironment("dev");
options.setProjectID("PROJECT_ID");
options.setPath("/"); // Default
options.setType("shared"); // Default

DeleteSecretResponseSecret deletedSecret = client.deleteSecret(options);
```

Delete a secret in Infisical.

#### Methods

<ParamField query="Parameters" type="object" optional>
    <Expandable title="properties">
        <ParamField query="setSecretName()" type="string">
            The key of the secret to update.
        </ParamField>
        <ParamField query="setProjectID()" type="string" required>
            The project ID where the secret lives in.
        </ParamField>
        <ParamField query="setEnvironment()" type="string" required>
            The slug name (dev, prod, etc) of the environment from where secrets should be fetched from.
        </ParamField>
        <ParamField query="setPath()" type="string" optional>
            The path from where secret should be deleted.
        </ParamField>
        <ParamField query="setType()" type="string" optional>
            The type of the secret. Valid options are "shared" or "personal". If not specified, the default value is "shared".
        </ParamField>
    </Expandable>
</ParamField>

## Cryptography

### Create a symmetric key

Create a base64-encoded, 256-bit symmetric key to be used for encryption/decryption.

```java
String key = client.createSymmetricKey();
```

#### Returns (string)
`key` (string): A base64-encoded, 256-bit symmetric key, that can be used for encryption/decryption purposes.

### Encrypt symmetric
```java
EncryptSymmetricOptions options = new EncryptSymmetricOptions();
options.setKey(key);
options.setPlaintext("Infisical is awesome!");

EncryptSymmetricResponse encryptedData = client.encryptSymmetric(options);
```

#### Methods

<ParamField query="Parameters" type="object" required>
    <Expandable title="properties">
        <ParamField query="setPlaintext()" type="string">
            The plaintext you want to encrypt.
        </ParamField>
        <ParamField query="setKey()" type="string" required>
            The symmetric key to use for encryption.
        </ParamField>
    </Expandable>
</ParamField>

#### Returns (object)
`tag (getTag())` (string): A base64-encoded, 128-bit authentication tag.
`iv (getIv())` (string): A base64-encoded, 96-bit initialization vector.
`ciphertext (getCipherText())` (string): A base64-encoded, encrypted ciphertext.


### Decrypt symmetric
```java
DecryptSymmetricOptions decryptOptions = new DecryptSymmetricOptions();
decryptOptions.setKey(key);
decryptOptions.setCiphertext(encryptedData.getCiphertext());
decryptOptions.setIv(encryptedData.getIv());
decryptOptions.setTag(encryptedData.getTag());

String decryptedString = client.decryptSymmetric(decryptOptions);
```

#### Methods
<ParamField query="Parameters" type="object" required>
    <Expandable title="properties">
        <ParamField query="setCiphertext()" type="string">
            The ciphertext you want to decrypt.
        </ParamField>
        <ParamField query="setKey()" type="string" required>
            The symmetric key to use for encryption.
        </ParamField>
        <ParamField query="setIv()" type="string" required>
            The initialization vector to use for decryption.
        </ParamField>
        <ParamField query="setTag()" type="string" required>
            The authentication tag to use for decryption.
        </ParamField>
    </Expandable>
</ParamField>

#### Returns (string)
`Plaintext` (string): The decrypted plaintext.