100 lines
3.4 KiB
Plaintext
100 lines
3.4 KiB
Plaintext
emqx_gateway_api_authn {
|
||
|
||
get_authn {
|
||
desc {
|
||
en: """Gets the configuration of the specified gateway authenticator.<br/>
|
||
Returns 404 when gateway or authentication is not enabled."""
|
||
zh: """获取指定网关认证器的配置
|
||
当网关或认证未启用时，返回 404。"""
|
||
}
|
||
}
|
||
|
||
update_authn {
|
||
desc {
|
||
en: """Update the configuration of the specified gateway authenticator, or disable the authenticator."""
|
||
zh: """更新指定网关认证器的配置，或停用认证器。"""
|
||
}
|
||
}
|
||
|
||
add_authn {
|
||
desc {
|
||
en: """Enables the authenticator for client authentication for the specified gateway. <br/>
|
||
When the authenticator is not configured or turned off, all client connections are assumed to be allowed. <br/>
|
||
Note: Only one authenticator is allowed to be enabled at a time in the gateway, rather than allowing multiple authenticators to be configured to form an authentication chain as in MQTT."""
|
||
zh: """为指定网关开启认证器实现客户端认证的功能。<br/>
|
||
当未配置认证器或关闭认证器时，则认为允许所有客户端的连接。<br/>
|
||
注：在网关中仅支持添加一个认证器，而不是像 MQTT 一样允许配置多个认证器构成认证链。"""
|
||
}
|
||
}
|
||
|
||
delete_authn {
|
||
desc {
|
||
en: """Delete the authenticator of the specified gateway."""
|
||
zh: """删除指定网关的认证器。"""
|
||
}
|
||
}
|
||
|
||
list_users {
|
||
desc {
|
||
en: """Get the users for the authenticator (only supported by <code>built_in_database</code>)."""
|
||
zh: """获取用户列表（仅支持 built_in_database 类型的认证器）"""
|
||
}
|
||
}
|
||
|
||
add_user {
|
||
desc {
|
||
en: """Add user for the authenticator (only supports built_in_database)."""
|
||
zh: """添加用户（仅支持 built_in_database 类型的认证器）"""
|
||
}
|
||
}
|
||
|
||
get_user {
|
||
desc {
|
||
en: """Get user info from the gateway authenticator (only supports built_in_database)"""
|
||
zh: """获取用户信息（仅支持 built_in_database 类型的认证器）"""
|
||
}
|
||
}
|
||
|
||
update_user {
|
||
desc {
|
||
en: """Update the user info for the gateway authenticator (only supports built_in_database)"""
|
||
zh: """更新用户信息（仅支持 built_in_database 类型的认证器）"""
|
||
}
|
||
}
|
||
|
||
delete_user {
|
||
desc {
|
||
en: """Delete the user for the gateway authenticator (only supports built_in_database)"""
|
||
zh: """删除用户（仅支持 built_in_database 类型的认证器）"""
|
||
}
|
||
}
|
||
|
||
import_users {
|
||
desc {
|
||
en: """Import users into the gateway authenticator (only supports built_in_database)"""
|
||
zh: """导入用户（仅支持 built_in_database 类型的认证器）"""
|
||
}
|
||
}
|
||
|
||
user_id {
|
||
desc {
|
||
en: """User ID"""
|
||
zh: """用户 ID"""
|
||
}
|
||
}
|
||
|
||
like_user_id {
|
||
desc {
|
||
en: """Fuzzy search using user ID (username or clientid), only supports search by substring."""
|
||
zh: """使用用户 ID （username 或 clientid）模糊搜索，仅支持按子串的方式进行搜索。"""
|
||
}
|
||
}
|
||
|
||
is_superuser {
|
||
desc {
|
||
en: """Is superuser"""
|
||
zh: """是否是超级用户"""
|
||
}
|
||
}
|
||
}
|