gper/Gnuboard7
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
Gnuboard7/docs/backend/api/roles.md
T
HeuJung 71abdeaf60 fix(security): KVE-2026-1914/1915/1919 remediation 전건 
위임 관리자(부관리자)가 권한·역할·표현식·비밀 콘텐츠 경계를 우회하던
결함군을 계층 대칭성 원칙으로 전건 차단한다. 약한 경로가 정상 응답을
내보내는 것이 유일한 증상이라, 게이트를 생산 지점 한 곳(SSoT)에 두고
같은 데이터를 내보내는 소비 경로 전부가 그 게이트를 경유하도록 맞췄다.

- 등급 상한(rank ceiling): 슈퍼관리자 보호·역할/사용자 역할 배정(추가·제거
 대칭)·일괄 상태변경·순서변경을 상세 경로와 동일 강도로 재적용. 가드는
 DB 쓰기에 선행하여 거부 시 상태 불변.
- 레이아웃 표현식: new Function/with 실행을 AST 화이트리스트 평가기로 교체.
 비-문자열 computed 키 정규화(normalizeKey)·Object facade(리플렉션 static
 제거)·legacy 접근자 차단. 저장측 검증·정적 검사와 3계층 동형.
- secret 게이트: 비밀글의 댓글·첨부·문의 독립 경로 재적용, hash 파일서빙
 소유권·비밀·발행 상태 검사 통일.
- 신뢰 스크립트 호스트: 확장 선언 기반 + same-origin 브라우저 정규화를
 런타임·저장측·정적검사 3층 동형화.
- 회귀 감지: 단위·Feature·E2E·시나리오 매니페스트 전축 + audit 룰 4종 신설.
2026-08-17 01:45:09 +09:00

778 lines
34 KiB
Markdown
Raw Permalink Blame History

