콘텐츠로 이동

멤버 개인 API Key 일괄 활성화/비활성화¶

POST /api/v1/workspace/member/personal_api_key/enable/modify

개요¶

멤버 개인 API Key 사용 권한을 일괄적으로 활성화 또는 비활성화합니다.

Body 요청 매개변수¶

매개변수명	유형	필수	설명
accountUUIDs	array	Y	멤버 계정 UUID 목록 예시: ['acnt_xxxx32'] 빈 값 허용: False
enablePersonalAPIKey	integer	Y	개인 API Key 활성화 여부, 1은 활성화, 0은 비활성화 예시: 1 빈 값 허용: False 선택 가능 값: [0, 1]

매개변수 추가 설명¶

요청 본문은 프론트엔드 인터페이스 /api/v1/workspace/member/personal_api_key/enable/modify와 동일합니다.

enablePersonalAPIKey=1는 멤버 개인 API Key 사용 권한을 활성화합니다.
enablePersonalAPIKey=0는 멤버 개인 API Key 사용 권한을 비활성화하며, 멤버는 더 이상 개인 API Key를 사용하여 현재 워크스페이스 리소스에 접근할 수 없습니다.
owner 멤버의 개인 API Key 권한을 비활성화하는 것은 거부됩니다.
무료 플랜 워크스페이스는 이 기능을 지원하지 않습니다.

요청 예시¶

curl 'https://openapi.guance.com/api/v1/workspace/member/personal_api_key/enable/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"accountUUIDs": ["acnt_xxxx32"], "enablePersonalAPIKey": 1}' \
--compressed

응답¶

{
    "code": 200,
    "content": {
        "updated": 1
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-B6A69C1D-ED27-42C2-93FD-BC943F8675D2"
}