Grafana文档

开发人员

HTTP API

RBAC HTTP API

RBAC API

基于角色的访问控制API仅可在Grafana企业。阅读更多关于Grafana企业。

API可以用来创建、更新、删除,角色列表。

检查基本的或固定的角色所必需的权限,请参考RBAC角色定义。

获得地位

/ api /访问控制/状态

返回一个指示器检查是否启用了基于角色的访问控制。

需要的权限

行动	范围
状态:accesscontrol	服务:accesscontrol

示例请求

GET / api /访问控制/状态接受:application / json - type: application / json

示例响应

HTTP / 1.1 200 OK - type: application / json;utf - 8字符集={“启用”:真正的}

状态码

代码	描述
200年	返回一个标志指示是否启用了基于角色的访问控制。
403年	拒绝访问
404年	没有找到,这表明基于角色的访问控制是不可用的。
500年	意想不到的错误。指身体和/或服务器日志获取详情。

创建和管理自定义角色

把所有角色

GET / api /访问控制角色

所有现有的角色。响应包含所有全球和当地组织角色,组织用户签署。

查询参数:

includeHidden:可选的。设置为真正的包括角色隐藏的。

需要的权限

行动	范围
角色:读	角色:*

示例请求

GET / api /访问控制角色接受:application / json - type: application / json

示例响应

