読み取り専用のdosya APIキーを作成する

読み取り専用の認証情報では一覧表示とダウンロードができますが、アップロードを開始したり保存済みデータを変更したりすることはできません。レポート、バックアップの読み取り、一覧作成に使用してください。

対応するアクセス範囲を設定する

権限カードには一覧表示とダウンロードのみ可能です。アップロード、移動、削除はできません。と表示されます。RESTクライアントではREST APIを選択し、必要に応じて1つのワークスペースに固定してください。フォルダーを指定した認証情報はWebDAVまたはS3でのみ動作するため、RESTではフォルダーを指定しないでください。

現在のロールには引き続きaccess_filesが必要です。非表示またはロックされた項目にも通常の制限が適用されます。

手順

1. プロフィール → API（APIキー）を開いてAPI：APIキーを作成を選択し、レポートまたはダウンロード用クライアントを区別できる名前を付けてください。
2. 何ができますか？で読み取り専用を選択し、制限と有効期限を開いてください。
3. REST APIを許可し、可能であれば対象のワークスペースに固定して、用途に合った接続元、使用回数、有効期限の制限を設定してください。
4. キーを生成を押し、一度だけシークレットをコピーして、クライアントの認証情報管理機能に保存してください。
5. GET /api/files?workspace_id=wks_…で許可される操作を試し、応答に期待する一覧が含まれることを確認してください。
6. テスト用のPOST /api/foldersで拒否される操作を試し、スコープによる403応答が返り、フォルダーが作成されていないことを確認してください。

スコープの境界

RESTではGET、HEAD、OPTIONSを読み取り操作として扱います。ドキュメントに記載された一括ダウンロードのPOSTルートは、既存のデータを返すため読み取りに分類されます。アップロードのエンドポイントとPOST /api/foldersには書き込み権限が必要です。名前の変更、移動、共有、削除には通常フルアクセスが必要です。

拒否されたフォルダーへのリクエストにはThis credential's scope is 'read' and cannot perform POST /api/foldersと表示されます。別の403応答はプロトコル、固定先、ロール、ロックのルールによる場合もあるため、個別に原因を調べてください。

キーを取り消すと行が完全に削除され、REST/S3キャッシュの無効化が予定されます。キャッシュされた認証は最大5分間有効な場合があるため、クライアントを停止し、使用を終えたシークレットが拒否されることを確認してからアクセスの遮断を完了としてください。本番用の読み取り認証情報は、目的の一覧表示またはダウンロードと、変更操作の拒否の両方を確認してから使用してください。

期待される結果

認証情報で許可されたメタデータやダウンロードが返され、影響のない作成操作のテストはデータが変更される前に拒否されます。ワークスペースの境界も維持されます。

関連ガイド

• APIキーを作成する
• キーのスコープを選ぶ