Management API Reference for jdbc-realm

Provided Capabilities (1)

Attributes (2)

• 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 }

• principal-query - The authentication query used to authenticate users based on specific key types.

  Type	LIST
  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" : "The authentication query used to authenticate users based on specific key types.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "sql" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The SQL statement used to obtain the keys(as table columns) for a specific user and map them accordingly with their type.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "data-source" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the datasource used to connect to the database.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.data-source", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "attribute-mapping" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The attribute mappings defined for this resource.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "to" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the identity attribute mapped from a column returned from a SQL query.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from a query that representing the mapped attribute.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" } } }, "clear-password-mapper" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A key mapper that maps a column returned from a SQL query to a Clear Password key type.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : {"password-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the user's password.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }} }, "bcrypt-mapper" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A key mapper that maps a column returned from a SQL query to a Bcrypt key type.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "password-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the user's password.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "salt-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the password's salt, if supported.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "iteration-count-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the password's iteration count, if supported.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "hash-encoding" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The encoding of the user's password hash.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "base64", "allowed" : [ "base64", "hex" ], "stability" : "default" }, "salt-encoding" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The encoding of the password's salt.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "base64", "allowed" : [ "base64", "hex" ], "stability" : "default" } } }, "salted-simple-digest-mapper" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A key mapper that maps a column returned from a SQL query to a Salted Simple Digest key type.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "algorithm" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The algorithm for a specific password key mapper.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "password-salt-digest-md5", "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-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the user's password.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "salt-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the password's salt, if supported.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "hash-encoding" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The encoding of the user's password hash.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "base64", "allowed" : [ "base64", "hex" ], "stability" : "default" }, "salt-encoding" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The encoding of the password's salt.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "base64", "allowed" : [ "base64", "hex" ], "stability" : "default" } } }, "simple-digest-mapper" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A key mapper that maps a column returned from a SQL query to a Simple Digest key type.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "algorithm" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The algorithm for a specific password key mapper.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "simple-digest-md5", "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-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the user's password.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "hash-encoding" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The encoding of the user's password hash.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "base64", "allowed" : [ "base64", "hex" ], "stability" : "default" } } }, "scram-mapper" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A key mapper that maps a column returned from a SQL query to a Scram key type.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "algorithm" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The algorithm for a specific password key mapper.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "scram-sha-256", "allowed" : [ "scram-sha-1", "scram-sha-256", "scram-sha-384", "scram-sha-512" ], "stability" : "default" }, "password-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the user's password.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "salt-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the password's salt, if supported.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "iteration-count-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the password's iteration count, if supported.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "hash-encoding" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The encoding of the user's password hash.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "base64", "allowed" : [ "base64", "hex" ], "stability" : "default" }, "salt-encoding" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The encoding of the password's salt.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "base64", "allowed" : [ "base64", "hex" ], "stability" : "default" } } }, "modular-crypt-mapper" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A key mapper that maps a column returned from a SQL query to a Modular Crypt key type.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : {"password-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the user's password.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }} } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

Operations (2)

• add - The add operation for the security realm.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  hash-charset	STRING	false	true	UTF-8	The character set to use when converting the password string to a byte array.
  principal-query	LIST	true	false		The authentication query used to authenticate users based on specific key types.

  Raw DMR model

  { "operation-name" : "add", "description" : "The add operation for the security realm.", "request-properties" : { "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" }, "principal-query" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The authentication query used to authenticate users based on specific key types.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "sql" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The SQL statement used to obtain the keys(as table columns) for a specific user and map them accordingly with their type.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "data-source" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the datasource used to connect to the database.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.data-source", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "attribute-mapping" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The attribute mappings defined for this resource.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "to" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the identity attribute mapped from a column returned from a SQL query.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from a query that representing the mapped attribute.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" } } }, "clear-password-mapper" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A key mapper that maps a column returned from a SQL query to a Clear Password key type.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : {"password-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the user's password.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }} }, "bcrypt-mapper" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A key mapper that maps a column returned from a SQL query to a Bcrypt key type.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "password-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the user's password.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "salt-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the password's salt, if supported.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "iteration-count-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the password's iteration count, if supported.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "hash-encoding" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The encoding of the user's password hash.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "base64", "allowed" : [ "base64", "hex" ], "stability" : "default" }, "salt-encoding" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The encoding of the password's salt.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "base64", "allowed" : [ "base64", "hex" ], "stability" : "default" } } }, "salted-simple-digest-mapper" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A key mapper that maps a column returned from a SQL query to a Salted Simple Digest key type.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "algorithm" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The algorithm for a specific password key mapper.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "password-salt-digest-md5", "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-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the user's password.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "salt-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the password's salt, if supported.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "hash-encoding" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The encoding of the user's password hash.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "base64", "allowed" : [ "base64", "hex" ], "stability" : "default" }, "salt-encoding" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The encoding of the password's salt.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "base64", "allowed" : [ "base64", "hex" ], "stability" : "default" } } }, "simple-digest-mapper" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A key mapper that maps a column returned from a SQL query to a Simple Digest key type.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "algorithm" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The algorithm for a specific password key mapper.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "simple-digest-md5", "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-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the user's password.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "hash-encoding" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The encoding of the user's password hash.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "base64", "allowed" : [ "base64", "hex" ], "stability" : "default" } } }, "scram-mapper" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A key mapper that maps a column returned from a SQL query to a Scram key type.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "algorithm" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The algorithm for a specific password key mapper.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "scram-sha-256", "allowed" : [ "scram-sha-1", "scram-sha-256", "scram-sha-384", "scram-sha-512" ], "stability" : "default" }, "password-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the user's password.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "salt-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the password's salt, if supported.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "iteration-count-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the password's iteration count, if supported.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "hash-encoding" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The encoding of the user's password hash.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "base64", "allowed" : [ "base64", "hex" ], "stability" : "default" }, "salt-encoding" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The encoding of the password's salt.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "base64", "allowed" : [ "base64", "hex" ], "stability" : "default" } } }, "modular-crypt-mapper" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "A key mapper that maps a column returned from a SQL query to a Modular Crypt key type.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : {"password-index" : { "type" : { "TYPE_MODEL_VALUE" : "INT" }, "description" : "The column index from an authentication query that represents the user's password.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }} } } } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "resource-services", "runtime-only" : false }

• 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.jdbc-realm

          
  <feature spec="subsystem.elytron.jdbc-realm">
    <param name="jdbc-realm" value="{resource name}"/>
    <param name="hash-charset" value="{value}"/>
    <param name="principal-query" value="{value}"/>
  <feature/>
          
        

  📋