Skip to content

Commit 5290139

Browse files
authored
docs: add realm attribute to zh auth plugin docs (#12886)
1 parent 4990927 commit 5290139

5 files changed

Lines changed: 5 additions & 0 deletions

File tree

docs/zh/latest/plugins/basic-auth.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ Route 端:
5555
| ---------------- | ------- | ------ | ------ | --------------------------------------------------------------- |
5656
| hide_credentials | boolean || false | 该参数设置为 `true` 时,则不会将 Authorization 请求头传递给 Upstream。|
5757
| anonymous_consumer | boolean || false | 匿名消费者名称。如果已配置,则允许匿名用户绕过身份验证。 |
58+
| realm | string || basic |在身份验证失败时,应包含在 `WWW-Authenticate` 标头中的域。|
5859

5960
## 示例
6061

docs/zh/latest/plugins/hmac-auth.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ description: hmac-auth 插件支持 HMAC 认证,保证请求的完整性,防
5757
| validate_request_body | boolean || false | | 如果为 true,则验证请求正文的完整性,以确保在传输过程中没有被篡改。具体来说,插件会创建一个 SHA-256 的 base64 编码 digest,并将其与 `Digest` 头进行比较。如果 `Digest` 头丢失或 digest 不匹配,验证将失败。 |
5858
| hide_credentials | boolean || false | | 如果为 true,则不会将授权请求头传递给上游服务。 |
5959
| anonymous_consumer | string || | | 匿名消费者名称。如果已配置,则允许匿名用户绕过身份验证。 |
60+
| realm | string || hmac |在身份验证失败时,应包含在 `WWW-Authenticate` 标头中的域。|
6061

6162
注意:schema 中还定义了 `encrypt_fields = {"secret_key"}`,这意味着该字段将会被加密存储在 etcd 中。具体参考 [加密存储字段](../plugin-develop.md#加密存储字段)
6263

docs/zh/latest/plugins/jwt-auth.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ Route 端:
6464
| key_claim_name | string || key | 包含用户密钥(对应消费者的密钥属性)的 JWT 声明的名称。|
6565
| anonymous_consumer | string || false | 匿名消费者名称。如果已配置,则允许匿名用户绕过身份验证。 |
6666
| store_in_ctx | boolean || false | 设置为 `true` 将会将 JWT 负载存储在请求上下文 (`ctx.jwt_auth_payload`) 中。这允许在同一请求上随后运行的低优先级插件检索和使用 JWT 令牌。 |
67+
| realm | string || jwt |在身份验证失败时,应包含在 `WWW-Authenticate` 标头中的域。|
6768
| claims_to_verify | array[string] || ["exp", "nbf"] | ["exp", "nbf"] | 需要在 JWT 负载中验证的声明。 |
6869

6970
您可以使用 [HashiCorp Vault](https://www.vaultproject.io/) 实施 `jwt-auth`,以从其[加密的 KV 引擎](https://developer.hashicorp.com/vault/docs/secrets/kv) 使用 [APISIX Secret](../terminology/secret.md) 资源。

docs/zh/latest/plugins/key-auth.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Route 端:
5757
| header | string || apikey | 设置我们从哪个 header 获取 key。 |
5858
| query | string || apikey | 设置我们从哪个 query string 获取 key,优先级低于 `header`|
5959
| hide_credentials | boolean || false | 如果为 `true`,则不要将含有认证信息的 header 或 query string 传递给 Upstream。 |
60+
| realm | string || key |在身份验证失败时,应包含在 `WWW-Authenticate` 标头中的域。|
6061

6162
## 示例
6263

docs/zh/latest/plugins/ldap-auth.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ Route 端:
5151
| use_tls | boolean || false | 如果设置为 `true` 则表示启用 TLS。 |
5252
| tls_verify| boolean || false | 是否校验 LDAP 服务器的证书。如果设置为 `true`,你必须设置 `config.yaml` 里面的 `ssl_trusted_certificate`,并且确保 `ldap_uri` 里的 host 和服务器证书中的 host 匹配。 |
5353
| uid | string || cn | UID 属性。 |
54+
| realm | string || ldap |在身份验证失败时,应包含在 `WWW-Authenticate` 标头中的域。|
5455

5556
## 启用插件
5657

0 commit comments

Comments
 (0)