# Roles API 레퍼런스
> **소유**: 코어 · **생성**: `php artisan api:docgen` (실측 기반). @generated 블록은 재생성 시 갱신되며, 사람이 작성한 설명은 보존됩니다.
---
## TL;DR (5초 요약)
```text
1. 이 문서는 실제 API 호출로 실측한 Roles 엔드포인트 레퍼런스입니다
2. 각 엔드포인트: 메서드/URI/권한 + 요청 파라미터 표 + 요청 예시(curl) + 실측 응답 필드 표 + 응답 예시(envelope)
3. 응답 필드의 예시값·응답 예시 JSON 은 실제 호출 응답에서 관측된 값입니다
4. 갱신: 코드 변경 후 php artisan api:docgen 재실행
5. 설명(TODO) 칸은 사람이 채웁니다
```
---
### GET /api/admin/roles
<!-- @generated:start:api.admin.roles.index -->
- **라우트명**: `api.admin.roles.index`
- **컨트롤러**: `App\Http\Controllers\Api\Admin\RoleController@index`
- **인증/권한**: `auth:sanctum` + `permission:core.permissions.read`
**요청 파라미터**
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
| --- | --- | --- | --- | --- | --- |
| page | query | integer | 아니오 | min 1 | 조회할 페이지 번호 (1부터 시작) |
| per_page | query | integer | 아니오 | min 1, max 100 | 페이지당 항목 수 |
| search | query | string | 아니오 | max 255 | 검색어 (지정한 검색 대상 필드에서 부분 일치) |
| is_active | query | boolean | 아니오 | — | 활성 여부 (true 활성 / false 비활성) |
**요청 예시**
```http
GET /api/admin/roles?page=1&per_page=1&search=%EC%98%88%EC%8B%9C%EA%B0%92&is_active=1 HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
```
**응답 필드** (`data` 내부)
_목록 응답: `data.data[]` 배열 항목의 필드 + `data.pagination`._
| 필드 | 타입 | 실측 예시값 | 용도/설명 |
| --- | --- | --- | --- |
| id | integer | `157` | 기본 키 (내부 식별자) |
| identifier | string | `i492_scope_self` | 역할명 (예: admin, user, manager) |
| name | string | `#492 스코프검증(self)` | 역할 이름 (다국어 JSON) |
| name_raw | object | `{"ko":"#492 스코프검증(self)","en":"#492 Scope Self"}` | `name` 의 원본 값 (현재 로케일 미해석 원본 JSON/문자열) |
| description | string | `#492 브라우저 실측 G10 전용` | 역할 설명 (다국어 JSON) |
| description_raw | object | `{"ko":"#492 브라우저 실측 G10 전용","en":"for #492 G10"}` | `description` 의 원본 값 (현재 로케일 미해석 원본 JSON/문자열) |
| extension_type | string | `core` | 확장 소유 타입: core(코어), module(모듈), plugin(플러그인), NULL(사용자 정의) |
| extension_identifier | string | `core` | 확장 식별자 (예: core, sirsoft-board, sirsoft-payment) |
| extension_name | string | `게시판` | 이 리소스를 소유한 확장의 표시 이름 (manifest name) |
| is_deletable | boolean | `false` | deletable 여부 |
| is_active | boolean | `true` | active 여부 |
| users_count | integer | `1` | users 개수 (집계) |
| permissions_count | integer | `2` | 이 역할에 할당된 권한 개수 (집계 — 목록은 권한 배열을 싣지 않고 규모만 제공) |
| created_at | string | `2026-07-31 00:46:12` | 생성 일시 |
| updated_at | string | `2026-07-31 00:46:12` | 최종 수정 일시 |
| abilities | object | `{"can_create":true,"can_update":true,"can_delete":true,"c…` | 현재 사용자가 이 리소스에 수행 가능한 작업 불리언 맵 (can_update, can_delete 등 — 권한 맵 기반) |
**응답 예시**
```http
HTTP/1.1 200
```
```json
{
"success": true,
"message": "역할 정보를 성공적으로 가져왔습니다.",
"data": {
"data": [
{
"id": 157,
"identifier": "i492_scope_self",
"name": "#492 스코프검증(self)",
"name_raw": {
"ko": "#492 스코프검증(self)",
"en": "#492 Scope Self"
},
"description": "#492 브라우저 실측 G10 전용",
"description_raw": {
"ko": "#492 브라우저 실측 G10 전용",
"en": "for #492 G10"
},
"extension_type": "core",
"extension_identifier": "core",
"extension_name": null,
"is_deletable": false,
"is_active": true,
"users_count": 1,
"created_at": "2026-07-31 00:46:12",
"updated_at": "2026-07-31 00:46:12",
"abilities": {
"can_create": true,
"can_update": true,
"can_delete": true,
"can_toggle_status": true
}
},
{
"id": 156,
"identifier": "manager",
"name": "매니저",
"name_raw": {
"ko": "매니저",
"en": "Manager",
"ja": "マネージャー"
},
"description": "콘텐츠 및 사용자 관리 권한을 가진 관리자입니다.",
"description_raw": {
"ko": "콘텐츠 및 사용자 관리 권한을 가진 관리자입니다.",
"en": "Manager with content and user management permissions.",
"ja": "コンテンツおよびユーザー管理権限を持つ管理者です。"
},
"extension_type": "core",
"extension_identifier": "core",
"extension_name": null,
"is_deletable": false,
"is_active": true,
"users_count": 0,
"created_at": "2026-07-31 00:03:11",
"updated_at": "2026-08-01 11:46:14",
"abilities": {
"can_create": true,
"can_update": true,
"can_delete": true,
"can_toggle_status": true
}
},
"... (총 25건 중 2건 표시)"
],
"abilities": {
"can_create": true,
"can_update": true,
"can_delete": true
},
"pagination": {
"current_page": 1,
"last_page": 4,
"per_page": 25,
"total": 100,
"from": 1,
"to": 25,
"has_more_pages": true
}
}
}
```
**에러 응답**
| 상태코드 | 의미 | 발생 조건 |
| --- | --- | --- |
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(`core.permissions.read`)이 없는 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (`error.errors` 에 필드별 메시지) |
<!-- @generated:end -->
**설명**
역할 관리 화면(`admin_role_list.json`)의 목록 데이터를 제공하는 페이지네이션 조회 엔드포인트다. `search`(identifier/name 텍스트 검색)와 `is_active`(활성 여부)로 필터링하며 `per_page` 로 페이지 크기를 조절한다. 응답에는 소유 확장 정보, 사용자 수(`users_count`), 할당 권한 개수(`permissions_count`), 현재 사용자의 조작 가능 여부(abilities)가 포함된다. 목록에는 **할당 권한의 목록(`permission_ids`/`permission_values`/`permissions`)이 실리지 않는다** — 권한 트리는 역할 하나당 수백 건까지 갈 수 있어 목록을 여는 것만으로 전 행의 권한이 전송됐다. 권한 목록이 필요하면 단건 조회(`GET /api/admin/roles/{role}`)를 사용한다. `core.permissions.read` 권한이 필요하다.
### POST /api/admin/roles
<!-- @generated:start:api.admin.roles.store -->
- **라우트명**: `api.admin.roles.store`
- **컨트롤러**: `App\Http\Controllers\Api\Admin\RoleController@store`
- **인증/권한**: `auth:sanctum` + `permission:core.permissions.create`
**요청 파라미터**
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
| --- | --- | --- | --- | --- | --- |
| identifier | body | string | 예 | max 100 | 대상 확장/리소스의 식별자 |
| name | body | string | 예 | — | 대상의 이름/명칭 |
| description | body | string | 아니오 | — | 설명 |
| is_active | body | boolean | 아니오 | — | 활성 여부 (true 활성 / false 비활성) |
| permissions | body | array | 아니오 | — | 역할에 부여할 권한 목록. 각 원소는 `{id, scope_type}` (id=권한 식별자, scope_type=적용 범위: null 전체 / role 역할 범위 / self 본인 범위). 전달된 목록 기준으로 역할의 권한 집합이 재설정됨 |
> 이 엔드포인트는 확장이 파라미터를 추가할 수 있습니다 (`core.role.store_validation_rules`).
**요청 예시**
```http
POST /api/admin/roles HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
Content-Type: application/json
{
"identifier": "example-key",
"name": "예시 이름",
"description": "예시 내용입니다.",
"is_active": true,
"permissions": [
"예시값"
]
}
```
**응답 필드** (`data` 내부)
_단건 응답: `data` 객체의 필드._
| 필드 | 타입 | 실측 예시값 | 용도/설명 |
| --- | --- | --- | --- |
| id | integer | `893` | 기본 키 (내부 식별자) |
| identifier | string | `probe_6a71e0db284f0` | 역할명 (예: admin, user, manager) |
| name | string | `실측 예시값` | 대상의 이름/명칭 (다국어 필드는 로케일별 값 객체) |
| name_raw | object | `{"ko":"실측 예시값","en":"실측 예시값"}` | `name` 의 원본 값 (현재 로케일 미해석 원본 JSON/문자열) |
| description | string | `실측 예시값` | 설명 (다국어 필드는 로케일별 값 객체) |
| description_raw | object | `{"ko":"실측 예시값","en":"실측 예시값"}` | `description` 의 원본 값 (현재 로케일 미해석 원본 JSON/문자열) |
| extension_type | null | `null` | 이 리소스를 소유한 확장의 타입 (core/module/plugin/template) |
| extension_identifier | null | `null` | 이 리소스를 소유한 확장의 식별자 |
| extension_name | null | `null` | 이 리소스를 소유한 확장의 표시 이름 (manifest name) |
| is_deletable | boolean | `true` | deletable 여부 |
| is_active | boolean | `true` | active 여부 |
| created_at | string | `2026-08-04 21:53:47` | 생성 일시 |
| updated_at | string | `2026-08-04 21:53:47` | 최종 수정 일시 |
| abilities | object | `{"can_create":true,"can_update":true,"can_delete":true,"c…` | 현재 사용자가 이 리소스에 수행 가능한 작업 불리언 맵 (can_update, can_delete 등 — 권한 맵 기반) |
**응답 예시**
```http
HTTP/1.1 201
```
```json
{
"success": true,
"message": "역할이 성공적으로 생성되었습니다.",
"data": {
"id": 893,
"identifier": "probe_6a71e0db284f0",
"name": "실측 예시값",
"name_raw": {
"ko": "실측 예시값",
"en": "실측 예시값"
},
"description": "실측 예시값",
"description_raw": {
"ko": "실측 예시값",
"en": "실측 예시값"
},
"extension_type": null,
"extension_identifier": null,
"extension_name": null,
"is_deletable": true,
"is_active": true,
"created_at": "2026-08-04 21:53:47",
"updated_at": "2026-08-04 21:53:47",
"abilities": {
"can_create": true,
"can_update": true,
"can_delete": true,
"can_toggle_status": true
}
}
}
```
**에러 응답**
| 상태코드 | 의미 | 발생 조건 |
| --- | --- | --- |
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(`core.permissions.create`)이 없는 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (`error.errors` 에 필드별 메시지) |
<!-- @generated:end -->
**설명**
새 역할을 생성한다. `identifier` 는 소문자로 시작하는 영숫자·언더스코어 형식(`^[a-z][a-z0-9_]*$`)이어야 하고 전역 고유해야 한다. `name`·`description` 은 다국어 필드로, 문자열로 보내면 설정된 로케일 전체에 동일 값이 채워지고 객체(`{"ko":..., "en":...}`)로도 보낼 수 있다. `permissions` 는 `[{id, scope_type}]` 형식으로 부여할 권한과 각 권한의 적용 범위(scope_type: null=전체, role, self)를 지정한다. 검증 규칙은 `core.role.store_validation_rules` 필터 훅으로 확장이 확장할 수 있다. `core.permissions.create` 권한이 필요하며 성공 시 201 로 생성된 역할을 반환한다.
### GET /api/admin/roles/active
<!-- @generated:start:api.admin.roles.active -->
- **라우트명**: `api.admin.roles.active`
- **컨트롤러**: `App\Http\Controllers\Api\Admin\RoleController@active`
- **인증/권한**: `auth:sanctum`
**요청 파라미터**
_요청 파라미터 없음._
**요청 예시**
```http
GET /api/admin/roles/active HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
```
**응답 필드** (`data` 내부)
_목록 응답: `data.data[]` 배열 항목의 필드._
| 필드 | 타입 | 실측 예시값 | 용도/설명 |
| --- | --- | --- | --- |
| id | integer | `1` | 기본 키 (내부 식별자) |
| identifier | string | `admin` | 역할명 (예: admin, user, manager) |
| name | string | `관리자` | 역할 이름 (다국어 JSON) |
| name_raw | object | `{"ko":"관리자","en":"Administrator","ja":"管理者"}` | `name` 의 원본 값 (현재 로케일 미해석 원본 JSON/문자열) |
| description | string | `시스템의 모든 기능에 접근할 수 있는 최고 관리자입니다.` | 역할 설명 (다국어 JSON) |
| description_raw | object | `{"ko":"시스템의 모든 기능에 접근할 수 있는 최고 관리자입니다.","en":"Super admin…` | `description` 의 원본 값 (현재 로케일 미해석 원본 JSON/문자열) |
| extension_type | string | `core` | 확장 소유 타입: core(코어), module(모듈), plugin(플러그인), NULL(사용자 정의) |
| extension_identifier | string | `core` | 확장 식별자 (예: core, sirsoft-board, sirsoft-payment) |
| extension_name | string | `이커머스` | 이 리소스를 소유한 확장의 표시 이름 (manifest name) |
| is_deletable | boolean | `false` | deletable 여부 |
| is_active | boolean | `true` | active 여부 |
| created_at | string | `2026-07-30 17:36:00` | 생성 일시 |
| updated_at | string | `2026-08-01 11:46:14` | 최종 수정 일시 |
| abilities | object | `{"can_create":true,"can_update":true,"can_delete":true,"c…` | 현재 사용자가 이 리소스에 수행 가능한 작업 불리언 맵 (can_update, can_delete 등 — 권한 맵 기반) |
**응답 예시**
```http
HTTP/1.1 200
```
```json
{
"success": true,
"message": "역할 정보를 성공적으로 가져왔습니다.",
"data": {
"data": [
{
"id": 1,
"identifier": "admin",
"name": "관리자",
"name_raw": {
"ko": "관리자",
"en": "Administrator",
"ja": "管理者"
},
"description": "시스템의 모든 기능에 접근할 수 있는 최고 관리자입니다.",
"description_raw": {
"ko": "시스템의 모든 기능에 접근할 수 있는 최고 관리자입니다.",
"en": "Super administrator with access to all system features.",
"ja": "システムのすべての機能にアクセスできる最高管理者です。"
},
"extension_type": "core",
"extension_identifier": "core",
"extension_name": null,
"is_deletable": false,
"is_active": true,
"created_at": "2026-07-30 17:36:00",
"updated_at": "2026-08-01 11:46:14",
"abilities": {
"can_create": true,
"can_update": true,
"can_delete": true,
"can_toggle_status": true
}
},
{
"id": 2,
"identifier": "user",
"name": "일반 사용자",
"name_raw": {
"ko": "일반 사용자",
"en": "User",
"ja": "一般ユーザー"
},
"description": "기본 사용자 역할입니다.",
"description_raw": {
"ko": "기본 사용자 역할입니다.",
"en": "Default user role.",
"ja": "基本ユーザーロールです。"
},
"extension_type": "core",
"extension_identifier": "core",
"extension_name": null,
"is_deletable": false,
"is_active": true,
"created_at": "2026-07-30 17:36:00",
"updated_at": "2026-08-01 11:46:14",
"abilities": {
"can_create": true,
"can_update": true,
"can_delete": true,
"can_toggle_status": true
}
},
"... (총 100건 중 2건 표시)"
],
"abilities": {
"can_assign_roles": true
}
}
}
```
**에러 응답**
| 상태코드 | 의미 | 발생 조건 |
| --- | --- | --- |
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(`core.permissions.read`)이 없는 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (`error.errors` 에 필드별 메시지) |
<!-- @generated:end -->
**설명**
셀렉트 UI(사용자 폼·메뉴 편집의 역할 선택 등)에 채울 활성 역할 목록을 제공한다. 별도 권한 미들웨어가 없어 인증만 되면 호출 가능하지만, 내부에서 권한에 따라 범위가 갈린다. `core.permissions.read` 권한 보유자는 전체 활성 역할을 받고(사용자에게 역할을 부여하는 관리 용도), 미보유자는 자신에게 부여된 활성 역할만 받는다(자기 정보 폼 표시 용도). 응답의 `abilities.can_assign_roles` 는 `core.users.update`(사용자 관리) 권한 보유 여부를 나타낸다 — 역할 부여는 사용자 관리의 일부이지 역할 정의 수정(`core.permissions.update`)이 아니다. 부여 가능한 개별 역할의 범위는 서버 상한(권한 상승 가드)이 역할별로 강제한다.
### DELETE /api/admin/roles/{role}
<!-- @generated:start:api.admin.roles.destroy -->
- **라우트명**: `api.admin.roles.destroy`
- **컨트롤러**: `App\Http\Controllers\Api\Admin\RoleController@destroy`
- **인증/권한**: `auth:sanctum` + `permission:core.permissions.delete`
**요청 파라미터**
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
| --- | --- | --- | --- | --- | --- |
| role | path | string | 예 | — | 대상 role의 식별자 |
**요청 예시**
```http
DELETE /api/admin/roles/{role} HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
```
**응답 필드** (`data` 내부)
_이 엔드포인트는 `data` 를 반환하지 않습니다 (성공 메시지만 — 컨트롤러가 `role.delete_success` 키로 `success()` 만 호출)._
**응답 예시**
```http
HTTP/1.1 200
```
```json
{
"success": true,
"message": "역할이 성공적으로 삭제되었습니다.",
"data": null
}
```
**에러 응답**
| 상태코드 | 의미 | 발생 조건 |
| --- | --- | --- |
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(`core.permissions.delete`)이 없는 경우 |
| 404 | Not Found | path 파라미터에 해당하는 리소스가 없는 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (`error.errors` 에 필드별 메시지) |
<!-- @generated:end -->
**설명**
역할을 삭제한다. 코어 소유 역할(admin/user 등)은 403(`role.system_role_delete_error`)으로, 모듈·플러그인이 소유한 확장 역할은 403(`role.extension_owned_role_delete_error`)으로 거부된다. 삭제 가능한(사용자 정의) 역할만 제거되며, CASCADE 에 의존하지 않고 권한·메뉴·사용자 매핑을 명시적으로 해제한 뒤 역할을 삭제한다. `core.permissions.delete` 권한이 필요하다.
### GET /api/admin/roles/{role}
<!-- @generated:start:api.admin.roles.show -->
- **라우트명**: `api.admin.roles.show`
- **컨트롤러**: `App\Http\Controllers\Api\Admin\RoleController@show`
- **인증/권한**: `auth:sanctum` + `permission:core.permissions.read`
**요청 파라미터**
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
| --- | --- | --- | --- | --- | --- |
| role | path | string | 예 | — | 대상 role의 식별자 |
**요청 예시**
```http
GET /api/admin/roles/{role} HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
```
**응답 필드** (`data` 내부)
_단건 응답: `data` 객체의 필드._
| 필드 | 타입 | 실측 예시값 | 용도/설명 |
| --- | --- | --- | --- |
| id | integer | `1` | 기본 키 (내부 식별자) |
| identifier | string | `admin` | 역할명 (예: admin, user, manager) |
| name | string | `관리자` | 역할 이름 (다국어 JSON) |
| name_raw | object | `{"ko":"관리자","en":"Administrator","ja":"管理者"}` | `name` 의 원본 값 (현재 로케일 미해석 원본 JSON/문자열) |
| description | string | `시스템의 모든 기능에 접근할 수 있는 최고 관리자입니다.` | 역할 설명 (다국어 JSON) |
| description_raw | object | `{"ko":"시스템의 모든 기능에 접근할 수 있는 최고 관리자입니다.","en":"Super admin…` | `description` 의 원본 값 (현재 로케일 미해석 원본 JSON/문자열) |
| extension_type | string | `core` | 확장 소유 타입: core(코어), module(모듈), plugin(플러그인), NULL(사용자 정의) |
| extension_identifier | string | `core` | 확장 식별자 (예: core, sirsoft-board, sirsoft-payment) |
| extension_name | null | `null` | 이 리소스를 소유한 확장의 표시 이름 (manifest name) |
| is_deletable | boolean | `false` | deletable 여부 |
| is_active | boolean | `true` | active 여부 |
| users_count | integer | `71` | users 개수 (집계) |
| permission_ids | array | `[2,3,4,5,6,1470,1471,1472,1473,1475,1476,1478,1479,1481,1…` | permission 식별자 배열 (연관 리소스 참조) |
| permission_values | array | `[{"id":2,"scope_type":null},{"id":3,"scope_type":null},{"…` | 할당된 각 권한의 id와 적용 범위만 담은 경량 목록 (원소 id/scope_type — 역할-권한 pivot 파생). scope_type: null=전체, role=역할 범위, self=본인 범위 |
| permissions | array | `[{"id":1468,"parent_id":null,"identifier":"sirsoft-board"…` | 연결된 권한 목록 (id/identifier/name — 역할 경유 권한 관계 파생) |
| created_at | string | `2026-07-30 17:36:00` | 생성 일시 |
| updated_at | string | `2026-08-01 11:46:14` | 최종 수정 일시 |
| abilities | object | `{"can_create":true,"can_update":true,"can_delete":true,"c…` | 현재 사용자가 이 리소스에 수행 가능한 작업 불리언 맵 (can_update, can_delete 등 — 권한 맵 기반) |
**응답 예시**
```http
HTTP/1.1 200
```
```json
{
"success": true,
"message": "역할 정보를 성공적으로 가져왔습니다.",
"data": {
"id": 1,
"identifier": "admin",
"name": "관리자",
"name_raw": {
"ko": "관리자",
"en": "Administrator",
"ja": "管理者"
},
"description": "시스템의 모든 기능에 접근할 수 있는 최고 관리자입니다.",
"...": "(13개 키 생략, 총 18개)"
}
}
```
**에러 응답**
| 상태코드 | 의미 | 발생 조건 |
| --- | --- | --- |
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(`core.permissions.read`)이 없는 경우 |
| 404 | Not Found | path 파라미터에 해당하는 리소스가 없는 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (`error.errors` 에 필드별 메시지) |
<!-- @generated:end -->
**설명**
단일 역할의 상세 정보를 조회한다. 역할 편집 화면과 복제(clone_from) 시 원본 값을 채우는 데 사용된다. 목록 응답과 달리 permissions 관계를 pivot(scope_type)과 함께 로드하므로 `permission_ids`·`permission_values`·`permissions`(계층 트리)와 `users_count` 가 항상 포함된다. `core.permissions.read` 권한이 필요하다.
### PUT /api/admin/roles/{role}
<!-- @generated:start:api.admin.roles.update -->
- **라우트명**: `api.admin.roles.update`
- **컨트롤러**: `App\Http\Controllers\Api\Admin\RoleController@update`
- **인증/권한**: `auth:sanctum` + `permission:core.permissions.update`
**요청 파라미터**
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
| --- | --- | --- | --- | --- | --- |
| role | path | string | 예 | — | 대상 role의 식별자 |
| name | body | string | 예 | — | 대상의 이름/명칭 |
| description | body | string | 아니오 | — | 설명 |
| is_active | body | boolean | 아니오 | — | 활성 여부 (true 활성 / false 비활성) |
| permissions | body | array | 아니오 | — | 역할에 부여할 권한 목록. 각 원소는 `{id, scope_type}` (id=권한 식별자, scope_type=적용 범위: null 전체 / role 역할 범위 / self 본인 범위). 전달된 목록 기준으로 역할의 권한 집합이 재설정됨 |
> 이 엔드포인트는 확장이 파라미터를 추가할 수 있습니다 (`core.role.update_validation_rules`).
**요청 예시**
```http
PUT /api/admin/roles/{role} HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
Content-Type: application/json
{
"name": "예시 이름",
"description": "예시 내용입니다.",
"is_active": true,
"permissions": [
"예시값"
]
}
```
**응답 필드** (`data` 내부)
_단건 응답: `data` 객체의 필드._
| 필드 | 타입 | 실측 예시값 | 용도/설명 |
| --- | --- | --- | --- |
| id | integer | `1` | 기본 키 (내부 식별자) |
| identifier | string | `admin` | 역할명 (예: admin, user, manager) |
| name | string | `실측 예시값` | 대상의 이름/명칭 (다국어 필드는 로케일별 값 객체) |
| name_raw | object | `{"ko":"실측 예시값","en":"실측 예시값"}` | `name` 의 원본 값 (현재 로케일 미해석 원본 JSON/문자열) |
| description | string | `실측 예시값` | 설명 (다국어 필드는 로케일별 값 객체) |
| description_raw | object | `{"ko":"실측 예시값","en":"실측 예시값"}` | `description` 의 원본 값 (현재 로케일 미해석 원본 JSON/문자열) |
| extension_type | string | `core` | 이 리소스를 소유한 확장의 타입 (core/module/plugin/template) |
| extension_identifier | string | `core` | 이 리소스를 소유한 확장의 식별자 |
| extension_name | null | `null` | 이 리소스를 소유한 확장의 표시 이름 (manifest name) |
| is_deletable | boolean | `false` | deletable 여부 |
| is_active | boolean | `true` | active 여부 |
| created_at | string | `2026-07-30 17:36:00` | 생성 일시 |
| updated_at | string | `2026-08-04 21:53:48` | 최종 수정 일시 |
| abilities | object | `{"can_create":false,"can_update":false,"can_delete":false…` | 현재 사용자가 이 리소스에 수행 가능한 작업 불리언 맵 (can_update, can_delete 등 — 권한 맵 기반) |
**응답 예시**
```http
HTTP/1.1 200
```
```json
{
"success": true,
"message": "역할이 성공적으로 수정되었습니다.",
"data": {
"id": 1,
"identifier": "admin",
"name": "실측 예시값",
"name_raw": {
"ko": "실측 예시값",
"en": "실측 예시값"
},
"description": "실측 예시값",
"description_raw": {
"ko": "실측 예시값",
"en": "실측 예시값"
},
"extension_type": "core",
"extension_identifier": "core",
"extension_name": null,
"is_deletable": false,
"is_active": true,
"created_at": "2026-07-30 17:36:00",
"updated_at": "2026-08-04 21:53:48",
"abilities": {
"can_create": false,
"can_update": false,
"can_delete": false,
"can_toggle_status": false
}
}
}
```
**에러 응답**
| 상태코드 | 의미 | 발생 조건 |
| --- | --- | --- |
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(`core.permissions.update`)이 없는 경우 |
| 404 | Not Found | path 파라미터에 해당하는 리소스가 없는 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (`error.errors` 에 필드별 메시지) |
<!-- @generated:end -->
**설명**
기존 역할의 `name`·`description`·`is_active`·`permissions` 를 수정한다. 생성과 달리 `identifier` 는 변경 대상이 아니며, 각 필드는 `sometimes` 규칙이라 전달된 항목만 갱신된다. `permissions` 를 보내면 `[{id, scope_type}]` 형식으로 역할의 권한 집합 전체가 동기화된다(전달된 목록 기준으로 재설정). `name`·`description` 은 문자열/다국어 객체 양쪽을 받는다. 검증 규칙은 `core.role.update_validation_rules` 필터 훅으로 확장할 수 있다. `core.permissions.update` 권한이 필요하다.
### PATCH /api/admin/roles/{role}/toggle-status
<!-- @generated:start:api.admin.roles.toggle-status -->
- **라우트명**: `api.admin.roles.toggle-status`
- **컨트롤러**: `App\Http\Controllers\Api\Admin\RoleController@toggleStatus`
- **인증/권한**: `auth:sanctum` + `permission:core.permissions.update`
**요청 파라미터**
| 이름 | 위치 | 타입 | 필수 | 허용값 | 용도 |
| --- | --- | --- | --- | --- | --- |
| role | path | string | 예 | — | 대상 role의 식별자 |
**요청 예시**
```http
PATCH /api/admin/roles/{role}/toggle-status HTTP/1.1
Host: api.example.com
Accept: application/json
Authorization: Bearer {YOUR_TOKEN}
```
**응답 필드** (`data` 내부)
_단건 응답: `data` 객체의 필드._
| 필드 | 타입 | 실측 예시값 | 용도/설명 |
| --- | --- | --- | --- |
| id | integer | `1` | 기본 키 (내부 식별자) |
| identifier | string | `admin` | 역할명 (예: admin, user, manager) |
| name | string | `관리자` | 대상의 이름/명칭 (다국어 필드는 로케일별 값 객체) |
| name_raw | object | `{"ko":"관리자","en":"Administrator","ja":"管理者"}` | `name` 의 원본 값 (현재 로케일 미해석 원본 JSON/문자열) |
| description | string | `시스템의 모든 기능에 접근할 수 있는 최고 관리자입니다.` | 설명 (다국어 필드는 로케일별 값 객체) |
| description_raw | object | `{"ko":"시스템의 모든 기능에 접근할 수 있는 최고 관리자입니다.","en":"Super admin…` | `description` 의 원본 값 (현재 로케일 미해석 원본 JSON/문자열) |
| extension_type | string | `core` | 이 리소스를 소유한 확장의 타입 (core/module/plugin/template) |
| extension_identifier | string | `core` | 이 리소스를 소유한 확장의 식별자 |
| extension_name | null | `null` | 이 리소스를 소유한 확장의 표시 이름 (manifest name) |
| is_deletable | boolean | `false` | deletable 여부 |
| is_active | boolean | `false` | active 여부 |
| users_count | integer | `71` | users 개수 (집계) |
| created_at | string | `2026-07-30 17:36:00` | 생성 일시 |
| updated_at | string | `2026-08-04 21:53:48` | 최종 수정 일시 |
| abilities | object | `{"can_create":true,"can_update":true,"can_delete":true,"c…` | 현재 사용자가 이 리소스에 수행 가능한 작업 불리언 맵 (can_update, can_delete 등 — 권한 맵 기반) |
**응답 예시**
```http
HTTP/1.1 200
```
```json
{
"success": true,
"message": "역할이 성공적으로 수정되었습니다.",
"data": {
"id": 1,
"identifier": "admin",
"name": "관리자",
"name_raw": {
"ko": "관리자",
"en": "Administrator",
"ja": "管理者"
},
"description": "시스템의 모든 기능에 접근할 수 있는 최고 관리자입니다.",
"description_raw": {
"ko": "시스템의 모든 기능에 접근할 수 있는 최고 관리자입니다.",
"en": "Super administrator with access to all system features.",
"ja": "システムのすべての機能にアクセスできる最高管理者です。"
},
"extension_type": "core",
"extension_identifier": "core",
"extension_name": null,
"is_deletable": false,
"is_active": false,
"users_count": 71,
"created_at": "2026-07-30 17:36:00",
"updated_at": "2026-08-04 21:53:48",
"abilities": {
"can_create": true,
"can_update": true,
"can_delete": true,
"can_toggle_status": true
}
}
}
```
**에러 응답**
| 상태코드 | 의미 | 발생 조건 |
| --- | --- | --- |
| 401 | Unauthenticated | 유효한 Bearer 토큰이 없거나 만료된 경우 |
| 403 | Forbidden | 요구 권한(`core.permissions.update`)이 없는 경우 |
| 404 | Not Found | path 파라미터에 해당하는 리소스가 없는 경우 |
| 422 | Unprocessable Entity | 요청 파라미터가 검증 규칙을 위반한 경우 (`error.errors` 에 필드별 메시지) |
<!-- @generated:end -->
**설명**
역할의 `is_active` 상태를 반대로 토글한다(활성↔비활성). 목록 화면의 상태 스위치에서 호출되며, 별도 본문 없이 대상 역할만 지정하면 된다. 성공 시 사용자 수를 다시 집계한 갱신된 역할 리소스를 반환한다. `core.permissions.update` 권한이 필요하다.
Reference in New Issue View Git Blame Copy Permalink