Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Activiti Admin Groups API

Manage Endpoints

Activiti Admin Groups API is one of 43 APIs that Activiti publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Admin Groups. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 16 operations across 11 paths, and defines 9 schemas. It is described by OpenAPI 3.0.3, at version 1.4.0.

Requests are made against a single base URL, https://{host}/activiti-app.

16 operations 11 paths 9 schemas 4 DELETE5 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.4.0
Base URL
https://your-activiti-host/activiti-rest/service
Authentication
HTTP Basic
License
Resource Areas
1

Authentication & Security 1

Activiti Admin Groups API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Authentication using valid Activiti user credentials

Paths & Operations 16

Across 11 paths, the API surfaces 16 operations — 4 DELETE, 5 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Admin Groups 16

Manage Endpoints

GET
/api/enterprise/admin/groups
getGroups
getGroupsUsingGET_2 3 params → 200401403404
POST
/api/enterprise/admin/groups
createNewGroup
createNewGroupUsingPOST_1 body → 200201401403404
GET
/api/enterprise/admin/groups/{groupId}
getGroup
getGroupUsingGET_1 3 params → 200401403404
PUT
/api/enterprise/admin/groups/{groupId}
updateGroup
updateGroupUsingPUT_1 1 param body → 200201401403404
DELETE
/api/enterprise/admin/groups/{groupId}
deleteGroup
deleteGroupUsingDELETE_1 1 param → 200204401403
POST
/api/enterprise/admin/groups/{groupId}/action/activate
activate
activateUsingPOST_1 1 param → 200201401403404
POST
/api/enterprise/admin/groups/{groupId}/add-all-users
addAllUsersToGroup
addAllUsersToGroupUsingPOST_1 1 param → 200201401403404
POST
/api/enterprise/admin/groups/{groupId}/capabilities
addGroupCapabilities
addGroupCapabilitiesUsingPOST_1 1 param body → 200201401403404
DELETE
/api/enterprise/admin/groups/{groupId}/capabilities/{groupCapabilityId}
deleteGroupCapability
deleteGroupCapabilityUsingDELETE_1 2 params → 200204401403
POST
/api/enterprise/admin/groups/{groupId}/members/{userId}
addGroupMember
addGroupMemberUsingPOST_1 2 params → 200201401403404
DELETE
/api/enterprise/admin/groups/{groupId}/members/{userId}
deleteGroupMember
deleteGroupMemberUsingDELETE_1 2 params → 200204401403
GET
/api/enterprise/admin/groups/{groupId}/potential-capabilities
getCapabilities
getCapabilitiesUsingGET_1 1 param → 200401403404
GET
/api/enterprise/admin/groups/{groupId}/related-groups
getRelatedGroups
getRelatedGroupsUsingGET_1 1 param → 200401403404
POST
/api/enterprise/admin/groups/{groupId}/related-groups/{relatedGroupId}
addRelatedGroup
addRelatedGroupUsingPOST_1 3 params → 200201401403404
DELETE
/api/enterprise/admin/groups/{groupId}/related-groups/{relatedGroupId}
deleteRelatedGroup
deleteRelatedGroupUsingDELETE_1 2 params → 200204401403
GET
/api/enterprise/admin/groups/{groupId}/users
getGroupUsers
getGroupUsersUsingGET_1 4 params → 200401403404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are UserRepresentation (20 properties), GroupRepresentation (12 properties), LightGroupRepresentation (5 properties), LightAppRepresentation (5 properties). Each schema is shown below with its type and property counts.

UserRepresentation
object
20 properties
ResultListDataRepresentation
object
4 properties
AbstractRepresentation
AddGroupCapabilitiesRepresentation
object
1 property
LightGroupRepresentation
object
5 properties
GroupRepresentation
object
12 properties
AbstractGroupRepresentation
object
4 properties
GroupCapabilityRepresentation
object
2 properties
LightAppRepresentation
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activiti-admin-groups-api-openapi.yml Raw ↑

Other APIs Activiti publishes across the network.

Activiti Cloud Runtime Bundle API
Activiti About API
Activiti Admin Endpoints API
Activiti Admin Tenants API
Activiti Admin Users API
Activiti Alfresco API
Activiti Apps API
Activiti Apps Definition API
Activiti Apps Runtime API
Activiti Comments API
Activiti Content API
Activiti Content Rendition API