Version: 2.8.1
憑證
在憑證頁籤中,可以設定驗證插件所需要的憑證。
驗證插件包括 Basic Authentication、Key Authentication、OAuth2、HMAC Authentication 以及 JWT.
#
Basic Authentication搭配的插件配置及說明部分請參考 Basic Authentication 頁面。
#
欄位配置說明變數 | 類型 | 預設值 | 說明 | 必填 |
---|---|---|---|---|
username | string | 使用在 Basic Authentication 中的使用者名稱。 | V | |
password | string | 使用在 Basic Authentication 中的密碼。 | V | |
tags | array of string | 可填入任意字串來做分類使用。 |
#
Key Authentication搭配的插件配置及說明部分請參考 Key Authentication 頁面。
#
欄位配置說明變數 | 類型 | 預設值 | 說明 | 必填 |
---|---|---|---|---|
key | string | 可設定獨一無二的金鑰。或是留空自動生成。 | ||
tags | array of string | 可填入任意字串來做分類使用。 |
#
OAuth2搭配的插件配置及說明部分請參考 OAuth2 頁面。
#
欄位配置說明變數 | 類型 | 預設值 | 說明 | 必填 |
---|---|---|---|---|
name | string | 代表此憑證之名稱。 | V | |
client_id | number | 可以設定獨一無二的 client_id ,或是留空自動生成。 | ||
client_secret | string | 可以設定獨一無二的 client_secret ,或是留空自動生成。 | ||
client_type | string | confidential | 客戶端類型,可以選擇 confidential 或是 public 。 | |
redirect_uris | array of string | 通過驗證後會被送往的 URLs 列表。可參考 RFC 6742 Section 3.1.2。 | V | |
hash_secret | boolean | false | 表示 client_secret 欄位的字段是否將以 hash 形式儲存。如果在現有插件實例上啟用(設為 true ),則 client secrets 會在首次使用時被 hash。 | V |
tags | array of string | 可填入任意字串來做分類使用。 |
#
HMAC Authentication搭配的插件配置及說明部分請參考 HMAC Authentication 頁面。
#
欄位配置說明變數 | 類型 | 預設值 | 說明 | 必填 |
---|---|---|---|---|
username | string | 使用在 HMAC Signature 中的使用者名稱。 | V | |
secret | string | 使用在 HMAC Signature 中的密鑰。如果留空則會自動產生值,並將其當作回應的 Body 一部分來發送。 | ||
tags | array of string | 可填入任意字串來做分類使用。 |
#
JWT搭配的插件配置及說明部分請參考 JWT 頁面。
#
欄位配置說明變數 | 類型 | 預設值 | 說明 | 必填 |
---|---|---|---|---|
key | string | 代表此憑證獨一無二之金鑰。如留空則會自動生成。 | ||
algorithm | string | HS256 | 用來驗證簽署的演算法。此欄位接受輸入的值為以下其一: HS256 、 HS384 、 HS512 、 RS256 、 RS384 、 RS512 、 ES256 及 ES384 。 | |
rsa_public_key | string | 如果 algorithm 是 RS256 、 RS384 、 RS512 、 ES256 或 ES384 ,則用來驗證簽署的公開金鑰(PEM格式)。 | ||
secret | string | 如果 algorithm 是 HS256 、 HS384 或 HS512 ,則用來簽署 JWTs 的祕鑰。如留空則會自動生成。 | ||
tags | array of string | 可填入任意字串來做分類使用。 |