Revoke API Key API
출처: 문서
본문
API 키 해제 API
3.7에서 도입 {: .label .label-purple }
API 키를 해제하면 인증에 즉시 사용할 수 없게 돼요. 이건 소프트 삭제예요. 키는 revoked_at 타임스탬프와 함께 목록 응답에 계속 표시돼요.
API 키를 해제할 때는 다음 사항에 유의하세요:
- 해제는 동기적으로 처리돼요. 응답이 반환되기 전에 키가 무효 상태로 모든 노드에 브로드캐스트돼요.
- 해제된 키는 다시 활성화할 수 없어요.
- 해제 후에는 키 이름을 재사용할 수 없어요.
엔드포인트
DELETE /_plugins/_security/api/apitokens/{id}
경로 파라미터
다음 표는 사용 가능한 경로 파라미터를 보여줘요.
| 파라미터 | 데이터 타입 | 필수 여부 | 설명 |
|---|---|---|---|
id |
String | 예 | 해제할 키의 고유 식별자예요. |
요청 예제
DELETE _plugins/_security/api/apitokens/_ofOi6ABkhwU_cGa4M3v
{% include copy-curl.html security=true %}
응답 예제
{
"message": "Token _ofOi6ABkhwU_cGa4M3v revoked successfully."
}
응답 본문 필드
응답 본문은 다음 필드를 가진 JSON 객체예요.
| 필드 | 데이터 타입 | 설명 |
|---|---|---|
message |
String | 키가 해제되었음을 확인하는 메시지예요. |