WildFly Full 26.1 Model Reference

  1. home
  2. subsystem=elytron
  3. secret-key-credential-store

A simple credential store to manage secret keys store clearly.

Provided capabilities(1)

Attributes (7)

  • create If the credential store does not exist should it be dynamically created?
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • default-alias The alias name of any key generated by default.
    • Attribute Value
    Default Value key
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • key-size The default size for any generated keys.
    • Attribute Value
    Default Value 256
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
    Allowed Values 128
    192
    256
  • path The path to the credential store.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • populate If the credential store does not contain the default-alias should it be dynamically added?
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • relative-to A reference to a previously defined path that the path is relative to.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • state The state of the credential store service.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
    Allowed Values DOWN
    STARTING
    START_FAILED
    UP
    STOPPING
    REMOVED

Operations (8)

  • add The add operation for the credential store.
    Request Parameter Type Required Expressions Allowed Default value Description
    path STRING true true The path to the credential store.
    relative-to STRING false false A reference to a previously defined path that the path is relative to.
    create BOOLEAN false true true If the credential store does not exist should it be dynamically created?
    default-alias STRING false true key The alias name of any key generated by default.
    key-size INT false true 256 The default size for any generated keys.
    populate BOOLEAN false true true If the credential store does not contain the default-alias should it be dynamically added?
  • export-secret-key Export an existing SecretKey.
    Request Parameter Type Required Expressions Allowed Default value Description
    alias STRING true false The alias of the SecretKey to export.
  • generate-secret-key Generate a mew SecretKey and store it in the credential store.
    Request Parameter Type Required Expressions Allowed Default value Description
    alias STRING true false The alias to use when storing the new SecretKey.
    key-size INT false true The size of key to generate (bits).
  • import-secret-key Import a previously exported SecretKey and add it to the credential store.
    Request Parameter Type Required Expressions Allowed Default value Description
    alias STRING true false The alias to use when storing the imported SecretKey.
    key STRING true false The previously exported key to import.
  • read-aliases Read aliases (entries) from a credential store.
  • reload Reload credential store (reinitialize and load new data if present).
  • remove The remove operation for the credential store.
  • remove-alias Remove a credential (entry) stored in the credential store.
    Request Parameter Type Required Expressions Allowed Default value Description
    alias STRING true false The alias of the credential store item to remove.