Skip to content

Commit ce57ee7

Browse files
docs
Signed-off-by: Abhishek Choudhary <shreemaan.abhishek@gmail.com>
1 parent 315f659 commit ce57ee7

File tree

5 files changed

+5
-0
lines changed

5 files changed

+5
-0
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ For Route:
5555
|------------------|---------|----------|---------|------------------------------------------------------------------------|
5656
| hide_credentials | boolean | False | false | If true, do not pass the authorization request header to Upstream services. |
5757
| anonymous_consumer | boolean | False | false | Anonymous Consumer name. If configured, allow anonymous users to bypass the authentication. |
58+
| realm | string | False | basic | The realm to include in the `WWW-Authenticate` header when authentication fails. |
5859

5960
## Examples
6061

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ The following attributes are available for configurations on Routes or Services.
5757
| validate_request_body | boolean | False | false | | If true, validate the integrity of the request body to ensure it has not been tampered with during transmission. Specifically, the Plugin creates a SHA-256 base64-encoded digest and compare it to the `Digest` header. If the Digest` header is missing or if the digests do not match, the validation fails. |
5858
| hide_credentials | boolean | False | false | | If true, do not pass the authorization request header to Upstream services. |
5959
| anonymous_consumer | string | False | | | Anonymous Consumer name. If configured, allow anonymous users to bypass the authentication. |
60+
| realm | string | False | hmac | | The realm to include in the `WWW-Authenticate` header when authentication fails. |
6061

6162
NOTE: `encrypt_fields = {"secret_key"}` is also defined in the schema, which means that the field will be stored encrypted in etcd. See [encrypted storage fields](../plugin-develop.md#encrypted-storage-fields).
6263

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ For Routes or Services:
6868
| key_claim_name | string | False | key | The name of the JWT claim that contains the user key (corresponds to Consumer's key attribute). |
6969
| anonymous_consumer | string | False | false | Anonymous Consumer name. If configured, allow anonymous users to bypass the authentication. |
7070
| store_in_ctx | boolean | False | false | Set to true will store the JWT payload in the request context (`ctx.jwt_auth_payload`). This allows lower-priority plugins that run afterwards on the same request to retrieve and use the JWT token. |
71+
| realm | string | False | jwt | The realm to include in the `WWW-Authenticate` header when authentication fails. |
7172

7273
You can implement `jwt-auth` with [HashiCorp Vault](https://www.vaultproject.io/) to store and fetch secrets and RSA keys pairs from its [encrypted KV engine](https://developer.hashicorp.com/vault/docs/secrets/kv) using the [APISIX Secret](../terminology/secret.md) resource.
7374

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ For Route:
5858
| query | string | False | apikey | The query string to get the key from. Lower priority than header. |
5959
| hide_credentials | boolean | False | false | If true, do not pass the header or query string with key to Upstream services. |
6060
| anonymous_consumer | string | False | false | Anonymous Consumer name. If configured, allow anonymous users to bypass the authentication. |
61+
| realm | string | False | key | The realm to include in the `WWW-Authenticate` header when authentication fails. |
6162

6263
## Examples
6364

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ For Route:
5353
| use_tls | boolean | False | `false` | If set to `true` uses TLS. |
5454
| tls_verify| boolean | False | `false` | Whether to verify the server certificate when `use_tls` is enabled; If set to `true`, you must set `ssl_trusted_certificate` in `config.yaml`, and make sure the host of `ldap_uri` matches the host in server certificate. |
5555
| uid | string | False | `cn` | uid attribute. |
56+
| realm | string | False | ldap | The realm to include in the `WWW-Authenticate` header when authentication fails. |
5657

5758
## Enable plugin
5859

0 commit comments

Comments
 (0)