Alleva Users API
The Users API from Alleva — 20 operation(s) for users.
Documentation
Documentation
https://api.helloalleva.com/swagger/index.html
APIReference
https://api.helloalleva.com/swagger/index.html
OpenAPI Specification
openapi: 3.2.0
info:
title: Alleva Rest Users API
version: '1.0'
security:
- Bearer: []
tags:
- name: Users
paths:
/users/me:
get:
tags:
- Users
parameters:
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/User'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/User'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/User'
/v{version}/users/me:
get:
tags:
- Users
parameters:
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/User'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/User'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/User'
/users/licenses:
get:
tags:
- Users
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: licenseId
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
post:
tags:
- Users
parameters:
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
/v{version}/users/licenses:
get:
tags:
- Users
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: licenseId
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
post:
tags:
- Users
parameters:
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
/users/licenses/{licenseId}:
get:
tags:
- Users
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: licenseId
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
delete:
tags:
- Users
parameters:
- name: licenseId
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
patch:
tags:
- Users
parameters:
- name: licenseId
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
text/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/*+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
/v{version}/users/licenses/{licenseId}:
get:
tags:
- Users
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: licenseId
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
delete:
tags:
- Users
parameters:
- name: licenseId
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
patch:
tags:
- Users
parameters:
- name: licenseId
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
text/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/*+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
/users/{id}/licenses:
get:
tags:
- Users
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: licenseId
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
post:
tags:
- Users
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
patch:
tags:
- Users
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/JToken'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/JToken'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/JToken'
application/*+json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/JToken'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
/v{version}/users/{id}/licenses:
get:
tags:
- Users
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: licenseId
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
post:
tags:
- Users
parameters:
- name: version
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
patch:
tags:
- Users
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/JToken'
application/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/JToken'
text/json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/JToken'
application/*+json; ver=1.0:
schema:
type: array
items:
$ref: '#/components/schemas/JToken'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
/users/{id}/licenses/{licenseId}:
delete:
tags:
- Users
parameters:
- name: licenseId
in: path
required: true
schema:
type: integer
format: int64
- name: id
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
patch:
tags:
- Users
parameters:
- name: licenseId
in: path
required: true
schema:
type: integer
format: int64
- name: id
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
text/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/*+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
/v{version}/users/{id}/licenses/{licenseId}:
delete:
tags:
- Users
parameters:
- name: licenseId
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
patch:
tags:
- Users
parameters:
- name: licenseId
in: path
required: true
schema:
type: integer
format: int64
- name: version
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
text/json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
application/*+json; ver=1.0:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/JToken'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLicense'
/users/{id}/image:
post:
tags:
- Users
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLogoData'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLogoData'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLogoData'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLogoData'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
/v{version}/users/{id}/image:
post:
tags:
- Users
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLogoData'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLogoData'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLogoData'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLogoData'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
/users/{id}/provider-image:
post:
tags:
- Users
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ExternalProviderLogoData'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ExternalProviderLogoData'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ExternalProviderLogoData'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ExternalProviderLogoData'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
/v{version}/users/{id}/provider-image:
post:
tags:
- Users
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/ExternalProviderLogoData'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/ExternalProviderLogoData'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/ExternalProviderLogoData'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/ExternalProviderLogoData'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
/users/{id}/admin-image:
post:
tags:
- Users
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLogoData'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLogoData'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLogoData'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLogoData'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
/v{version}/users/{id}/admin-image:
post:
tags:
- Users
parameters:
- name: id
in: path
required: true
schema:
type: integer
format: int32
- name: version
in: path
required: true
schema:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
requestBody:
content:
application/json-patch+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLogoData'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLogoData'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLogoData'
application/*+json; ver=1.0:
schema:
$ref: '#/components/schemas/UserLogoData'
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
application/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
text/json; ver=1.0:
schema:
$ref: '#/components/schemas/UpdateResult'
/users:
get:
tags:
- Users
parameters:
- name: Limit
in: query
schema:
type: integer
format: int64
- name: Cursor
in: query
schema:
type: integer
format: int32
- name: StartDate
in: query
schema:
type: string
format: date-time
- name: EndDate
in: query
schema:
type: string
format: date-time
- name: fields
in: query
schema:
type: array
items:
type: string
- name: api-version
in: query
schema:
type: string
- name: X-Version
in: header
schema:
type: string
responses:
'200':
description: Success
content:
text/plain; ver=1.0:
# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/alleva/refs/heads/main/openapi/alleva-users-api-openapi.yml