• registration-controller
  • postrequestAccess
  • postrequestExternalAccess
  • getverifyEmail
  • delremoveAccessRequest
  • putacceptAccessRequest
  • putactiveAccess
  • putdenyAccessRequest
  • putinactiveAccess
• license-controller
  • getretrieveLicense
  • putacceptLicense
  • putresetLicense
• maintenance-controller
  • getretrieveTenantsInMaintenance
  • putunSetMaintenance
  • putsetMaintenance
• module-manager-controller
  • getexportConfiguration
  • postimportConfiguration
  • getisConfigurationEnabled
  • getisReady
  • getisReadyEnabled
  • getrestart
  • getisRestartEnabled
• notification-controller
  • getretrieveNotifications
  • postcreateNotification
  • putmarkAllNotificationAsRead
  • putmarkAllNotificationAsUnread
  • deldeleteNotification_1
  • getretrieveNotificationSettings
  • putupdateNotificationSettings
  • getsummary
  • deldeleteNotification
  • getretrieveNotification
  • putsetNotificationRead
  • putsetNotificationUnRead
• jpa-multitenant-controller
  • getgetDataSourceStatus
  • gettestTenantConnection
• resource-controller
  • getgetAllResourceAccesses
  • getgetResourceAccess
  • putupdateResourceAccess
• microservice-resource-controller
  • getgetAllResourceAccessesByMicroservice
  • postregisterMicroserviceEndpoints
  • getretrieveMicroserviceControllers
  • getretrieveMicroserviceControllerEndpoints
• role-controller
  • getGet roles
  • postcreateRole
  • getgetBorrowableRoles
  • getshouldAccessToResourceRequiring
  • getgetRolesAccesingResource
  • delremoveRole
  • getretrieveRole
  • putupdateRole
  • getretrieveRoleAscendants
  • getretrieveRoleDescendants
• role-resource-controller
  • getgetRoleResources
  • postaddRoleResource
  • getgetRoleResourcesForMicroservice
  • deldeleteRoleResource
• security-resources-controller
  • getgetAllResources
• session-manager-controller
  • getgetSessions
  • getgetSessionNames
  • deldeleteSession
  • getgetSessionById
• dynamic-tenant-setting-controller
  • getretrieveAll
  • delreset
  • putupdate
• manager-controller
  • postimmediateShutdown
• source-manager-controller
  • getgetSources
  • getgetSourcesNames
  • deldeleteSource
• project-users-controller
  • postcreateUser
  • getgetUserCountByAccessGroup
  • getretrieveProjectUserByEmail
  • getisAdmin
  • postlinkAccessGroups
  • putupdateOrigin
  • getsendVerificationEmail
  • postexportAsCSV
  • getretrieveCurrentProjectUser
  • putupdateCurrentProjectUser
  • getretrieveAccessRequestList
  • getretrieveRoleProjectUsersList
  • getretrieveRoleProjectUserList
  • postGet users of the project
  • delremoveProjectUser
  • getretrieveProjectUser
  • putupdateProjectUser
• user-resource-controller
  • delremoveProjectUserResources
  • getretrieveProjectUserResources
  • putupdateProjectUserResources
• project-user-metadata-controller
  • delremoveProjectUserMetaData
  • getretrieveProjectUserMetaData
  • putupdateProjectUserMetaData

API docs by Redocly

MICROSERVICE ADMIN (1.13.0)

Download OpenAPI specification:Download

License: GPL-3.0

System management and configuration

registration-controller

requestAccess

Generated server url

/api/v1/rs-admin/accesses

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

Generated server url

/api/v1/rs-admin/accesses/external

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

Generated server url

/api/v1/rs-admin/accesses/verifyEmail/{token}

Authorizations:

REGARDS_OAUTH2

path Parameters

token required

string

Responses

removeAccessRequest

Generated server url

/api/v1/rs-admin/accesses/{access_id}

Authorizations:

REGARDS_OAUTH2

path Parameters

access_id required

integer <int64>

Responses

acceptAccessRequest

Generated server url

/api/v1/rs-admin/accesses/{access_id}/accept

Authorizations:

REGARDS_OAUTH2

path Parameters

access_id required

integer <int64>

Responses

activeAccess

Generated server url

/api/v1/rs-admin/accesses/{access_id}/active

Authorizations:

REGARDS_OAUTH2

path Parameters

access_id required

integer <int64>

Responses

denyAccessRequest

Generated server url

/api/v1/rs-admin/accesses/{access_id}/deny

Authorizations:

REGARDS_OAUTH2

path Parameters

access_id required

integer <int64>

Responses

