Management API Reference for properties-realm

A security realm definition backed by properties files.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.security-realm	true	/subsystem=elytron/jaas-realm=* /subsystem=elytron/jdbc-realm=* /subsystem=elytron/filesystem-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/caching-realm=* /subsystem=elytron/custom-realm=*

Attributes (6)

groups-attribute - The name of the attribute in the returned AuthorizationIdentity that should contain the group membership information for the identity.

Type	STRING
Default Value	groups
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 attribute in the returned AuthorizationIdentity that should contain the group membership information for the identity.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "groups", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

groups-properties - The properties file containing the users and their groups.

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" : "The properties file containing the users and their groups.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "path" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The path to the file containing the users and their groups.", "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" } }, "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	hex
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" : "hex", "allowed" : [ "base64", "hex" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

synchronized - The time the properties files that back this realm were last loaded.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The time the properties files that back this realm were last loaded.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

users-properties - The properties file containing the users and their passwords.

Type	OBJECT
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" : "The properties file containing the users and their passwords.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "value-type" : { "path" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The path to the file containing the users and their passwords. The file should contain realm name declaration.", "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" }, "digest-realm-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The default realm name to use for digested passwords if one is not discovered in the properties file.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "plain-text" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Are the passwords in properties file stored in plain text or pre-hashed? (Pre-hashed form: HEX( MD5( username ':' realm ':' password ) ) )", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

Operations (3)

add - The add operation for the security realm.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
groups-attribute	STRING	false	true	groups	The name of the attribute in the returned AuthorizationIdentity that should contain the group membership information for the identity.
groups-properties	OBJECT	false	false		The properties file containing the users and their groups.
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	hex	The string format for the password if it is not stored in plain text.
users-properties	OBJECT	true	false		The properties file containing the users and their passwords.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "The add operation for the security realm.",
    "request-properties" : {
        "groups-attribute" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the attribute in the returned AuthorizationIdentity that should contain the group membership information for the identity.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : "groups",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "groups-properties" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The properties file containing the users and their groups.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "path" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The path to the file containing the users and their groups.",
                    "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"
                }
            }
        },
        "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" : "hex",
            "allowed" : [
                "base64",
                "hex"
            ],
            "stability" : "default"
        },
        "users-properties" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The properties file containing the users and their passwords.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "stability" : "default",
            "value-type" : {
                "path" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The path to the file containing the users and their passwords. The file should contain realm name declaration.",
                    "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"
                },
                "digest-realm-name" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The default realm name to use for digested passwords if one is not discovered in the properties file.",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "plain-text" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "BOOLEAN"
                    },
                    "description" : "Are the passwords in properties file stored in plain text or pre-hashed? (Pre-hashed form: HEX( MD5( username ':' realm ':' password ) ) )",
                    "expressions-allowed" : true,
                    "required" : false,
                    "nillable" : true,
                    "default" : false,
                    "stability" : "default"
                }
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

load - Reload the properties files from the file system.

Raw DMR model


{
    "operation-name" : "load",
    "description" : "Reload the properties files from the file system.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "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
}

Galleon Features

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

subsystem.elytron.properties-realm

        
<feature spec="subsystem.elytron.properties-realm">
  <param name="properties-realm" value="{resource name}"/>
  <param name="groups-attribute" value="{value}"/>
  <param name="groups-properties" value="{value}"/>
  <param name="hash-charset" value="{value}"/>
  <param name="hash-encoding" value="{value}"/>
  <param name="users-properties" value="{value}"/>
<feature/>