OpenAPI Specification
openapi: 3.0.3
info:
title: Activiti Public Rest About Profile API
description: " The Alfresco Activiti BPM Suite comes with a REST API. It includes both an Enterprise equivalent of the Activiti Open Source REST API exposing the generic Activiti Engine operations, and a dedicated set op REST API endpoints specific for the functionality in the Alfresco Activiti BPM Suite. \n Note that there is also an 'internal' REST API, which are the REST endpoints used by the Javascript UI. It is advised not to use this API, these REST API urls and way of using it will change and evolve with the product and are unsupported. The supported API is stable. Also, the internal REST API uses a different authentication mechanism tailored towards web browser usage.\n"
version: 1.4.0
contact:
name: Activiti Community
url: https://www.activiti.org/
email: activiti-community@alfresco.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://{host}/activiti-app
description: Activiti BPM Server
variables:
host:
default: localhost:8080
description: The Activiti server host
security:
- basicAuth: []
tags:
- name: Profile
description: Manage User Information
paths:
/api/enterprise/profile:
get:
tags:
- Profile
summary: Retrieve user information
description: ' This is useful to get the name, email, the groups that the user is part of, the user picture, etc.'
operationId: getProfileUsingGET
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserRepresentation'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
post:
tags:
- Profile
summary: Update user information
description: Only a first name, last name, email and company can be updated
operationId: updateProfile
requestBody:
description: userRepresentation
content:
application/json:
schema:
$ref: '#/components/schemas/UserRepresentation'
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/UserRepresentation'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/enterprise/profile-password:
post:
tags:
- Profile
summary: Change user password
operationId: changePasswordUsingPOST
requestBody:
description: changePasswordRepresentation
content:
application/json:
schema:
$ref: '#/components/schemas/ChangePasswordRepresentation'
required: true
responses:
'200':
description: OK
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/enterprise/profile-picture:
get:
tags:
- Profile
summary: Retrieve user profile picture
description: Generally returns an image file
operationId: getProfilePictureUsingGET
responses:
'200':
description: OK
content:
application/json:
schema:
type: file
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
post:
tags:
- Profile
summary: Change user profile picture
operationId: uploadProfilePictureUsingPOST
parameters:
- name: file
in: formData
description: file
required: true
schema:
type: file
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ImageUploadRepresentation'
'201':
description: Created
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
components:
schemas:
UserRepresentation:
properties:
apps:
type: array
items:
$ref: '#/components/schemas/LightAppRepresentation'
capabilities:
type: array
items:
type: string
company:
type: string
created:
type: string
format: date-time
email:
type: string
externalId:
type: string
firstName:
type: string
fullname:
type: string
groups:
type: array
items:
$ref: '#/components/schemas/GroupRepresentation'
id:
type: integer
format: int64
lastName:
type: string
lastUpdate:
type: string
format: date-time
latestSyncTimeStamp:
type: string
format: date-time
password:
type: string
pictureId:
type: integer
format: int64
status:
type: string
tenantId:
type: integer
format: int64
tenantName:
type: string
tenantPictureId:
type: integer
format: int64
type:
type: string
ImageUploadRepresentation:
properties:
created:
type: string
format: date-time
id:
type: integer
format: int64
name:
type: string
userId:
type: integer
format: int64
GroupRepresentation:
properties:
capabilities:
type: array
items:
$ref: '#/components/schemas/GroupCapabilityRepresentation'
externalId:
type: string
groups:
type: array
items:
$ref: '#/components/schemas/GroupRepresentation'
id:
type: integer
format: int64
lastSyncTimeStamp:
type: string
format: date-time
name:
type: string
parentGroupId:
type: integer
format: int64
status:
type: string
tenantId:
type: integer
format: int64
type:
type: integer
format: int32
userCount:
type: integer
format: int64
users:
type: array
items:
$ref: '#/components/schemas/UserRepresentation'
GroupCapabilityRepresentation:
properties:
id:
type: integer
format: int64
name:
type: string
ChangePasswordRepresentation:
properties:
newPassword:
type: string
oldPassword:
type: string
LightAppRepresentation:
properties:
description:
type: string
icon:
type: string
id:
type: integer
format: int64
name:
type: string
theme:
type: string
securitySchemes:
basicAuth:
type: http
scheme: basic
description: HTTP Basic Authentication using valid Activiti user credentials