inactiveAccess

Generated server url

/api/v1/rs-admin/accesses/{access_id}/inactive

Authorizations:

REGARDS_OAUTH2

path Parameters

access_id required

integer <int64>

Responses

license-controller

retrieveLicense

Generated server url

/api/v1/rs-admin/license

Authorizations:

REGARDS_OAUTH2

Responses

acceptLicense

Generated server url

/api/v1/rs-admin/license

Authorizations:

REGARDS_OAUTH2

Responses

resetLicense

Generated server url

/api/v1/rs-admin/license/reset

Authorizations:

REGARDS_OAUTH2

Responses

maintenance-controller

retrieveTenantsInMaintenance

Generated server url

/api/v1/rs-admin/maintenance

Authorizations:

REGARDS_OAUTH2

Responses

unSetMaintenance

Generated server url

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

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

setMaintenance

Generated server url

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

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

module-manager-controller

exportConfiguration

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Responses

importConfiguration

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Request Body schema: multipart/form-data

file required

string <binary>

Responses

isConfigurationEnabled

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Responses

isReady

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Responses

isReadyEnabled

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Responses

restart

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Responses

isRestartEnabled

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Responses

notification-controller

retrieveNotifications

Generated server url

/api/v1/rs-admin/notifications

Authorizations:

REGARDS_OAUTH2

query Parameters

required	object (Pageable)
state	string Enum: "READ" "UNREAD"

Responses

createNotification

Generated server url

/api/v1/rs-admin/notifications

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

level	string Enum: "INFO" "WARNING" "ERROR" "FATAL"
message	string
	object (MimeType)
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": {

  • "charset": "string",
  • "concrete": true,
  • "parameters": {

    • "property1": "string",
    • "property2": "string"

    },
  • "subtype": "string",
  • "subtypeSuffix": "string",
  • "type": "string",
  • "wildcardSubtype": true,
  • "wildcardType": true

  },
• "projectUserRecipients": [

  • "string"

  ],
• "roleRecipients": [

  • "string"

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

}

markAllNotificationAsRead

Generated server url

/api/v1/rs-admin/notifications/all/read

Authorizations:

REGARDS_OAUTH2

Responses

markAllNotificationAsUnread

Generated server url

/api/v1/rs-admin/notifications/all/unread

Authorizations:

REGARDS_OAUTH2

Responses

deleteNotification_1

Generated server url

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

Authorizations:

REGARDS_OAUTH2

Responses

retrieveNotificationSettings

Generated server url

/api/v1/rs-admin/notifications/settings

Authorizations:

REGARDS_OAUTH2

Responses

updateNotificationSettings

Generated server url

/api/v1/rs-admin/notifications/settings

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

Generated server url

/api/v1/rs-admin/notifications/summary

Authorizations:

REGARDS_OAUTH2

Responses

deleteNotification

Generated server url

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

Authorizations:

REGARDS_OAUTH2

path Parameters

notification_id required

integer <int64>

Responses

retrieveNotification

Generated server url

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

Authorizations:

REGARDS_OAUTH2

path Parameters

notification_id required

integer <int64>

Responses

setNotificationRead

Generated server url

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

Authorizations:

REGARDS_OAUTH2

path Parameters

notification_id required

integer <int64>

Responses

setNotificationUnRead

Generated server url

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

Authorizations:

REGARDS_OAUTH2

path Parameters

notification_id required

integer <int64>

Responses

jpa-multitenant-controller

getDataSourceStatus

Generated server url

/api/v1/rs-admin/regards/{tenant}/datasource/status

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

Response samples

• 200

Content type

application/json;charset=UTF-8

{

• "message": "string",
• "properties": {

  • "property1": { },
  • "property2": { }

  }

}

testTenantConnection

Generated server url

/api/v1/rs-admin/regards/{tenant}/datasource/test

Authorizations:

REGARDS_OAUTH2

path Parameters

tenant required

string

Responses

Response samples

• 200

Content type

application/json;charset=UTF-8

{

• "message": "string",
• "properties": {

  • "property1": { },
  • "property2": { }

  }

}

resource-controller

getAllResourceAccesses

Generated server url

/api/v1/rs-admin/resources

Authorizations:

REGARDS_OAUTH2

query Parameters

required

object (Pageable)

Responses

getResourceAccess

Generated server url

/api/v1/rs-admin/resources/{resource_id}

Authorizations:

REGARDS_OAUTH2

path Parameters

resource_id required

integer <int64>

Responses

updateResourceAccess

Generated server url

/api/v1/rs-admin/resources/{resource_id}

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

Generated server url

