Management API Reference for filesystem-realm

A simple security realm definition backed by the filesystem.

Provided Capabilities (2)

Name	Dynamic	Other provider points
org.wildfly.security.security-realm	true	/subsystem=elytron/jaas-realm=* /subsystem=elytron/jdbc-realm=* /subsystem=elytron/token-realm=* /subsystem=elytron/ldap-realm=* /subsystem=elytron/distributed-realm=* /subsystem=elytron/key-store-realm=* /subsystem=elytron/failover-realm=* /subsystem=security/elytron-realm=* /subsystem=elytron/custom-modifiable-realm=* /subsystem=elytron/identity-realm=* /subsystem=elytron/aggregate-realm=* /subsystem=elytron/properties-realm=* /subsystem=elytron/caching-realm=* /subsystem=elytron/custom-realm=*
org.wildfly.security.modifiable-security-realm	true	/subsystem=elytron/custom-modifiable-realm=* /subsystem=elytron/token-realm=* /subsystem=elytron/ldap-realm=*

Attributes (10)

credential-store - The reference to the credential store that contains the secret key to encrypt and decrypt the realm.

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 reference to the credential store that contains the secret key to encrypt and decrypt the realm.", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["secret-key"], "capability-reference" : "org.wildfly.security.credential-store", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

encoded - Whether the identity names should be stored encoded (Base32) in file names. If encryption is configured, this attribute is ignored.

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" : "Whether the identity names should be stored encoded (Base32) in file names. If encryption is configured, this attribute is ignored.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

hash-charset - The character set to use when converting the password string to a byte array.

Type	STRING
Default Value	UTF-8
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The character set to use when converting the password string to a byte array.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "UTF-8", "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

hash-encoding - The string format for the password if it is not stored in plain text.

Type	STRING
Default Value	base64
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Allowed Values	base64 hex
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The string format for the password if it is not stored in plain text.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "base64", "allowed" : [ "base64", "hex" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

key-store - The reference to the key store that contains the key pair to use to verify integrity.

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?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The reference to the key store that contains the key pair to use to verify integrity.", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["key-store-alias"], "capability-reference" : "org.wildfly.security.key-store", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services" }`

key-store-alias - The alias that identifies the PrivateKeyEntry within the key store to use to verify integrity.

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 alias that identifies the PrivateKeyEntry within the key store to use to verify integrity.", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["key-store"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

levels - The number of levels of directory hashing to apply.

Type	INT
Default Value	2
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 number of levels of directory hashing to apply.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : 2, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

path - The path to the file containing the realm.

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 to the file containing the realm.", "attribute-group" : "file", "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 }`

relative-to - The pre-defined path the path is relative to.

Type	STRING
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" : "STRING" }, "description" : "The pre-defined path the path is relative to.", "attribute-group" : "file", "expressions-allowed" : false, "required" : false, "nillable" : true, "requires" : ["path"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

secret-key - The alias of the secret key to encrypt and decrypt the realm.

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 alias of the secret key to encrypt and decrypt the realm.", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["credential-store"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (10)

