Skip to main content
Version: 1.15

MICROSERVICE AUTHENTICATION (1.15.2)

Download OpenAPI specification:Download

License: GPL-3.0

System authentication management

borrow-role-controller

switchRole

Authorizations:
REGARDS_OAUTH2
path Parameters
target_name
required
string

Responses

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

plugin-controller

getPlugins

Authorizations:
REGARDS_OAUTH2
query Parameters
pluginType
string

Responses

Response samples

Content type
application/json
[
]

emptyCache

Authorizations:
REGARDS_OAUTH2

Responses

Get plugin configurations

Return a list of plugin configurations for a specific type

Authorizations:
REGARDS_OAUTH2
query Parameters
pluginType
string

Responses

Response samples

Content type
application/json
[
]

getPluginConfigurationDirectAccess

Authorizations:
REGARDS_OAUTH2
path Parameters
configBusinessId
required
string

Responses

Response samples

Content type
application/json
{
}

getPluginMetaDataById

Authorizations:
REGARDS_OAUTH2
path Parameters
pluginId
required
string

Responses

Response samples

Content type
application/json
{
}

getPluginConfigurations

Authorizations:
REGARDS_OAUTH2
path Parameters
pluginId
required
string

Responses

Response samples

Content type
application/json
[
]

savePluginConfiguration

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
active
boolean
businessId
string[0-9a-zA-Z_-]*
iconUrl
string <url>
id
integer <int64>
identifiable
boolean
interfaceNames
Array of strings unique
isActive
boolean
label
required
string
object (PluginMetaData)
object (PluginMetaData)
Array of objects (IPluginParam) unique
pluginClassName
string
pluginId
string
priorityOrder
required
integer <int32>
version
string

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

deletePluginConfiguration

Authorizations:
REGARDS_OAUTH2
path Parameters
configBusinessId
required
string
pluginId
required
string

Responses

getPluginConfiguration

Authorizations:
REGARDS_OAUTH2
path Parameters
configBusinessId
required
string
pluginId
required
string

Responses

Response samples

Content type
application/json
{
}

updatePluginConfiguration

Authorizations:
REGARDS_OAUTH2
path Parameters
configBusinessId
required
string
pluginId
required
string
Request Body schema: application/json
required
active
boolean
businessId
string[0-9a-zA-Z_-]*
iconUrl
string <url>
id
integer <int64>
identifiable
boolean
interfaceNames
Array of strings unique
isActive
boolean
label
required
string
object (PluginMetaData)
object (PluginMetaData)
Array of objects (IPluginParam) unique
pluginClassName
string
pluginId
string
priorityOrder
required
integer <int32>
version
string

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

getPluginTypes

Authorizations:
REGARDS_OAUTH2
query Parameters
available
boolean

Responses

Response samples

Content type
application/json
[
]

jpa-multitenant-controller

getDataSourceStatus

Authorizations:
REGARDS_OAUTH2
path Parameters
tenant
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
}

testTenantConnection

Authorizations:
REGARDS_OAUTH2
path Parameters
tenant
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
}

security-resources-controller

getAllResources

Authorizations:
REGARDS_OAUTH2

Responses

Response samples

Content type
application/json
[
]

service-provider-controller

getServiceProviders

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)

Responses

saveServiceProvider

Authorizations:
REGARDS_OAUTH2
Request Body schema: application/json
required
authUrl
string
descriptionEn
string
descriptionFr
string
name
string
object (PluginConfiguration)

Responses

Request samples

Content type
application/json
{
}

verifyAndAuthenticate

Authorizations:
REGARDS_OAUTH2
query Parameters
externalToken
required
string

Responses

deleteServiceProvider

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string

Responses

getServiceProvider

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string

Responses

updateServiceProvider

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string
Request Body schema: application/json
required
authUrl
string
descriptionEn
string
descriptionFr
string
name
string
object (PluginConfiguration)

Responses

Request samples

Content type
application/json
{
}

authenticate

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string
Request Body schema: application/json
required
object (ServiceProviderAuthenticationParams)

Responses

Request samples

Content type
application/json
{ }

deauthenticate

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string

Responses

service-provider-public-controller

getServiceProvidersPublic

Authorizations:
REGARDS_OAUTH2
query Parameters
required
object (Pageable)

Responses

getServiceProvider_1

Authorizations:
REGARDS_OAUTH2
path Parameters
name
required
string

Responses

manager-controller

immediateShutdown

Authorizations:
REGARDS_OAUTH2

Responses