• Email request controller
  • postCreate an email request in database, then send a email by a asynchronous process.
• accounts-controller
  • getretrieveAccountList
  • postcreateAccount
  • getretrieveAccounByEmail
  • getgetOrigins
  • getgetPasswordRules
  • postcheckPassword
  • putacceptAccount
  • putactiveAccount
  • putperformChangePassword
  • putinactiveAccount
  • putlink
  • putupdateOrigin
  • putrefuseAccount
  • postrequestResetPassword
  • putperformResetPassword
  • putunlink
  • postrequestUnlockAccount
  • putperformUnlockAccount
  • getvalidatePassword
  • delremoveAccount
  • getretrieveAccount
  • putupdateAccount
• tenant-connection-controller
  • getgetTenantConnections
  • postaddTenantConnection
  • putupdateState
• maintenance-controller
  • getretrieveTenantsInMaintenance
  • putunSetMaintenance
  • putsetMaintenance
• module-manager-controller
  • getexportConfiguration
  • postimportConfiguration
  • getisConfigurationEnabled
  • getisReady
  • getisReadyEnabled
  • getrestart
  • getisRestartEnabled
• notification-controller
  • postretrieveNotifications
  • postcreateNotification
  • delDelete a selection of notifications.
  • deldeleteNotification
  • getretrieveNotification
  • putsetNotificationRead
• project-controller
  • getretrieveProjectList
  • postcreateProject
  • getretrievePublicProjectList
  • deldeleteProject
  • getretrieveProject
  • putupdateProject
  • putresetLicense
• project-connection-controller
  • getgetAllProjectConnections
  • postcreateProjectConnection
  • deldeleteProjectConnection
  • getgetProjectConnection
  • putupdateProjectConnection
• security-resources-controller
  • getgetAllResources
• dynamic-tenant-setting-controller
  • getretrieveAll
  • delreset
  • putupdate
• manager-controller
  • postimmediateShutdown
• tenant-controller
  • getgetAllTenants
  • getgetAllActiveTenants

API docs by Redocly

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.

Generated server url

/api/v1/rs-admin-instance/email

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

• Payload

Content type

application/json

{

• "bcc": [

  • "string"

  ],
• "cc": [

  • "string"

  ],
• "from": "string",
• "replyTo": "string",
• "sentDate": "2019-08-24T14:15:22Z",
• "subject": "string",
• "text": "string",
• "to": [

  • "string"

  ]

}

accounts-controller

retrieveAccountList

Generated server url

/api/v1/rs-admin-instance/accounts

Authorizations:

REGARDS_OAUTH2

query Parameters

required	object (Pageable)
required	object (AccountSearchParameters)

Responses

createAccount

Generated server url

/api/v1/rs-admin-instance/accounts

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

	object (Account)
password	string
project	string

Responses

Request samples

• Payload

Content type

application/json

{

• "account": {

  • "authenticationFailedCounter": 0,
  • "email": "string",
  • "external": true,
  • "firstName": "string",
  • "id": 0,
  • "identifiable": true,
  • "invalidityDate": "2019-08-24T14:15:22Z",
  • "lastName": "string",
  • "origin": "string",
  • "password": "string",
  • "passwordUpdateDate": "2019-08-24T14:15:22Z",
  • "projects": [

    • {

      • "crs": "string",
      • "description": "string",
      • "host": "string",
      • "icon": "string",
      • "id": 0,
      • "identifiable": true,
      • "isAccessible": true,
      • "isDeleted": true,
      • "isPoleToBeManaged": true,
      • "isPublic": true,
      • "label": "string",
      • "licenceLink": "string",
      • "licenseLink": "string",
      • "name": "string"

      }

    ],
  • "status": "INACTIVE"

  },
• "password": "string",
• "project": "string"

}

retrieveAccounByEmail

Generated server url

/api/v1/rs-admin-instance/accounts/account/{account_email}

Authorizations:

REGARDS_OAUTH2

path Parameters

account_email required

string

Responses

getOrigins

Generated server url

/api/v1/rs-admin-instance/accounts/origins

Authorizations:

REGARDS_OAUTH2

Responses

getPasswordRules

Generated server url

/api/v1/rs-admin-instance/accounts/password

Authorizations:

REGARDS_OAUTH2

Responses

checkPassword

Generated server url

/api/v1/rs-admin-instance/accounts/password

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

password

string

Responses

Request samples

• Payload

Content type

application/json

{

• "password": "string"

}

acceptAccount

Generated server url

