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

Manage Endpoints

Activiti Admin Endpoints 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 Endpoints. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

10 operations 4 paths 4 schemas 2 DELETE4 GET2 POST2 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 Endpoints 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 10

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

Admin Endpoints 10

Manage Endpoints

GET
/api/enterprise/admin/basic-auths
getBasicAuthConfigurations
getBasicAuthConfigurationsUsingGET_1 1 param → 200401403404
POST
/api/enterprise/admin/basic-auths
createBasicAuthConfiguration
createBasicAuthConfigurationUsingPOST_1 body → 200201401403404
GET
/api/enterprise/admin/basic-auths/{basicAuthId}
getBasicAuthConfiguration
getBasicAuthConfigurationUsingGET_1 2 params → 200401403404
PUT
/api/enterprise/admin/basic-auths/{basicAuthId}
updateBasicAuthConfiguration
updateBasicAuthConfigurationUsingPUT_1 1 param body → 200201401403404
DELETE
/api/enterprise/admin/basic-auths/{basicAuthId}
removeBasicAuthonfiguration
removeBasicAuthonfigurationUsingDELETE_1 2 params → 200204401403
GET
/api/enterprise/admin/endpoints
getEndpointConfigurations
getEndpointConfigurationsUsingGET_1 1 param → 200401403404
POST
/api/enterprise/admin/endpoints
createEndpointConfiguration
createEndpointConfigurationUsingPOST_1 body → 200201401403404
GET
/api/enterprise/admin/endpoints/{endpointConfigurationId}
getEndpointConfiguration
getEndpointConfigurationUsingGET_1 2 params → 200401403404
PUT
/api/enterprise/admin/endpoints/{endpointConfigurationId}
updateEndpointConfiguration
updateEndpointConfigurationUsingPUT_1 1 param body → 200201401403404
DELETE
/api/enterprise/admin/endpoints/{endpointConfigurationId}
removeEndpointConfiguration
removeEndpointConfigurationUsingDELETE_1 2 params → 200204401403

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are EndpointConfigurationRepresentation (10 properties), EndpointBasicAuthRepresentation (6 properties), CreateEndpointBasicAuthRepresentation (4 properties), EndpointRequestHeaderRepresentation (2 properties). Each schema is shown below with its type and property counts.

EndpointConfigurationRepresentation
object
10 properties
CreateEndpointBasicAuthRepresentation
object
4 properties
EndpointBasicAuthRepresentation
object
6 properties
EndpointRequestHeaderRepresentation
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Activiti publishes across the network.

Activiti Cloud Runtime Bundle API
Activiti About 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
Activiti Content Rendition API