Management API Reference for ldap-key-store

A LdapKeyStore definition.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.key-store	true	/subsystem=elytron/filtering-key-store=* /subsystem=elytron/key-store=* /subsystem=security/elytron-key-store=* /subsystem=security/elytron-trust-store=*

Attributes (17)

alias-attribute - The name of LDAP attribute, where will be item alias stored.

Type	STRING
Default Value	cn
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 LDAP attribute, where will be item alias stored.", "attribute-group" : "attribute-mapping", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "cn", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

certificate-attribute - The name of LDAP attribute, where will be certificate stored.

Type	STRING
Default Value	usercertificate
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 LDAP attribute, where will be certificate stored.", "attribute-group" : "attribute-mapping", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "usercertificate", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

certificate-chain-attribute - The name of LDAP attribute, where will be certificate chain stored.

Type	STRING
Default Value	userSMIMECertificate
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 LDAP attribute, where will be certificate chain stored.", "attribute-group" : "attribute-mapping", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "userSMIMECertificate", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

certificate-chain-encoding - The encoding of the certificate chain.

Type	STRING
Default Value	PKCS7
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 encoding of the certificate chain.", "attribute-group" : "attribute-mapping", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "PKCS7", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

certificate-type - The type of the Certificate.

Type	STRING
Default Value	X.509
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 type of the Certificate.", "attribute-group" : "attribute-mapping", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "X.509", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

dir-context - The name of DirContext, which will be used to communication with LDAP server.

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 name of DirContext, which will be used to communication with LDAP server.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.dir-context", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

filter-alias - The LDAP filter for obtaining an item of the KeyStore by alias. If this is not specified then the default value will be (alias_attribute={0}). The string '{0}' will be replaced by the searched alias and the 'alias_attribute' value will be the value of the attribute 'alias-attribute'.

Type	STRING
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 LDAP filter for obtaining an item of the KeyStore by alias. If this is not specified then the default value will be (alias_attribute={0}). The string '{0}' will be replaced by the searched alias and the 'alias_attribute' value will be the value of the attribute 'alias-attribute'.", "attribute-group" : "search", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

filter-certificate - The LDAP filter for obtaining an item of the KeyStore by certificate. If this is not specified then the default value will be (certificate_attribute={0}). The string '{0}' will be replaced by searched encoded certificate and the 'certificate_attribute' will be the value of the attribute 'certificate-attribute'.

Type	STRING
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 LDAP filter for obtaining an item of the KeyStore by certificate. If this is not specified then the default value will be (certificate_attribute={0}). The string '{0}' will be replaced by searched encoded certificate and the 'certificate_attribute' will be the value of the attribute 'certificate-attribute'.", "attribute-group" : "search", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

filter-iterate - The LDAP filter for iterating over all items of the KeyStore. If this is not specified then the default value will be (alias_attribute=*). The 'alias_attribute' will be the value of the attribute 'alias-attribute'.

Type	STRING
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 LDAP filter for iterating over all items of the KeyStore. If this is not specified then the default value will be (alias_attribute=*). The 'alias_attribute' will be the value of the attribute 'alias-attribute'.", "attribute-group" : "search", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

key-attribute - The name of LDAP attribute, where will be key stored.

Type	STRING
Default Value	userPKCS12
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 LDAP attribute, where will be key stored.", "attribute-group" : "attribute-mapping", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "userPKCS12", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

key-type - The type of KeyStore, in which will be key serialized to LDAP attribute.

Type	STRING
Default Value	PKCS12
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 type of KeyStore, in which will be key serialized to LDAP attribute.", "attribute-group" : "attribute-mapping", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "PKCS12", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

new-item-template - Configuration for item creation. Define how will look LDAP entry of newly created keystore item.