/api/v1/rs-admin-instance/accounts/{account_email}/accept

Authorizations:

REGARDS_OAUTH2

path Parameters

account_email required

string

Responses

activeAccount

Generated server url

/api/v1/rs-admin-instance/accounts/{account_email}/active

Authorizations:

REGARDS_OAUTH2

path Parameters

account_email required

string

Responses

performChangePassword

Generated server url

/api/v1/rs-admin-instance/accounts/{account_email}/changePassword

Authorizations:

REGARDS_OAUTH2

path Parameters

account_email required

string

Request Body schema: application/json

required

newPassword	string
oldPassword	string

Responses

Request samples

• Payload

Content type

application/json

{

• "newPassword": "string",
• "oldPassword": "string"

}

inactiveAccount

Generated server url

/api/v1/rs-admin-instance/accounts/{account_email}/inactive

Authorizations:

REGARDS_OAUTH2

path Parameters

account_email required

string

Responses

link

Generated server url

/api/v1/rs-admin-instance/accounts/{account_email}/link/{project}

Authorizations:

REGARDS_OAUTH2

path Parameters

account_email required	string
project required	string

Responses

updateOrigin

Generated server url

/api/v1/rs-admin-instance/accounts/{account_email}/origin/{origin}

Authorizations:

REGARDS_OAUTH2

path Parameters

account_email required	string
origin required	string

Responses

refuseAccount

Generated server url

/api/v1/rs-admin-instance/accounts/{account_email}/refuse

Authorizations:

REGARDS_OAUTH2

path Parameters

account_email required

string

Responses

requestResetPassword

Generated server url

/api/v1/rs-admin-instance/accounts/{account_email}/resetPassword

Authorizations:

REGARDS_OAUTH2

path Parameters

account_email required

string

Request Body schema: application/json

required

originUrl	string
requestLink	string

Responses

Request samples

• Payload

Content type

application/json

{

• "originUrl": "string",
• "requestLink": "string"

}

performResetPassword

Generated server url

/api/v1/rs-admin-instance/accounts/{account_email}/resetPassword

Authorizations:

REGARDS_OAUTH2

path Parameters

account_email required

string

Request Body schema: application/json

required

newPassword	string
token	string

Responses

Request samples

• Payload

Content type

application/json

{

• "newPassword": "string",
• "token": "string"

}

unlink

Generated server url

/api/v1/rs-admin-instance/accounts/{account_email}/unlink/{project}

Authorizations:

REGARDS_OAUTH2

path Parameters

account_email required	string
project required	string

Responses

requestUnlockAccount

Generated server url

/api/v1/rs-admin-instance/accounts/{account_email}/unlockAccount

Authorizations:

REGARDS_OAUTH2

path Parameters

account_email required

string

Request Body schema: application/json

required

originUrl required	string
requestLink required	string

Responses

Request samples

• Payload

Content type

application/json

{

• "originUrl": "string",
• "requestLink": "string"

}

performUnlockAccount

Generated server url

/api/v1/rs-admin-instance/accounts/{account_email}/unlockAccount

Authorizations:

REGARDS_OAUTH2

path Parameters

account_email required

string

Request Body schema: application/json

required

token

string

Responses

Request samples

• Payload

Content type

application/json

{

• "token": "string"

}

validatePassword

Generated server url

/api/v1/rs-admin-instance/accounts/{account_email}/validate

Authorizations:

REGARDS_OAUTH2

path Parameters

account_email required

string

query Parameters

password required

string

Responses

removeAccount

Generated server url

/api/v1/rs-admin-instance/accounts/{account_id}

Authorizations:

REGARDS_OAUTH2

path Parameters

account_id required

integer <int64>

Responses

retrieveAccount

Generated server url

/api/v1/rs-admin-instance/accounts/{account_id}

Authorizations:

REGARDS_OAUTH2

path Parameters

account_id required

integer <int64>

Responses

updateAccount

Generated server url

/api/v1/rs-admin-instance/accounts/{account_id}

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

• Payload

Content type

application/json

{

• "authenticationFailedCounter": 0,
• "email": "string",
• "external": true,
• "firstName": "string",
• "id": 0,
• "identifiable": true,
• "invalidityDate": "2019-08-24T14:15:22Z",
• "lastName": "string",
• "origin": "string",
• "password": "string",
• "passwordUpdateDate": "2019-08-24T14:15:22Z",
• "projects": [

  • {

    • "crs": "string",
    • "description": "string",
    • "host": "string",
    • "icon": "string",
    • "id": 0,
    • "identifiable": true,
    • "isAccessible": true,
    • "isDeleted": true,
    • "isPoleToBeManaged": true,
    • "isPublic": true,
    • "label": "string",
    • "licenceLink": "string",
    • "licenseLink": "string",
    • "name": "string"

    }

  ],
• "status": "INACTIVE"

}

