Skip to main content
システムAPIキーとシステムWebhookは、ワークスペースの全メンバーに共有されたフォルダに入っているノートのみを扱います。読み取りだけでなく、ノートを変更するリクエストにも同じ範囲が適用されます。メンバーが個人フォルダに置いたノート、一部のメンバーにだけ共有したフォルダのノート、どのフォルダにも入れていないノートは、この範囲から外れます。アカウントのAPIキーとアカウントのWebhookはユーザーの識別情報と実際のアクセス権限に従うため、このシステム範囲は適用されません。 どのフォルダにも入れていないノートは見落としやすいところです。共有先が決まっていない状態なので、全メンバーに共有されたフォルダのノートとしては扱いません。

キーの種類ごとにどのノートを読み取りますか?

キーの種類を見分ける方法と発行の手順は、認証でご確認ください。
スコープを広げてもこの範囲は変わりません。 スコープはキーが呼び出せるAPIを決めるもので、このページで説明する範囲は、そのAPIがどのノートに届くかを決めるものです。note:read を持つシステムAPIキーでも、全メンバーに共有されたフォルダの外にあるノートは読み取れず、note:write を持っていてもそのノートを変更できません。管理者が発行したキーでも同じです。

範囲の外にあるノートはどのように見えますか?

範囲の外にあるノートは、403 ではなく 404 を返します。ノートが存在するかどうか自体を知らせないための動作です。そのため、削除されたノートと同じレスポンスになります。 昨日まで通っていたリクエストが 404 を返しはじめた場合は、そのノートが全メンバーに共有されたフォルダの外へ移動していないかを先にご確認ください。
連携でノートの件数をもとに動作を判断している場合、範囲が狭まったときと、実際にノートがないときを見分けられないことがあります。

フォルダはどこまで扱えますか?

システムAPIキーで行えるフォルダの操作は、タイトルの変更・移動・並び替えの3つです。フォルダの一覧取得と個別取得、フォルダの削除、フォルダへのノートの追加と削除は、フォルダの種類にかかわらずアカウントのAPIキーのみで行え、システムAPIキーで呼び出すと 401 を返します。 この3つの操作は、全メンバーに共有されたフォルダにのみ行えます。個人フォルダや一部の人にだけ共有したフォルダを対象にすると 403 を返し、移動先として指定した親フォルダにも同じ条件が適用されます。並び替えは、リストに全メンバー共有ではないフォルダが1つでも含まれるとリクエスト全体が 403 になるため、全メンバーに共有されたフォルダだけを送ってください。 フォルダを移動しても共有範囲は変わりません。移動先の親フォルダの共有設定を引き継ぐオプション(sharingTypeUpdateStrategy)を指定しても、システムAPIキーでは適用されません。 ノートがどのフォルダに入っているかを取得する場合GET /v1/external/notes/{guid}/folders)は、全メンバーに共有されたフォルダだけがレスポンスに含まれます。同じノートがメンバーの個人フォルダにも入っている場合、そのフォルダは外れます。このときエラーにはならず一覧が短くなるだけなので、フォルダ名で分類する連携ではアカウントのAPIキーで見るときと結果が異なることがあります。 ノートを検索する際に folderId でフォルダを指定する場合も同様です。個人フォルダのIDを指定すると 404 を返します。

この範囲が適用されないAPIはどれですか?

音声ファイルジョブ(Voice File Job)のAPIと voice_file_job.* イベント(createdcompletedfaileddeleted)は、この範囲の対象外です。

個人フォルダのノートが必要な場合

アカウントのAPIキーを発行してご利用ください。 発行の手順は認証をご覧ください。 連携に必要なノートを、全メンバーに共有されたフォルダへ移す方法もあります。

すでに発行したキーはどうなりますか?

この範囲が適用される前に発行したシステムAPIキーと、登録したシステムWebhookは、当面これまでの動作を維持し、順次移行される予定です。そのため、いま新しく発行したキーが以前のキーより少ないノートを返すことがありますが、これは正常な動作です。 移行されると、取得できるノートが減るだけでなく、フォルダのタイトル変更・移動・並び替えが 403 で拒否されることがあります。 いま成功しているリクエストでも、全メンバーに共有されたフォルダでなければ移行後は拒否されます。 移行の対象となるキーとWebhookは、Tiro Platform の API Keys、Webhooks 画面でご確認ください。