Skip to main content
Version: 1.15

MICROSERVICE ADMIN INSTANCE (1.15.2)

Download OpenAPI specification:Download

License: GPL-3.0

System management and configuration

Email request controller

Create an email request in database, then send a email by a asynchronous process.

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
bcc
Array of strings
cc
Array of strings
from
string
replyTo
string
sentDate
string <date-time>
subject
string
text
string
to
Array of strings

Responses

Request samples

Content type
application/json
{
}

accounts-controller

retrieveAccountList

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)
required
object (AccountSearchParameters)

Responses

createAccount

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
object (Account)
password
string
project
string

Responses

Request samples

Content type
application/json
{
}

retrieveAccounByEmail

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

Responses

getOrigins

Authorizations:
REGARDS_OAUTH2

Responses

getPasswordRules

Authorizations:
REGARDS_OAUTH2

Responses

checkPassword

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
password
string

Responses

Request samples

Content type
application/json
{
}

acceptAccount

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

Responses

activeAccount

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

Responses

performChangePassword

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string
Request Body schema: application/json
required
newPassword
string
oldPassword
string

Responses

Request samples

Content type
application/json
{
}

inactiveAccount

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

Responses

updateOrigin

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string
origin
required
string

Responses

refuseAccount

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

Responses

requestResetPassword

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string
Request Body schema: application/json
required
originUrl
string
requestLink
string

Responses

Request samples

Content type
application/json
{
}

performResetPassword

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string
Request Body schema: application/json
required
newPassword
string
token
string

Responses

Request samples

Content type
application/json
{
}

requestUnlockAccount

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string
Request Body schema: application/json
required
originUrl
required
string
requestLink
required
string

Responses

Request samples

Content type
application/json
{
}

performUnlockAccount

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string
Request Body schema: application/json
required
token
string

Responses

Request samples

Content type
application/json
{
}

validatePassword

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string
query Parameters
password
required
string

Responses

removeAccount

Authorizations:
REGARDS_OAUTH2
path Parameters
account_id
required
integer <int64>

Responses

retrieveAccount

Authorizations:
REGARDS_OAUTH2
path Parameters
account_id
required
integer <int64>

Responses

updateAccount

Authorizations:
REGARDS_OAUTH2
path Parameters
account_id
required
integer <int64>
Request Body schema: application/json
required
authenticationFailedCounter
integer <int64>
email
string
external
boolean
firstName
required
string
id
integer <int64>
identifiable
boolean
invalidityDate
string <date-time>
lastName
required
string
origin
string
password
string
passwordUpdateDate
string <date-time>
Array of objects (Project) unique
status
required
string
Enum: "INACTIVE" "INACTIVE_PASSWORD" "ACTIVE" "LOCKED" "PENDING"

Responses

Request samples

Content type
application/json
{
}

tenant-connection-controller

getTenantConnections

Authorizations:
REGARDS_OAUTH2
path Parameters
microservice
required
string

Responses

addTenantConnection

Authorizations:
REGARDS_OAUTH2
path Parameters
microservice
required
string
Request Body schema: application/json
required
driverClassName
string
errorCause
string
password
string
state
string
Enum: "ENABLED" "DISABLED" "CONNECTING" "ERROR"
tenant
required
string
url
string
userName
string

Responses

Request samples

Content type
application/json
{
}

updateState

Authorizations:
REGARDS_OAUTH2
path Parameters
microservice
required
string
Request Body schema: application/json
required
driverClassName
string
errorCause
string
password
string
state
string
Enum: "ENABLED" "DISABLED" "CONNECTING" "ERROR"
tenant
required
string
url
string
userName
string

Responses

Request samples

Content type
application/json
{
}

maintenance-controller

retrieveTenantsInMaintenance

Authorizations:
REGARDS_OAUTH2

Responses

unSetMaintenance

Authorizations:
REGARDS_OAUTH2
path Parameters
tenant
required
string

Responses

setMaintenance

Authorizations:
REGARDS_OAUTH2
path Parameters
tenant
required
string

Responses

module-manager-controller

exportConfiguration

Authorizations:
REGARDS_OAUTH2

Responses

importConfiguration

Authorizations:
REGARDS_OAUTH2
Request Body schema: multipart/form-data
file
required
string <binary>

Responses

isConfigurationEnabled

Authorizations:
REGARDS_OAUTH2

Responses

isReady

Authorizations:
REGARDS_OAUTH2

Responses

isReadyEnabled

Authorizations:
REGARDS_OAUTH2

Responses

restart

Authorizations:
REGARDS_OAUTH2

Responses

isRestartEnabled

Authorizations:
REGARDS_OAUTH2

Responses

notification-controller

retrieveNotifications

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)

Sorting and page configuration

Request Body schema: application/json
required

Set of search criterias.

object (DatesRangeRestriction)

Filter on notification date

object (ValuesRestrictionLong)

Filter on notification id

object (ValuesRestrictionNotificationLevel)

Filter on notification level

