Dashboards Info API
출처: 문서
본문
Dashboards Info API
1.0에서 도입 {: .label .label-purple }
OpenSearch Dashboards의 동적 보안 설정에 대한 현재 값을 조회해요.
엔드포인트
GET /_plugins/_security/dashboardsinfo
POST /_plugins/_security/dashboardsinfo
두 메서드 모두 요청 본문을 받지 않으며, 동일한 응답을 반환해요.
요청 예제
GET _plugins/_security/dashboardsinfo
{% include copy-curl.html security=true %}
응답 예제
{
"user_name": "admin",
"not_fail_on_forbidden_enabled": false,
"opensearch_dashboards_mt_enabled": true,
"opensearch_dashboards_index": ".kibana",
"opensearch_dashboards_server_user": "kibanaserver",
"multitenancy_enabled": true,
"preferred_tenants": [],
"private_tenant_enabled": true,
"default_tenant": "Global",
"sign_in_options": [],
"password_validation_error_message": "Password should be at least 8 characters long and contain at least one uppercase letter, one lowercase letter, one digit, and one special character.",
"password_validation_regex": "(?=.*[A-Z])(?=.*[^a-zA-Z\\d])(?=.*[0-9])(?=.*[a-z]).{8,}",
"resource_sharing_enabled": false,
"api_tokens_enabled": false,
"max_duration_seconds": 7776000
}
응답 본문 필드
응답 본문은 다음 필드를 가진 JSON 객체예요.
| 필드 | 데이터 타입 | 설명 |
|---|---|---|
user_name |
String | 현재 사용자의 이름 |
not_fail_on_forbidden_enabled |
Boolean | 오류를 반환하는 대신 OpenSearch가 검색 응답에서 사용자가 접근할 수 없는 결과를 생략하는지 여부 |
multitenancy_enabled |
Boolean | 멀티 테넌시가 활성화되어 있는지 여부 |
opensearch_dashboards_mt_enabled |
Boolean | OpenSearch Dashboards에 대해 멀티 테넌시가 활성화되어 있는지 여부 |
opensearch_dashboards_index |
String | OpenSearch Dashboards가 저장된 객체를 보관하는 인덱스의 이름 |
opensearch_dashboards_server_user |
String | OpenSearch Dashboards가 OpenSearch에 연결할 때 사용하는 사용자의 이름 |
default_tenant |
String | OpenSearch Dashboards가 기본적으로 여는 테넌트 |
private_tenant_enabled |
Boolean | 사용자가 프라이빗 테넌트를 사용할 수 있는지 여부 |
preferred_tenants |
Array of Strings | 테넌트 선택기에서 선호도 순서대로 다른 테넌트보다 앞에 표시되는 테넌트 |
sign_in_options |
Array of Strings | OpenSearch Dashboards가 제공하는 로그인 방식 |
password_validation_regex |
String | 새 비밀번호가 반드시 일치해야 하는 정규 표현식 |
password_validation_error_message |
String | 비밀번호가 password_validation_regex와 일치하지 않을 때 OpenSearch Dashboards가 표시하는 메시지 |
resource_sharing_enabled |
Boolean | 리소스 공유 기능이 활성화되어 있는지 여부 |
api_tokens_enabled |
Boolean | API key API가 활성화되어 있는지 여부 |
max_duration_seconds |
Integer | API key에 부여할 수 있는 최대 수명(초 단위) |