tenants
tenants API, 엔드포인트 10개 (자동 생성)
테넌트 디렉터리 및 전환, 그리고 전역 관리자의 테넌트 프로비저닝.
GET /api/v1/tenants
GET/api/v1/tenants
호출자가 접근 가능한 테넌트
호출 사용자가 권한을 가진 테넌트를 역할과 함께 조회합니다.
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |
GET /api/v1/settings/features
GET/api/v1/settings/features
토글 가능한 기능 카탈로그 (관리자)
테넌트별로 켜고 끌 수 있는 기능 목록을 반환합니다.
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |
GET /api/v1/settings/tenants
GET/api/v1/settings/tenants
전체 테넌트 (관리자)
멤버십과 무관하게 시스템의 모든 테넌트를 조회합니다.
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |
POST /api/v1/settings/tenants
POST/api/v1/settings/tenants
테넌트 생성
code, name 및 선택적 설정으로 새 테넌트를 프로비저닝합니다.
요청 본문: application/json, TenantCreate
| 필드 | 형식 | 필수 | 설명 |
|---|---|---|---|
code | string | ✓ | Code |
name | string | ✓ | Name |
kpi_targets | object | Kpi Targets | |
retention | object | Retention | |
features | object | Features | |
shared_defaults | SharedDefault[] | Shared Defaults |
응답
| 상태 | 설명 |
|---|---|
| 201 | Successful Response (TenantOut) |
| 422 | Validation Error (HTTPValidationError) |
PATCH /api/v1/settings/tenants/{tenant_id}
PATCH/api/v1/settings/tenants/{tenant_id}
테넌트 수정
tenant_id로 테넌트의 변경 가능한 필드를 부분 수정합니다.
파라미터
| 이름 | 위치 | 형식 | 필수 | 설명 |
|---|---|---|---|---|
tenant_id | path | string (uuid) | ✓ |
요청 본문: application/json, TenantUpdate
| 필드 | 형식 | 필수 | 설명 |
|---|---|---|---|
name | string? | Name | |
kpi_targets | object? | Kpi Targets | |
retention | object? | Retention | |
is_active | boolean? | Is Active | |
features | object? | Features |
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (TenantOut) |
| 422 | Validation Error (HTTPValidationError) |
GET /api/v1/settings/tenants/deletions
GET/api/v1/settings/tenants/deletions
테넌트 삭제 이력 (관리자)
지금까지 실행된 테넌트 삭제 작업을 최신순으로 조회합니다.
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |
GET /api/v1/settings/tenants/deletions/{deletion_id}
GET/api/v1/settings/tenants/deletions/{deletion_id}
테넌트 삭제 상세
삭제 작업 하나의 상태, 스텝 체크리스트, 전체 로그를 조회합니다.
파라미터
| 이름 | 위치 | 형식 | 필수 | 설명 |
|---|---|---|---|---|
deletion_id | path | string (uuid) | ✓ |
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (DeletionOut) |
| 422 | Validation Error (HTTPValidationError) |
GET /api/v1/settings/tenants/{tenant_id}/deletion-preview
GET/api/v1/settings/tenants/{tenant_id}/deletion-preview
테넌트 삭제 영향 미리보기
삭제 시 제거될 리소스를 집계합니다(확인 다이얼로그용).
파라미터
| 이름 | 위치 | 형식 | 필수 | 설명 |
|---|---|---|---|---|
tenant_id | path | string (uuid) | ✓ |
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
POST /api/v1/settings/tenants/{tenant_id}/deletion
POST/api/v1/settings/tenants/{tenant_id}/deletion
테넌트 삭제 시작
테넌트와 그에 속한 모든 리소스의 삭제를 시작합니다. 되돌릴 수 없습니다.
파라미터
| 이름 | 위치 | 형식 | 필수 | 설명 |
|---|---|---|---|---|
tenant_id | path | string (uuid) | ✓ |
요청 본문: application/json, TenantDeleteRequest
| 필드 | 형식 | 필수 | 설명 |
|---|---|---|---|
confirm_code | string | ✓ | Confirm Code |
응답
| 상태 | 설명 |
|---|---|
| 202 | Successful Response (DeletionOut) |
| 422 | Validation Error (HTTPValidationError) |
POST /api/v1/settings/tenants/deletions/{deletion_id}/retry
POST/api/v1/settings/tenants/deletions/{deletion_id}/retry
실패한 테넌트 삭제 재시도
끝난 삭제 작업에서 완료되지 않은 스텝만 다시 실행합니다.
파라미터
| 이름 | 위치 | 형식 | 필수 | 설명 |
|---|---|---|---|---|
deletion_id | path | string (uuid) | ✓ |
응답
| 상태 | 설명 |
|---|---|
| 202 | Successful Response (DeletionOut) |
| 422 | Validation Error (HTTPValidationError) |