tenant-connection-controller

getTenantConnections

Generated server url

/api/v1/rs-admin-instance/connections/{microservice}

Authorizations:

REGARDS_OAUTH2

path Parameters

microservice required

string

Responses

addTenantConnection

Generated server url

/api/v1/rs-admin-instance/connections/{microservice}

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

• Payload

Content type

application/json

{

• "driverClassName": "string",
• "errorCause": "string",
• "password": "string",
• "state": "ENABLED",
• "tenant": "string",
• "url": "string",
• "userName": "string"

}

updateState

Generated server url

/api/v1/rs-admin-instance/connections/{microservice}

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

• Payload

Content type

application/json

{

• "driverClassName": "string",
• "errorCause": "string",
• "password": "string",
• "state": "ENABLED",
• "tenant": "string",
• "url": "string",
• "userName": "string"

}

maintenance-controller

retrieveTenantsInMaintenance

Generated server url

/api/v1/rs-admin-instance/maintenance

Authorizations:

REGARDS_OAUTH2

Responses

unSetMaintenance

Generated server url

/api/v1/rs-admin-instance/maintenance/{tenant}/disable

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

setMaintenance

Generated server url

/api/v1/rs-admin-instance/maintenance/{tenant}/enable

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

module-manager-controller

exportConfiguration

Generated server url

/api/v1/rs-admin-instance/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Responses

importConfiguration

Generated server url

/api/v1/rs-admin-instance/microservice/configuration

Authorizations:

REGARDS_OAUTH2

Request Body schema: multipart/form-data

file required

string <binary>

Responses

isConfigurationEnabled

Generated server url

/api/v1/rs-admin-instance/microservice/configuration/enabled

Authorizations:

REGARDS_OAUTH2

Responses

isReady

Generated server url

/api/v1/rs-admin-instance/microservice/ready

Authorizations:

REGARDS_OAUTH2

Responses

isReadyEnabled

Generated server url

/api/v1/rs-admin-instance/microservice/ready/enabled

Authorizations:

REGARDS_OAUTH2

Responses

restart

Generated server url

/api/v1/rs-admin-instance/microservice/restart

Authorizations:

REGARDS_OAUTH2

Responses

isRestartEnabled

Generated server url

/api/v1/rs-admin-instance/microservice/restart/enabled

Authorizations:

REGARDS_OAUTH2

Responses

notification-controller

retrieveNotifications

Generated server url

/api/v1/rs-admin-instance/notifications

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

• Payload

Content type

application/json

{

• "dates": {

  • "after": "2019-08-24T14:15:22Z",
  • "before": "2019-08-24T14:15:22Z"

  },
• "ids": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • 0

    ]

  },
• "levels": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • "INFO"

    ]

  },
• "senders": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • "string"

    ]

  },
• "status": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • "READ"

    ]

  }

}

createNotification

Generated server url

/api/v1/rs-admin-instance/notifications/create

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

• Payload

Content type

application/json

{

• "level": "INFO",
• "message": "string",
• "mimeType": "string",
• "projectUserRecipients": [

  • "string"

  ],
• "roleRecipients": [

  • "string"

  ],
• "sender": "string",
• "title": "string"

}

Delete a selection of notifications.

Generated server url

/api/v1/rs-admin-instance/notifications/delete

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

• Payload

Content type

application/json

{

• "dates": {

  • "after": "2019-08-24T14:15:22Z",
  • "before": "2019-08-24T14:15:22Z"

  },
• "ids": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • 0

    ]

  },
• "levels": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • "INFO"

    ]

  },
• "senders": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • "string"

    ]

  },
• "status": {

  • "ignoreCase": true,
  • "matchMode": "STRICT",
  • "mode": "INCLUDE",
  • "values": [

    • "READ"

    ]

  }

}

deleteNotification

Generated server url

/api/v1/rs-admin-instance/notifications/{notification_id}

Authorizations:

REGARDS_OAUTH2

path Parameters

notification_id required

integer <int64>

Responses

retrieveNotification

Generated server url

/api/v1/rs-admin-instance/notifications/{notification_id}

Authorizations:

REGARDS_OAUTH2

path Parameters

notification_id required