Type	OBJECT
Is the attribute nillable?	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" : "OBJECT" }, "description" : "Configuration for item creation. Define how will look LDAP entry of newly created keystore item.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "new-item-path" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The path in LDAP, where will be newly created KeyStore items stored.", "expressions-allowed" : true, "required" : true, "nillable" : false, "requires" : [ "new-item-rdn", "new-item-attributes" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "new-item-rdn" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of LDAP attribute, which will be used in RDN of newly created items.", "expressions-allowed" : true, "required" : true, "nillable" : false, "requires" : [ "new-item-path", "new-item-attributes" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "new-item-attributes" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The LDAP attributes, which will be set for newly created items.", "expressions-allowed" : false, "required" : true, "nillable" : false, "requires" : [ "new-item-path", "new-item-rdn" ], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the LDAP attribute.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "value" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The value of LDAP attribute.", "expressions-allowed" : true, "required" : true, "nillable" : false, "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 }

search-path - The path in LDAP, where will be KeyStore items searched.

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 path in LDAP, where will be KeyStore items searched.", "attribute-group" : "search", "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 }`

search-recursive - If the LDAP search should be recursive.

Type	BOOLEAN
Default Value	true
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" : "BOOLEAN" }, "description" : "If the LDAP search should be recursive.", "attribute-group" : "search", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

search-time-limit - The time limit for obtaining keystore items from LDAP.

Type	INT
Default Value	10000
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" : "INT" }, "description" : "The time limit for obtaining keystore items from LDAP.", "attribute-group" : "search", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 10000, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

size - The size of LDAP KeyStore in amount of items/aliases.

Type	INT
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The size of LDAP KeyStore in amount of items/aliases.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

state - The state of the underlying service that represents this KeyStore at runtime, if it is anything other than UP runtime operations will not be available.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Allowed Values	DOWN STARTING START_FAILED UP STOPPING REMOVED
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The state of the underlying service that represents this KeyStore at runtime, if it is anything other than UP runtime operations will not be available.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "allowed" : [ "DOWN", "STARTING", "START_FAILED", "UP", "STOPPING", "REMOVED" ], "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

Operations (5)

add - Add a new LDAP KeyStore.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
dir-context	STRING	true	false		The name of DirContext, which will be used to communication with LDAP server.
new-item-template	OBJECT	false	false		Configuration for item creation. Define how will look LDAP entry of newly created keystore item.
alias-attribute	STRING	false	true	cn	The name of LDAP attribute, where will be item alias stored.
certificate-attribute	STRING	false	true	usercertificate	The name of LDAP attribute, where will be certificate stored.
certificate-chain-attribute	STRING	false	true	userSMIMECertificate	The name of LDAP attribute, where will be certificate chain stored.
certificate-chain-encoding	STRING	false	true	PKCS7	The encoding of the certificate chain.
certificate-type	STRING	false	true	X.509	The type of the Certificate.
key-attribute	STRING	false	true	userPKCS12	The name of LDAP attribute, where will be key stored.
key-type	STRING	false	true	PKCS12	The type of KeyStore, in which will be key serialized to LDAP attribute.
filter-alias	STRING	false	true		The LDAP filter for obtaining an item of the KeyStore by alias. If this is not specified then the default value will be (alias_attribute={0}). The string '{0}' will be replaced by the searched alias and the 'alias_attribute' value will be the value of the attribute 'alias-attribute'.
filter-certificate	STRING	false	true		The LDAP filter for obtaining an item of the KeyStore by certificate. If this is not specified then the default value will be (certificate_attribute={0}). The string '{0}' will be replaced by searched encoded certificate and the 'certificate_attribute' will be the value of the attribute 'certificate-attribute'.
filter-iterate	STRING	false	true		The LDAP filter for iterating over all items of the KeyStore. If this is not specified then the default value will be (alias_attribute=*). The 'alias_attribute' will be the value of the attribute 'alias-attribute'.
search-path	STRING	true	true		The path in LDAP, where will be KeyStore items searched.
search-recursive	BOOLEAN	false	true	true	If the LDAP search should be recursive.
search-time-limit	INT	false	true	10000	The time limit for obtaining keystore items from LDAP.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a new LDAP KeyStore.",
    "request-properties" : {
        "dir-context" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of DirContext, which will be used to communication with LDAP server.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.security.dir-context",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "new-item-template" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Configuration for item creation. Define how will look LDAP entry of newly created keystore item.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "new-item-path" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The path in LDAP, where will be newly created KeyStore items stored.",
                    "expressions-allowed" : true,
                    "required" : true,
                    "nillable" : false,
                    "requires" : [
                        "new-item-rdn",
                        "new-item-attributes"
                    ],
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "new-item-rdn" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The name of LDAP attribute, which will be used in RDN of newly created items.",
                    "expressions-allowed" : true,
                    "required" : true,
                    "nillable" : false,
                    "requires" : [
                        "new-item-path",
                        "new-item-attributes"
                    ],
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "new-item-attributes" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "LIST"
                    },
                    "description" : "The LDAP attributes, which will be set for newly created items.",
                    "expressions-allowed" : false,
                    "required" : true,
                    "nillable" : false,
                    "requires" : [
                        "new-item-path",
                        "new-item-rdn"
                    ],
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default",
                    "value-type" : {
                        "name" : {
                            "type" : {
                                "TYPE_MODEL_VALUE" : "STRING"
                            },
                            "description" : "The name of the LDAP attribute.",
                            "expressions-allowed" : true,
                            "required" : true,
                            "nillable" : false,
                            "min-length" : 1,
                            "max-length" : 2147483647,
                            "stability" : "default"
                        },
                        "value" : {
                            "type" : {
                                "TYPE_MODEL_VALUE" : "LIST"
                            },
                            "description" : "The value of LDAP attribute.",
                            "expressions-allowed" : true,
                            "required" : true,
                            "nillable" : false,
                            "min-length" : 1,
                            "max-length" : 2147483647,
                            "stability" : "default",
                            "value-type" : {
                                "TYPE_MODEL_VALUE" : "STRING"
                            }
                        }
                    }
                }
            }
        },
        "alias-attribute" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of LDAP attribute, where will be item alias stored.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "cn",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "certificate-attribute" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of LDAP attribute, where will be certificate stored.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "usercertificate",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "certificate-chain-attribute" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of LDAP attribute, where will be certificate chain stored.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "userSMIMECertificate",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "certificate-chain-encoding" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The encoding of the certificate chain.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "PKCS7",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "certificate-type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The type of the Certificate.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "X.509",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "key-attribute" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of LDAP attribute, where will be key stored.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "userPKCS12",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "key-type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The type of KeyStore, in which will be key serialized to LDAP attribute.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "PKCS12",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "filter-alias" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The LDAP filter for obtaining an item of the KeyStore by alias. If this is not specified then the default value will be (alias_attribute={0}). The string '{0}' will be replaced by the searched alias and the 'alias_attribute' value will be the value of the attribute 'alias-attribute'.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "filter-certificate" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The LDAP filter for obtaining an item of the KeyStore by certificate. If this is not specified then the default value will be (certificate_attribute={0}). The string '{0}' will be replaced by searched encoded certificate and the 'certificate_attribute' will be the value of the attribute 'certificate-attribute'.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "filter-iterate" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The LDAP filter for iterating over all items of the KeyStore. If this is not specified then the default value will be (alias_attribute=*). The 'alias_attribute' will be the value of the attribute 'alias-attribute'.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "search-path" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The path in LDAP, where will be KeyStore items searched.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "search-recursive" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "If the LDAP search should be recursive.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "search-time-limit" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The time limit for obtaining keystore items from LDAP.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 10000,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

read-alias - Read an alias from a KeyStore.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
alias	STRING	true	false		The alias of the KeyStore item to read.
verbose	BOOLEAN	false	false	true	Whether or not to include the public key and encoded form of a certificate in the output. The default value is true.

Raw DMR model


{
    "operation-name" : "read-alias",
    "description" : "Read an alias from a KeyStore.",
    "request-properties" : {
        "alias" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The alias of the KeyStore item to read.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "verbose" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether or not to include the public key and encoded form of a certificate in the output. The default value is true.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

read-aliases - Read aliases from a KeyStore.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
recursive	BOOLEAN	false	false	false	Include information about each alias in the KeyStore. The default value is false.
verbose	BOOLEAN	false	false	true	Whether or not to include the public key and encoded form of a certificate in the output. The default value is true.

Raw DMR model


{
    "operation-name" : "read-aliases",
    "description" : "Read aliases from a KeyStore.",
    "request-properties" : {
        "recursive" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Include information about each alias in the KeyStore. The default value is false.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "verbose" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether or not to include the public key and encoded form of a certificate in the output. The default value is true.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "requires" : ["recursive"],
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

remove - Remove the LDAP KeyStore.

Raw DMR model


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

remove-alias - Remove an alias from a KeyStore.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
alias	STRING	true	false		The alias of the KeyStore item to remove.

Raw DMR model


{
    "operation-name" : "remove-alias",
    "description" : "Remove an alias from a KeyStore.",
    "request-properties" : {"alias" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The alias of the KeyStore item to remove.",
        "expressions-allowed" : false,
        "required" : true,
        "nillable" : false,
        "min-length" : 1,
        "max-length" : 2147483647,
        "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.ldap-key-store

        
<feature spec="subsystem.elytron.ldap-key-store">
  <param name="ldap-key-store" value="{resource name}"/>
  <param name="alias-attribute" value="{value}"/>
  <param name="certificate-attribute" value="{value}"/>
  <param name="certificate-chain-attribute" value="{value}"/>
  <param name="certificate-chain-encoding" value="{value}"/>
  <param name="certificate-type" value="{value}"/>
  <param name="dir-context" value="{value}"/>
  <param name="filter-alias" value="{value}"/>
  <param name="filter-certificate" value="{value}"/>
  <param name="filter-iterate" value="{value}"/>
  <param name="key-attribute" value="{value}"/>
  <param name="key-type" value="{value}"/>
  <param name="new-item-template" value="{value}"/>
  <param name="search-path" value="{value}"/>
  <param name="search-recursive" value="{value}"/>
  <param name="search-time-limit" value="{value}"/>
<feature/>