HTTP / 1.1 200 OK - type: application / json;charset = utf - 8[{“版本”:3,“uid”:“XvHQJq57z”、“名称”:“固定:报告:读者”、“displayName”:“报告读者”、“描述”:“阅读所有报告和共享报告设置”。“集团”:“报告”,“更新”:“2021 - 11 - 19 t10:48:00 + 01:00”,“创建”:“2021 - 11 - 19 t10:48:00 + 01:00”、“全球”:假},{“版本”:5“uid”:“vi9mlLjGz”,“名字”:“固定:数据源。权限:作家”、“描述:“创建、读取或删除数据源权限。”,“全球”:真的,“更新”:“2021 - 05 - 13 - t22:41:49 + 02:00”,“创建”:“2021 - 05 - 13 - t16:24:26 + 02:00 "})

状态码

代码	描述
200年	全球和当地组织角色返回。
403年	拒绝访问
500年	意想不到的错误。指身体和/或服务器日志获取详情。

得到一个角色

GET / api /访问控制/角色/:uid

得到一个角色为给定的UID。

需要的权限

行动	范围
角色:读	角色:*

示例请求

GET / api /访问控制/角色/ PYnDO3rMk接受:application / json - type: application / json

示例响应

HTTP / 1.1 200 OK - type: application / json;utf - 8字符集={“版本”:4,“uid”:“6 dnwjq57z”、“名称”:“固定:报告:作家”、“displayName”:“报告作家”、“描述”:“创建、读取、更新或删除所有报告和报告共享设置”。“集团”:“报告”、“权限”:[{“行动”:“报告:删除”,“范围”:“报告:*”,“更新”:“2021 - 11 - 19 t10:48:00 + 01:00”,“创建”:“2021 - 11 - 19 t10:48:00 + 01:00”},{“行动”:“报告:读”,“范围”:“报告:*”,“更新”:“2021 - 11 - 19 t10:48:00 + 01:00”,“创建”:“2021 - 11 - 19 t10:48:00 + 01:00”},{“行动”:报告:“送出去”,“范围”:“报告:*”,“更新”:“2021 - 11 - 19 t10:48:00 + 01:00”,“创建”:“2021 - 11 - 19 t10:48:00 + 01:00”},{“行动”:“报告:创建”,“范围”:“”,“更新”:“2021 - 11 - 19 t10:48:00 + 01:00”,“创建”:“2021 - 11 - 19 t10:48:00 + 01:00”},{“行动”:“报告:写”,“范围”:“报告:*”,“更新”:“2021 - 11 - 19 t10:48:00 + 01:00”,“创建”:“2021 - 11 - 19 t10:48:00 + 01:00”},{“行动”:“报告。设置:阅读”、“范围”:“”、“更新”:“2021 - 11 - 19 - t10:48:00 + 01:00”、“创建”:“2021 - 11 - 19 t10:48:00 + 01:00”},{“行动”:“报告。设置:”、“范围”:“写”、“更新”:“2021 - 11 - 19 - t10:48:00 + 01:00”、“创建”:“2021 - 11 - 19 - t10:48:00 + 01:00}],“更新”:“2021 - 11 - 19 - t10:48:00 + 01:00”、“创建”:“2021 - 11 - 19 - t10:48:00 + 01:00”、“全球”:假}

状态码

代码	描述
200年	返回角色。
403年	拒绝访问。
500年	意想不到的错误。指身体和/或服务器日志获取详情。

创建一个新的自定义角色

POST / api /访问控制角色

创建一个新的自定义角色和地图的权限,角色。请注意角色相同的前缀固定的角色不能被创建。

需要的权限

权限:类型:委托确保用户只能创建自定义角色范围相同,或用户的权限的一个子集。例如,如果一个用户没有创建用户所需要的权限,他们将无法创建一个自定义的角色,允许这样做。这样做是为了防止特权升级。

行动	范围
角色:写	权限:类型:委托

示例请求

POST / api /访问控制/角色接受:application / json application / json - type:{“版本”:1、“uid”:“jZrmlLCGka”、“名称”:“自定义:删除角色”,“displayName”:“自定义删除角色”,“描述”:“我的自定义角色赋予用户权限删除角色”、“集团”:“我的小组”,“displayName”:“我的自定义角色”,“全球”:假的,“权限”:[{“行动”:“角色:删除”、“范围”:“权限:类型:委托”}]}

JSON身体模式

字段名	日期类型	要求	描述
uid	字符串	没有	UID的角色。如果不存在,则UID将自动为您创建并返回响应。指的是自定义角色为更多的信息。
全球	布尔	没有	一个标志指示是否这个角色是全球性的。如果设置为`假`,默认的组织身份验证的用户的ID将使用从请求。
版本	数量	没有	版本的角色。如果不存在,版本0将被分配到的角色和返回的响应。指的是自定义角色为更多的信息。
的名字	字符串	是的	角色的名称。指自定义角色为更多的信息。
描述	字符串	没有	角色的描述。
displayName	字符串	没有	显示名称的作用,可见的UI。
集团	字符串	没有	属于的组名的作用。
隐藏的	布尔	没有	指定是否隐藏角色。如果设置为`真正的`,那么这个角色不会显示在角色选择器。它不会列出API端点,除非显式指定。
权限	许可	没有	如果不存在,将创建角色没有任何权限。

许可

字段名	数据类型	要求	描述
行动	字符串	是的	指自定义角色的行为和作用域完全可用的行动列表。
范围	字符串	没有	如果不存在,没有将映射到权限范围。指自定义角色的行为和作用域可用范围的完整列表。

示例响应

HTTP / 1.1 200 OK - type: application / json;utf - 8字符集={“版本”:2,“uid”:“jZrmlLCGka”、“名称”:“自定义:删除:创建角色”、“displayName”:“自定义删除创建的角色”、“描述”:“我的自定义角色赋予用户权限删除和创建角色”、“集团”:“我的小组”,“displayName”:“我的自定义角色”,“全球”:假的,“权限”:[{“行动”:“角色:删除”、“范围”:“权限:类型:委托”,“更新”:“2021 - 05 - 13 - t23:19:46 + 02:00”,“创建”:“2021 - 05 - 13 - t23:19:46 + 02:00”}],“更新”:“2021 - 05 - 13 - t23:20:51.416518 + 02:00”,“创建”:“2021 - 05 - 13 - t23:19:46 + 02:00 "}

状态码

代码	描述
200年	角色是更新。
400年	坏的请求(无效的json,丢失的内容类型,缺失或无效的字段,等等)。
403年	拒绝访问
500年	意想不到的错误。指身体和/或服务器日志获取详情。

更新一个角色

把/ api /访问控制/角色/:uid

用给定的UID更新作用,其权限。幂等操作,所有角色的权限将被取代基于请求的内容。你需要增加每次更新版本的角色,否则请求将失败。

你可以更新自定义角色和基本角色权限。然而固定角色不能被更新。

需要的权限

权限:类型:委托范围将确保用户只能更新相同的自定义角色,或用户的权限的一个子集。例如,如果一个用户没有创建用户所需要的权限,他们将无法更新自定义角色,允许这样做。这样做是为了防止特权升级。

行动	范围
角色:写	权限:类型:委托

示例请求

把/ api /访问控制/角色/ jZrmlLCGka接受:application / json application / json - type:{“版本”:3,“名字”:“自定义:删除:写:角色”、“displayName”:“自定义删除写角色”、“描述”:“我的定制角色赋予用户权限删除和写角色”、“集团”:“我的小组”,“displayName”:“我的自定义角色”,“全球”:假的,“权限”:[{“行动”:“角色:删除”、“范围”:“权限:类型:委托”},{“行动”:“角色:写”,“范围”:“权限:类型:委托”}]}

JSON身体模式

字段名	数据类型	要求	描述
版本	数量	是的	版本的角色。必须增加更新工作。
的名字	字符串	是的	角色的名称。
描述	字符串	没有	角色的描述。
displayName	字符串	没有	显示名称的作用,可见的UI。
集团	字符串	没有	属于的组名的作用。
隐藏的	布尔	没有	指定是否隐藏角色。如果设置为`真正的`,那么这个角色不会显示在角色选择器。它不会列出API端点,除非显式指定。
权限	的权限列表	没有	完整的更新后的角色的权限列表。

许可

字段名	数据类型	要求	描述
行动	字符串	是的	指自定义角色的行为和作用域完全可用的行动列表。
范围	字符串	没有	如果不存在,没有将映射到权限范围。指自定义角色的行为和作用域可用范围的完整列表。

示例响应

HTTP / 1.1 200 OK - type: application / json;utf - 8字符集={“版本”:3,“uid”:“jZrmlLCGka”、“名称”:“自定义:删除:写:角色”、“displayName”:“自定义删除写角色”、“描述”:“我的定制角色赋予用户权限删除和写角色”、“集团”:“我的小组”,“displayName”:“我的自定义角色”,“权限”:[{“行动”:“角色:删除”、“范围”:“权限:类型:委托”,“更新”:“2021 - 08 - 06 - t18:27:40 + 02:00”,“创建”:“2021 - 08 - 06 - t18:27:40 + 02:00 "},{"行动”:“角色:写”,“范围”:“权限:类型:委托”,“更新”:“2021 - 08 - 06 - t18:27:41 + 02:00”,“创建”:“2021 - 08 - 06 - t18:27:41 + 02:00”}],“更新”:“2021 - 08 - 06 - t18:27:41 + 02:00”,“创建”:“2021 - 08 - 06 - t18:27:40 + 02:00”、“全球”:假}

状态码

代码	描述
200年	角色是更新。
400年	坏的请求(无效的json,丢失的内容类型,缺失或无效的字段,等等)。
403年	拒绝访问
404年	角色不存在更新。
500年	意想不到的错误。指身体和/或服务器日志获取详情。

删除自定义角色

删除/ api /访问控制/角色/:uid ?力= false

用给定的UID,删除一个角色的权限。如果分配角色,删除操作会失败,除非力查询参数设置真正的,在这种情况下所有的任务也将被删除。

需要的权限

权限:类型:委托范围可以确保用户只能删除相同的自定义角色,或用户的权限的一个子集。例如,如果一个用户没有创建用户所需要的权限,他们将无法删除自定义角色,允许这样做。

行动	范围
角色:删除	权限:类型:委托

示例请求

删除/ api /访问控制/角色/ jZrmlLCGka吗?力=true&global=false Accept: application/json

查询参数

参数	类型	要求	描述
力	布尔	没有	当设置为`真正的`,与所有的作业将被删除。
全球	布尔	没有	一个标志指示是否这个角色是全球性的。如果设为false,默认将使用org身份验证的用户的ID的请求。指的是对RBAC为更多的信息。

示例响应

HTTP / 1.1 200 OK - type: application / json;utf - 8字符集={“消息”:“角色删除”}

状态码

代码	描述
200年	作用是删除。
400年	坏的请求(无效的json,丢失的内容类型,缺失或无效的字段,等等)。
403年	拒绝访问
500年	意想不到的错误。指身体和/或服务器日志获取详情。

创建和删除用户角色分配

角色分配给一个用户列表

GET / api /访问控制/用户/:userId /角色

列出的角色直接分配给特定用户。列表中不包括基本角色(查看、编辑、管理或Grafana Admin),和它不包括角色继承自一个团队。

查询参数:

includeHidden:可选的。设置为真正的包括角色隐藏的。

需要的权限

行动	范围
users.roles:阅读	用户:id:`<用户名>`

示例请求

GET / api /访问控制角色/用户/ 1 /接受:application / json

示例响应

HTTP / 1.1 200 OK - type: application / json;charset = utf - 8[{“版本”:4,“uid”:“6 dnwjq57z”、“名称”:“固定:报告:作家”、“displayName”:“报告作家”,“描述”:“创建、读取、更新或删除所有报告和报告共享设置”。“集团”:“报告”,“更新”:“2021 - 11 - 19 t10:48:00 + 01:00”,“创建”:“2021 - 11 - 19 t10:48:00 + 01:00”、“全球”:假}]

状态码

代码	描述
200年	返回组分配角色。
403年	拒绝访问。
500年	意想不到的错误。指身体和/或服务器日志获取详情。

列出你的权限

GET / api /访问控制/用户/权限

列表的权限授予用户的签名。

需要的权限

不需要许可。

查询参数

参数	类型	要求	描述
reloadcache	布尔	没有	国旗重新加载权限缓存。

示例请求

GET / api /访问控制/用户/权限接受:application / json

示例响应

HTTP / 1.1 200 OK - type: application / json;utf - 8字符集={“仪表板:读”:["仪表板:uid: 70年kry6ivz],“仪表板:写”:["仪表板:uid: 70年kry6ivz],”数据源。id:读”:“数据源:*”,“数据源:读”:“数据源:*”,“数据源:探索“:["],”数据源:查询”:“数据源:uid: grafana”,“数据源:读”:“数据源:uid: grafana”,“组织:读”:(" ")}

状态码

代码	描述
200年	返回组分配权限。
403年	拒绝访问。
500年	意想不到的错误。指身体和/或服务器日志获取详情。

权限分配给一个用户列表

GET / api /访问控制/用户/:userId /权限

列表的权限授予一个给定的用户。

需要的权限

行动	范围
users.permissions:阅读	用户:id:`<用户名>`

示例请求

得到/ api /访问控制/用户/ 1 /权限接受:application / json

示例响应

HTTP / 1.1 200 OK - type: application / json;charset = utf - 8[{“行动”:“ldap。状态:阅读”、“范围”:“”},{“行动”:“ldap。用户:阅读”、“范围”:““})

状态码

代码	描述
200年	返回组分配权限。
403年	拒绝访问。
500年	意想不到的错误。指身体和/或服务器日志获取详情。

添加一个用户角色分配

POST / api /访问控制/用户/:userId /角色

将角色分配给特定的用户。

批量更新的考虑设置用户角色分配。

需要的权限

权限:类型:委托确保用户只能分配角色范围相同,或用户的权限的一个子集。例如,如果一个用户没有创建用户所需要的权限,他们无法分配一个角色将允许这样做。这样做是为了防止特权升级。

行动	范围
users.roles:添加	权限:类型:委托

示例请求

POST / api /访问控制角色/用户/ 1 /接受:application / json application / json - type:{“全球”:假的,“roleUid”:“XvHQJq57z”}

JSON身体模式

字段名	数据类型	要求	描述
roleUid	字符串	是的	UID的角色。
全球	布尔	没有	一个标志指示是否赋值是全球性的。如果设置为`假`,默认的组织身份验证的用户的ID将从请求用于创建组织本地任务。

示例响应

HTTP / 1.1 200 OK - type: application / json;utf - 8字符集={“消息”:“角色添加到用户”。}

状态码

代码	描述
200年	角色分配给一个用户。
403年	拒绝访问。
404年	找不到角色。
500年	意想不到的错误。指身体和/或服务器日志获取详情。

删除一个用户角色分配

删除/ api /访问控制/用户/:userId /角色/:roleUID

从用户撤销的作用。

批量更新的考虑设置用户角色分配。

需要的权限

权限:类型:委托确保用户只能unassign角色范围相同,或用户的权限的一个子集。例如,如果一个用户没有创建用户所需要的权限,他们无法unassign角色将允许这样做。这样做是为了防止特权升级。

行动	范围
users.roles:删除	权限:类型:委托

查询参数

参数	类型	要求	描述
全球	布尔	没有	一个标志指示是否赋值是全球性的。如果设置为`假`,默认的组织身份验证的用户的ID将使用从请求删除任务。

示例请求

删除/ api /访问控制角色/用户/ 1 / / AFUXBHKnk接受:application / json

示例响应

HTTP / 1.1 200 OK - type: application / json;utf - 8字符集={“消息”:“从用户删除角色。”}

状态码

代码	描述
200年	角色未赋值的。
403年	拒绝访问。
500年	意想不到的错误。指身体和/或服务器日志获取详情。

设置用户角色分配

把/ api /访问控制/用户/:userId /角色

更新用户的角色分配匹配提供的uid。这将删除任何分配角色,不是在请求并添加角色设置但尚未分配给用户。

如果你想添加或删除一个角色,考虑使用添加一个用户角色分配或删除一个用户角色分配代替。

需要的权限

权限:类型:委托确保用户只能分配或unassign角色范围相同,或用户的权限的一个子集。例如,如果一个用户没有创建用户所需要的权限,他们无法分配或unassign角色将允许这样做。这样做是为了防止特权升级。

行动	范围
users.roles:添加	权限:类型:委托
users.roles:删除	权限:类型:委托

示例请求

把/ api /访问控制角色/用户/ 1 /接受:application / json application / json - type:{“全球”:假的,“roleUids”: [“ZiHQJq5nk”、“GzNQ1357k”]}

JSON身体模式

字段名	日期类型	要求	描述
全球	布尔	没有	一个标志指示是否赋值是全球性的。如果设置为`假`,默认的组织身份验证的用户的ID将使用从请求。
roleUids	列表	是的	uid角色列表。
includeHidden	布尔	没有	指定隐藏角色分配是否应该被更新。

示例响应

HTTP / 1.1 200 OK - type: application / json;utf - 8字符集={“消息”:“用户角色已经更新。”}

状态码

代码	描述
200年	角色分配。
403年	拒绝访问。
404年	找不到角色。
500年	意想不到的错误。指身体和/或服务器日志获取详情。

创建和删除服务帐户角色分配

角色分配给一个服务帐户列表

GET / api /访问控制/用户/:serviceAccountId /角色

列出的角色直接分配给一个服务帐户。列表中不包括基本角色(查看、编辑、管理或Grafana Admin)。

查询参数:

includeHidden:可选的。设置为真正的包括角色隐藏的。

需要的权限

行动	范围
users.roles:阅读	用户:id:`<服务帐户ID >`

示例请求

GET / api /访问控制角色/用户/ 1 /接受:application / json

示例响应

HTTP / 1.1 200 OK - type: application / json;charset = utf - 8[{“版本”:4,“uid”:“6 dnwjq57z”、“名称”:“固定:报告:作家”、“displayName”:“报告作家”,“描述”:“创建、读取、更新或删除所有报告和报告共享设置”。“集团”:“报告”,“更新”:“2021 - 11 - 19 t10:48:00 + 01:00”,“创建”:“2021 - 11 - 19 t10:48:00 + 01:00”、“全球”:假}]

状态码

代码	描述
200年	返回组分配角色。
403年	拒绝访问。
500年	意想不到的错误。指身体和/或服务器日志获取详情。

列表的权限分配给一个服务帐户

GET / api /访问控制/用户/:serviceAccountId /权限

列出给定服务帐户的权限。

需要的权限

行动	范围
users.permissions:阅读	用户:id:`<服务帐户ID >`

示例请求

得到/ api /访问控制/用户/ 1 /权限接受:application / json

示例响应

HTTP / 1.1 200 OK - type: application / json;charset = utf - 8[{“行动”:“ldap。状态:阅读”、“范围”:“”},{“行动”:“ldap。用户:阅读”、“范围”:““})

状态码

代码	描述
200年	返回组分配权限。
403年	拒绝访问。
500年	意想不到的错误。指身体和/或服务器日志获取详情。

添加一个服务帐户角色分配

POST / api /访问控制/用户/:serviceAccountId /角色

将角色分配给一个特定的服务帐户。

批量更新的考虑服务帐户设置角色分配。

需要的权限

行动	范围
users.roles:添加	权限:类型:委托

示例请求

POST / api /访问控制角色/用户/ 1 /接受:application / json application / json - type:{“全球”:假的,“roleUid”:“XvHQJq57z”}

JSON身体模式

字段名	数据类型	要求	描述
roleUid	字符串	是的	UID的角色。
全球	布尔	没有	一个标志指示是否赋值是全球性的。如果设置为`假`,默认的组织身份验证的用户的ID将从请求用于创建组织本地任务。

示例响应

HTTP / 1.1 200 OK - type: application / json;utf - 8字符集={“消息”:“角色添加到用户”。}

状态码

代码	描述
200年	角色分配给一个用户。
403年	拒绝访问。
404年	找不到角色。
500年	意想不到的错误。指身体和/或服务器日志获取详情。

删除一个服务帐户角色分配

删除/ api /访问控制/用户/:serviceAccountId /角色/:roleUID

撤销一个角色从一个服务帐户。

批量更新的考虑服务帐户设置角色分配。

需要的权限

行动	范围
users.roles:删除	权限:类型:委托

查询参数

参数	类型	要求	描述
全球	布尔	没有	一个标志指示是否赋值是全球性的。如果设置为`假`,默认的组织身份验证的用户的ID将使用从请求删除任务。

示例请求

删除/ api /访问控制角色/用户/ 1 / / AFUXBHKnk接受:application / json

示例响应

HTTP / 1.1 200 OK - type: application / json;utf - 8字符集={“消息”:“从用户删除角色。”}

状态码

代码	描述
200年	角色未赋值的。
403年	拒绝访问。
500年	意想不到的错误。指身体和/或服务器日志获取详情。

服务帐户设置角色分配

把/ api /访问控制/用户/:serviceAccountId /角色

更新服务帐户的角色分配来匹配提供的uid。这将删除任何分配角色,不是在请求并添加角色设置但尚未分配给服务帐户。

如果你想添加或删除一个角色,考虑使用添加一个服务帐户角色分配或删除一个服务帐户角色分配代替。

需要的权限

行动	范围
users.roles:添加	权限:类型:委托
users.roles:删除	权限:类型:委托

示例请求

把/ api /访问控制角色/用户/ 1 /接受:application / json application / json - type:{“全球”:假的,“roleUids”: [“ZiHQJq5nk”、“GzNQ1357k”]}

JSON身体模式

字段名	日期类型	要求	描述
全球	布尔	没有	一个标志指示是否赋值是全球性的。如果设置为`假`,默认的组织身份验证的用户的ID将使用从请求。
roleUids	列表	是的	uid角色列表。
includeHidden	布尔	没有	指定隐藏角色分配是否应该被更新。

示例响应

HTTP / 1.1 200 OK - type: application / json;utf - 8字符集={“消息”:“用户角色已经更新。”}

状态码

代码	描述
200年	角色分配。
403年	拒绝访问。
404年	找不到角色。
500年	意想不到的错误。指身体和/或服务器日志获取详情。

创建和删除团队角色分配

角色分配给团队名单

GET / api /访问控制/团队/:teamId /角色

列出的角色直接分配给一个特定的团队。

查询参数:

includeHidden:可选的。设置为真正的包括角色隐藏的。

需要的权限

行动	范围
teams.roles:阅读	团队:id:`<团队ID >`

示例请求

GET / api /访问控制/团队/ 1 /角色接受:application / json

示例响应

HTTP / 1.1 200 OK - type: application / json;charset = utf - 8[{“版本”:4,“uid”:“j08ZBi-nk”、“名称”:“固定:许可:读者”,“displayName”:“许可读者”,“描述”:“阅读授权信息和授权报告。”“集团”:“许可证”、“更新”:“2022 - 02 - 03 - t14:19:50 + 01:00”,“创建”:“0001 - 01 - 01 t00:00:00z”、“全球”:假}]

状态码

代码	描述
200年	返回组分配角色。
403年	拒绝访问。
500年	意想不到的错误。指身体和/或服务器日志获取详情。

添加一个团队角色分配

POST / api /访问控制/团队/:teamId /角色

将角色分配给一个特定的团队。

批量更新的考虑设置团队角色分配。

需要的权限

权限:类型:委托确保用户只能分配角色范围相同,或用户的权限的一个子集。例如,如果一个用户没有创建用户所需的权限,他们无法分配一个角色,包含这些权限。这样做是为了防止特权升级。

行动	范围
teams.roles:添加	权限:类型:委托

示例请求

POST / api /访问控制/团队/ 1 /角色接受:application / json application / json - type: {“roleUid”:“XvHQJq57z”}

JSON身体模式

字段名	数据类型	要求	描述
roleUid	字符串	是的	UID的角色。

示例响应

HTTP / 1.1 200 OK - type: application / json;utf - 8字符集={“消息”:“添加到团队的角色。”}

状态码

代码	描述
200年	角色分配给一个团队。
403年	拒绝访问。
404年	找不到角色。
500年	意想不到的错误。指身体和/或服务器日志获取详情。

删除一个团队角色分配

删除/ api /访问控制/团队/:团队/角色/:roleUID

撤销一个角色从一个团队。

批量更新的考虑设置团队角色分配。

需要的权限

权限:类型:委托确保用户只能unassign角色范围相同,或用户的权限的一个子集。例如,如果一个用户没有创建用户所需的权限,他们无法分配一个角色,包含这些权限。这样做是为了防止升级privileges.’‘

行动	范围
teams.roles:删除	权限:类型:委托

示例请求

删除/ api /访问控制/团队/ 1 /角色/ AFUXBHKnk接受:application / json

示例响应

HTTP / 1.1 200 OK - type: application / json;utf - 8字符集={“消息”:“从团队的角色。”}

状态码

代码	描述
200年	角色未赋值的。
403年	拒绝访问。
500年	意想不到的错误。指身体和/或服务器日志获取详情。

设置团队角色分配

把/ api /访问控制/团队/:teamId /角色

更新团队的角色分配匹配提供的uid。这将删除任何分配角色,不是在请求并添加角色设置但尚未分配给用户。

如果你想添加或删除一个角色,考虑使用添加一个团队角色分配或删除一个团队角色分配代替。

需要的权限

权限:类型:委托确保用户只能分配或unassign角色范围相同,或用户的权限的一个子集。例如,如果一个用户没有创建用户所需要的权限,他们无法或unassign角色分配给一个团队将允许这样做。这样做是为了防止特权升级。

行动	范围
teams.roles:添加	权限:类型:委托
teams.roles:删除	权限:类型:委托

示例请求

把/ api /访问控制/团队/ 1 /角色接受:application / json application / json - type: {“roleUids”: [“ZiHQJq5nk”、“GzNQ1357k”]}

JSON身体模式

字段名	日期类型	要求	描述
roleUids	列表	是的	uid角色列表。
includeHidden	布尔	没有	指定隐藏角色分配是否应该被更新。

示例响应

HTTP / 1.1 200 OK - type: application / json;utf - 8字符集={“消息”:“团队角色已经更新。”}

状态码

代码	描述
200年	角色分配。
403年	拒绝访问。
404年	找不到角色。
500年	意想不到的错误。指身体和/或服务器日志获取详情。

重置默认的基本角色

POST / api /访问控制/角色/硬复位

权限:类型:升级使用户能够重置基本角色的权限范围。这可能导致基本角色拥有权限exceedind呼叫者。

重置默认的基本角色权限。

需要的权限

行动	范围
角色:写	权限:类型:升级

示例请求

POST / api /访问控制/角色/硬重置接受:application / json - type: application / json {“BasicRoles”:真正的}

JSON身体模式

字段名	数据类型	要求	描述
BasicRoles	布尔	没有	选择重置基本角色权限。

示例响应

HTTP / 1.1 200 OK - type: application / json;utf - 8字符集={“消息”:“重置”执行}

状态码

代码	描述
200年	重新执行
500年	未能复位的基本角色

这个页面是有用吗?

建议一个编辑

为文档

报告问题