integer <int64>

Responses

setNotificationRead

Generated server url

/api/v1/rs-admin-instance/notifications/{notification_id}/read

Authorizations:

REGARDS_OAUTH2

path Parameters

notification_id required

integer <int64>

Responses

project-controller

retrieveProjectList

Generated server url

/api/v1/rs-admin-instance/projects

Authorizations:

REGARDS_OAUTH2

query Parameters

required

object (Pageable)

Responses

Response samples

• 200

Content type

application/json

{

• "content": [

  • {

    • "content": {

      • "crs": "string",
      • "description": "string",
      • "host": "string",
      • "icon": "string",
      • "id": 0,
      • "identifiable": true,
      • "isAccessible": true,
      • "isDeleted": true,
      • "isPoleToBeManaged": true,
      • "isPublic": true,
      • "label": "string",
      • "licenceLink": "string",
      • "name": "string"

      },
    • "links": [

      • {

        • "deprecation": "string",
        • "href": "string",
        • "hreflang": "string",
        • "media": "string",
        • "name": "string",
        • "profile": "string",
        • "rel": "string",
        • "title": "string",
        • "type": "string"

        }

      ]

    }

  ],
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ],
• "page": {

  • "number": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0

  }

}

createProject

Generated server url

/api/v1/rs-admin-instance/projects

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

• Payload

Content type

application/json

{

• "crs": "string",
• "description": "string",
• "host": "string",
• "icon": "string",
• "id": 0,
• "identifiable": true,
• "isAccessible": true,
• "isDeleted": true,
• "isPoleToBeManaged": true,
• "isPublic": true,
• "label": "string",
• "licenceLink": "string",
• "licenseLink": "string",
• "name": "string"

}

Response samples

• 200

Content type

application/json

{

• "content": {

  • "crs": "string",
  • "description": "string",
  • "host": "string",
  • "icon": "string",
  • "id": 0,
  • "identifiable": true,
  • "isAccessible": true,
  • "isDeleted": true,
  • "isPoleToBeManaged": true,
  • "isPublic": true,
  • "label": "string",
  • "licenceLink": "string",
  • "name": "string"

  },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

retrievePublicProjectList

Generated server url

/api/v1/rs-admin-instance/projects/public

Authorizations:

REGARDS_OAUTH2

query Parameters

required

object (Pageable)

Responses

Response samples

• 200

Content type

application/json

{

• "content": [

  • {

    • "content": {

      • "crs": "string",
      • "description": "string",
      • "host": "string",
      • "icon": "string",
      • "id": 0,
      • "identifiable": true,
      • "isAccessible": true,
      • "isDeleted": true,
      • "isPoleToBeManaged": true,
      • "isPublic": true,
      • "label": "string",
      • "licenceLink": "string",
      • "name": "string"

      },
    • "links": [

      • {

        • "deprecation": "string",
        • "href": "string",
        • "hreflang": "string",
        • "media": "string",
        • "name": "string",
        • "profile": "string",
        • "rel": "string",
        • "title": "string",
        • "type": "string"

        }

      ]

    }

  ],
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ],
• "page": {

  • "number": 0,
  • "size": 0,
  • "totalElements": 0,
  • "totalPages": 0

  }

}

deleteProject

Generated server url

/api/v1/rs-admin-instance/projects/{project_name}

Authorizations:

REGARDS_OAUTH2

path Parameters

project_name required

string

Responses

retrieveProject

Generated server url

/api/v1/rs-admin-instance/projects/{project_name}

Authorizations:

REGARDS_OAUTH2

path Parameters

project_name required

string

Responses

Response samples

• 200

Content type

application/json

{

• "content": {

  • "crs": "string",
  • "description": "string",
  • "host": "string",
  • "icon": "string",
  • "id": 0,
  • "identifiable": true,
  • "isAccessible": true,
  • "isDeleted": true,
  • "isPoleToBeManaged": true,
  • "isPublic": true,
  • "label": "string",
  • "licenceLink": "string",
  • "name": "string"

  },
• "links": [

  • {

    • "deprecation": "string",
    • "href": "string",
    • "hreflang": "string",
    • "media": "string",
    • "name": "string",
    • "profile": "string",
    • "rel": "string",
    • "title": "string",
    • "type": "string"

    }

  ]

}

updateProject

Generated server url

/api/v1/rs-admin-instance/projects/{project_name}

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

• Payload

Content type

application/json