/api/v1/rs-admin/resources/microservices/{microservicename}

Authorizations:

REGARDS_OAUTH2

path Parameters

microservicename required

string

query Parameters

required

object (Pageable)

Responses

registerMicroserviceEndpoints

Generated server url

/api/v1/rs-admin/resources/microservices/{microservicename}

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

Generated server url

/api/v1/rs-admin/resources/microservices/{microservicename}/controllers

Authorizations:

REGARDS_OAUTH2

path Parameters

microservicename required

string

Responses

retrieveMicroserviceControllerEndpoints

Generated server url

/api/v1/rs-admin/resources/microservices/{microservicename}/controllers/{controllername}

Authorizations:

REGARDS_OAUTH2

path Parameters

controllername required	string
microservicename required	string

Responses

role-controller

Get roles

Generated server url

/api/v1/rs-admin/roles

Return a list of roles

Authorizations:

REGARDS_OAUTH2

Responses

createRole

Generated server url

/api/v1/rs-admin/roles

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

Generated server url

/api/v1/rs-admin/roles/borrowables

Authorizations:

REGARDS_OAUTH2

Responses

shouldAccessToResourceRequiring

Generated server url

/api/v1/rs-admin/roles/include/{role_name}

Authorizations:

REGARDS_OAUTH2

path Parameters

role_name required

string

Responses

getRolesAccesingResource

Generated server url

/api/v1/rs-admin/roles/resources/{resourceId}

Authorizations:

REGARDS_OAUTH2

path Parameters

resourceId required

integer <int64>

Responses

removeRole

Generated server url

/api/v1/rs-admin/roles/{role_name}

Authorizations:

REGARDS_OAUTH2

path Parameters

role_name required

string

Responses

retrieveRole

Generated server url

/api/v1/rs-admin/roles/{role_name}

Authorizations:

REGARDS_OAUTH2

path Parameters

role_name required

string

Responses

updateRole

Generated server url

/api/v1/rs-admin/roles/{role_name}

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

Generated server url

/api/v1/rs-admin/roles/{role_name}/ascendants

Authorizations:

REGARDS_OAUTH2

path Parameters

role_name required

string

Responses

retrieveRoleDescendants

Generated server url

/api/v1/rs-admin/roles/{role_name}/descendants

Authorizations:

REGARDS_OAUTH2

path Parameters

role_name required

string

Responses

role-resource-controller

getRoleResources

Generated server url

/api/v1/rs-admin/roles/{role_name}/resources

Authorizations:

REGARDS_OAUTH2

path Parameters

role_name required

string

Responses

addRoleResource

Generated server url

/api/v1/rs-admin/roles/{role_name}/resources

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

Generated server url

/api/v1/rs-admin/roles/{role_name}/resources/{microservice}

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

Generated server url

/api/v1/rs-admin/roles/{role_name}/resources/{resources_access_id}

Authorizations:

REGARDS_OAUTH2

path Parameters

resources_access_id required	integer <int64>
role_name required	string

Responses

security-resources-controller

getAllResources

Generated server url

/api/v1/rs-admin/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"

  }

]

session-manager-controller

getSessions

Generated server url

/api/v1/rs-admin/sessions

Authorizations:

REGARDS_OAUTH2

query Parameters

required	object (Pageable)
sessionName	string
sessionState	string
sourceName	string

Responses

getSessionNames

Generated server url

/api/v1/rs-admin/sessions/names

Authorizations:

REGARDS_OAUTH2

query Parameters

name

string

Responses

deleteSession

Generated server url

/api/v1/rs-admin/sessions/{id}

Authorizations:

REGARDS_OAUTH2

path Parameters

id required

integer <int64>

Responses

getSessionById

Generated server url

/api/v1/rs-admin/sessions/{id}

Authorizations:

REGARDS_OAUTH2

path Parameters

id required

integer <int64>

Responses

dynamic-tenant-setting-controller

retrieveAll

Generated server url

/api/v1/rs-admin/settings

Authorizations:

REGARDS_OAUTH2

query Parameters

names

Array of strings unique

Responses

reset

Generated server url

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

Authorizations:

REGARDS_OAUTH2

path Parameters

name required

string

Responses

update

Generated server url

/api/v1/rs-admin/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/shutdown/immediate

Authorizations:

REGARDS_OAUTH2

Responses

source-manager-controller

getSources

Generated server url

/api/v1/rs-admin/sources

Authorizations:

REGARDS_OAUTH2

query Parameters

required	object (Pageable)
sourceName	string
sourceState	string

Responses

getSourcesNames

Generated server url

/api/v1/rs-admin/sources/names

Authorizations:

REGARDS_OAUTH2

query Parameters

name

string

Responses

deleteSource

Generated server url

/api/v1/rs-admin/sources/{name}

Authorizations:

REGARDS_OAUTH2

path Parameters

name required

string

Responses

project-users-controller

createUser

Generated server url

/api/v1/rs-admin/users

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

Generated server url

/api/v1/rs-admin/users/count

Authorizations:

REGARDS_OAUTH2

Responses

retrieveProjectUserByEmail

Generated server url

/api/v1/rs-admin/users/email/{email}

Authorizations:

REGARDS_OAUTH2

path Parameters

email required

string

Responses

isAdmin

Generated server url

/api/v1/rs-admin/users/email/{email}/admin

Authorizations:

REGARDS_OAUTH2

path Parameters

email required

string

Responses

linkAccessGroups

Generated server url

/api/v1/rs-admin/users/email/{email}/groups

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

Generated server url

/api/v1/rs-admin/users/email/{email}/origin/{origin}

Authorizations:

REGARDS_OAUTH2

path Parameters

email required	string
origin required	string

Responses

sendVerificationEmail

Generated server url

/api/v1/rs-admin/users/email/{email}/verification/resend

Authorizations:

REGARDS_OAUTH2

path Parameters

email required

string

Responses

exportAsCSV

Generated server url

/api/v1/rs-admin/users/export

Authorizations:

REGARDS_OAUTH2

Request Body schema: application/json

required

	object (ValuesRestrictionString) Filter on access groups
	object (DatesRangeRestriction) Filter on last connection date
email	string Filter on user email
firstName	string Filter on user firstName
	object (DatesRangeRestriction) Filter on last connection date
lastName	string Filter on user lastname
	object (ValuesRestrictionString) Filter on access groups
quotaWarningCount	integer <int64> Filter on quota warning count
	object (ValuesRestrictionString) Filter on access groups
	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

Generated server url

/api/v1/rs-admin/users/myuser

Authorizations:

REGARDS_OAUTH2

Responses

updateCurrentProjectUser

Generated server url

/api/v1/rs-admin/users/myuser

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

Generated server url

/api/v1/rs-admin/users/pendingaccesses

Authorizations:

REGARDS_OAUTH2

query Parameters

required

object (Pageable)

Responses

retrieveRoleProjectUsersList

Generated server url

/api/v1/rs-admin/users/roles

Authorizations:

REGARDS_OAUTH2

query Parameters

required	object (Pageable)
role_name required	string

Responses

retrieveRoleProjectUserList

Generated server url

/api/v1/rs-admin/users/roles/{role_id}

Authorizations:

REGARDS_OAUTH2

path Parameters

role_id required

integer <int64>

query Parameters

required

object (Pageable)

Responses

Get users of the project

Generated server url

/api/v1/rs-admin/users/search

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 access groups
	object (DatesRangeRestriction) Filter on last connection date
email	string Filter on user email
firstName	string Filter on user firstName
	object (DatesRangeRestriction) Filter on last connection date
lastName	string Filter on user lastname
	object (ValuesRestrictionString) Filter on access groups
quotaWarningCount	integer <int64> Filter on quota warning count
	object (ValuesRestrictionString) Filter on access groups
	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

Generated server url

/api/v1/rs-admin/users/{user_id}

Authorizations:

REGARDS_OAUTH2

path Parameters

user_id required

integer <int64>

Responses

retrieveProjectUser

Generated server url

/api/v1/rs-admin/users/{user_id}

Authorizations:

REGARDS_OAUTH2

path Parameters

user_id required

integer <int64>

Responses

updateProjectUser

Generated server url

/api/v1/rs-admin/users/{user_id}

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

Generated server url

/api/v1/rs-admin/users/{user_email}/resources

Authorizations:

REGARDS_OAUTH2

path Parameters

user_email required

string

Responses

retrieveProjectUserResources

Generated server url

/api/v1/rs-admin/users/{user_email}/resources

Authorizations:

REGARDS_OAUTH2

path Parameters

user_email required

string

query Parameters

borrowedRoleName

string

Responses

updateProjectUserResources

Generated server url

/api/v1/rs-admin/users/{user_email}/resources

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

Generated server url

/api/v1/rs-admin/users/{user_id}/metadatas

Authorizations:

REGARDS_OAUTH2

path Parameters

user_id required

integer <int64>

Responses

retrieveProjectUserMetaData

Generated server url

/api/v1/rs-admin/users/{user_id}/metadatas

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

Generated server url

/api/v1/rs-admin/users/{user_id}/metadatas

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"

  }

]