Patch Security Configuration API
출처: 문서
본문
Patch Security Configuration API
2.10에 도입됨 {: .label .label-purple }
Patch Configuration API를 사용하면 전체 구성 문서를 교체하지 않고도 Security 플러그인 구성의 특정 부분만 업데이트할 수 있어요.
이 작업은 기존 보안 구성을 쉽게 망가뜨릴 수 있어요. 검증과 안전장치가 포함되어 있어 잘못된 구성을 방지해 주는 securityadmin.sh 스크립트를 대신 사용하는 것을 강력히 권장해요.
{: .warning}
엔드포인트
PATCH /_plugins/_security/api/securityconfig
요청 본문 필드
요청 본문은 필수예요. JSON 객체의 배열(NDJSON) 형태예요. 각 객체는 다음과 같은 필드를 가지고 있어요.
| 속성 | 필수 여부 | 데이터 타입 | 설명 |
|---|---|---|---|
op |
필수 | String | 수행할 작업이에요. 유효한 값은 add, remove, replace, move, copy, test이에요. |
path |
필수 | String | 구성에서 수정할 위치를 가리키는 JSON 포인터 경로예요. |
value |
선택 | Object | 작업에 사용할 값이에요. add, replace, test 작업에는 필수예요. |
요청 예제
PATCH /_plugins/_security/api/securityconfig
[
{
"op": "replace",
"path": "/config/dynamic/authc/basic_internal_auth_domain/description",
"value": "Authenticate via HTTP Basic against the internal users database"
}
]
{% include copy-curl.html security=true %}
응답 예제
{
"status": "OK",
"message": "Resource updated."
}
응답 본문 필드
응답 본문은 다음 필드로 이루어진 JSON 객체예요.
| 속성 | 데이터 타입 | 설명 |
|---|---|---|
status |
String | 요청의 상태예요. 성공한 요청은 "OK"를 반환해요. |
message |
String | 작업 결과를 설명하는 메시지예요. |
이 API 활성화하기
기본적으로 이 API는 보안상의 이유로 비활성화되어 있어요. 활성화하려면 opensearch.yml에 다음 줄을 추가하세요:
plugins.security.unsupported.restapi.allow_securityconfig_modification: true
{% include copy.html %}
Security API에 대한 접근 권한을 부여하는 방법을 자세히 알아보려면 API에 대한 접근 제어를 참고하세요.