settings
settings API, 엔드포인트 8개 (자동 생성)
전역 관리자 백오피스: 사용자 및 역할, 통합 상태 및 감사 로그.
GET /api/v1/settings/users
GET/api/v1/settings/users
현재 테넌트의 멤버 목록
현재 테넌트에 멤버십이 있는 사용자를 그 테넌트의 역할과 함께 조회합니다.
파라미터
| 이름 | 위치 | 형식 | 필수 | 설명 |
|---|---|---|---|---|
page | query | integer | ||
page_size | query | integer? | ||
q | query | string? | 이름 부분 일치 검색 | |
sort | query | string? | 정렬 키 | |
order | query | string | asc | desc |
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
GET /api/v1/settings/roles
GET/api/v1/settings/roles
역할/권한 매트릭스
정적 RBAC 모델, 즉 모든 역할과 그에 부여된 권한을 노출합니다.
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |
POST /api/v1/settings/users/invite
POST/api/v1/settings/users/invite
기존 사용자에게 현재 테넌트 역할 부여
이미 등록된 사용자에게 현재 테넌트의 역할을 부여합니다.
요청 본문: application/json, InviteBody
| 필드 | 형식 | 필수 | 설명 |
|---|---|---|---|
email | string | ✓ | |
tenant_code | string | ✓ | Tenant Code |
role | string | ✓ | Role |
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
POST /api/v1/settings/users/create
POST/api/v1/settings/users/create
현재 테넌트에 사용자를 직접 생성
비밀번호를 가진 계정을 만들고 현재 테넌트의 역할을 부여합니다.
요청 본문: application/json, CreateUserBody
| 필드 | 형식 | 필수 | 설명 |
|---|---|---|---|
email | string (email) | ✓ | |
password | string | ✓ | Password |
tenant_code | string | ✓ | Tenant Code |
role | string | ✓ | Role |
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
PATCH /api/v1/settings/users/{user_id}/role
PATCH/api/v1/settings/users/{user_id}/role
현재 테넌트 내 사용자 역할 설정
사용자의 현재 테넌트 역할을 변경(또는 부여)합니다.
파라미터
| 이름 | 위치 | 형식 | 필수 | 설명 |
|---|---|---|---|---|
user_id | path | string (uuid) | ✓ |
요청 본문: application/json, RoleAssign
| 필드 | 형식 | 필수 | 설명 |
|---|---|---|---|
tenant_code | string | ✓ | Tenant Code |
role | string | ✓ | Role |
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
DELETE /api/v1/settings/users/{user_id}/role
DELETE/api/v1/settings/users/{user_id}/role
현재 테넌트 내 사용자 역할 제거
현재 테넌트에서 사용자의 멤버십을 제거합니다.
파라미터
| 이름 | 위치 | 형식 | 필수 | 설명 |
|---|---|---|---|---|
user_id | path | string (uuid) | ✓ | |
tenant | query | string | ✓ |
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
GET /api/v1/settings/audit
GET/api/v1/settings/audit
현재 테넌트의 감사 로그 (+ CSV 내보내기)
현재 테넌트에서 일어난 감사 로그를 조회합니다(테넌트 없는 시스템 로그 제외).
파라미터
| 이름 | 위치 | 형식 | 필수 | 설명 |
|---|---|---|---|---|
action | query | string? | action 접두 (예: role) | |
tenant | query | string? | ||
since | query | string (date-time)? | 이 시각 이후, ISO 8601 | |
until | query | string (date-time)? | 이 시각 이전, ISO 8601 | |
actor | query | string? | 행위자 이메일·이름 일부 | |
target | query | string? | 대상 문자열 또는 대상 이메일 일부 | |
format | query | string | ||
page | query | integer | ||
page_size | query | integer? |
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |
| 422 | Validation Error (HTTPValidationError) |
GET /api/v1/settings/audit/actions
GET/api/v1/settings/audit/actions
현재 테넌트 감사 로그의 action 값 목록
필터 선택지: 이 테넌트 기록에 실제로 있는 action 만, 이름순으로.
응답
| 상태 | 설명 |
|---|---|
| 200 | Successful Response (object) |