Skip to main content
Version: 2.1.0
API docs by Redocly

MICROSERVICE ADMIN INSTANCE (2.2.0)

Download OpenAPI specification:Download

License: GPL-3.0

System management and configuration

accounts-controller

Get Accounts

Retrieve the list of accounts on the instance

Authorizations:
REGARDS_OAUTH2
query Parameters
email
string
firstName
string
lastName
string
origin
string
page
integer >= 0
Default: 0

Zero-based page index (0..N)

project
string
size
integer >= 1
Default: 10

The size of the page to be returned

sort
Array of strings
Default: "id,ASC"

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

status
string

Responses

Create Account

Create a new account.

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

Account details to update

originUrl
string

The URL of the app from where the account creation request was issued. This field is mandatory only if the account status is left unspecified, or set to EMAIL_VERIFICATION.

password
string

The initial password of the account.

project
string

An optional project to associate the account to.

requestLink
string

The URL to redirect the user to the password verification interface. This field is mandatory only if the account status is left unspecified, or set to EMAIL_VERIFICATION.

Responses

Request samples

Content type
application/json
{
}

Get Account By Email

Retrieve details of the account with the specified email.

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

The account email

Responses

List Origins

Return all possible origins for an account

Authorizations:
REGARDS_OAUTH2

Responses

Get Password Rules

Retrieve the list of password rules applicable to all new passwords set by users.

Authorizations:
REGARDS_OAUTH2

Responses

Check Password Validity

Verify that the specified password meets the password requirements.

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

The password

Responses

Request samples

Content type
application/json
{
}

Verify Email

Confirm an account email using the specified email verification token.

Authorizations:
REGARDS_OAUTH2
path Parameters
token
required
string

The verification token that was generated for the verification email

Responses

Accept Account

Accept an access request for an account in PENDING status.

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

The account email

Responses

Activate Account

Activate an account in status INACTIVE.

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

The account email

Responses

Change Password

Changes the user password, given their current password.

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

The account email

Request Body schema: application/json
required
newPassword
string

The new password of the user.

oldPassword
string

The current password of the user.

Responses

Request samples

Content type
application/json
{
}

Deactivate Account

Deactivate an account in status ACTIVE.

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

The account email

Responses

Update Origin

Updates the origin of an account.

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

The account email

origin
required
string

The new origin. If this string is empty, the origin is not updated.

Responses

Refuse Account

Refuse an access request for an account in PENDING status.

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

The account email

Responses

Send Password Reset Email

Send to the user an email containing a link with limited validity to reset its password.

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

The account email

Request Body schema: application/json
required
originUrl
string

The URL of the app from where the request was issued.

requestLink
string

The URL to redirect the user to the reset password interface.

Responses

Request samples

Content type
application/json
{
}

Reset Password

Change an account password using a reset token that was received by email.

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

The account email

Request Body schema: application/json
required
newPassword
string

The new password of the user.

token
string

The reset token that was provided in the email received by the user.

Responses

Request samples

Content type
application/json
{
}

Send Unlock Account Email

Send to the user an email containing a link with limited validity to unlock their account.

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

The account email

Request Body schema: application/json
required
originUrl
required
string

The URL of the app from where the request was issued.

requestLink
required
string

The URL to redirect the user to the unlock account interface.

Responses

Request samples

Content type
application/json
{
}

Unlock Account

Unlock a locked account using an unlock token that was received by email.

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

The account email

Request Body schema: application/json
required
token
string

The unlock token that was provided in the email received by the user to unlock their account.

Responses

Request samples

Content type
application/json
{
}

Verify Password

Verify that the provided password is valid for the account with the specified email.

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

The account email

query Parameters
password
required
string

The candidate password

Responses

Send Verification Email.

Send a new verification email for an account. Such an email is automatically sent upon account creation, but an administrator may resend it if the validation token has expired.

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

Responses

Reverify Email

Resets the account with the specified email to the EMAIL_VERIFICATION state, with the provided token details.
This endpoint is meant for migration purpose only.

Authorizations:
REGARDS_OAUTH2
path Parameters
account_email
required
string

The account email

Request Body schema: application/json
required
expiryDate
string <date-time>

The token expiration date.

originUrl
string

The URL of the app from where the request was issued.

requestLink
string

The URL to redirect the user to the account created interface.

token
string

The token value.

Responses

Request samples

Content type
application/json
{
}

Delete Account

Delete the account with the specified ID.
Note: It is not possible to delete an account that is referenced at least one project.

Authorizations:
REGARDS_OAUTH2
path Parameters
account_id
required
integer <int64>

ID of the account

Responses

Get Account By ID

Retrieve details of the account with the specified ID.

Authorizations:
REGARDS_OAUTH2
path Parameters
account_id
required
integer <int64>

ID of the account

Responses

Update Account

Update details for the account with the specified ID.

Authorizations:
REGARDS_OAUTH2
path Parameters
account_id
required
integer <int64>

ID of the account

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" "EMAIL_VERIFICATION"

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
{
}

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
{
}

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