관리 API 개요
콘솔 세션으로 조직, 멤버, 워크스페이스, 초대, API 키를 프로그래밍 방식으로 관리하는 엔드포인트와 권한을 설명합니다
관리 API는 콘솔이 쓰는 엔드포인트입니다, 조직의 멤버, 워크스페이스, 초대, API 키, 한도를 화면 대신 HTTP로 다룰 때 씁니다, 잡을 실행하는 Jobs API와 같은 주소(https://xenoci.com/api/runner/v1) 아래에 있고 오류 형식도 같습니다
인증
관리 API는 콘솔 세션 하나만 받습니다
| 자격 증명 | 보내는 방법 | 관리 API |
|---|---|---|
| 콘솔 세션 | 로그인 쿠키 xci_console과 Origin: https://xenoci.com 헤더 | 사용 가능, 역할에 따라 |
| API 키 | Authorization: Bearer xci_live_… | 403 console_only |
curl "https://xenoci.com/api/runner/v1/organizations/org_7Kq2m9ZtP3/members" \
--cookie "xci_console=$SESSION" \
-H "Origin: https://xenoci.com"세션은 로그인 후 14일 동안 유효합니다, 상태를 바꾸는 요청은 Origin 헤더가 https://xenoci.com이어야 합니다
관리 API 작동 방식
모든 경로는 조직 ID(org_…)로 시작합니다, 세션의 사용자가 그 조직의 멤버가 아니면 조직이 없는 것처럼 404 not_found를 돌려줍니다
| 영역 | 엔드포인트 |
|---|---|
| 조직 | 조직 목록, 조직 조회, 조직 이름 바꾸기 |
| 멤버 | 멤버 목록, 멤버 역할 바꾸기, 멤버 내보내기 |
| 초대 | 초대 목록, 초대 보내기, 초대 취소, 초대 수락 |
| 워크스페이스 | 목록, 만들기, 수정, 보관 |
| 워크스페이스 멤버 | 목록, 추가, 빼기 |
| API 키 | 발급, 목록, 이름 바꾸기, 폐기 |
| 티어와 한도 | 조직 티어 조회, 한도 조회 |
전체 목록은 API 레퍼런스 개요에 있습니다
조직 역할과 권한
| 역할 | 관리 API로 할 수 있는 일 |
|---|---|
| 소유자 | 모든 일, 소유자 역할을 주거나 빼기 포함 |
| 관리자 | 멤버, 워크스페이스, 키, 한도, 충전 관리, 소유자 역할은 바꿀 수 없음 |
| 개발자 | 조직과 멤버 보기, 배정된 워크스페이스에서 키 발급과 사용량 보기 |
역할마다 할 수 있는 일 전체는 역할과 키 권한에 있습니다, 역할이 모자라면 403 insufficient_permission입니다
주요 개념
조직 멤버
조직에 속한 사용자이고 소유자, 관리자, 개발자 가운데 하나의 역할을 가집니다, 조직에는 소유자가 항상 한 명 이상 있어야 하고 마지막 소유자를 바꾸는 요청은 last_owner로 거절됩니다
조직 초대
이메일로 보내고 7일 동안 유효합니다, 받은 사람은 초대받은 이메일로 로그인해야 수락할 수 있습니다
워크스페이스
API 키, 사용량, 월 지출 한도를 묶는 단위입니다, 기본 워크스페이스 Default는 보관할 수 없습니다
API 키
워크스페이스 하나에 묶이고 권한은 run 또는 read입니다, 관리 API로 발급하면 응답에 키 값이 한 번만 들어 있습니다
감사 기록
워크스페이스 보관, API 키 발급과 폐기, 역할 변경 같은 관리 작업은 누가 언제 했는지 감사 기록에 남습니다, 문의할 때 조직 ID와 요청 ID를 함께 알려 주시면 확인해 드립니다