Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The encryption API provides functionality that allows the encryption/decryption of passwords or secrets using the configured Aspire Encryption Provider. 

Easy Heading Free
navigationTitleOn this Page
navigationExpandOptionexpand-all-by-default

Section

Encrypt

Encrypts a given password or secret, this endpoint need at least the OPERATOR role to be executed.

Panel
borderColorblack
bgColor#fafafb

POST /aspire/_api/encryption/encrypt

Request body

Code Block
languagejs
themeRDark
{
   "0" : "secretToEncrypt1",
   "1" : "secretToEncrypt2"
}

Response

Code Block
languagejs
themeRDark
{
    "0" : "encrypted:...........",
    "1" : "encrypted:............"
}

Status: 200

Section

Decrypt

Decrypts a given password or secret, this endpoint need at least theADMINISTRATOR role to be executed.

Panel
borderColorblack
bgColor#fafafb

POST /aspire/_api/encryption/decrypt

Request body

Code Block
languagejs
themeRDark
encrypted:....................

Response

Code Block
languagejs
themeRDark
secretToEncrypt1

Status: 200