コンテンツにスキップ

メンバーの個人 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"
}