- 인증 방식과 API Key 종류 비교: 인증
- 조직 단위 웹훅으로 이벤트를 받는 방법: Webhook 개요
조직 API Key와 조직 웹훅은 조직 관리자만 발급·등록할 수 있어요.
조직 API Key는 어디까지 닿나요?
조직 API Key는 조직에 소속된 워크스페이스에 들어 있는 노트에 닿아요. 조직 밖 개인 워크스페이스의 노트에는 닿지 않아요. 조직 API Key는 시스템 API Key라서, 소속 워크스페이스 안에서도 전체 구성원에게 공유된 폴더의 노트만 조회해요. 구성원의 개인 폴더에 있는 노트, 일부 구성원에게만 공유한 폴더의 노트, 어느 폴더에도 넣지 않은 노트는 조회 범위에서 빠져요. 자세한 범위는 시스템 API Key가 조회하는 노트 범위에 정리해 두었어요.조직 API Key로 호출할 수 있는 엔드포인트
조직 API Key는 아래 엔드포인트로 조직, 워크스페이스, 구성원 접근과 노트를 관리해요.워크스페이스를 프로그래밍 방식으로 관리하기
조직 API Key로 워크스페이스를 만들고 수정하거나 삭제할 수 있어요. 사내 프로비저닝 도구나 자동화 스크립트에 사용하세요.- 목록·조회:
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 scope가 필요해요. 이 API는 사용자 생성·초대, 비밀번호 변경, 계정 삭제를 제공하지 않아요.
Next steps
인증
API Key 종류별 접근 범위와 발급 방법
Webhook 개요
이벤트 구조, 재시도 정책, 검증 방법