emqx_authz_api_schema {
enable {
desc {
en: """Set to true
or false
to disable this ACL provider."""
zh: """设为 true
或 false
以启用或禁用此访问控制数据源。"""
}
label {
en: """enable"""
zh: """enable"""
}
}
type {
desc {
en: """Backend type."""
zh: """数据后端类型。"""
}
label {
en: """type"""
zh: """type"""
}
}
#==== authz_file
rules {
desc {
en: """Authorization static file rules."""
zh: """静态授权文件规则。"""
}
label {
en: """rules"""
zh: """规则"""
}
}
#==== authz_http
method {
desc {
en: """HTTP method."""
zh: """HTTP 请求方法。"""
}
label {
en: """method"""
zh: """method"""
}
}
url {
desc {
en: """URL of the auth server."""
zh: """认证服务器 URL。"""
}
label {
en: """url"""
zh: """url"""
}
}
headers {
desc {
en: """List of HTTP Headers."""
zh: """HTTP Headers 列表"""
}
label {
en: """Headers"""
zh: """请求头"""
}
}
headers_no_content_type {
desc {
en: """List of HTTP headers (without content-type
)."""
zh: """HTTP Headers 列表(无 content-type
)。"""
}
label {
en: """headers_no_content_type"""
zh: """请求头(无 content-type)"""
}
}
body {
desc {
en: """HTTP request body."""
zh: """HTTP 请求体。"""
}
label {
en: """body"""
zh: """请求体"""
}
}
request_timeout {
desc {
en: """Request timeout."""
zh: """请求超时时间。"""
}
label {
en: """request_timeout"""
zh: """请求超时"""
}
}
#==== authz_mnesia
# only common fields(`enable` and `type`)
#==== authz_mongo
collection {
desc {
en: """`MongoDB` collection containing the authorization data."""
zh: """`MongoDB` 授权数据集。"""
}
label {
en: """collection"""
zh: """数据集"""
}
}
filter {
desc {
en: """Conditional expression that defines the filter condition in the query.
Filter supports the following placeholders:
- ${username}
: Will be replaced at runtime with Username
used by the client when connecting;
- ${clientid}
: Will be replaced at runtime with Client ID
used by the client when connecting."""
zh: """在查询中定义过滤条件的条件表达式。
过滤器支持如下占位符:
- ${username}
: 将在运行时被替换为客户端连接时使用的用户名
- ${clientid}
: 将在运行时被替换为客户端连接时使用的客户端标识符"""
}
label {
en: """Filter"""
zh: """过滤器"""
}
}
#==== authz_mysql
# `query`, is common field
#==== authz_pgsql
# `query`, is common field
#==== authz_redis
cmd {
desc {
en: """Database query used to retrieve authorization data."""
zh: """访问控制数据查询命令。"""
}
label {
en: """cmd"""
zh: """查询命令"""
}
}
#==== common field for DBs (except mongodb and redis)
query {
desc {
en: """Database query used to retrieve authorization data."""
zh: """访问控制数据查询语句。"""
}
label {
en: """query"""
zh: """查询语句"""
}
}
#==== fields
position {
desc {
en: """Where to place the source."""
zh: """认证数据源位置。"""
}
label {
en: """position"""
zh: """位置"""
}
}
}