Group API

Overview

Group API is an API for managing Fess groups. You can create, update, and delete groups.

Base URL

/api/admin/group

Endpoint List

Method Path description
GET /settings List groups
GET /setting/{id} Get group
POST /setting Create group
PUT /setting Update group
dELETE /setting/{id} delete group

List Groups

Request

GET /api/admin/group/settings

Parameters

Parameter Type Required description
size Integer No Number of items per page (default: 25)
page Integer No Page number (starts from 1, default: 1)
id String No Filters by exact match on the specified group Id

Response

{
  "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 Group

Request

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

Response

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

Create Group

Request

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

Request Body

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

Field description

Field Required description
name Yes Group name (max 100 characters)
attributes No Map of attributes (includes LdAP attributes such as gidNumber). Values are specified as strings

Response

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

Update Group

Request

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

Request Body

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

Field description

Field Required description
id Yes Group Id to update
name Yes Group name (max 100 characters)
attributes No Map of attributes (includes LdAP attributes such as gidNumber). Values are specified as strings
versionNo Yes Version number for optimistic locking. Specify the versionNo value obtained from Get Group

Response

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

delete Group

Request

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

Response

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

Usage Examples

Create New Group

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"
       }
     }'

List Groups

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

Reference