システムAPIキーとWebhookは、ワークスペースの全メンバーに共有されたフォルダに入っているノートのみを読み取ります。メンバーが個人フォルダに置いたノート、一部のメンバーにだけ共有したフォルダのノート、どのフォルダにも入れていないノートは、読み取り範囲から外れます。
Tiroは、ノートを作成した本人のものとして扱い、管理者やシステムが個人のノートを閲覧しないように設計してきました。アプリではこの基準がすでに適用されており、システムの資格で呼び出すAPIとWebhookにも同じ基準を合わせています。
キーの種類ごとにどのノートを読み取りますか?
キーの種類を見分ける方法と発行の手順は、認証でご確認ください。
どのノートが読み取れませんか?
システムキーでは、次のノートを読み取れません。
- メンバーの個人フォルダにあるノート
- 一部のメンバーにだけ共有したフォルダのノート
- どのフォルダにも入っていないノート
最後の項目は見落としやすいところです。フォルダに入れていないノートは共有先が決まっていない状態なので、全メンバーに共有されたフォルダのノートとしては扱いません。
スコープを広げても読み取り範囲は変わりません。 スコープはキーが呼び出せるAPIを決めるもので、このページで説明する読み取り範囲は、そのAPIがどのノートを返すかを決めるものです。note:read を持つシステムキーでも、全メンバーに共有されたフォルダの外にあるノートは読み取れません。管理者が発行したキーでも同じです。
読み取れないノートはどのように見えますか?
呼び出すAPIによって表れ方が変わります。
読み取り範囲の外にあるノートは、403 ではなく 404 を返します。ノートが存在するかどうか自体を知らせないための動作です。そのため、削除されたノートと同じレスポンスになります。 昨日まで読み取れていたノートが 404 を返しはじめた場合は、そのノートが全メンバーに共有されたフォルダの外へ移動していないかを先にご確認ください。
一覧と検索は、エラーが出ないまま結果だけが少なくなります。連携でノートの件数をもとに動作を判断している場合、読み取り範囲が狭まったときと、実際にノートがないときを見分けられないことがあります。
この範囲が適用されないAPIはどれですか?
ノート本文の読み取りではない次の項目は、この範囲の対象外です。
- フォルダイベント(
folder.note.*)のWebhook
- 音声ファイルジョブ(Voice File Job)のAPIとイベント
個人フォルダのノートが必要な場合
ユーザーキーを発行してご利用ください。 ユーザーキーは、そのユーザーがアプリで見られるノートを読み取るため、本人の個人フォルダのノートも取得できます。発行の手順は認証をご覧ください。
連携に必要なノートを、全メンバーに共有されたフォルダへ移す方法もあります。この場合、そのノートはワークスペースのメンバー全員に見えるようになるため、移す前に共有してよい内容かどうかをご確認ください。
すでに発行したキーはどうなりますか?
この範囲が適用される前に発行したシステムキーと、登録したWebhookは、当面これまでの動作を維持し、順次移行される予定です。そのため、いま新しく発行したキーが以前のキーより少ないノートを返すことがありますが、これは正常な動作です。移行が完了すると、すべてのシステムキーとWebhookがこのページの範囲に従います。
移行の対象となるキーとWebhookは、Tiro Platform の API Keys、Webhooks 画面でご確認ください。