Patch Tenants API
출처: 문서
본문
테넌트 패치 API
1.0에 도입됨 {: .label .label-purple }
테넌트를 교체하지 않고 업데이트해요. 테넌트 이름을 지정하면 한 테넌트의 개별 속성을 업데이트할 수 있고, 테넌트 이름을 생략하면 한 번의 호출로 여러 테넌트를 추가, 삭제, 수정할 수 있어요.
엔드포인트
PATCH /_plugins/_security/api/tenants
PATCH /_plugins/_security/api/tenants/{tenant}
경로 파라미터
다음 표는 사용할 수 있는 경로 파라미터를 나열한 거예요.
| 파라미터 | 데이터 타입 | 필수 여부 | 설명 |
|---|---|---|---|
tenant |
String | 아니요 | 업데이트할 테넌트의 이름이에요. 생략하면 요청 하나로 여러 테넌트를 수정할 수 있어요. |
요청 본문 필드
요청 본문은 필수예요. JSON 객체의 배열이고, 각 객체는 다음 필드를 포함해요.
| 필드 | 데이터 타입 | 설명 | 필수 여부 |
|---|---|---|---|
op |
String | 수행할 작업이에요. 유효한 값은 add, remove, replace, move, copy, test예요. |
예 |
path |
String | 수정할 경로예요. 테넌트 이름을 지정하면 경로가 해당 테넌트를 기준으로 상대적이에요. 예를 들어 /description처럼요. 테넌트 이름을 생략하면 경로가 테넌트 이름으로 시작해요. 예를 들어 /human_resources/description처럼요. |
예 |
value |
Object | 새 값이에요. add, replace, test 작업에는 필수예요. |
아니요 |
요청 예제
다음 요청은 human_resources 테넌트의 설명을 업데이트해요:
PATCH _plugins/_security/api/tenants/human_resources
[
{
"op": "replace", "path": "/description", "value": "An updated description"
}
]
{% include copy-curl.html security=true %}
다음 요청은 human_resources 테넌트의 설명을 업데이트하고 another_tenant 테넌트를 추가해요:
PATCH _plugins/_security/api/tenants
[
{
"op": "replace",
"path": "/human_resources/description",
"value": "An updated description"
},
{
"op": "add",
"path": "/another_tenant",
"value": {
"description": "Another description."
}
}
]
{% include copy-curl.html security=true %}
응답 예제
테넌트 하나를 업데이트하는 요청은 응답에 해당 테넌트 이름을 표시해요:
{
"status": "OK",
"message": "'human_resources' updated."
}
벌크 요청은 변경한 테넌트 이름을 표시하지 않아요:
{
"status": "OK",
"message": "Resource updated."
}