Management API Reference for certificate-authority-account

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.

Type	STRING
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "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-group" : "account-key", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

certificate-authority - The name of the certificate authority to use.

Type	STRING
Default Value	LetsEncrypt
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the certificate authority to use.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "LetsEncrypt", "capability-reference" : "org.wildfly.security.certificate-authority", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

contact-urls - A list of URLs that the certificate authority can contact about any issues related to this account.

Type	LIST
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A list of URLs that the certificate authority can contact about any issues related to this account.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

credential-reference - Credential to be used when accessing the certificate authority account key.

Type	OBJECT
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Credential to be used when accessing the certificate authority account key.", "attribute-group" : "account-key", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "access-constraints" : {"sensitive" : {"credential" : {"type" : "core"}}}, "value-type" : { "store" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the credential store holding the alias to credential.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.credential-store", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "alias" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The alias which denotes stored secret or credential in the store.", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["store"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of credential this reference is denoting.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "clear-text" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Secret specified using clear text. Check credential store way of supplying credential/secrets to services.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

key-store - The keystore that contains the certificate authority account key.

Type	STRING
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The keystore that contains the certificate authority account key.", "attribute-group" : "account-key", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.key-store", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

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.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a new certificate authority account definition.",
    "request-properties" : {
        "certificate-authority" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the certificate authority to use.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "LetsEncrypt",
            "capability-reference" : "org.wildfly.security.certificate-authority",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "contact-urls" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "A list of URLs that the certificate authority can contact about any issues related to this account.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "alias" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "credential-reference" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Credential to be used when accessing the certificate authority account key.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "store" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The name of the credential store holding the alias to credential.",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "capability-reference" : "org.wildfly.security.credential-store",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "alias" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The alias which denotes stored secret or credential in the store.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "requires" : ["store"],
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "type" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The type of credential this reference is denoting.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "clear-text" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "Secret specified using clear text. Check credential store way of supplying credential/secrets to services.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        },
        "key-store" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The keystore that contains the certificate authority account key.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.security.key-store",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

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.

Raw DMR model


{
    "operation-name" : "change-account-key",
    "description" : "Change the key associated with this certificate authority account.",
    "request-properties" : {"staging" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "BOOLEAN"
        },
        "description" : "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.",
        "expressions-allowed" : true,
        "required" : false,
        "nillable" : true,
        "default" : false,
        "stability" : "default"
    }},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

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.

Raw DMR model


{
    "operation-name" : "create-account",
    "description" : "Create an account with the certificate authority if one doesn't already exist.",
    "request-properties" : {
        "agree-to-terms-of-service" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Indicates whether or not the user agrees to the certificate authority's terms of service.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "stability" : "default"
        },
        "staging" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

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.

Raw DMR model


{
    "operation-name" : "deactivate-account",
    "description" : "Deactivate this certificate authority account.",
    "request-properties" : {"staging" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "BOOLEAN"
        },
        "description" : "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.",
        "expressions-allowed" : true,
        "required" : false,
        "nillable" : true,
        "default" : false,
        "stability" : "default"
    }},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

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.

Raw DMR model


{
    "operation-name" : "get-metadata",
    "description" : "Get the metadata associated with the certificate authority.",
    "request-properties" : {"staging" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "BOOLEAN"
        },
        "description" : "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.",
        "expressions-allowed" : true,
        "required" : false,
        "nillable" : true,
        "default" : false,
        "stability" : "default"
    }},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

remove - Remove the certificate authority account definition.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove the certificate authority account definition.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

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.

Raw DMR model


{
    "operation-name" : "update-account",
    "description" : "Update an account with the certificate authority.",
    "request-properties" : {
        "agree-to-terms-of-service" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Indicates whether or not the user agrees to the certificate authority's terms of service.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "stability" : "default"
        },
        "staging" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "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.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

subsystem.elytron.certificate-authority-account

        
<feature spec="subsystem.elytron.certificate-authority-account">
  <param name="certificate-authority-account" value="{resource name}"/>
  <param name="alias" value="{value}"/>
  <param name="contact-urls" value="{value}"/>
  <param name="credential-reference" value="{value}"/>
  <param name="key-store" value="{value}"/>
<feature/>