Get Accounts
Retrieve the list of accounts on the instance
Authorizations:
query Parameters
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:
Request Body schema: application/jsonrequired
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 |
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 |
Responses
Request samples
- Payload
{- "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"
}, - "originUrl": "string",
- "password": "string",
- "project": "string",
- "requestLink": "string"
}
Change Password
Changes the user password, given their current password.
Authorizations:
path Parameters
account_email required | string The account email |
Request Body schema: application/jsonrequired
newPassword | string The new password of the user. |
oldPassword | string The current password of the user. |
Responses
Request samples
- Payload
{- "newPassword": "string",
- "oldPassword": "string"
}
Send Password Reset Email
Send to the user an email containing a link with limited validity to reset its password.
Authorizations:
path Parameters
account_email required | string The account email |
Request Body schema: application/jsonrequired
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
- Payload
{- "originUrl": "string",
- "requestLink": "string"
}
Reset Password
Change an account password using a reset token that was received by email.
Authorizations:
path Parameters
account_email required | string The account email |
Request Body schema: application/jsonrequired
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
- Payload
{- "newPassword": "string",
- "token": "string"
}
Send Unlock Account Email
Send to the user an email containing a link with limited validity to unlock their account.
Authorizations:
path Parameters
account_email required | string The account email |
Request Body schema: application/jsonrequired
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
- Payload
{- "originUrl": "string",
- "requestLink": "string"
}
Unlock Account
Unlock a locked account using an unlock token that was received by email.
Authorizations:
path Parameters
account_email required | string The account email |
Request Body schema: application/jsonrequired
token | string The unlock token that was provided in the email received by the user to unlock their account. |
Responses
Request samples
- Payload
{- "token": "string"
}
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:
path Parameters
account_email required | string The account email |
Request Body schema: application/jsonrequired
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
- Payload
{- "expiryDate": "2019-08-24T14:15:22Z",
- "originUrl": "string",
- "requestLink": "string",
- "token": "string"
}
Update Account
Update details for the account with the specified ID.
Authorizations:
path Parameters
account_id required | integer <int64> ID of the account |
Request Body schema: application/jsonrequired
authenticationFailedCounter | integer <int64> |
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
- Payload
{- "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"
}
addTenantConnection
Authorizations:
path Parameters
microservice required | string |
Request Body schema: application/jsonrequired
driverClassName | string |
errorCause | string |
password | string |
state | string Enum: "ENABLED" "DISABLED" "CONNECTING" "ERROR" |
tenant required | string |
url | string |
userName | string |
Responses
Request samples
- Payload
{- "driverClassName": "string",
- "errorCause": "string",
- "password": "string",
- "state": "ENABLED",
- "tenant": "string",
- "url": "string",
- "userName": "string"
}
updateState
Authorizations:
path Parameters
microservice required | string |
Request Body schema: application/jsonrequired
driverClassName | string |
errorCause | string |
password | string |
state | string Enum: "ENABLED" "DISABLED" "CONNECTING" "ERROR" |
tenant required | string |
url | string |
userName | string |
Responses
Request samples
- Payload
{- "driverClassName": "string",
- "errorCause": "string",
- "password": "string",
- "state": "ENABLED",
- "tenant": "string",
- "url": "string",
- "userName": "string"
}
Create an email request in database, then send a email by a asynchronous process.
Authorizations:
Request Body schema: application/jsonrequired
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
{- "bcc": [
- "string"
], - "cc": [
- "string"
], - "from": "string",
- "replyTo": "string",
- "sentDate": "2019-08-24T14:15:22Z",
- "subject": "string",
- "text": "string",
- "to": [
- "string"
]
}
retrieveNotifications
Authorizations:
query Parameters
required | object (Pageable) Sorting and page configuration |
Request Body schema: application/jsonrequired
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
{- "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
Authorizations:
Request Body schema: application/jsonrequired
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
{- "level": "INFO",
- "message": "string",
- "mimeType": "string",
- "projectUserRecipients": [
- "string"
], - "roleRecipients": [
- "string"
], - "sender": "string",
- "title": "string"
}
Delete a selection of notifications.
Find and delete notifications from criterias defined in request body.
Authorizations:
Request Body schema: application/jsonrequired
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
{- "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"
]
}
}
retrieveProjectList
Authorizations:
query Parameters
required | object (Pageable) |
Responses
Response samples
- 200
{- "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
Authorizations:
Request Body schema: application/jsonrequired
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
{- "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": {
- "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
Authorizations:
query Parameters
required | object (Pageable) |
Responses
Response samples
- 200
{- "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
}
}
Response samples
- 200
{- "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
Authorizations:
path Parameters
project_name required | string |
Request Body schema: application/jsonrequired
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
{- "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"
}
createProjectConnection
Authorizations:
path Parameters
projectName required | string |
Request Body schema: application/jsonrequired
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
{- "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"
}
updateProjectConnection
Authorizations:
path Parameters
connectionId required | integer <int64> |
projectName required | string |
Request Body schema: application/jsonrequired
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
{- "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"
}
Response samples
- 200
[- {
- "autorizedRoles": [
- {
- "authority": "string",
- "authorizedIpAdresses": [
- "string"
], - "roleName": "string"
}
], - "controllerSimpleName": "string",
- "fullPath": "string",
- "method": "GET",
- "resourceAccess": { },
- "resourceMappingId": "string"
}
]
update
Authorizations:
path Parameters
name required | string |
Request Body schema: application/jsonrequired
defaultValue | object |
description | string |
name | string |
value | object |
Responses
Request samples
- Payload
{- "defaultValue": { },
- "description": "string",
- "name": "string",
- "value": { }
}