Static Credentials

The Static Credentials external source stores a single username and password pair directly in the RADKit Service database in encrypted form. It is the simplest way to share one set of credentials across multiple devices.

The main benefit over configuring credentials directly on each device is centralised management: when the shared password changes, only the Static Credentials definition needs to be updated — all devices that reference it will automatically use the new credentials on their next connection.

Configuration Steps

1. Username: The username that RADKit Service will use when connecting to devices that reference this external source.

2. Password: The password associated with the username above. The password is encrypted and stored in the RADKit Service database; it is never stored in plain text.

Usage

To apply a single set of credentials to an entire protocol block, use !combine with !external in the device YAML configuration:

terminal: !combine
  - !external
    name: <name_of_external_source>
    use: <key_in_external_source>

To reference only individual fields (username or password) from the external source, use !external-key, which automatically selects the field matching the parent key name (e.g. username or password):

terminal:
  username: !external-key <name_of_external_source>
  password: !external-key <name_of_external_source>

Alternatively, use !external with an explicit use: parameter:

terminal:
  username: !external
    name: <name_of_external_source>
    use: <key_in_external_source>
  password: !external
    name: <name_of_external_source>
    use: <key_in_external_source>

Note

Both forms can be mixed, for example to override just the password of an otherwise statically configured protocol block.