object (ValuesRestrictionString)

Filter on notification sender

object (ValuesRestrictionNotificationStatus)

Filter on notification status

Responses

Request samples

Content type
application/json
{
}

createNotification

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
level
string
Enum: "INFO" "WARNING" "ERROR" "FATAL"
message
string
mimeType
string
projectUserRecipients
Array of strings unique
roleRecipients
Array of strings unique
sender
string
title
string

Responses

Request samples

Content type
application/json
{
}

Delete a selection of notifications.

Find and delete notifications from criterias defined in request body.

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required

Set of search criterias.

object (DatesRangeRestriction)

Filter on notification date

object (ValuesRestrictionLong)

Filter on notification id

object (ValuesRestrictionNotificationLevel)

Filter on notification level

object (ValuesRestrictionString)

Filter on notification sender

object (ValuesRestrictionNotificationStatus)

Filter on notification status

Responses

Request samples

Content type
application/json
{
}

deleteNotification

Authorizations:
REGARDS_OAUTH2
path Parameters
notification_id
required
integer <int64>

Responses

retrieveNotification

Authorizations:
REGARDS_OAUTH2
path Parameters
notification_id
required
integer <int64>

Responses

setNotificationRead

Authorizations:
REGARDS_OAUTH2
path Parameters
notification_id
required
integer <int64>

Responses

project-controller

retrieveProjectList

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)

Responses

Response samples

Content type
application/json
{
}

createProject

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
crs
required
string
description
required
string
host
string
icon
string
id
integer <int64>
identifiable
boolean
isAccessible
boolean
isDeleted
boolean
isPoleToBeManaged
boolean
isPublic
boolean
label
required
string
licenceLink
string
licenseLink
string
name
required
string[a-zA-Z0-9-_]*

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

retrievePublicProjectList

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)

Responses

Response samples

Content type
application/json
{
}

deleteProject

Authorizations:
REGARDS_OAUTH2
path Parameters
project_name
required
string

Responses

retrieveProject

Authorizations:
REGARDS_OAUTH2
path Parameters
project_name
required
string

Responses

Response samples

Content type
application/json
{
}

updateProject

Authorizations:
REGARDS_OAUTH2
path Parameters
project_name
required
string
Request Body schema: application/json
required
crs
required
string
description
required
string
host
string
icon
string
id
integer <int64>
identifiable
boolean
isAccessible
boolean
isDeleted
boolean
isPoleToBeManaged
boolean
isPublic
boolean
label
required
string
licenceLink
string
licenseLink
string
name
required
string[a-zA-Z0-9-_]*

Responses

Request samples

Content type
application/json
{
}

resetLicense

Authorizations:
REGARDS_OAUTH2
path Parameters
project_name
required
string

Responses

project-connection-controller

getAllProjectConnections

Authorizations:
REGARDS_OAUTH2
path Parameters
projectName
required
string
query Parameters
required
object (Pageable)

Responses

createProjectConnection

Authorizations:
REGARDS_OAUTH2
path Parameters
projectName
required
string
Request Body schema: application/json
required
driverClassName
required
string
errorCause
string
id
integer <int64>
identifiable
boolean
microservice
required
string
password
required
string
required
object (Project)
state
string
Enum: "ENABLED" "DISABLED" "CONNECTING" "ERROR"
url
required
string
userName
required
string

Responses

Request samples

Content type
application/json
{
}

deleteProjectConnection

Authorizations:
REGARDS_OAUTH2
path Parameters
connectionId
required
integer <int64>
projectName
required
string

Responses

getProjectConnection

Authorizations:
REGARDS_OAUTH2
path Parameters
connectionId
required
integer <int64>
projectName
required
string

Responses

updateProjectConnection

Authorizations:
REGARDS_OAUTH2
path Parameters
connectionId
required
integer <int64>
projectName
required
string
Request Body schema: application/json
required
driverClassName
required
string
errorCause
string
id
integer <int64>
identifiable
boolean
microservice
required
string
password
required
string
required
object (Project)
state
string
Enum: "ENABLED" "DISABLED" "CONNECTING" "ERROR"
url
required
string
userName
required
string

Responses

Request samples

Content type
application/json
{
}

security-resources-controller

getAllResources

Authorizations:
REGARDS_OAUTH2

Responses

Response samples

Content type
application/json
[
]

dynamic-tenant-setting-controller

retrieveAll

Authorizations:
REGARDS_OAUTH2
query Parameters
names
Array of strings unique

Responses

reset

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string

Responses

update

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string
Request Body schema: application/json
required
defaultValue
object
description
string
name
string
value
object

Responses

Request samples

Content type
application/json
{
}

manager-controller

immediateShutdown

Authorizations:
REGARDS_OAUTH2

Responses

tenant-controller

getAllTenants

Authorizations:
REGARDS_OAUTH2

Responses

getAllActiveTenants

Authorizations:
REGARDS_OAUTH2
path Parameters
microserviceName
required
string

Responses