This is an automated email from the ASF dual-hosted git repository.
navendu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix.git
The following commit(s) were added to refs/heads/master by this push:
new 45086fd6a docs: update token endpoint in authz-keycloak plugin (#10742)
45086fd6a is described below
commit 45086fd6ae02374e0bf9473e603ae1027c30729e
Author: Traky Deng <[email protected]>
AuthorDate: Tue Jan 2 21:24:55 2024 -0800
docs: update token endpoint in authz-keycloak plugin (#10742)
---
docs/en/latest/plugins/authz-keycloak.md | 8 ++++----
docs/zh/latest/plugins/authz-keycloak.md | 8 ++++----
2 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/docs/en/latest/plugins/authz-keycloak.md
b/docs/en/latest/plugins/authz-keycloak.md
index 2804998b4..8d900b726 100644
--- a/docs/en/latest/plugins/authz-keycloak.md
+++ b/docs/en/latest/plugins/authz-keycloak.md
@@ -44,9 +44,9 @@ Refer to [Authorization Services
Guide](https://www.keycloak.org/docs/latest/aut
| Name | Type | Required |
Default | Valid values
| Description
|
|----------------------------------------------|---------------|----------|-----------------------------------------------|--------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| discovery | string | False |
|
https://host.domain/auth/realms/foo/.well-known/uma2-configuration | URL to
[discovery
document](https://www.keycloak.org/docs/latest/authorization_services/index.html)
of Keycloak Authorization Services.
|
-| token_endpoint | string | False |
|
https://host.domain/auth/realms/foo/protocol/openid-connect/token | An
OAuth2-compliant token endpoint that supports the
`urn:ietf:params:oauth:grant-type:uma-ticket` grant type. If provided,
overrides the value from discovery.
|
-| resource_registration_endpoint | string | False |
|
https://host.domain/auth/realms/foo/authz/protection/resource_set | A
UMA-compliant resource registration endpoint. If provided, overrides the value
from discovery.
|
+| discovery | string | False |
|
https://host.domain/realms/foo/.well-known/uma2-configuration | URL to
[discovery
document](https://www.keycloak.org/docs/latest/authorization_services/index.html)
of Keycloak Authorization Services.
|
+| token_endpoint | string | False |
|
https://host.domain/realms/foo/protocol/openid-connect/token | An
OAuth2-compliant token endpoint that supports the
`urn:ietf:params:oauth:grant-type:uma-ticket` grant type. If provided,
overrides the value from discovery.
|
+| resource_registration_endpoint | string | False |
|
https://host.domain/realms/foo/authz/protection/resource_set | A UMA-compliant
resource registration endpoint. If provided, overrides the value from
discovery.
|
| client_id | string | True |
|
| The identifier of the resource server to
which the client is seeking access.
|
| client_secret | string | False |
|
| The client secret, if required. You can use
APISIX secret to store and reference this value. APISIX currently supports
storing secrets in two ways. [Environment Variables and HashiCorp
Vault](../terminology/secret.md)
[...]
| grant_type | string | False |
"urn:ietf:params:oauth:grant-type:uma-ticket" |
["urn:ietf:params:oauth:grant-type:uma-ticket"] |
|
@@ -153,7 +153,7 @@ curl http://127.0.0.1:9180/apisix/admin/routes/5 -H
'X-API-KEY: edd1c9f034335f13
"uri": "/get",
"plugins": {
"authz-keycloak": {
- "token_endpoint":
"http://127.0.0.1:8090/auth/realms/${realm}/protocol/openid-connect/token";,
+ "token_endpoint":
"http://127.0.0.1:8090/realms/${realm}/protocol/openid-connect/token";,
"permissions": ["resource name#scope name"],
"client_id": "Client ID"
}
diff --git a/docs/zh/latest/plugins/authz-keycloak.md
b/docs/zh/latest/plugins/authz-keycloak.md
index 621aab46e..460a90653 100644
--- a/docs/zh/latest/plugins/authz-keycloak.md
+++ b/docs/zh/latest/plugins/authz-keycloak.md
@@ -44,9 +44,9 @@ description: 本文介绍了关于 Apache APISIX `authz-keycloak` 插件的基
| 名称 | 类型 | 必选项 | 默认值
| 有效值
| 描述
|
|----------------------------------------------|---------------|-------|-----------------------------------------------|--------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| discovery | string | 否 |
|
https://host.domain/auth/realms/foo/.well-known/uma2-configuration | Keycloak
授权服务的 [discovery
document](https://www.keycloak.org/docs/latest/authorization_services/index.html)
的 URL。
|
-| token_endpoint | string | 否 |
|
https://host.domain/auth/realms/foo/protocol/openid-connect/token | 接受 OAuth2
兼容 token 的接口，需要支持 `urn:ietf:params:oauth:grant-type:uma-ticket` 授权类型。
|
-| resource_registration_endpoint | string | 否 |
|
https://host.domain/auth/realms/foo/authz/protection/resource_set | 符合 UMA
的资源注册端点。如果提供，则覆盖发现中的值。
|
+| discovery | string | 否 |
|
https://host.domain/realms/foo/.well-known/uma2-configuration | Keycloak 授权服务的
[discovery
document](https://www.keycloak.org/docs/latest/authorization_services/index.html)
的 URL。
|
+| token_endpoint | string | 否 |
|
https://host.domain/realms/foo/protocol/openid-connect/token | 接受 OAuth2 兼容
token 的接口，需要支持 `urn:ietf:params:oauth:grant-type:uma-ticket` 授权类型。
|
+| resource_registration_endpoint | string | 否 |
|
https://host.domain/realms/foo/authz/protection/resource_set | 符合 UMA
的资源注册端点。如果提供，则覆盖发现中的值。
|
| client_id | string | 是 |
|
| 客户端正在寻求访问的资源服务器的标识符。
|
| client_secret | string | 否 |
|
| 客户端密码（如果需要）。
|
| grant_type | string | 否 |
"urn:ietf:params:oauth:grant-type:uma-ticket" |
["urn:ietf:params:oauth:grant-type:uma-ticket"] |
|
@@ -138,7 +138,7 @@ curl http://127.0.0.1:9180/apisix/admin/routes/1 \
"uri": "/get",
"plugins": {
"authz-keycloak": {
- "token_endpoint":
"http://127.0.0.1:8090/auth/realms/${realm}/protocol/openid-connect/token";,
+ "token_endpoint":
"http://127.0.0.1:8090/realms/${realm}/protocol/openid-connect/token";,
"permissions": ["resource name#scope name"],
"client_id": "Client ID"
}
