1. Registry
  2. Packages
  3. Venafi Provider
  4. API Docs
  5. Provider
Viewing docs for Venafi v1.13.4
published on Tuesday, Oct 27, 2026 by Pulumi
venafi logo venafi logo
Viewing docs for Venafi v1.13.4
published on Tuesday, Oct 27, 2026 by Pulumi

    The provider type for the venafi package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

    Create Provider Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Provider(name: string, args?: ProviderArgs, opts?: CustomResourceOptions);
    @overload
    def Provider(resource_name: str,
                 args: Optional[ProviderArgs] = None,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Provider(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 access_token: Optional[str] = None,
                 api_key: Optional[str] = None,
                 client_id: Optional[str] = None,
                 client_secret: Optional[str] = None,
                 dev_mode: Optional[bool] = None,
                 external_jwt: Optional[str] = None,
                 p12_cert_data: Optional[str] = None,
                 p12_cert_filename: Optional[str] = None,
                 p12_cert_password: Optional[str] = None,
                 skip_retirement: Optional[bool] = None,
                 token_url: Optional[str] = None,
                 tpp_password: Optional[str] = None,
                 tpp_username: Optional[str] = None,
                 trust_bundle: Optional[str] = None,
                 tsg_id: Optional[str] = None,
                 url: Optional[str] = None,
                 zone: Optional[str] = None)
    func NewProvider(ctx *Context, name string, args *ProviderArgs, opts ...ResourceOption) (*Provider, error)
    public Provider(string name, ProviderArgs? args = null, CustomResourceOptions? opts = null)
    public Provider(String name, ProviderArgs args)
    public Provider(String name, ProviderArgs args, CustomResourceOptions options)
    
    type: pulumi:providers:venafi
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "pulumi_providers_venafi" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Provider Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Provider resource accepts the following input properties:

    AccessToken string
    Access token for CyberArk Certificate Manager, Self-Hosted, user should use this for authentication
    ApiKey string
    API key for CyberArk Certificate Manager, SaaS. Example: 142231b7-cvb0-412e-886b-6aeght0bc93d
    ClientId string
    application that will be using the token
    ClientSecret string
    Client Secret for CyberArk Certificate Manager, Self-Hosted or Palo Alto Networks Next-Gen Trust Security (NGTS)
    DevMode bool
    When set to true, the resulting certificate will be issued by an ephemeral, no trust CA rather than enrolling using CyberArk Certificate Manager, SaaS or CyberArk Certificate Manager, Self-Hosted. Useful for development and testing
    ExternalJwt string
    JWT of the identity provider associated to the CyberArk Certificate Manager, SaaS service account that is granting the access token
    P12CertData string
    Base64 encoded PKCS#12 keystore containing a client certificate, private key, and chain certificates to authenticate to CyberArk Certificate Manager, Self-Hosted
    P12CertFilename string
    Filename of PKCS#12 keystore containing a client certificate, private key, and chain certificates to authenticate to CyberArk Certificate Manager, Self-Hosted
    P12CertPassword string
    Password for the PKCS#12 keystore declared in p12Cert / p12_cert_data
    SkipRetirement bool
    When true, certificates will not be retired on CyberArk platforms when terraform destroy is run. Default is false
    TokenUrl string
    Endpoint URL to request new CyberArk Certificate Manager, SaaS access tokens
    TppPassword string
    Password for WebSDK user. Example: password

    Deprecated: , please use accessToken instead

    TppUsername string
    WebSDK user for CyberArk Certificate Manager, Self-Hosted. Example: admin

    Deprecated: , please use accessToken instead

    TrustBundle string
    Use to specify a PEM-formatted file that contains certificates to be trust anchors for all communications with the CyberArk Web Service. Example: trustBundle = "${file("chain.pem")}"
    TsgId string
    The Palo Alto Networks Next-Gen Trust Security (NGTS) TSG ID to use when issuing a token. Only used if platform is detected as 'ngts'
    Url string
    The CyberArk Platform URL. Example: https://cmsh.cyberark.example/vedsdk
    Zone string
    DN of the CyberArk Certificate Manager, Self-Hosted policy folder or name of the CyberArk Certificate Manager, SaaS application plus issuing template alias. Example for CyberArk Certificate Manager, Self-Hosted: testPolicy\vault Example for CyberArk Certificate Manager, SaaS: myApp\Default
    AccessToken string
    Access token for CyberArk Certificate Manager, Self-Hosted, user should use this for authentication
    ApiKey string
    API key for CyberArk Certificate Manager, SaaS. Example: 142231b7-cvb0-412e-886b-6aeght0bc93d
    ClientId string
    application that will be using the token
    ClientSecret string
    Client Secret for CyberArk Certificate Manager, Self-Hosted or Palo Alto Networks Next-Gen Trust Security (NGTS)
    DevMode bool
    When set to true, the resulting certificate will be issued by an ephemeral, no trust CA rather than enrolling using CyberArk Certificate Manager, SaaS or CyberArk Certificate Manager, Self-Hosted. Useful for development and testing
    ExternalJwt string
    JWT of the identity provider associated to the CyberArk Certificate Manager, SaaS service account that is granting the access token
    P12CertData string
    Base64 encoded PKCS#12 keystore containing a client certificate, private key, and chain certificates to authenticate to CyberArk Certificate Manager, Self-Hosted
    P12CertFilename string
    Filename of PKCS#12 keystore containing a client certificate, private key, and chain certificates to authenticate to CyberArk Certificate Manager, Self-Hosted
    P12CertPassword string
    Password for the PKCS#12 keystore declared in p12Cert / p12_cert_data
    SkipRetirement bool
    When true, certificates will not be retired on CyberArk platforms when terraform destroy is run. Default is false
    TokenUrl string
    Endpoint URL to request new CyberArk Certificate Manager, SaaS access tokens
    TppPassword string
    Password for WebSDK user. Example: password

    Deprecated: , please use accessToken instead

    TppUsername string
    WebSDK user for CyberArk Certificate Manager, Self-Hosted. Example: admin

    Deprecated: , please use accessToken instead

    TrustBundle string
    Use to specify a PEM-formatted file that contains certificates to be trust anchors for all communications with the CyberArk Web Service. Example: trustBundle = "${file("chain.pem")}"
    TsgId string
    The Palo Alto Networks Next-Gen Trust Security (NGTS) TSG ID to use when issuing a token. Only used if platform is detected as 'ngts'
    Url string
    The CyberArk Platform URL. Example: https://cmsh.cyberark.example/vedsdk
    Zone string
    DN of the CyberArk Certificate Manager, Self-Hosted policy folder or name of the CyberArk Certificate Manager, SaaS application plus issuing template alias. Example for CyberArk Certificate Manager, Self-Hosted: testPolicy\vault Example for CyberArk Certificate Manager, SaaS: myApp\Default
    access_token string
    Access token for CyberArk Certificate Manager, Self-Hosted, user should use this for authentication
    api_key string
    API key for CyberArk Certificate Manager, SaaS. Example: 142231b7-cvb0-412e-886b-6aeght0bc93d
    client_id string
    application that will be using the token
    client_secret string
    Client Secret for CyberArk Certificate Manager, Self-Hosted or Palo Alto Networks Next-Gen Trust Security (NGTS)
    dev_mode bool
    When set to true, the resulting certificate will be issued by an ephemeral, no trust CA rather than enrolling using CyberArk Certificate Manager, SaaS or CyberArk Certificate Manager, Self-Hosted. Useful for development and testing
    external_jwt string
    JWT of the identity provider associated to the CyberArk Certificate Manager, SaaS service account that is granting the access token
    p12_cert_data string
    Base64 encoded PKCS#12 keystore containing a client certificate, private key, and chain certificates to authenticate to CyberArk Certificate Manager, Self-Hosted
    p12_cert_filename string
    Filename of PKCS#12 keystore containing a client certificate, private key, and chain certificates to authenticate to CyberArk Certificate Manager, Self-Hosted
    p12_cert_password string
    Password for the PKCS#12 keystore declared in p12Cert / p12_cert_data
    skip_retirement bool
    When true, certificates will not be retired on CyberArk platforms when terraform destroy is run. Default is false
    token_url string
    Endpoint URL to request new CyberArk Certificate Manager, SaaS access tokens
    tpp_password string
    Password for WebSDK user. Example: password

    Deprecated: , please use accessToken instead

    tpp_username string
    WebSDK user for CyberArk Certificate Manager, Self-Hosted. Example: admin

    Deprecated: , please use accessToken instead

    trust_bundle string
    Use to specify a PEM-formatted file that contains certificates to be trust anchors for all communications with the CyberArk Web Service. Example: trustBundle = "${file("chain.pem")}"
    tsg_id string
    The Palo Alto Networks Next-Gen Trust Security (NGTS) TSG ID to use when issuing a token. Only used if platform is detected as 'ngts'
    url string
    The CyberArk Platform URL. Example: https://cmsh.cyberark.example/vedsdk
    zone string
    DN of the CyberArk Certificate Manager, Self-Hosted policy folder or name of the CyberArk Certificate Manager, SaaS application plus issuing template alias. Example for CyberArk Certificate Manager, Self-Hosted: testPolicy\vault Example for CyberArk Certificate Manager, SaaS: myApp\Default
    accessToken String
    Access token for CyberArk Certificate Manager, Self-Hosted, user should use this for authentication
    apiKey String
    API key for CyberArk Certificate Manager, SaaS. Example: 142231b7-cvb0-412e-886b-6aeght0bc93d
    clientId String
    application that will be using the token
    clientSecret String
    Client Secret for CyberArk Certificate Manager, Self-Hosted or Palo Alto Networks Next-Gen Trust Security (NGTS)
    devMode Boolean
    When set to true, the resulting certificate will be issued by an ephemeral, no trust CA rather than enrolling using CyberArk Certificate Manager, SaaS or CyberArk Certificate Manager, Self-Hosted. Useful for development and testing
    externalJwt String
    JWT of the identity provider associated to the CyberArk Certificate Manager, SaaS service account that is granting the access token
    p12CertData String
    Base64 encoded PKCS#12 keystore containing a client certificate, private key, and chain certificates to authenticate to CyberArk Certificate Manager, Self-Hosted
    p12CertFilename String
    Filename of PKCS#12 keystore containing a client certificate, private key, and chain certificates to authenticate to CyberArk Certificate Manager, Self-Hosted
    p12CertPassword String
    Password for the PKCS#12 keystore declared in p12Cert / p12_cert_data
    skipRetirement Boolean
    When true, certificates will not be retired on CyberArk platforms when terraform destroy is run. Default is false
    tokenUrl String
    Endpoint URL to request new CyberArk Certificate Manager, SaaS access tokens
    tppPassword String
    Password for WebSDK user. Example: password

    Deprecated: , please use accessToken instead

    tppUsername String
    WebSDK user for CyberArk Certificate Manager, Self-Hosted. Example: admin

    Deprecated: , please use accessToken instead

    trustBundle String
    Use to specify a PEM-formatted file that contains certificates to be trust anchors for all communications with the CyberArk Web Service. Example: trustBundle = "${file("chain.pem")}"
    tsgId String
    The Palo Alto Networks Next-Gen Trust Security (NGTS) TSG ID to use when issuing a token. Only used if platform is detected as 'ngts'
    url String
    The CyberArk Platform URL. Example: https://cmsh.cyberark.example/vedsdk
    zone String
    DN of the CyberArk Certificate Manager, Self-Hosted policy folder or name of the CyberArk Certificate Manager, SaaS application plus issuing template alias. Example for CyberArk Certificate Manager, Self-Hosted: testPolicy\vault Example for CyberArk Certificate Manager, SaaS: myApp\Default
    accessToken string
    Access token for CyberArk Certificate Manager, Self-Hosted, user should use this for authentication
    apiKey string
    API key for CyberArk Certificate Manager, SaaS. Example: 142231b7-cvb0-412e-886b-6aeght0bc93d
    clientId string
    application that will be using the token
    clientSecret string
    Client Secret for CyberArk Certificate Manager, Self-Hosted or Palo Alto Networks Next-Gen Trust Security (NGTS)
    devMode boolean
    When set to true, the resulting certificate will be issued by an ephemeral, no trust CA rather than enrolling using CyberArk Certificate Manager, SaaS or CyberArk Certificate Manager, Self-Hosted. Useful for development and testing
    externalJwt string
    JWT of the identity provider associated to the CyberArk Certificate Manager, SaaS service account that is granting the access token
    p12CertData string
    Base64 encoded PKCS#12 keystore containing a client certificate, private key, and chain certificates to authenticate to CyberArk Certificate Manager, Self-Hosted
    p12CertFilename string
    Filename of PKCS#12 keystore containing a client certificate, private key, and chain certificates to authenticate to CyberArk Certificate Manager, Self-Hosted
    p12CertPassword string
    Password for the PKCS#12 keystore declared in p12Cert / p12_cert_data
    skipRetirement boolean
    When true, certificates will not be retired on CyberArk platforms when terraform destroy is run. Default is false
    tokenUrl string
    Endpoint URL to request new CyberArk Certificate Manager, SaaS access tokens
    tppPassword string
    Password for WebSDK user. Example: password

    Deprecated: , please use accessToken instead

    tppUsername string
    WebSDK user for CyberArk Certificate Manager, Self-Hosted. Example: admin

    Deprecated: , please use accessToken instead

    trustBundle string
    Use to specify a PEM-formatted file that contains certificates to be trust anchors for all communications with the CyberArk Web Service. Example: trustBundle = "${file("chain.pem")}"
    tsgId string
    The Palo Alto Networks Next-Gen Trust Security (NGTS) TSG ID to use when issuing a token. Only used if platform is detected as 'ngts'
    url string
    The CyberArk Platform URL. Example: https://cmsh.cyberark.example/vedsdk
    zone string
    DN of the CyberArk Certificate Manager, Self-Hosted policy folder or name of the CyberArk Certificate Manager, SaaS application plus issuing template alias. Example for CyberArk Certificate Manager, Self-Hosted: testPolicy\vault Example for CyberArk Certificate Manager, SaaS: myApp\Default
    access_token str
    Access token for CyberArk Certificate Manager, Self-Hosted, user should use this for authentication
    api_key str
    API key for CyberArk Certificate Manager, SaaS. Example: 142231b7-cvb0-412e-886b-6aeght0bc93d
    client_id str
    application that will be using the token
    client_secret str
    Client Secret for CyberArk Certificate Manager, Self-Hosted or Palo Alto Networks Next-Gen Trust Security (NGTS)
    dev_mode bool
    When set to true, the resulting certificate will be issued by an ephemeral, no trust CA rather than enrolling using CyberArk Certificate Manager, SaaS or CyberArk Certificate Manager, Self-Hosted. Useful for development and testing
    external_jwt str
    JWT of the identity provider associated to the CyberArk Certificate Manager, SaaS service account that is granting the access token
    p12_cert_data str
    Base64 encoded PKCS#12 keystore containing a client certificate, private key, and chain certificates to authenticate to CyberArk Certificate Manager, Self-Hosted
    p12_cert_filename str
    Filename of PKCS#12 keystore containing a client certificate, private key, and chain certificates to authenticate to CyberArk Certificate Manager, Self-Hosted
    p12_cert_password str
    Password for the PKCS#12 keystore declared in p12Cert / p12_cert_data
    skip_retirement bool
    When true, certificates will not be retired on CyberArk platforms when terraform destroy is run. Default is false
    token_url str
    Endpoint URL to request new CyberArk Certificate Manager, SaaS access tokens
    tpp_password str
    Password for WebSDK user. Example: password

    Deprecated: , please use accessToken instead

    tpp_username str
    WebSDK user for CyberArk Certificate Manager, Self-Hosted. Example: admin

    Deprecated: , please use accessToken instead

    trust_bundle str
    Use to specify a PEM-formatted file that contains certificates to be trust anchors for all communications with the CyberArk Web Service. Example: trustBundle = "${file("chain.pem")}"
    tsg_id str
    The Palo Alto Networks Next-Gen Trust Security (NGTS) TSG ID to use when issuing a token. Only used if platform is detected as 'ngts'
    url str
    The CyberArk Platform URL. Example: https://cmsh.cyberark.example/vedsdk
    zone str
    DN of the CyberArk Certificate Manager, Self-Hosted policy folder or name of the CyberArk Certificate Manager, SaaS application plus issuing template alias. Example for CyberArk Certificate Manager, Self-Hosted: testPolicy\vault Example for CyberArk Certificate Manager, SaaS: myApp\Default
    accessToken String
    Access token for CyberArk Certificate Manager, Self-Hosted, user should use this for authentication
    apiKey String
    API key for CyberArk Certificate Manager, SaaS. Example: 142231b7-cvb0-412e-886b-6aeght0bc93d
    clientId String
    application that will be using the token
    clientSecret String
    Client Secret for CyberArk Certificate Manager, Self-Hosted or Palo Alto Networks Next-Gen Trust Security (NGTS)
    devMode Boolean
    When set to true, the resulting certificate will be issued by an ephemeral, no trust CA rather than enrolling using CyberArk Certificate Manager, SaaS or CyberArk Certificate Manager, Self-Hosted. Useful for development and testing
    externalJwt String
    JWT of the identity provider associated to the CyberArk Certificate Manager, SaaS service account that is granting the access token
    p12CertData String
    Base64 encoded PKCS#12 keystore containing a client certificate, private key, and chain certificates to authenticate to CyberArk Certificate Manager, Self-Hosted
    p12CertFilename String
    Filename of PKCS#12 keystore containing a client certificate, private key, and chain certificates to authenticate to CyberArk Certificate Manager, Self-Hosted
    p12CertPassword String
    Password for the PKCS#12 keystore declared in p12Cert / p12_cert_data
    skipRetirement Boolean
    When true, certificates will not be retired on CyberArk platforms when terraform destroy is run. Default is false
    tokenUrl String
    Endpoint URL to request new CyberArk Certificate Manager, SaaS access tokens
    tppPassword String
    Password for WebSDK user. Example: password

    Deprecated: , please use accessToken instead

    tppUsername String
    WebSDK user for CyberArk Certificate Manager, Self-Hosted. Example: admin

    Deprecated: , please use accessToken instead

    trustBundle String
    Use to specify a PEM-formatted file that contains certificates to be trust anchors for all communications with the CyberArk Web Service. Example: trustBundle = "${file("chain.pem")}"
    tsgId String
    The Palo Alto Networks Next-Gen Trust Security (NGTS) TSG ID to use when issuing a token. Only used if platform is detected as 'ngts'
    url String
    The CyberArk Platform URL. Example: https://cmsh.cyberark.example/vedsdk
    zone String
    DN of the CyberArk Certificate Manager, Self-Hosted policy folder or name of the CyberArk Certificate Manager, SaaS application plus issuing template alias. Example for CyberArk Certificate Manager, Self-Hosted: testPolicy\vault Example for CyberArk Certificate Manager, SaaS: myApp\Default

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Provider resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Provider Resource Methods

    TerraformConfig Method

    This function returns a Terraform config object with terraform-namecased keys,to be used with the Terraform Module Provider.

    Using TerraformConfig

    terraformConfig(): Output<Provider.TerraformConfigResult>
    def terraform_config() -> Output[Provider.Terraform_configResult]
    func (r *Provider) TerraformConfig() (ProviderTerraformConfigResultOutput, error)
    public Output<Provider.TerraformConfigResult> TerraformConfig()

    TerraformConfig Result

    Result Dictionary<string, object>
    Result map[string]interface{}
    result map(any)
    result Map<String,Object>
    result {[key: string]: any}
    result Mapping[str, Any]
    result Map<Any>

    Package Details

    Repository
    Venafi pulumi/pulumi-venafi
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the venafi Terraform Provider.
    venafi logo venafi logo
    Viewing docs for Venafi v1.13.4
    published on Tuesday, Oct 27, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial