MICROSERVICE ADMIN (2.0.0)

Download OpenAPI specification:Download

License: GPL-3.0

System management and configuration

registration-controller

requestAccess

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

accessGroups	Array of strings unique
email required	string
firstName	string
lastName	string
maxQuota	integer <int64>
	Array of objects (MetaData)
origin	string
originUrl	string
password	string
requestLink	string
roleName	string

Responses

Request samples

Payload

Content type

application/json

{"accessGroups": ["string"
],
"email": "string",
"firstName": "string",
"lastName": "string",
"maxQuota": 0,
"metadata": [{"id": 0,
"identifiable": true,
"key": "string",
"value": "string",
"visibility": "READABLE"
}
],
"origin": "string",
"originUrl": "string",
"password": "string",
"requestLink": "string",
"roleName": "string"
}

requestExternalAccess

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

accessGroups	Array of strings unique
email required	string
firstName	string
lastName	string
maxQuota	integer <int64>
	Array of objects (MetaData)
origin	string
originUrl	string
password	string
requestLink	string
roleName	string

Responses

Request samples

Payload

Content type

application/json

{"accessGroups": ["string"
],
"email": "string",
"firstName": "string",
"lastName": "string",
"maxQuota": 0,
"metadata": [{"id": 0,
"identifiable": true,
"key": "string",
"value": "string",
"visibility": "READABLE"
}
],
"origin": "string",
"originUrl": "string",
"password": "string",
"requestLink": "string",
"roleName": "string"
}

verifyEmail

Authorizations:

REGARDS_OAUTH2

path Parameters

token

required

string

Responses

removeAccessRequest

Authorizations:

REGARDS_OAUTH2

path Parameters

access_id

required

integer <int64>

Responses

acceptAccessRequest

Authorizations:

REGARDS_OAUTH2

path Parameters

access_id

required

integer <int64>

Responses

activeAccess

Authorizations:

REGARDS_OAUTH2

path Parameters

access_id

required

integer <int64>

Responses

denyAccessRequest

Authorizations:

REGARDS_OAUTH2

path Parameters

access_id

required

integer <int64>

Responses

inactiveAccess

Authorizations:

REGARDS_OAUTH2

path Parameters

access_id

required

integer <int64>

Responses

license-controller

retrieveLicense

Authorizations:

REGARDS_OAUTH2

Responses

acceptLicense

Authorizations:

REGARDS_OAUTH2

Responses

resetLicense

Authorizations:

REGARDS_OAUTH2

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

notification-controller

retrieveNotifications

Authorizations:

REGARDS_OAUTH2

query Parameters

required

object (Pageable)

Sorting and page configuration

Request Body schema: application/json
required

Set of search criteria.

	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

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.

Find and delete notifications from criteria defined in request body.

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

Set of search criteria.

	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"
]
}
}

retrieveNotificationSettings

Authorizations:

REGARDS_OAUTH2

Responses

updateNotificationSettings

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

days	integer <int32>
frequency	string Enum: "DAILY" "WEEKLY" "MONTHLY" "CUSTOM"
hours	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"days": 0,
"frequency": "DAILY",
"hours": 0
}

summary

Authorizations:

REGARDS_OAUTH2

Responses

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

jpa-multitenant-controller

getDataSourceStatus

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant

required

string

Responses

Response samples

200

Content type

application/json

{"message": "string",
"properties": {"property1": { },
"property2": { }
}
}

testTenantConnection

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant

required

string

Responses

Response samples

200

Content type

application/json

{"message": "string",
"properties": {"property1": { },
"property2": { }
}
}

resource-controller

getAllResourceAccesses

Authorizations:

REGARDS_OAUTH2

query Parameters

required

object (Pageable)

Responses

getResourceAccess

Authorizations:

REGARDS_OAUTH2

path Parameters

resource_id

required

integer <int64>

Responses

updateResourceAccess

Authorizations:

REGARDS_OAUTH2

path Parameters

resource_id

required

integer <int64>

Request Body schema: application/json
required

controllerSimpleName required	string
defaultRole required	string Enum: "INSTANCE_ADMIN" "PROJECT_ADMIN" "EXPLOIT" "ADMIN" "REGISTERED_USER" "PUBLIC"
description	string
id	integer <int64>
identifiable	boolean
microservice required	string
resource required	string
verb required	string Enum: "GET" "HEAD" "POST" "PUT" "PATCH" "DELETE" "OPTIONS" "TRACE"

Responses

Request samples

Payload

Content type

application/json

{"controllerSimpleName": "string",
"defaultRole": "INSTANCE_ADMIN",
"description": "string",
"id": 0,
"identifiable": true,
"microservice": "string",
"resource": "string",
"verb": "GET"
}

microservice-resource-controller

getAllResourceAccessesByMicroservice

Authorizations:

REGARDS_OAUTH2

path Parameters

microservicename

required

string

query Parameters

required

object (Pageable)

Responses

registerMicroserviceEndpoints

Authorizations:

REGARDS_OAUTH2

path Parameters

microservicename

required

string

Request Body schema: application/json
required

Array

	Array of objects (RoleAuthority)
controllerSimpleName	string
fullPath	string
method	string Enum: "GET" "HEAD" "POST" "PUT" "PATCH" "DELETE" "OPTIONS" "TRACE"
resourceAccess	object (ResourceAccess)
resourceMappingId	string

Responses

Request samples

Payload

Content type

application/json

[{"autorizedRoles": [{"authority": "string",
"authorizedIpAdresses": ["string"
],
"roleName": "string"
}
],
"controllerSimpleName": "string",
"fullPath": "string",
"method": "GET",
"resourceAccess": { },
"resourceMappingId": "string"
}
]

retrieveMicroserviceControllers

Authorizations:

REGARDS_OAUTH2

path Parameters

microservicename

required

string

Responses

retrieveMicroserviceControllerEndpoints

Authorizations:

REGARDS_OAUTH2

path Parameters

controllername required	string
microservicename required	string

Responses

role-controller

Get roles

Return a list of roles

Authorizations:

REGARDS_OAUTH2

Responses

createRole

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

authorizedAddresses	Array of strings
id	integer <int64>
identifiable	boolean
isDefault	boolean
isNative	boolean
name required	string
parentRole	object (Role) Recursive
	Array of objects (ResourcesAccess) unique

Responses

Request samples

Payload

Content type

application/json

{"authorizedAddresses": ["string"
],
"id": 0,
"identifiable": true,
"isDefault": true,
"isNative": true,
"name": "string",
"parentRole": { },
"permissions": [{"controllerSimpleName": "string",
"defaultRole": "INSTANCE_ADMIN",
"description": "string",
"id": 0,
"identifiable": true,
"microservice": "string",
"resource": "string",
"verb": "GET"
}
]
}

getBorrowableRoles

Authorizations:

REGARDS_OAUTH2

Responses

shouldAccessToResourceRequiring

Authorizations:

REGARDS_OAUTH2

path Parameters

role_name

required

string

Responses

getRolesAccesingResource

Authorizations:

REGARDS_OAUTH2

path Parameters

resourceId

required

integer <int64>

Responses

removeRole

Authorizations:

REGARDS_OAUTH2

path Parameters

role_name

required

string

Responses

retrieveRole

Authorizations:

REGARDS_OAUTH2

path Parameters

role_name

required

string

Responses

updateRole

Authorizations:

REGARDS_OAUTH2

path Parameters

role_name

required

string

Request Body schema: application/json
required

authorizedAddresses	Array of strings
id	integer <int64>
identifiable	boolean
isDefault	boolean
isNative	boolean
name required	string
parentRole	object (Role) Recursive
	Array of objects (ResourcesAccess) unique

Responses

Request samples

Payload

Content type

application/json

{"authorizedAddresses": ["string"
],
"id": 0,
"identifiable": true,
"isDefault": true,
"isNative": true,
"name": "string",
"parentRole": { },
"permissions": [{"controllerSimpleName": "string",
"defaultRole": "INSTANCE_ADMIN",
"description": "string",
"id": 0,
"identifiable": true,
"microservice": "string",
"resource": "string",
"verb": "GET"
}
]
}

retrieveRoleAscendants

Authorizations:

REGARDS_OAUTH2

path Parameters

role_name

required

string

Responses

retrieveRoleDescendants

Authorizations:

REGARDS_OAUTH2

path Parameters

role_name

required

string

Responses

role-resource-controller

getRoleResources

Authorizations:

REGARDS_OAUTH2

path Parameters

role_name

required

string

Responses

addRoleResource

Authorizations:

REGARDS_OAUTH2

path Parameters

role_name

required

string

Request Body schema: application/json
required

controllerSimpleName required	string
defaultRole required	string Enum: "INSTANCE_ADMIN" "PROJECT_ADMIN" "EXPLOIT" "ADMIN" "REGISTERED_USER" "PUBLIC"
description	string
id	integer <int64>
identifiable	boolean
microservice required	string
resource required	string
verb required	string Enum: "GET" "HEAD" "POST" "PUT" "PATCH" "DELETE" "OPTIONS" "TRACE"

Responses

Request samples

Payload

Content type

application/json

{"controllerSimpleName": "string",
"defaultRole": "INSTANCE_ADMIN",
"description": "string",
"id": 0,
"identifiable": true,
"microservice": "string",
"resource": "string",
"verb": "GET"
}

getRoleResourcesForMicroservice

Authorizations:

REGARDS_OAUTH2

path Parameters

microservice required	string
role_name required	string

Responses

Response samples

200

Content type

application/json

[{"content": {"controllerSimpleName": "string",
"defaultRole": "INSTANCE_ADMIN",
"description": "string",
"id": 0,
"identifiable": true,
"microservice": "string",
"resource": "string",
"verb": "GET"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}
]

deleteRoleResource

Authorizations:

REGARDS_OAUTH2

path Parameters

resources_access_id required	integer <int64>
role_name required	string

Responses

security-resources-controller

getAllResources

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"
}
]

session-manager-controller

getSessions

Authorizations:

REGARDS_OAUTH2

query Parameters

required	object (Pageable)
sessionName	string
sessionState	string
sourceName	string

Responses

getSessionNames

Authorizations:

REGARDS_OAUTH2

query Parameters

name

string

Responses

deleteSession

Authorizations:

REGARDS_OAUTH2

path Parameters

id

required

integer <int64>

Responses

getSessionById

Authorizations:

REGARDS_OAUTH2

path Parameters

id

required

integer <int64>

Responses

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

Payload

Content type

application/json

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

manager-controller

immediateShutdown

Authorizations:

REGARDS_OAUTH2

Responses

source-manager-controller

getSources

Authorizations:

REGARDS_OAUTH2

query Parameters

required	object (Pageable)
sourceName	string
sourceState	string

Responses

getSourcesNames

Authorizations:

REGARDS_OAUTH2

query Parameters

name

string

Responses

deleteSource

Authorizations:

REGARDS_OAUTH2

path Parameters

name

required

string

Responses

project-users-controller

createUser

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

accessGroups	Array of strings unique
email required	string
firstName	string
lastName	string
maxQuota	integer <int64>
	Array of objects (MetaData)
origin	string
originUrl	string
password	string
requestLink	string
roleName	string

Responses

Request samples

Payload

Content type

application/json

{"accessGroups": ["string"
],
"email": "string",
"firstName": "string",
"lastName": "string",
"maxQuota": 0,
"metadata": [{"id": 0,
"identifiable": true,
"key": "string",
"value": "string",
"visibility": "READABLE"
}
],
"origin": "string",
"originUrl": "string",
"password": "string",
"requestLink": "string",
"roleName": "string"
}

getUserCountByAccessGroup

Authorizations:

REGARDS_OAUTH2

Responses

retrieveProjectUserByEmail

Authorizations:

REGARDS_OAUTH2

path Parameters

email

required

string

Responses

isAdmin

Authorizations:

REGARDS_OAUTH2

path Parameters

email

required

string

Responses

linkAccessGroups

Authorizations:

REGARDS_OAUTH2

path Parameters

email

required

string

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

updateOrigin

Authorizations:

REGARDS_OAUTH2

path Parameters

email required	string
origin required	string

Responses

sendVerificationEmail

Authorizations:

REGARDS_OAUTH2

path Parameters

email

required

string

Responses

exportAsCSV

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

	object (ValuesRestrictionString) Filter on notification sender
	object (DatesRangeRestriction) Filter on notification date
email	string Filter on user email
firstName	string Filter on user firstName
	object (DatesRangeRestriction) Filter on notification date
lastName	string Filter on user lastname
	object (ValuesRestrictionString) Filter on notification sender
quotaWarningCount	integer <int64> Filter on quota warning count
	object (ValuesRestrictionString) Filter on notification sender
	object (ValuesRestrictionUserStatus) Filter on status

Responses

Request samples

Payload

Content type

application/json

{"accessGroups": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"creationDate": {"after": "2019-08-24T14:15:22Z",
"before": "2019-08-24T14:15:22Z"
},
"email": "string",
"firstName": "string",
"lastConnection": {"after": "2019-08-24T14:15:22Z",
"before": "2019-08-24T14:15:22Z"
},
"lastName": "string",
"origins": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"quotaWarningCount": 0,
"roles": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"status": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["WAITING_ACCESS"
]
}
}

retrieveCurrentProjectUser

Authorizations:

REGARDS_OAUTH2

Responses

updateCurrentProjectUser

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json
required

accessGroups	Array of strings unique
created	string <date-time>
currentQuota	integer <int64>
email	string
firstName	string
id	integer <int64>
identifiable	boolean
lastConnection	string <date-time>
lastName	string
lastUpdate	string <date-time>
licenseAccepted	boolean
maxQuota	integer <int64>
	Array of objects (MetaData) unique
origin required	string
	Array of objects (ResourcesAccess)
	object (Role)
status required	string Enum: "WAITING_ACCESS" "ACCESS_DENIED" "ACCESS_GRANTED" "ACCESS_INACTIVE" "WAITING_ACCOUNT_ACTIVE" "WAITING_EMAIL_VERIFICATION"

Responses

Request samples

Payload

Content type

application/json

{"accessGroups": ["string"
],
"created": "2019-08-24T14:15:22Z",
"currentQuota": 0,
"email": "string",
"firstName": "string",
"id": 0,
"identifiable": true,
"lastConnection": "2019-08-24T14:15:22Z",
"lastName": "string",
"lastUpdate": "2019-08-24T14:15:22Z",
"licenseAccepted": true,
"maxQuota": 0,
"metadata": [{"id": 0,
"identifiable": true,
"key": "string",
"value": "string",
"visibility": "READABLE"
}
],
"origin": "string",
"permissions": [{"controllerSimpleName": "string",
"defaultRole": "INSTANCE_ADMIN",
"description": "string",
"id": 0,
"identifiable": true,
"microservice": "string",
"resource": "string",
"verb": "GET"
}
],
"role": {"authorizedAddresses": ["string"
],
"id": 0,
"identifiable": true,
"isDefault": true,
"isNative": true,
"name": "string",
"parentRole": { },
"permissions": [{"controllerSimpleName": "string",
"defaultRole": "INSTANCE_ADMIN",
"description": "string",
"id": 0,
"identifiable": true,
"microservice": "string",
"resource": "string",
"verb": "GET"
}
]
},
"status": "WAITING_ACCESS"
}

retrieveAccessRequestList

Authorizations:

REGARDS_OAUTH2

query Parameters

required

object (Pageable)

Responses

retrieveRoleProjectUsersList

Authorizations:

REGARDS_OAUTH2

query Parameters

required	object (Pageable)
role_name required	string

Responses

retrieveRoleProjectUserList

Authorizations:

REGARDS_OAUTH2

path Parameters

role_id

required

integer <int64>

query Parameters

required

object (Pageable)

Responses

Get users of the project

Return a page of users of the project matching according criterias.

Authorizations:

REGARDS_OAUTH2

query Parameters

required

object (Pageable)

Sorting and page configuration

Request Body schema: application/json
required

Set of search criterias.

	object (ValuesRestrictionString) Filter on notification sender
	object (DatesRangeRestriction) Filter on notification date
email	string Filter on user email
firstName	string Filter on user firstName
	object (DatesRangeRestriction) Filter on notification date
lastName	string Filter on user lastname
	object (ValuesRestrictionString) Filter on notification sender
quotaWarningCount	integer <int64> Filter on quota warning count
	object (ValuesRestrictionString) Filter on notification sender
	object (ValuesRestrictionUserStatus) Filter on status

Responses

Request samples

Payload

Content type

application/json

{"accessGroups": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"creationDate": {"after": "2019-08-24T14:15:22Z",
"before": "2019-08-24T14:15:22Z"
},
"email": "string",
"firstName": "string",
"lastConnection": {"after": "2019-08-24T14:15:22Z",
"before": "2019-08-24T14:15:22Z"
},
"lastName": "string",
"origins": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"quotaWarningCount": 0,
"roles": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["string"
]
},
"status": {"ignoreCase": true,
"matchMode": "STRICT",
"mode": "INCLUDE",
"values": ["WAITING_ACCESS"
]
}
}

removeProjectUser

Authorizations:

REGARDS_OAUTH2

path Parameters

user_id

required

integer <int64>

Responses

retrieveProjectUser

Authorizations:

REGARDS_OAUTH2

path Parameters

user_id

required

integer <int64>

Responses

updateProjectUser

Authorizations:

REGARDS_OAUTH2

path Parameters

user_id

required

integer <int64>

Request Body schema: application/json
required

accessGroups	Array of strings unique
created	string <date-time>
currentQuota	integer <int64>
email	string
firstName	string
id	integer <int64>
identifiable	boolean
lastConnection	string <date-time>
lastName	string
lastUpdate	string <date-time>
licenseAccepted	boolean
maxQuota	integer <int64>
	Array of objects (MetaData) unique
origin required	string
	Array of objects (ResourcesAccess)
	object (Role)
status required	string Enum: "WAITING_ACCESS" "ACCESS_DENIED" "ACCESS_GRANTED" "ACCESS_INACTIVE" "WAITING_ACCOUNT_ACTIVE" "WAITING_EMAIL_VERIFICATION"

Responses

Request samples

Payload

Content type

application/json

{"accessGroups": ["string"
],
"created": "2019-08-24T14:15:22Z",
"currentQuota": 0,
"email": "string",
"firstName": "string",
"id": 0,
"identifiable": true,
"lastConnection": "2019-08-24T14:15:22Z",
"lastName": "string",
"lastUpdate": "2019-08-24T14:15:22Z",
"licenseAccepted": true,
"maxQuota": 0,
"metadata": [{"id": 0,
"identifiable": true,
"key": "string",
"value": "string",
"visibility": "READABLE"
}
],
"origin": "string",
"permissions": [{"controllerSimpleName": "string",
"defaultRole": "INSTANCE_ADMIN",
"description": "string",
"id": 0,
"identifiable": true,
"microservice": "string",
"resource": "string",
"verb": "GET"
}
],
"role": {"authorizedAddresses": ["string"
],
"id": 0,
"identifiable": true,
"isDefault": true,
"isNative": true,
"name": "string",
"parentRole": { },
"permissions": [{"controllerSimpleName": "string",
"defaultRole": "INSTANCE_ADMIN",
"description": "string",
"id": 0,
"identifiable": true,
"microservice": "string",
"resource": "string",
"verb": "GET"
}
]
},
"status": "WAITING_ACCESS"
}

user-resource-controller

removeProjectUserResources

Authorizations:

REGARDS_OAUTH2

path Parameters

user_email

required

string

Responses

retrieveProjectUserResources

Authorizations:

REGARDS_OAUTH2

path Parameters

user_email

required

string

query Parameters

borrowedRoleName

string

Responses

updateProjectUserResources

Authorizations:

REGARDS_OAUTH2

path Parameters

user_email

required

string

Request Body schema: application/json
required

Array

controllerSimpleName required	string
defaultRole required	string Enum: "INSTANCE_ADMIN" "PROJECT_ADMIN" "EXPLOIT" "ADMIN" "REGISTERED_USER" "PUBLIC"
description	string
id	integer <int64>
identifiable	boolean
microservice required	string
resource required	string
verb required	string Enum: "GET" "HEAD" "POST" "PUT" "PATCH" "DELETE" "OPTIONS" "TRACE"

Responses

Request samples

Payload

Content type

application/json

[{"controllerSimpleName": "string",
"defaultRole": "INSTANCE_ADMIN",
"description": "string",
"id": 0,
"identifiable": true,
"microservice": "string",
"resource": "string",
"verb": "GET"
}
]

project-user-metadata-controller

removeProjectUserMetaData

Authorizations:

REGARDS_OAUTH2

path Parameters

user_id

required

integer <int64>

Responses

retrieveProjectUserMetaData

Authorizations:

REGARDS_OAUTH2

path Parameters

user_id

required

integer <int64>

Responses

Response samples

200

Content type

application/json

[{"content": {"id": 0,
"identifiable": true,
"key": "string",
"value": "string",
"visibility": "READABLE"
},
"links": [{"deprecation": "string",
"href": "string",
"hreflang": "string",
"media": "string",
"name": "string",
"profile": "string",
"rel": "string",
"title": "string",
"type": "string"
}
]
}
]

updateProjectUserMetaData

Authorizations:

REGARDS_OAUTH2

path Parameters

user_id

required

integer <int64>

Request Body schema: application/json
required

Array

id	integer <int64>
identifiable	boolean
key required	string
value	string
visibility	string Enum: "READABLE" "WRITEABLE" "HIDDEN"

Responses

Request samples

Payload

Content type

application/json

[{"id": 0,
"identifiable": true,
"key": "string",
"value": "string",
"visibility": "READABLE"
}
]

MICROSERVICE ADMIN (2.0.0)

registration-controller

requestAccess

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

requestExternalAccess

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

verifyEmail

Authorizations:

path Parameters

Responses

removeAccessRequest

Authorizations:

path Parameters

Responses

acceptAccessRequest

Authorizations:

path Parameters

Responses

activeAccess

Authorizations:

path Parameters

Responses

denyAccessRequest

Authorizations:

path Parameters

Responses

inactiveAccess

Authorizations:

path Parameters

Responses

license-controller

retrieveLicense

Authorizations:

Responses

acceptLicense

Authorizations:

Responses

resetLicense

Authorizations:

Responses

maintenance-controller

retrieveTenantsInMaintenance

Authorizations:

Responses

unSetMaintenance

Authorizations:

path Parameters

Responses

setMaintenance

Authorizations:

path Parameters

Responses

module-manager-controller

exportConfiguration

Authorizations:

Responses

importConfiguration

Authorizations:

Request Body schema: multipart/form-data

Responses

isConfigurationEnabled

Authorizations:

Responses

isReady

Authorizations:

Responses

isReadyEnabled

Authorizations:

Responses

restart

Authorizations:

Responses

isRestartEnabled

Authorizations:

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required