1. Packages
  2. HashiCorp Vault Provider
  3. API Docs
  4. transit
  5. getSign
HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi

vault.transit.getSign

Explore with Pulumi AI

vault logo
HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi

    This is a data source which can be used to generate a signature using a Vault Transit key.

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vault.transit.TransitFunctions;
    import com.pulumi.vault.transit.inputs.GetSignArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var test = TransitFunctions.getSign(GetSignArgs.builder()
                .path("transit")
                .key("test")
                .input("aGVsbG8gd29ybGQ=")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: vault:transit:getSign
          arguments:
            path: transit
            key: test
            input: aGVsbG8gd29ybGQ=
    

    Using getSign

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSign(args: GetSignArgs, opts?: InvokeOptions): Promise<GetSignResult>
    function getSignOutput(args: GetSignOutputArgs, opts?: InvokeOptions): Output<GetSignResult>
    def get_sign(batch_inputs: Optional[Sequence[Mapping[str, str]]] = None,
                 batch_results: Optional[Sequence[Mapping[str, str]]] = None,
                 context: Optional[str] = None,
                 hash_algorithm: Optional[str] = None,
                 input: Optional[str] = None,
                 key_version: Optional[int] = None,
                 marshaling_algorithm: Optional[str] = None,
                 name: Optional[str] = None,
                 namespace: Optional[str] = None,
                 path: Optional[str] = None,
                 prehashed: Optional[bool] = None,
                 reference: Optional[str] = None,
                 salt_length: Optional[str] = None,
                 signature: Optional[str] = None,
                 signature_algorithm: Optional[str] = None,
                 signature_context: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetSignResult
    def get_sign_output(batch_inputs: Optional[pulumi.Input[Sequence[pulumi.Input[Mapping[str, pulumi.Input[str]]]]]] = None,
                 batch_results: Optional[pulumi.Input[Sequence[pulumi.Input[Mapping[str, pulumi.Input[str]]]]]] = None,
                 context: Optional[pulumi.Input[str]] = None,
                 hash_algorithm: Optional[pulumi.Input[str]] = None,
                 input: Optional[pulumi.Input[str]] = None,
                 key_version: Optional[pulumi.Input[int]] = None,
                 marshaling_algorithm: Optional[pulumi.Input[str]] = None,
                 name: Optional[pulumi.Input[str]] = None,
                 namespace: Optional[pulumi.Input[str]] = None,
                 path: Optional[pulumi.Input[str]] = None,
                 prehashed: Optional[pulumi.Input[bool]] = None,
                 reference: Optional[pulumi.Input[str]] = None,
                 salt_length: Optional[pulumi.Input[str]] = None,
                 signature: Optional[pulumi.Input[str]] = None,
                 signature_algorithm: Optional[pulumi.Input[str]] = None,
                 signature_context: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetSignResult]
    func GetSign(ctx *Context, args *GetSignArgs, opts ...InvokeOption) (*GetSignResult, error)
    func GetSignOutput(ctx *Context, args *GetSignOutputArgs, opts ...InvokeOption) GetSignResultOutput

    > Note: This function is named GetSign in the Go SDK.

    public static class GetSign 
    {
        public static Task<GetSignResult> InvokeAsync(GetSignArgs args, InvokeOptions? opts = null)
        public static Output<GetSignResult> Invoke(GetSignInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSignResult> getSign(GetSignArgs args, InvokeOptions options)
    public static Output<GetSignResult> getSign(GetSignArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vault:transit/getSign:getSign
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Path string
    BatchInputs List<ImmutableDictionary<string, string>>
    BatchResults List<ImmutableDictionary<string, string>>
    The results returned from Vault if using batch_input
    Context string
    HashAlgorithm string
    Input string
    KeyVersion int
    MarshalingAlgorithm string
    Namespace string
    Prehashed bool
    Reference string
    SaltLength string
    Signature string
    The signature returned from Vault if using input
    SignatureAlgorithm string
    SignatureContext string
    Name string
    Path string
    BatchInputs []map[string]string
    BatchResults []map[string]string
    The results returned from Vault if using batch_input
    Context string
    HashAlgorithm string
    Input string
    KeyVersion int
    MarshalingAlgorithm string
    Namespace string
    Prehashed bool
    Reference string
    SaltLength string
    Signature string
    The signature returned from Vault if using input
    SignatureAlgorithm string
    SignatureContext string
    name String
    path String
    batchInputs List<Map<String,String>>
    batchResults List<Map<String,String>>
    The results returned from Vault if using batch_input
    context String
    hashAlgorithm String
    input String
    keyVersion Integer
    marshalingAlgorithm String
    namespace String
    prehashed Boolean
    reference String
    saltLength String
    signature String
    The signature returned from Vault if using input
    signatureAlgorithm String
    signatureContext String
    name string
    path string
    batchInputs {[key: string]: string}[]
    batchResults {[key: string]: string}[]
    The results returned from Vault if using batch_input
    context string
    hashAlgorithm string
    input string
    keyVersion number
    marshalingAlgorithm string
    namespace string
    prehashed boolean
    reference string
    saltLength string
    signature string
    The signature returned from Vault if using input
    signatureAlgorithm string
    signatureContext string
    name str
    path str
    batch_inputs Sequence[Mapping[str, str]]
    batch_results Sequence[Mapping[str, str]]
    The results returned from Vault if using batch_input
    context str
    hash_algorithm str
    input str
    key_version int
    marshaling_algorithm str
    namespace str
    prehashed bool
    reference str
    salt_length str
    signature str
    The signature returned from Vault if using input
    signature_algorithm str
    signature_context str
    name String
    path String
    batchInputs List<Map<String>>
    batchResults List<Map<String>>
    The results returned from Vault if using batch_input
    context String
    hashAlgorithm String
    input String
    keyVersion Number
    marshalingAlgorithm String
    namespace String
    prehashed Boolean
    reference String
    saltLength String
    signature String
    The signature returned from Vault if using input
    signatureAlgorithm String
    signatureContext String

    getSign Result

    The following output properties are available:

    BatchResults List<ImmutableDictionary<string, string>>
    The results returned from Vault if using batch_input
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Path string
    Signature string
    The signature returned from Vault if using input
    BatchInputs List<ImmutableDictionary<string, string>>
    Context string
    HashAlgorithm string
    Input string
    KeyVersion int
    MarshalingAlgorithm string
    Namespace string
    Prehashed bool
    Reference string
    SaltLength string
    SignatureAlgorithm string
    SignatureContext string
    BatchResults []map[string]string
    The results returned from Vault if using batch_input
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Path string
    Signature string
    The signature returned from Vault if using input
    BatchInputs []map[string]string
    Context string
    HashAlgorithm string
    Input string
    KeyVersion int
    MarshalingAlgorithm string
    Namespace string
    Prehashed bool
    Reference string
    SaltLength string
    SignatureAlgorithm string
    SignatureContext string
    batchResults List<Map<String,String>>
    The results returned from Vault if using batch_input
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    path String
    signature String
    The signature returned from Vault if using input
    batchInputs List<Map<String,String>>
    context String
    hashAlgorithm String
    input String
    keyVersion Integer
    marshalingAlgorithm String
    namespace String
    prehashed Boolean
    reference String
    saltLength String
    signatureAlgorithm String
    signatureContext String
    batchResults {[key: string]: string}[]
    The results returned from Vault if using batch_input
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    path string
    signature string
    The signature returned from Vault if using input
    batchInputs {[key: string]: string}[]
    context string
    hashAlgorithm string
    input string
    keyVersion number
    marshalingAlgorithm string
    namespace string
    prehashed boolean
    reference string
    saltLength string
    signatureAlgorithm string
    signatureContext string
    batch_results Sequence[Mapping[str, str]]
    The results returned from Vault if using batch_input
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    path str
    signature str
    The signature returned from Vault if using input
    batch_inputs Sequence[Mapping[str, str]]
    context str
    hash_algorithm str
    input str
    key_version int
    marshaling_algorithm str
    namespace str
    prehashed bool
    reference str
    salt_length str
    signature_algorithm str
    signature_context str
    batchResults List<Map<String>>
    The results returned from Vault if using batch_input
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    path String
    signature String
    The signature returned from Vault if using input
    batchInputs List<Map<String>>
    context String
    hashAlgorithm String
    input String
    keyVersion Number
    marshalingAlgorithm String
    namespace String
    prehashed Boolean
    reference String
    saltLength String
    signatureAlgorithm String
    signatureContext String

    Package Details

    Repository
    Vault pulumi/pulumi-vault
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vault Terraform Provider.
    vault logo
    HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi