데이터 소스 권한 API

데이터 소스 권한 API는 Grafana Enterprise에서만 사용할 수 있어요. Grafana Enterprise에 대해 자세히 알아보세요.

Grafana Enterprise를 사용 중이라면 일부 엔드포인트에 특정 권한이 필요해요. 자세한 내용은 "Role-based access control permissions" 문서를 참조해요.

이 API는 데이터 소스의 권한을 나열하고, 추가하고, 제거하는 데 사용할 수 있어요.

사용자, 팀, 서비스 계정 또는 기본 역할(Admin, Editor, Viewer)에 대해 권한을 설정할 수 있어요.

⚠️ Grafana 13부터 /api 엔드포인트가 /apis 라우트로 대체되어 더 이상 사용되지 않게(deprecated) 되고 있어요. Grafana가 기존 API를 마이그레이션하는 동안 현재 사용 중인 레거시 API와 정확히 일치하지 않을 수 있어요. 이 변경으로 현재 설정이 중단되거나 깨지지는 않아요. 레거시 API는 비활성화되지 않으며 완전히 접근·사용 가능하지만, /api 라우트는 더 이상 업데이트되지 않아요. 자세한 내용은 "Grafana의 새 API 구조" 문서를 참조해요.

출처: 문서

본문

선택적 `ds_type` 쿼리 매개변수

이 API의 모든 엔드포인트는 선택적 쿼리 매개변수 ds_type을 허용해요. 데이터 소스 플러그인 타입(예: prometheus 또는 loki)으로 설정해요. 조직에서 둘 이상의 데이터 소스가 같은 UID를 공유할 때 Grafana가 올바른 인스턴스를 해석할 수 있도록 ds_type을 사용해요.

데이터 소스의 권한 가져오기

GET /api/access-control/datasources/:uid

주어진 uid를 가진 데이터 소스의 모든 기존 권한을 가져와요.

UID를 명확히 구분해야 할 때 ?ds_type=<TYPE>을 추가해요. 선택적 ds_type 쿼리 매개변수 참조.

필요한 권한 — 서문의 참고를 참조해요.

Action	Scope
datasources.permissions:read	datasources:datasources:uid:datasources:uid:my_datasource (단일 데이터 소스)

예제 요청:

GET /api/access-control/datasources/my_datasource HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVI...>

예제 요청 (UID가 고유하지 않을 때 ds_type 사용):

GET /api/access-control/datasources/my_datasource?ds_type=prometheus HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVI...>

예제 응답:

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 551

[
    {
        "id": 1,
        "roleName": "fixed:datasources:reader",
        "isManaged": false,
        "isInherited": false,
        "isServiceAccount": false,
        "userId": 1,
        "userLogin": "admin_user",
        "userAvatarUrl": "/avatar/admin_user",
        "actions": [
            "datasources:read",
            "datasources:query",
            "datasources:read",
            "datasources:query",
            "datasources:write",
            "datasources:delete"
        ],
        "permission": "Edit"
    },
    {
        "id": 2,
        "roleName": "managed:teams:1:permissions",
        "isManaged": true,
        "isInherited": false,
        "isServiceAccount": false,
        "team": "A team",
        "teamId": 1,
        "teamAvatarUrl": "/avatar/523d70c8551046f441727d690431858c",
        "actions": [
            "datasources:read",
            "datasources:query"
        ],
        "permission": "Query"
    },
    {
        "id": 3,
        "roleName": "basic:admin",
        "isManaged": false,
        "isInherited": false,
        "isServiceAccount": false,
        "builtInRole": "Admin",
        "actions": [
            "datasources:query",
            "datasources:read",
            "datasources:write",
            "datasources:delete"
        ],
        "permission": "Edit"
    },
]

상태 코드:

200 - Ok
401 - Unauthorized
403 - Access denied
500 - Internal error

사용자에 대한 데이터 소스 접근 추가 또는 취소

POST /api/access-control/datasources/:uid/users/:id

주어진 uid를 가진 데이터 소스에 대한 사용자 권한을 설정해요.

UID를 명확히 구분해야 할 때 ?ds_type=<TYPE>을 추가해요. 선택적 ds_type 쿼리 매개변수 참조.

