WildFly Full 27 Model Reference

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

Credential store to keep alias for sensitive information such as passwords for external services.

Provided capabilities(1)

Attributes (12)

  • create Specifies whether credential store should create storage when it doesn't exist.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • credential-reference Credential reference to be used to create protection parameter.
    • Attribute Value
    Type OBJECT
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • implementation-properties Map of credentials store implementation specific properties.
    • Attribute Value
    Type OBJECT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • location File name of credential store storage.
    • Deprecated Since 13.0.0
    Use the 'path' attribute instead.
    Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • modifiable Specifies whether credential store is modifiable.
    • Attribute Value
    Default Value true
    Type BOOLEAN
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • other-providers The name of the providers defined within the subsystem to obtain the Providers to search for the one that can create the required Jakarta Connectors objects within credential store. This is valid only for key-store based CredentialStore. If this is not specified then the global list of Providers is used instead.
    • Attribute Value
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • path File name of credential store storage.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • provider-name The name of the provider to use to instantiate the CredentialStoreSpi. If the provider is not specified then the first provider found that can create an instance of the specified 'type' will be used.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • providers The name of the providers defined within the subsystem to obtain the Providers to search for the one that can create the required CredentialStore type. If this is not specified then the global list of Providers is used instead.
    • Attribute Value
    Capability reference
    Type STRING
    Nillable true
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required all-services
  • relative-to A reference to a previously defined path that the file name 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 underlying service that represents this credential store at runtime.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
    Allowed Values DOWN
    STARTING
    START_FAILED
    UP
    STOPPING
    REMOVED
  • type The credential store type, e.g. KeyStoreCredentialStore.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required all-services

Operations (10)

  • add Add another credential store to the configuration.
    Request Parameter Type Required Expressions Allowed Default value Description
    credential-reference OBJECT true false Credential reference to be used to create protection parameter.
    path STRING false true File name of credential store storage.
    relative-to STRING false false A reference to a previously defined path that the file name is relative to.
    create BOOLEAN false false false Specifies whether credential store should create storage when it doesn't exist.
    implementation-properties OBJECT false true Map of credentials store implementation specific properties.
    location STRING false true File name of credential store storage.
    modifiable BOOLEAN false false true Specifies whether credential store is modifiable.
    other-providers STRING false false The name of the providers defined within the subsystem to obtain the Providers to search for the one that can create the required Jakarta Connectors objects within credential store. This is valid only for key-store based CredentialStore. If this is not specified then the global list of Providers is used instead.
    provider-name STRING false true The name of the provider to use to instantiate the CredentialStoreSpi. If the provider is not specified then the first provider found that can create an instance of the specified 'type' will be used.
    providers STRING false false The name of the providers defined within the subsystem to obtain the Providers to search for the one that can create the required CredentialStore type. If this is not specified then the global list of Providers is used instead.
    type STRING false true The credential store type, e.g. KeyStoreCredentialStore.
  • add-alias Add an alias to the credential store.
    Request Parameter Type Required Expressions Allowed Default value Description
    alias STRING true false The alias of the credential store item to add.
    entry-type STRING false false Type of a credential (entry) stored in the credential store.
    secret-value STRING false false Secret value such as a password.
  • 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 new 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 false 256 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 Remove credential store from the configuration.
  • 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.
    entry-type STRING false false PasswordCredential The type of the credential to remove.
  • set-secret Set the secret value of 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 set.
    entry-type STRING false false Type of a credential (entry) stored in the credential store.
    secret-value STRING false false Secret value such as a password.