組織単位で連携する

組織 API キーは、組織に所属するワークスペースのノート、メンバー、セッションを管理するサーバー間連携用のキーです。認証と Webhook の動作は通常の API キーと同じで、アクセス範囲だけが異なります。

• 認証方式とキー種別の比較: 認証
• 組織単位のWebhookでイベントを受け取る方法: Webhookの概要

​

組織APIキーはどこまでアクセスできますか？

組織APIキーは、組織に所属するワークスペース内のノートにアクセスできます。組織外の個人ワークスペースのノートにはアクセスできません。 組織APIキーはシステムAPIキーなので、所属ワークスペースの中でも全メンバーに共有されたフォルダのノートのみを読み取ります。メンバーの個人フォルダにあるノートや、どのフォルダにも入れていないノートは、読み取り範囲から外れます。詳しい範囲はシステムAPIキーが読み取るノートの範囲にまとめています。

​

組織APIキーで呼び出せるエンドポイント

組織APIキーでは、以下のエンドポイントで組織・ワークスペース・メンバーアクセス・ノートを管理します。

​

ワークスペースをプログラムから管理する

組織 API キーでワークスペースの作成・更新・削除ができます。社内のプロビジョニングツールや自動化スクリプトからご利用ください。

• 一覧・照会: GET .../workspaces で組織所属のワークスペースを一覧できます。queryで名前を検索し、cursor・sizeでページを送ります。
• 作成・変更・削除: POSTで新しいワークスペースを作成し、PATCH .../{workspaceGuid} で名前・説明を変更し、DELETEで整理します。変更時はupdateMaskクエリパラメータに変更するフィールドだけを指定します。たとえば ?updateMask=name なら名前だけが変わり、ほかはそのまま維持されます。
• 利用上限の設定: PATCH .../{workspaceGuid}/quota の quotaInMinutes で、ワークスペースごとの録音上限を設定します。nullは無制限、0は全面ブロック、正の数はその分数（分）です。組織の上限を設定している場合、ワークスペース上限の合計が組織の上限を超えることはできません。

照会には workspace:read、作成・名前の変更・上限設定・削除には workspace:write scopeが必要です。scopeを指定せずに発行したキーは、すべての操作が許可されます。詳しくは認証をご覧ください。

​

メンバーのアクセスを管理する

GET .../membersで組織にすでに所属しているユーザーを取得し、PUT .../workspaces/{workspaceGuid}/members/{userGuid}でワークスペースと役割を割り当てます。同じPUTを再実行しても最終状態は変わりません。割り当ての解除にはDELETEを使用します。 役割はADMIN、MEMBER、VIEWERから選択します。ADMINはワークスペースを管理でき、ADMINとMEMBERはseatを使用して録音できます。VIEWERは読み取り専用で、seatを使用せず録音できません。空きseatがない場合、ADMIN・MEMBERの割り当ては409で拒否されます。 録音を停止するにはPUT .../recording-suspension、再開するには同じパスのDELETEを使用します。DELETE .../sessionsは現在のTiroセッションをすべて無効化しますが、再ログインまでは防止しません。継続的にアクセスを禁止するには、Entra IDなどのIDプロバイダー側でもアクセスを解除してください。 メンバーの取得にはorganization_member:read、録音・ワークスペース割り当ての変更にはorganization_member:write、セッションの無効化にはsession:writeが必要です。これらのAPIはユーザー作成・招待、パスワード変更、アカウント削除を提供しません。

​

Next steps