Get Roles API
출처: 문서
본문
역할 조회 API
1.0부터 도입 {: .label .label-purple }
역할을 조회해요. 역할 이름을 지정하면 해당 역할 하나를 조회하고, 역할 이름을 생략하면 모든 역할을 조회해요.
엔드포인트
GET /_plugins/_security/api/roles
GET /_plugins/_security/api/roles/{role}
경로 파라미터
사용할 수 있는 경로 파라미터는 다음 표에 정리되어 있어요.
| 파라미터 | 데이터 타입 | 필수 | 설명 |
|---|---|---|---|
role |
String | 아니요 | 조회할 역할의 이름이에요. 생략하면 모든 역할이 반환돼요. |
요청 예제
다음 요청은 모든 역할을 조회해요:
GET _plugins/_security/api/roles
{% include copy-curl.html security=true %}
다음 요청은 test-role 역할을 조회해요:
GET _plugins/_security/api/roles/test-role
{% include copy-curl.html security=true %}
응답 예제
여기서는 응답이 축약되어 있어요:
{
"observability_read_access": {
"cluster_permissions": [
"cluster:admin/opensearch/observability/get"
],
"hidden": false,
"index_permissions": [],
"reserved": true,
"static": false,
"tenant_permissions": []
},
...
}
역할 하나를 요청했을 때의 응답에는 해당 역할만 포함돼요:
{
"test-role": {
"cluster_permissions": [
"cluster_composite_ops",
"indices_monitor"
],
"hidden": false,
"index_permissions": [
{
"allowed_actions": [
"read"
],
"dls": "",
"fls": [],
"index_patterns": [
"movies*"
],
"masked_fields": []
}
],
"reserved": false,
"static": false,
"tenant_permissions": [
{
"allowed_actions": [
"kibana_all_read"
],
"tenant_patterns": [
"human_resources"
]
}
]
}
}