All Implemented Interfaces:
ApiRequest<GenerateSecretId.Request>
Enclosing class:
GenerateSecretId

public static class GenerateSecretId.Request extends VaultRequest<T>
Request object. Can be configured with additional headers, query parameters etc.
  • Method Details

    • builder

      public static GenerateSecretId.Request builder()
      Fluent API builder for configuring a request. The request builder is passed as is, without a build method. The equivalent of a build method is ApiJsonBuilder.toJson(jakarta.json.JsonBuilderFactory) used by the RestApi.
      Returns:
      new request builder
    • addMetadata

      public GenerateSecretId.Request addMetadata(String key, String value)
      This metadata will be set on tokens issued with this SecretID, and is logged in audit logs in plaintext.
      Parameters:
      key - name
      value - value
      Returns:
      updated request
    • addCidr

      public GenerateSecretId.Request addCidr(String cidr)
      CIDR blocks enforcing secret IDs to be used from specific set of IP addresses. If bound_cidr_list is set on the role, then the list of CIDR blocks listed here should be a subset of the CIDR blocks listed on the role.
      Parameters:
      cidr - CIDR block
      Returns:
      updated request
    • addTokenBoundCidr

      public GenerateSecretId.Request addTokenBoundCidr(String cidr)
      Specifies blocks of IP addresses which can use the auth tokens generated by this SecretID. Overrides any role-set value but must be a subset.
      Parameters:
      cidr - CIDR block
      Returns:
      updated request
    • postBuild

      protected void postBuild(JsonBuilderFactory factory, JsonObjectBuilder payload)
      Description copied from class: ApiJsonBuilder
      Called after adding properties defined in this request.
      Overrides:
      postBuild in class ApiJsonBuilder<GenerateSecretId.Request>
      Parameters:
      factory - json factory
      payload - payload builder
    • roleName

      public GenerateSecretId.Request roleName(String roleName)
      AppRole name.
      Parameters:
      roleName - AppRole name
      Returns:
      updated request