Admin Security API

Use the Admin Security API to manage users, groups, passwords, group membership, and permission assignments.

Operations

Method	Path	Summary
GET	/admin/groups	listGroups
POST	/admin/groups	createGroup
DELETE	/admin/groups/{id}	deleteGroup
PUT	/admin/groups/{id}	updateGroup
GET	/admin/groups/{id}/users	getGroupUsers
PUT	/admin/groups/{id}/users	updateGroupUsers
GET	/admin/users	listUsers
POST	/admin/users	createUser
DELETE	/admin/users/{id}	deleteUser
PUT	/admin/users/{id}	updateUser
PUT	/admin/users/{id}/password	resetPassword

GET /admin/groups

Property	Value
Operation ID	listGroups
Auth	Bearer token required unless security is disabled.
Response DTO	GroupResponse[]

Example request

curl -X GET "http://localhost:8080/admin/groups" \
  -H "Authorization: Bearer $TOKEN"

Responses

Status	Description	Schema
200	OK	GroupResponse[]

Example response

Status: 200 OK

[
  {
    "id": 3,
    "code": "PROCESS_OPERATORS",
    "name": "Process Operators",
    "permissions": [
      "ACCESS_BPM_ADMIN",
      "ACCESS_PROCESS_PORTAL"
    ]
  }
]

POST /admin/groups

Property	Value
Operation ID	createGroup
Auth	Bearer token required unless security is disabled.
Request DTO	CreateGroupRequest
Request content type	application/json
Response DTO	GroupResponse

Request body

Required	Content type	DTO/schema
Yes	application/json	CreateGroupRequest

Example request body:

{
  "code": "PROCESS_OPERATORS",
  "name": "Process Operators",
  "permissionCodes": [
    "ACCESS_BPM_ADMIN",
    "ACCESS_PROCESS_PORTAL"
  ]
}

Example request

curl -X POST "http://localhost:8080/admin/groups" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "PROCESS_OPERATORS",
  "name": "Process Operators",
  "permissionCodes": [
    "ACCESS_BPM_ADMIN",
    "ACCESS_PROCESS_PORTAL"
  ]
}'

Responses

Status	Description	Schema
200	OK	GroupResponse

Example response

Status: 200 OK

{
  "id": 3,
  "code": "PROCESS_OPERATORS",
  "name": "Process Operators",
  "permissions": [
    "ACCESS_BPM_ADMIN",
    "ACCESS_PROCESS_PORTAL"
  ]
}

PUT /admin/groups/{id}

Property	Value
Operation ID	updateGroup
Auth	Bearer token required unless security is disabled.
Request DTO	UpdateGroupRequest
Request content type	application/json
Response DTO	GroupResponse

Parameters

Name	In	Required	Type	Description
id	path	Yes	integer(int64)

Request body

Required	Content type	DTO/schema
Yes	application/json	UpdateGroupRequest

Example request body:

{
  "name": "Process Operators",
  "permissionCodes": [
    "ACCESS_BPM_ADMIN",
    "ACCESS_PROCESS_PORTAL"
  ]
}

Example request

curl -X PUT "http://localhost:8080/admin/groups/123" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Process Operators",
  "permissionCodes": [
    "ACCESS_BPM_ADMIN",
    "ACCESS_PROCESS_PORTAL"
  ]
}'

Responses

Status	Description	Schema
200	OK	GroupResponse

Example response

Status: 200 OK

{
  "id": 3,
  "code": "PROCESS_OPERATORS",
  "name": "Process Operators",
  "permissions": [
    "ACCESS_BPM_ADMIN",
    "ACCESS_PROCESS_PORTAL"
  ]
}

DELETE /admin/groups/{id}

Property	Value
Operation ID	deleteGroup
Auth	Bearer token required unless security is disabled.
Response DTO	No body

Parameters

Name	In	Required	Type	Description
id	path	Yes	integer(int64)

Example request

curl -X DELETE "http://localhost:8080/admin/groups/123" \
  -H "Authorization: Bearer $TOKEN"

Responses

Status	Description	Schema
200	OK	-

Example response

Status: 204 No Content

No response body.

GET /admin/groups/{id}/users

Property	Value
Operation ID	getGroupUsers
Auth	Bearer token required unless security is disabled.
Response DTO	UserResponse[]

Parameters

Name	In	Required	Type	Description
id	path	Yes	integer(int64)

Example request

curl -X GET "http://localhost:8080/admin/groups/123/users" \
  -H "Authorization: Bearer $TOKEN"

Responses

Status	Description	Schema
200	OK	UserResponse[]

Example response

Status: 200 OK

[
  {
    "id": 7,
    "username": "modeler.user",
    "enabled": true,
    "groups": [
      "MODELERS"
    ],
    "permissions": [
      "ACCESS_BPM_MODELER"
    ]
  }
]

PUT /admin/groups/{id}/users

