Cmdlets for Apache CouchDB

Build 24.0.9060

JWTKeyType Parameter (Connect-ApacheCouchDB Cmdlet)

The type of the encryption key which is used for signing the JWT token.

Syntax

Connect-ApacheCouchDB -JWTKeyType string

Possible Values

PEMKEY_FILE, PEMKEY_BLOB, SYMMETRIC

Data Type

cstr

Default Value

"PEMKEY_FILE"

Remarks

This property can take one of the following values:

PEMKEY_FILEAn absolute path to a PEM-encoded file that contains the private key.
PEMKEY_BLOBA base64 encoded value of the private key.
SYMMETRICA base64 encoded value of the symmetric key. Use this in cases when you are signing the JWT token with a symmetric algorithm (e.g. HS256, HS384, HS512, etc.).
The key itself can be any length, if needed the cmdlet pads or hashes the key to match the requirements of the chosen JWTAlgorithm. For best security the key should be at least as long as the hash output (for example, 32 bytes for SHA-256).

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060