Role API

Overview

Role API is an API for managing Fess roles. You can create, update, and delete roles.

Base URL

/api/admin/role

Endpoint List

Method Path Description
GET/PUT /settings List roles
GET /setting/{id} Get role
POST /setting Create role
PUT /setting Update role
DELETE /setting/{id} Delete role

List Roles

Request

GET /api/admin/role/settings
PUT /api/admin/role/settings

Parameters

Response

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

Get Role

Request

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

Response

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

Create Role

Request

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

Request Body

{
  "name": "editor"
}

Field Description

Response

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

Update Role

Request

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

Request Body

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

Response

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

Delete Role

Request

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

Response

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

Usage Examples

Create New Role

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

List Roles

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

Reference