Role API

개요

Role API는 Fess 의 역할을 관리하기 위한 API입니다. 역할의 생성, 업데이트, 삭제 등을 조작할 수 있습니다.

기본 URL

/api/admin/role

엔드포인트 목록

메서드 경로 설명
GET /settings 역할 목록 조회
GET /setting/{id} 역할 조회
POST /setting 역할 만들기
PUT /setting 역할 업데이트
DELETE /setting/{id} 역할 삭제

역할 목록 조회

요청

GET /api/admin/role/settings

파라미터

파라미터 타입 필수 설명
size Integer 아니오 페이지당 건수 (기본값: 25。fess_config.properties 의 paging.page.size 로 변경 가능)
page Integer 아니오 페이지 번호 (1부터 시작, 기본값: 1。0 이하를 지정한 경우 1로 처리됩니다)
id String 아니오 지정한 역할 ID로 완전 일치 필터링합니다

응답

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "role_id_1",
        "name": "admin",
        "versionNo": 1
      },
      {
        "id": "role_id_2",
        "name": "user",
        "versionNo": 1
      }
    ],
    "total": 5
  }
}

역할 조회

요청

GET /api/admin/role/setting/{id}

응답

{
  "response": {
    "status": 0,
    "setting": {
      "id": "role_id_1",
      "name": "admin",
      "versionNo": 1
    }
  }
}

역할 만들기

요청

POST /api/admin/role/setting
Content-Type: application/json

요청 본문

{
  "name": "editor"
}

필드 설명

필드 필수 설명
name 예 역할 이름 (최대 100자)
attributes 아니오 속성의 맵. 값은 문자열로 지정합니다

응답

{
  "response": {
    "status": 0,
    "id": "new_role_id",
    "created": true
  }
}

역할 업데이트

요청

PUT /api/admin/role/setting
Content-Type: application/json

요청 본문

{
  "id": "existing_role_id",
  "name": "editor_updated",
  "versionNo": 1
}

필드 설명

필드 필수 설명
id 예 업데이트 대상 역할 ID
name 예 역할 이름 (최대 100자)
attributes 아니오 속성의 맵. 값은 문자열로 지정합니다
versionNo 예 낙관적 잠금을 위한 버전 번호. 역할 조회에서 얻은 versionNo 값을 지정합니다

응답

{
  "response": {
    "status": 0,
    "id": "existing_role_id",
    "created": false
  }
}

역할 삭제

요청

DELETE /api/admin/role/setting/{id}

응답

{
  "response": {
    "status": 0,
    "id": "deleted_role_id",
    "created": false
  }
}

사용 예

새 역할 만들기

curl -X POST "http://localhost:8080/api/admin/role/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "content_manager"
     }'

역할 목록 조회

curl -X GET "http://localhost:8080/api/admin/role/settings?size=50&page=1" \
     -H "Authorization: Bearer YOUR_TOKEN"

참고 정보