WildFly 34 Model Reference

A certificate authority account definition.

Provided capabilities(1)

Name Dynamic Other provider points
org.wildfly.security.certificate-authority-account true

none

Attributes (5)

  • alias The alias of certificate authority account key in the keystore. If the alias does not already exist in the keystore, a certificate authority account key will be automatically generated and stored as a PrivateKeyEntry under the alias.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • certificate-authority The name of the certificate authority to use.
    • Attribute Value
    Default Value LetsEncrypt
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • contact-urls A list of URLs that the certificate authority can contact about any issues related to this account.
    • Attribute Value
    Type LIST
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default
  • credential-reference Credential to be used when accessing the certificate authority account key.
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Stability default
  • key-store The keystore that contains the certificate authority account key.
    • Attribute Value
    Capability reference
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Stability default

Operations (7)

  • add Add a new certificate authority account definition.
    Request Parameter Type Required Expressions Allowed Default value Description
    certificate-authority STRING false true LetsEncrypt The name of the certificate authority to use.
    contact-urls LIST false true A list of URLs that the certificate authority can contact about any issues related to this account.
    alias STRING true true The alias of certificate authority account key in the keystore. If the alias does not already exist in the keystore, a certificate authority account key will be automatically generated and stored as a PrivateKeyEntry under the alias.
    credential-reference OBJECT false false Credential to be used when accessing the certificate authority account key.
    key-store STRING true false The keystore that contains the certificate authority account key.
  • change-account-key Change the key associated with this certificate authority account.
    Request Parameter Type Required Expressions Allowed Default value Description
    staging BOOLEAN false true false Indicates whether or not the certificate authority's staging URL should be used. The default value is false. This should only be set to true for testing purposes. This should never be set to true in a production environment.
  • create-account Create an account with the certificate authority if one doesn't already exist.
    Request Parameter Type Required Expressions Allowed Default value Description
    agree-to-terms-of-service BOOLEAN true true Indicates whether or not the user agrees to the certificate authority's terms of service.
    staging BOOLEAN false true false Indicates whether or not the certificate authority's staging URL should be used. The default value is false. This should only be set to true for testing purposes. This should never be set to true in a production environment.
  • deactivate-account Deactivate this certificate authority account.
    Request Parameter Type Required Expressions Allowed Default value Description
    staging BOOLEAN false true false Indicates whether or not the certificate authority's staging URL should be used. The default value is false. This should only be set to true for testing purposes. This should never be set to true in a production environment.
  • get-metadata Get the metadata associated with the certificate authority.
    Request Parameter Type Required Expressions Allowed Default value Description
    staging BOOLEAN false true false Indicates whether or not the certificate authority's staging URL should be used. The default value is false. This should only be set to true for testing purposes. This should never be set to true in a production environment.
  • remove Remove the certificate authority account definition.
  • update-account Update an account with the certificate authority.
    Request Parameter Type Required Expressions Allowed Default value Description
    agree-to-terms-of-service BOOLEAN true true Indicates whether or not the user agrees to the certificate authority's terms of service.
    staging BOOLEAN false true false Indicates whether or not the certificate authority's staging URL should be used. The default value is false. This should only be set to true for testing purposes. This should never be set to true in a production environment.