add - The add operation for the security realm.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
credential-store	STRING	false	true		The reference to the credential store that contains the secret key to encrypt and decrypt the realm.
encoded	BOOLEAN	false	true	true	Whether the identity names should be stored encoded (Base32) in file names. If encryption is configured, this attribute is ignored.
hash-charset	STRING	false	true	UTF-8	The character set to use when converting the password string to a byte array.
hash-encoding	STRING	false	true	base64	The string format for the password if it is not stored in plain text.
key-store	STRING	false	true		The reference to the key store that contains the key pair to use to verify integrity.
key-store-alias	STRING	false	true		The alias that identifies the PrivateKeyEntry within the key store to use to verify integrity.
levels	INT	false	true	2	The number of levels of directory hashing to apply.
secret-key	STRING	false	true		The alias of the secret key to encrypt and decrypt the realm.
path	STRING	true	true		The path to the file containing the realm.
relative-to	STRING	false	false		The pre-defined path the path is relative to.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "The add operation for the security realm.",
    "request-properties" : {
        "credential-store" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The reference to the credential store that contains the secret key to encrypt and decrypt the realm.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "requires" : ["secret-key"],
            "capability-reference" : "org.wildfly.security.credential-store",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "encoded" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether the identity names should be stored encoded (Base32) in file names. If encryption is configured, this attribute is ignored.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "hash-charset" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The character set to use when converting the password string to a byte array.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "UTF-8",
            "stability" : "default"
        },
        "hash-encoding" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The string format for the password if it is not stored in plain text.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "base64",
            "allowed" : [
                "base64",
                "hex"
            ],
            "stability" : "default"
        },
        "key-store" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The reference to the key store that contains the key pair to use to verify integrity.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "requires" : ["key-store-alias"],
            "capability-reference" : "org.wildfly.security.key-store",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "key-store-alias" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The alias that identifies the PrivateKeyEntry within the key store to use to verify integrity.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "requires" : ["key-store"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "levels" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The number of levels of directory hashing to apply.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : 2,
            "stability" : "default"
        },
        "secret-key" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The alias of the secret key to encrypt and decrypt the realm.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "requires" : ["credential-store"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "path" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The path to the file containing the realm.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "relative-to" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The pre-defined path the path is relative to.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "requires" : ["path"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

add-identity - Add an identity to a security realm.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
identity	STRING	true	false		The name of the identity.

Raw DMR model


{
    "operation-name" : "add-identity",
    "description" : "Add an identity to a security realm.",
    "request-properties" : {"identity" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The name of the identity.",
        "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
}

add-identity-attribute - Add an attribute to an existing identity.

Request Parameter	Type	Required	Expressions Allowed	Description
identity	STRING	true	false	The name of the identity.
name	STRING	true	false	The name of the attribute.
value	LIST	true	false	The value of the attribute.

Raw DMR model


{
    "operation-name" : "add-identity-attribute",
    "description" : "Add an attribute to an existing identity.",
    "request-properties" : {
        "identity" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the identity.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the attribute.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "value" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The value of the attribute.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

read-identity - Read an identity from a security realm if it exists.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
identity	STRING	true	false		The name of the identity.

Raw DMR model


{
    "operation-name" : "read-identity",
    "description" : "Read an identity from a security realm if it exists.",
    "request-properties" : {"identity" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The name of the identity.",
        "expressions-allowed" : false,
        "required" : true,
        "nillable" : false,
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

remove - The remove operation for the security realm.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "The remove operation for the security realm.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

remove-identity - Remove an identity from a security realm.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
identity	STRING	true	false		The name of the identity.

Raw DMR model


{
    "operation-name" : "remove-identity",
    "description" : "Remove an identity from a security realm.",
    "request-properties" : {"identity" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The name of the identity.",
        "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
}

remove-identity-attribute - Remove an attribute to an existing identity.

Request Parameter	Type	Required	Expressions Allowed	Description
identity	STRING	true	false	The name of the identity.
name	STRING	true	false	The name of the attribute.
value	LIST	false	false	The value of the attribute.

Raw DMR model


{
    "operation-name" : "remove-identity-attribute",
    "description" : "Remove an attribute to an existing identity.",
    "request-properties" : {
        "identity" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the identity.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the attribute.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "value" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The value of the attribute.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

set-password - Add a password to an existing identity.

Request Parameter	Type	Required	Expressions Allowed	Description
identity	STRING	true	false	The name of the identity.
bcrypt	OBJECT	false	false	A password using the Bcrypt algorithm.
clear	OBJECT	false	false	A password in clear text.
simple-digest	OBJECT	false	false	A simple digest password.
salted-simple-digest	OBJECT	false	false	A salted simple digest password.
scram-digest	OBJECT	false	false	A password using the SCRAM digest algorithm.
digest	OBJECT	false	false	A digest password.
otp	OBJECT	false	false	A one-time password, used by the OTP SASL mechanism.

Raw DMR model


{
    "operation-name" : "set-password",
    "description" : "Add a password to an existing identity.",
    "request-properties" : {
        "identity" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the identity.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "bcrypt" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "A password using the Bcrypt algorithm.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "algorithm" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The algorithm used to encrypt the password.",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "default" : "bcrypt",
                    "allowed" : ["bcrypt"],
                    "stability" : "default"
                },
                "password" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The actual password to set.",
                    "expressions-allowed" : false,
                    "required" : true,
                    "nillable" : false,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "salt" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "BYTES"
                    },
                    "description" : "The salt to apply to the password.",
                    "expressions-allowed" : false,
                    "required" : true,
                    "nillable" : false,
                    "min-length" : 0,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "iteration-count" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "INT"
                    },
                    "description" : "The iteration count or cost to apply to the password.",
                    "expressions-allowed" : false,
                    "required" : true,
                    "nillable" : false,
                    "stability" : "default"
                }
            }
        },
        "clear" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "A password in clear text.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {"password" : {
                "type" : {
                    "TYPE_MODEL_VALUE" : "STRING"
                },
                "description" : "The actual password to set.",
                "expressions-allowed" : false,
                "required" : true,
                "nillable" : false,
                "min-length" : 1,
                "max-length" : 2147483647,
                "stability" : "default"
            }}
        },
        "simple-digest" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "A simple digest password.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "algorithm" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The algorithm used to encrypt the password.",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "default" : "simple-digest-sha-512",
                    "allowed" : [
                        "simple-digest-md2",
                        "simple-digest-md5",
                        "simple-digest-sha-1",
                        "simple-digest-sha-256",
                        "simple-digest-sha-384",
                        "simple-digest-sha-512"
                    ],
                    "stability" : "default"
                },
                "password" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The actual password to set.",
                    "expressions-allowed" : false,
                    "required" : true,
                    "nillable" : false,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        },
        "salted-simple-digest" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "A salted simple digest password.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "algorithm" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The algorithm used to encrypt the password.",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "default" : "password-salt-digest-sha-512",
                    "allowed" : [
                        "password-salt-digest-md5",
                        "password-salt-digest-sha-1",
                        "password-salt-digest-sha-256",
                        "password-salt-digest-sha-384",
                        "password-salt-digest-sha-512",
                        "salt-password-digest-md5",
                        "salt-password-digest-sha-1",
                        "salt-password-digest-sha-256",
                        "salt-password-digest-sha-384",
                        "salt-password-digest-sha-512"
                    ],
                    "stability" : "default"
                },
                "password" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The actual password to set.",
                    "expressions-allowed" : false,
                    "required" : true,
                    "nillable" : false,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "salt" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "BYTES"
                    },
                    "description" : "The salt to apply to the password.",
                    "expressions-allowed" : false,
                    "required" : true,
                    "nillable" : false,
                    "min-length" : 0,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        },
        "scram-digest" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "A password using the SCRAM digest algorithm.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "algorithm" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The algorithm used to encrypt the password.",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "default" : "scram-sha-512",
                    "allowed" : [
                        "scram-sha-1",
                        "scram-sha-256",
                        "scram-sha-384",
                        "scram-sha-512"
                    ],
                    "stability" : "default"
                },
                "password" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The actual password to set.",
                    "expressions-allowed" : false,
                    "required" : true,
                    "nillable" : false,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "salt" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "BYTES"
                    },
                    "description" : "The salt to apply to the password.",
                    "expressions-allowed" : false,
                    "required" : true,
                    "nillable" : false,
                    "min-length" : 0,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "iteration-count" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "INT"
                    },
                    "description" : "The iteration count or cost to apply to the password.",
                    "expressions-allowed" : false,
                    "required" : true,
                    "nillable" : false,
                    "stability" : "default"
                }
            }
        },
        "digest" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "A digest password.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "algorithm" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The algorithm used to encrypt the password.",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "default" : "digest-sha-512",
                    "allowed" : [
                        "digest-md5",
                        "digest-sha",
                        "digest-sha-256",
                        "digest-sha-384",
                        "digest-sha-512"
                    ],
                    "stability" : "default"
                },
                "password" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The actual password to set.",
                    "expressions-allowed" : false,
                    "required" : true,
                    "nillable" : false,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "realm" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The realm.",
                    "expressions-allowed" : false,
                    "required" : true,
                    "nillable" : false,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        },
        "otp" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "A one-time password, used by the OTP SASL mechanism.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "algorithm" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The algorithm used to encrypt the password.",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "default" : "otp-sha1",
                    "allowed" : [
                        "otp-md5",
                        "otp-sha1",
                        "otp-sha256",
                        "otp-sha384",
                        "otp-sha512"
                    ],
                    "stability" : "default"
                },
                "password" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The actual password to set.",
                    "expressions-allowed" : false,
                    "required" : true,
                    "nillable" : false,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "seed" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The seed used to generate the hash.",
                    "expressions-allowed" : true,
                    "required" : true,
                    "nillable" : false,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "sequence" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "INT"
                    },
                    "description" : "The sequence number used to generate the hash.",
                    "expressions-allowed" : true,
                    "required" : true,
                    "nillable" : false,
                    "stability" : "default"
                }
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

update-key-pair - Updates the filesystem realm to make use of the new key pair to verify integrity.

Raw DMR model


{
    "operation-name" : "update-key-pair",
    "description" : "Updates the filesystem realm to make use of the new key pair to verify integrity.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

verify-integrity - Verify the integrity of the entire filesystem realm.

Raw DMR model


{
    "operation-name" : "verify-integrity",
    "description" : "Verify the integrity of the entire filesystem realm.",
    "request-properties" : {},
    "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.filesystem-realm

        
<feature spec="subsystem.elytron.filesystem-realm">
  <param name="filesystem-realm" value="{resource name}"/>
  <param name="credential-store" value="{value}"/>
  <param name="encoded" value="{value}"/>
  <param name="hash-charset" value="{value}"/>
  <param name="hash-encoding" value="{value}"/>
  <param name="key-store" value="{value}"/>
  <param name="key-store-alias" value="{value}"/>
  <param name="levels" value="{value}"/>
  <param name="path" value="{value}"/>
  <param name="relative-to" value="{value}"/>
  <param name="secret-key" value="{value}"/>
<feature/>