Skip to content

config properties secrets

GitHub Action edited this page Aug 28, 2024 · 6 revisions

Version

v1.0.2

secrets Type

object (secrets)

secrets Properties

Property Type Required Nullable Defined by
keys array Optional cannot be null Config

keys

keys are used to en- and decrypt the JWKs which get used to sign the JWTs issued by the API. For every key a JWK is generated, encrypted with the key and persisted in the database.

You can use this list for key rotation: add a new key to the beginning of the list and the corresponding JWK will then be used for signing JWTs. All tokens signed with the previous JWK(s) will still be valid until they expire. Removing a key from the list does not remove the corresponding database record. If you remove a key, you also have to remove the database record, otherwise application startup will fail.

keys

  • is optional

  • cannot be null

keys Type

string[] (keys)

keys Constraints

minimum number of items: the minimum number of items for this array is: 1

Clone this wiki locally