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 User API

Retrieve Users

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

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

This API exposes 6 operations across 4 paths, and defines 8 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.

6 operations 4 paths 8 schemas 3 GET2 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 User 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 6

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

User 6

Retrieve Users

POST
/api/enterprise/idm/passwords
Request password reset
requestPasswordResetUsingPOST body → 200201401403404
GET
/api/enterprise/users
List users
getUsersUsingGET_2 8 params → 200401403404
GET
/api/enterprise/users/{userId}
Retrieve user information
getUserUsingGET_2 1 param → 200401403404
POST
/api/enterprise/users/{userId}
Execute an action for a specific user
executeActionUsingPOST 1 param body → 200201401403404
PUT
/api/enterprise/users/{userId}
Update user information
updateUserUsingPUT 1 param body → 200201401403404
GET
/api/enterprise/users/{userId}/picture
Retrieve user profile picture
getProfilePictureUsingGET_1 1 param → 200401403404

Schemas 8

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

UserRepresentation
object
20 properties
UserActionRepresentation
object
3 properties
ResultListDataRepresentation
object
4 properties
AbstractRepresentation
GroupRepresentation
object
12 properties
GroupCapabilityRepresentation
object
2 properties
ResetPasswordRepresentation
object
1 property
LightAppRepresentation
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activiti-user-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 Groups 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