组属性同步 API

组属性同步 API 允许您配置组属性同步功能。当您想要根据外部系统中的组成员身份管理用户角色时，此 API 非常有用。

注意： 在 Grafana Enterprise 和 Grafana Cloud 中可用

注意
此功能位于 groupAttributeSync 功能开关之后。您可以通过配置文件或环境变量启用功能开关。有关详细信息，请参阅配置文档。

列出组映射

GET /api/groupsync/groups

所需权限

操作	范围
groupsync.mappings:read	不适用

请求示例:

GET /api/groupsync/groups HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer glsa_kcVxDhZtu5ISOZIEt

响应示例:

HTTP/1.1 200
Content-Type: application/json

[
  {
    "groups": [
        {
            "groupID": "group 1",
            "mappings": {
                "1": {
                    "roles": [
                        "fixed_nzVQoNSDSn0fg1MDgO6XnZX2RZI",
                        "my_custom_role",
                    ]
                }
            }
        },
        {
            "groupID": "group 2",
            "mappings": {
                "1": {
                    "roles": [
                        "another_role",
                    ]
                }
            }
        }
    ],
    "total": 2
  }
]

状态代码

200 - 成功
400 - 错误请求
401 - 未经授权
403 - 权限被拒绝
500 - 内部服务器错误

创建组映射

POST /api/groupsync/groups/:groupID

所需权限

操作	范围
groupsync.mappings:write	不适用

请求示例:

POST /api/groupsync/groups/my_group_id HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer glsa_kcVxDhZtu5ISOZIEt

{
    "roles": [
        "fixed_nzVQoNSDSn0fg1MDgO6XnZX2RZI",
        "my_custom_role_uid"
    ]
}

响应示例:

HTTP/1.1 200
Content-Type: application/json

{
    "message": "Group mappings created."
}

状态代码

201 - 成功
400 - 错误请求
401 - 未经授权
403 - 权限被拒绝
500 - 内部服务器错误

更新组映射

PUT /api/groupsync/groups/:groupID

此端点将替换组的现有映射，并使用请求中提供的新映射。

所需权限

操作	范围
groupsync.mappings:write	不适用

请求示例:

PUT /api/groupsync/groups/my_group_id HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer glsa_kcVxDhZtu5ISOZIEt

{
    "roles": [
        "fixed_nzVQoNSDSn0fg1MDgO6XnZX2RZI",
        "my_custom_role_uid"
    ]
}

响应示例:

HTTP/1.1 200
Content-Type: application/json

{
    "message": "Group mappings set."
}

状态代码

201 - 成功
400 - 错误请求
401 - 未经授权
403 - 权限被拒绝
500 - 内部服务器错误

移除组映射

DELETE /api/groupsync/groups/:groupID

所需权限

操作	范围
groupsync.mappings:write	不适用

请求示例:

DELETE /api/groupsync/groups/my_group_id HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer glsa_kcVxDhZtu5ISOZIEt

状态代码