Property	Value
Operation ID	updateGroupUsers
Auth	Bearer token required unless security is disabled.
Request DTO	UpdateGroupUsersRequest
Request content type	application/json
Response DTO	UserResponse[]

Parameters

Name	In	Required	Type	Description
id	path	Yes	integer(int64)

Request body

Required	Content type	DTO/schema
Yes	application/json	UpdateGroupUsersRequest

Example request body:

{
  "userIds": [
    7,
    8
  ]
}

Example request

curl -X PUT "http://localhost:8080/admin/groups/123/users" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "userIds": [
    7,
    8
  ]
}'

Responses

Status	Description	Schema
200	OK	UserResponse[]

Example response

Status: 200 OK

[
  {
    "id": 7,
    "username": "modeler.user",
    "enabled": true,
    "groups": [
      "MODELERS"
    ],
    "permissions": [
      "ACCESS_BPM_MODELER"
    ]
  }
]

GET /admin/users

Property	Value
Operation ID	listUsers
Auth	Bearer token required unless security is disabled.
Response DTO	UserResponse[]

Example request

curl -X GET "http://localhost:8080/admin/users" \
  -H "Authorization: Bearer $TOKEN"

Responses

Status	Description	Schema
200	OK	UserResponse[]

Example response

Status: 200 OK

[
  {
    "id": 7,
    "username": "modeler.user",
    "enabled": true,
    "groups": [
      "MODELERS"
    ],
    "permissions": [
      "ACCESS_BPM_MODELER"
    ]
  }
]

POST /admin/users

Property	Value
Operation ID	createUser
Auth	Bearer token required unless security is disabled.
Request DTO	CreateUserRequest
Request content type	application/json
Response DTO	UserResponse

Request body

Required	Content type	DTO/schema
Yes	application/json	CreateUserRequest

Example request body:

{
  "username": "modeler.user",
  "password": "change-me-now",
  "enabled": true,
  "groupIds": [
    2
  ],
  "permissionCodes": [
    "ACCESS_BPM_MODELER"
  ]
}

Example request

curl -X POST "http://localhost:8080/admin/users" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "username": "modeler.user",
  "password": "change-me-now",
  "enabled": true,
  "groupIds": [
    2
  ],
  "permissionCodes": [
    "ACCESS_BPM_MODELER"
  ]
}'

Responses

Status	Description	Schema
200	OK	UserResponse

Example response

Status: 200 OK

{
  "id": 7,
  "username": "modeler.user",
  "enabled": true,
  "groups": [
    "MODELERS"
  ],
  "permissions": [
    "ACCESS_BPM_MODELER"
  ]
}

PUT /admin/users/{id}

Property	Value
Operation ID	updateUser
Auth	Bearer token required unless security is disabled.
Request DTO	UpdateUserRequest
Request content type	application/json
Response DTO	UserResponse

Parameters

Name	In	Required	Type	Description
id	path	Yes	integer(int64)

Request body

Required	Content type	DTO/schema
Yes	application/json	UpdateUserRequest

Example request body:

{
  "enabled": true,
  "groupIds": [
    2,
    3
  ],
  "permissionCodes": [
    "ACCESS_BPM_MODELER",
    "ACCESS_PROCESS_PORTAL"
  ]
}

Example request

curl -X PUT "http://localhost:8080/admin/users/123" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "groupIds": [
    2,
    3
  ],
  "permissionCodes": [
    "ACCESS_BPM_MODELER",
    "ACCESS_PROCESS_PORTAL"
  ]
}'

Responses

Status	Description	Schema
200	OK	UserResponse

Example response

Status: 200 OK

{
  "id": 7,
  "username": "modeler.user",
  "enabled": true,
  "groups": [
    "MODELERS"
  ],
  "permissions": [
    "ACCESS_BPM_MODELER"
  ]
}

DELETE /admin/users/{id}

Property	Value
Operation ID	deleteUser
Auth	Bearer token required unless security is disabled.
Response DTO	No body

Parameters

Name	In	Required	Type	Description
id	path	Yes	integer(int64)

Example request

curl -X DELETE "http://localhost:8080/admin/users/123" \
  -H "Authorization: Bearer $TOKEN"

Responses

Status	Description	Schema
200	OK	-

Example response

Status: 204 No Content

No response body.

PUT /admin/users/{id}/password

Property	Value
Operation ID	resetPassword
Auth	Bearer token required unless security is disabled.
Request DTO	ResetPasswordRequest
Request content type	application/json
Response DTO	No body

Parameters

Name	In	Required	Type	Description
id	path	Yes	integer(int64)

Request body

Required	Content type	DTO/schema
Yes	application/json	ResetPasswordRequest

Example request body:

{
  "password": "new-temporary-password"
}

Example request

curl -X PUT "http://localhost:8080/admin/users/123/password" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "password": "new-temporary-password"
}'

Responses

Status	Description	Schema
200	OK	-

Example response

Status: 204 No Content

No response body.