Group API

개요

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

기본 URL

/api/admin/group

엔드포인트 목록

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

그룹 목록 조회

요청

GET /api/admin/group/settings

파라미터

파라미터 타입 필수 설명
size Integer 아니오 페이지당 건수 (기본값: 25)
page Integer 아니오 페이지 번호 (1부터 시작, 기본값: 1)
id String 아니오 지정한 그룹 ID로 완전 일치 필터링합니다

응답

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "group_id_1",
        "name": "Engineering",
        "attributes": {
          "gidNumber": "1000"
        },
        "versionNo": 1
      },
      {
        "id": "group_id_2",
        "name": "Sales",
        "attributes": {
          "gidNumber": "1001"
        },
        "versionNo": 1
      }
    ],
    "total": 5
  }
}

그룹 조회

요청

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

응답

{
  "response": {
    "status": 0,
    "setting": {
      "id": "group_id_1",
      "name": "Engineering",
      "attributes": {
        "gidNumber": "1000"
      },
      "versionNo": 1
    }
  }
}

그룹 만들기

요청

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

요청 본문

{
  "name": "Marketing",
  "attributes": {
    "gidNumber": "1002"
  }
}

필드 설명

필드 필수 설명
name 예 그룹 이름 (최대 100자)
attributes 아니오 속성의 맵 (gidNumber 등의 LDAP 속성을 포함). 값은 문자열로 지정합니다

응답

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

그룹 업데이트

요청

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

요청 본문

{
  "id": "existing_group_id",
  "name": "Marketing Team",
  "attributes": {
    "gidNumber": "1002"
  },
  "versionNo": 1
}

필드 설명

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

응답

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

그룹 삭제

요청

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

응답

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

사용 예

새 그룹 만들기

curl -X POST "http://localhost:8080/api/admin/group/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "Product Team",
       "attributes": {
         "gidNumber": "2000"
       }
     }'

그룹 목록 조회

curl -X GET "http://localhost:8080/api/admin/group/settings" \
     -H "Authorization: Bearer YOUR_TOKEN"

참고 정보