Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community
published on Thursday, Nov 19, 2026 by akeyless-community
akeyless
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community
published on Thursday, Nov 19, 2026 by akeyless-community
Certificate data source
Using getCertificate
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 getCertificate(args: GetCertificateArgs, opts?: InvokeOptions): Promise<GetCertificateResult>
function getCertificateOutput(args: GetCertificateOutputArgs, opts?: InvokeOutputOptions): Output<GetCertificateResult>def get_certificate(format: Optional[str] = None,
id: Optional[str] = None,
ignore_cache: Optional[str] = None,
include_private_key: Optional[bool] = None,
leaf_only: Optional[bool] = None,
name: Optional[str] = None,
password: Optional[str] = None,
version: Optional[float] = None,
opts: Optional[InvokeOptions] = None) -> GetCertificateResult
def get_certificate_output(format: pulumi.Input[Optional[str]] = None,
id: pulumi.Input[Optional[str]] = None,
ignore_cache: pulumi.Input[Optional[str]] = None,
include_private_key: pulumi.Input[Optional[bool]] = None,
leaf_only: pulumi.Input[Optional[bool]] = None,
name: pulumi.Input[Optional[str]] = None,
password: pulumi.Input[Optional[str]] = None,
version: pulumi.Input[Optional[float]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetCertificateResult]func LookupCertificate(ctx *Context, args *LookupCertificateArgs, opts ...InvokeOption) (*LookupCertificateResult, error)
func LookupCertificateOutput(ctx *Context, args *LookupCertificateOutputArgs, opts ...InvokeOption) LookupCertificateResultOutput> Note: This function is named LookupCertificate in the Go SDK.
public static class GetCertificate
{
public static Task<GetCertificateResult> InvokeAsync(GetCertificateArgs args, InvokeOptions? opts = null)
public static Output<GetCertificateResult> Invoke(GetCertificateInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetCertificateResult> Invoke(GetCertificateInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetCertificateResult> getCertificate(GetCertificateArgs args, InvokeOptions options)
public static Output<GetCertificateResult> getCertificate(GetCertificateArgs args, InvokeOptions options)
public static Output<GetCertificateResult> getCertificate(GetCertificateArgs args, InvokeOutputOptions options)
fn::invoke:
function: akeyless:index/getCertificate:getCertificate
arguments:
# arguments dictionarydata "akeyless_get_certificate" "name" {
# arguments
}The following arguments are supported:
- Format string
- Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
- Id string
- The ID of this resource.
- Ignore
Cache string - Retrieve the Secret value without checking the Gateway's cache [true/false]
- Include
Private boolKey - If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
- Leaf
Only bool - If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
- Name string
- Certificate name
- Password string
- Password to protect the pfx/jks file, required when format is pfx or jks
- Version double
- Certificate version
- Format string
- Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
- Id string
- The ID of this resource.
- Ignore
Cache string - Retrieve the Secret value without checking the Gateway's cache [true/false]
- Include
Private boolKey - If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
- Leaf
Only bool - If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
- Name string
- Certificate name
- Password string
- Password to protect the pfx/jks file, required when format is pfx or jks
- Version float64
- Certificate version
- format string
- Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
- id string
- The ID of this resource.
- ignore_
cache string - Retrieve the Secret value without checking the Gateway's cache [true/false]
- include_
private_ boolkey - If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
- leaf_
only bool - If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
- name string
- Certificate name
- password string
- Password to protect the pfx/jks file, required when format is pfx or jks
- version number
- Certificate version
- format String
- Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
- id String
- The ID of this resource.
- ignore
Cache String - Retrieve the Secret value without checking the Gateway's cache [true/false]
- include
Private BooleanKey - If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
- leaf
Only Boolean - If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
- name String
- Certificate name
- password String
- Password to protect the pfx/jks file, required when format is pfx or jks
- version Double
- Certificate version
- format string
- Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
- id string
- The ID of this resource.
- ignore
Cache string - Retrieve the Secret value without checking the Gateway's cache [true/false]
- include
Private booleanKey - If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
- leaf
Only boolean - If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
- name string
- Certificate name
- password string
- Password to protect the pfx/jks file, required when format is pfx or jks
- version number
- Certificate version
- format str
- Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
- id str
- The ID of this resource.
- ignore_
cache str - Retrieve the Secret value without checking the Gateway's cache [true/false]
- include_
private_ boolkey - If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
- leaf_
only bool - If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
- name str
- Certificate name
- password str
- Password to protect the pfx/jks file, required when format is pfx or jks
- version float
- Certificate version
- format String
- Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
- id String
- The ID of this resource.
- ignore
Cache String - Retrieve the Secret value without checking the Gateway's cache [true/false]
- include
Private BooleanKey - If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
- leaf
Only Boolean - If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
- name String
- Certificate name
- password String
- Password to protect the pfx/jks file, required when format is pfx or jks
- version Number
- Certificate version
getCertificate Result
The following output properties are available:
- Certificate
Pem string - The certificate value in pem format
- Encoded
Certificate string - Base64-encoded certificate data, returned when format is pfx or jks
- Id string
- The ID of this resource.
- Private
Key stringPem - The private key value in pem format
- Format string
- Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
- Ignore
Cache string - Retrieve the Secret value without checking the Gateway's cache [true/false]
- Include
Private boolKey - If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
- Leaf
Only bool - If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
- Name string
- Certificate name
- Password string
- Password to protect the pfx/jks file, required when format is pfx or jks
- Version double
- Certificate version
- Certificate
Pem string - The certificate value in pem format
- Encoded
Certificate string - Base64-encoded certificate data, returned when format is pfx or jks
- Id string
- The ID of this resource.
- Private
Key stringPem - The private key value in pem format
- Format string
- Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
- Ignore
Cache string - Retrieve the Secret value without checking the Gateway's cache [true/false]
- Include
Private boolKey - If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
- Leaf
Only bool - If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
- Name string
- Certificate name
- Password string
- Password to protect the pfx/jks file, required when format is pfx or jks
- Version float64
- Certificate version
- certificate_
pem string - The certificate value in pem format
- encoded_
certificate string - Base64-encoded certificate data, returned when format is pfx or jks
- id string
- The ID of this resource.
- private_
key_ stringpem - The private key value in pem format
- format string
- Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
- ignore_
cache string - Retrieve the Secret value without checking the Gateway's cache [true/false]
- include_
private_ boolkey - If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
- leaf_
only bool - If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
- name string
- Certificate name
- password string
- Password to protect the pfx/jks file, required when format is pfx or jks
- version number
- Certificate version
- certificate
Pem String - The certificate value in pem format
- encoded
Certificate String - Base64-encoded certificate data, returned when format is pfx or jks
- id String
- The ID of this resource.
- private
Key StringPem - The private key value in pem format
- format String
- Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
- ignore
Cache String - Retrieve the Secret value without checking the Gateway's cache [true/false]
- include
Private BooleanKey - If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
- leaf
Only Boolean - If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
- name String
- Certificate name
- password String
- Password to protect the pfx/jks file, required when format is pfx or jks
- version Double
- Certificate version
- certificate
Pem string - The certificate value in pem format
- encoded
Certificate string - Base64-encoded certificate data, returned when format is pfx or jks
- id string
- The ID of this resource.
- private
Key stringPem - The private key value in pem format
- format string
- Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
- ignore
Cache string - Retrieve the Secret value without checking the Gateway's cache [true/false]
- include
Private booleanKey - If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
- leaf
Only boolean - If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
- name string
- Certificate name
- password string
- Password to protect the pfx/jks file, required when format is pfx or jks
- version number
- Certificate version
- certificate_
pem str - The certificate value in pem format
- encoded_
certificate str - Base64-encoded certificate data, returned when format is pfx or jks
- id str
- The ID of this resource.
- private_
key_ strpem - The private key value in pem format
- format str
- Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
- ignore_
cache str - Retrieve the Secret value without checking the Gateway's cache [true/false]
- include_
private_ boolkey - If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
- leaf_
only bool - If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
- name str
- Certificate name
- password str
- Password to protect the pfx/jks file, required when format is pfx or jks
- version float
- Certificate version
- certificate
Pem String - The certificate value in pem format
- encoded
Certificate String - Base64-encoded certificate data, returned when format is pfx or jks
- id String
- The ID of this resource.
- private
Key StringPem - The private key value in pem format
- format String
- Format to download the certificate in [pem/pfx/jks], pfx/jks require a password
- ignore
Cache String - Retrieve the Secret value without checking the Gateway's cache [true/false]
- include
Private BooleanKey - If set, includes the private key in the pfx/jks file, only relevant when format is pfx or jks
- leaf
Only Boolean - If set, downloads only the leaf certificate instead of the full chain, only available for certificates issued with split certificate chain enabled
- name String
- Certificate name
- password String
- Password to protect the pfx/jks file, required when format is pfx or jks
- version Number
- Certificate version
Package Details
- Repository
- akeyless akeyless-community/terraform-provider-akeyless
- License
- Notes
- This Pulumi package is based on the
akeylessTerraform Provider.
akeyless
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community
published on Thursday, Nov 19, 2026 by akeyless-community