Skip to content

Commit

Permalink
docs: add auth plugins that work with consumers to the consumer doc (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
kayx23 authored Sep 18, 2023
1 parent ca80873 commit edfdeba
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/en/latest/terminology/consumer.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ The process of identifying a Consumer in APISIX is described below:

Consumers are useful when you have different consumers requesting the same API and you need to execute different Plugin and Upstream configurations based on the consumer. These need to be used in conjunction with the user authentication system.

Authentcation plugins that can be configured with a Consumer include `basic-auth`, `hmac-auth`, `jwt-auth`, `key-auth`, `ldap-auth`, and `wolf-rbac`.

Refer to the documentation for the [key-auth](../plugins/key-auth.md) authentication Plugin to further understand the concept of a Consumer.

:::note
Expand Down
4 changes: 4 additions & 0 deletions docs/zh/latest/terminology/consumer.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ Consumer 是某类服务的消费者,需要与用户认证配合才可以使
2. 获取 consumer_name:通过授权认证,即可自然获取到对应的 Consumer name,它是 Consumer 对象的唯一识别标识;
3. 获取 Consumer 上绑定的 Plugin 或 Upstream 信息:完成对不同 Consumer 做不同配置的效果。

当有不同的使用者请求相同的 API,并且需要根据使用者执行不同的插件和上游配置时,使用 Consumer 是非常合适的。需要与用户身份验证系统结合使用。

目前,可以与 Consumer 配置的身份验证插件包括 `basic-auth``hmac-auth``jwt-auth``key-auth``ldap-auth``wolf-rbac`

你可以参考 [key-auth](../plugins/key-auth.md) 认证授权插件的调用逻辑,进一步理解 Consumer 概念和使用。

:::note 注意
Expand Down

0 comments on commit edfdeba

Please sign in to comment.