{

• "crs": "string",
• "description": "string",
• "host": "string",
• "icon": "string",
• "id": 0,
• "identifiable": true,
• "isAccessible": true,
• "isDeleted": true,
• "isPoleToBeManaged": true,
• "isPublic": true,
• "label": "string",
• "licenceLink": "string",
• "licenseLink": "string",
• "name": "string"

}

resetLicense

Generated server url

/api/v1/rs-admin-instance/projects/{project_name}/license/reset

Authorizations:

REGARDS_OAUTH2

path Parameters

project_name required

string

Responses

project-connection-controller

getAllProjectConnections

Generated server url

/api/v1/rs-admin-instance/projects/{projectName}/connections

Authorizations:

REGARDS_OAUTH2

path Parameters

projectName required

string

query Parameters

required

object (Pageable)

Responses

createProjectConnection

Generated server url

/api/v1/rs-admin-instance/projects/{projectName}/connections

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

• Payload

Content type

application/json

{

• "driverClassName": "string",
• "errorCause": "string",
• "id": 0,
• "identifiable": true,
• "microservice": "string",
• "password": "string",
• "project": {

  • "crs": "string",
  • "description": "string",
  • "host": "string",
  • "icon": "string",
  • "id": 0,
  • "identifiable": true,
  • "isAccessible": true,
  • "isDeleted": true,
  • "isPoleToBeManaged": true,
  • "isPublic": true,
  • "label": "string",
  • "licenceLink": "string",
  • "licenseLink": "string",
  • "name": "string"

  },
• "state": "ENABLED",
• "url": "string",
• "userName": "string"

}

deleteProjectConnection

Generated server url

/api/v1/rs-admin-instance/projects/{projectName}/connections/{connectionId}

Authorizations:

REGARDS_OAUTH2

path Parameters

connectionId required	integer <int64>
projectName required	string

Responses

getProjectConnection

Generated server url

/api/v1/rs-admin-instance/projects/{projectName}/connections/{connectionId}

Authorizations:

REGARDS_OAUTH2

path Parameters

connectionId required	integer <int64>
projectName required	string

Responses

updateProjectConnection

Generated server url

/api/v1/rs-admin-instance/projects/{projectName}/connections/{connectionId}

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

• Payload

Content type

application/json

{

• "driverClassName": "string",
• "errorCause": "string",
• "id": 0,
• "identifiable": true,
• "microservice": "string",
• "password": "string",
• "project": {

  • "crs": "string",
  • "description": "string",
  • "host": "string",
  • "icon": "string",
  • "id": 0,
  • "identifiable": true,
  • "isAccessible": true,
  • "isDeleted": true,
  • "isPoleToBeManaged": true,
  • "isPublic": true,
  • "label": "string",
  • "licenceLink": "string",
  • "licenseLink": "string",
  • "name": "string"

  },
• "state": "ENABLED",
• "url": "string",
• "userName": "string"

}

security-resources-controller

getAllResources

Generated server url

/api/v1/rs-admin-instance/security/resources

Authorizations:

REGARDS_OAUTH2

Responses

Response samples

• 200

Content type

application/json

[

• {

  • "autorizedRoles": [

    • {

      • "authority": "string",
      • "authorizedIpAdresses": [

        • "string"

        ],
      • "roleName": "string"

      }

    ],
  • "controllerSimpleName": "string",
  • "fullPath": "string",
  • "method": "GET",
  • "resourceAccess": { },
  • "resourceMappingId": "string"

  }

]

dynamic-tenant-setting-controller

retrieveAll

Generated server url

/api/v1/rs-admin-instance/settings

Authorizations:

REGARDS_OAUTH2

query Parameters

names

Array of strings unique

Responses

reset

Generated server url

/api/v1/rs-admin-instance/settings/{name}

Authorizations:

REGARDS_OAUTH2

path Parameters

name required

string

Responses

update

Generated server url

/api/v1/rs-admin-instance/settings/{name}

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

• Payload

Content type

application/json

{

• "defaultValue": { },
• "description": "string",
• "name": "string",
• "value": { }

}

manager-controller

immediateShutdown

Generated server url

/api/v1/rs-admin-instance/shutdown/immediate

Authorizations:

REGARDS_OAUTH2

Responses

tenant-controller

getAllTenants

Generated server url

/api/v1/rs-admin-instance/tenants

Authorizations:

REGARDS_OAUTH2

Responses

getAllActiveTenants

Generated server url

/api/v1/rs-admin-instance/tenants/{microserviceName}

Authorizations:

REGARDS_OAUTH2

path Parameters

microserviceName required

string

Responses