권한을 추가하려면 permission 필드를 Query, Edit 또는 Admin 중 하나로 설정해요. 권한을 제거하려면 permission 필드를 빈 문자열로 설정해요.

필요한 권한 — 서문의 참고를 참조해요.

Action	Scope
datasources.permissions:write	datasources:datasources:uid:datasources:uid:my_datasource (단일 데이터 소스)

예제 요청:

POST /api/access-control/datasources/my_datasource/users/1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVI...KEN>

{
  "permission": "Query",
}

Query 권한을 부여하면 사용자는 데이터 소스에 대한 읽기 접근도 갖게 돼요.

예제 응답:

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 35

{"message": "Permission updated"}

예제 요청:

POST /api/access-control/datasources/my_datasource/users/1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVI...KEN>

{
  "permission": "",
}

예제 응답:

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 35

{"message": "Permission removed"}

상태 코드:

200 - Ok
400 - 권한을 추가할 수 없음, 자세한 내용은 응답 body 참조
401 - Unauthorized
403 - Access denied

팀에 대한 데이터 소스 접근 추가 또는 취소

POST /api/access-control/datasources/:uid/teams/:id

주어진 uid를 가진 데이터 소스에 대한 팀 권한을 설정해요.

UID를 명확히 구분해야 할 때 ?ds_type=<TYPE>을 추가해요. 선택적 ds_type 쿼리 매개변수 참조.

권한을 추가하려면 permission 필드를 Query, Edit 또는 Admin 중 하나로 설정해요. 권한을 제거하려면 permission 필드를 빈 문자열로 설정해요.

Query, Edit 또는 Admin 권한을 추가하면 사용자는 암묵적으로 Read 접근을 갖게 돼요.

필요한 권한 — 서문의 참고를 참조해요.

Action	Scope
datasources.permissions:write	datasources:datasources:uid:datasources:uid:my_datasource (단일 데이터 소스)

예제 요청:

POST /api/access-control/datasources/my_datasource/teams/1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVI...KEN>

{
  "permission": "Edit",
}

예제 응답:

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 35

{"message": "Permission updated"}

예제 요청:

POST /api/access-control/datasources/my_datasource/teams/1
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVI...KEN>

{
  "permission": "",
}

예제 응답:

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 35

{"message": "Permission removed"}

상태 코드:

200 - Ok
400 - 권한을 추가할 수 없음, 자세한 내용은 응답 body 참조
401 - Unauthorized
403 - Access denied

기본 역할에 대한 데이터 소스 접근 추가 또는 취소

POST /api/access-control/datasources/:uid/builtInRoles/:builtinRoleName

주어진 uid를 가진 데이터 소스에 대해 지정된 기본 역할을 가진 모든 사용자에게 권한을 설정해요.

UID를 명확히 구분해야 할 때 ?ds_type=<TYPE>을 추가해요. 선택적 ds_type 쿼리 매개변수 참조.

다음 기본 역할에 대해 권한을 설정할 수 있어요: Admin, Editor, Viewer.

권한을 추가하려면 permission 필드를 Query, Edit 또는 Admin 중 하나로 설정해요. 권한을 제거하려면 permission 필드를 빈 문자열로 설정해요.

필요한 권한 — 서문의 참고를 참조해요.

Action	Scope
datasources.permissions:write	datasources:datasources:uid:datasources:uid:my_datasource (단일 데이터 소스)

예제 요청:

POST /api/access-control/datasources/my_datasource/builtInRoles/Admin
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVI...KEN>

{
  "permission": "Edit",
}

예제 응답:

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 35

{"message": "Permission updated"}

예제 요청:

POST /api/access-control/datasources/my_datasource/builtInRoles/Viewer
Accept: application/json
Content-Type: application/json
Authorization: Bearer <SERVI...KEN>

{
  "permission": "",
}

예제 응답:

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
Content-Length: 35

{"message": "Permission removed"}

상태 코드:

200 - Ok
400 - 권한을 추가할 수 없음, 자세한 내용은 응답 body 참조
401 - Unauthorized
403 - Access denied

더 알아보기 (Learn more)

데이터 소스 권한 (Enterprise)
역할 기반 접근 제어 (RBAC)
Grafana의 새 API 구조

데이터 소스 권한 API