1/*! For license information please see fa6636c2.0fd329a5.js.LICENSE.txt */ 2(globalThis.webpackChunkregardsoss_github_io=globalThis.webpackChunkregardsoss_github_io||[]).push([[5420],{36935(e,t,s){"use strict";s.r(t),s.d(t,{assets:()=>m,contentTitle:()=>p,default:()=>d,frontMatter:()=>c,metadata:()=>r,toc:()=>u});const r=JSON.parse('{"id":"development/services/access-project/api-guides/rest/backend-access-project-api-swagger","title":"All endpoints (OpenAPI)","description":"","source":"@site/versioned_docs/version-2.1.0/development/services/access-project/api-guides/rest/api-swagger.mdx","sourceDirName":"development/services/access-project/api-guides/rest","slug":"/development/services/access-project/api-swagger","permalink":"/docs/2.1.0/development/services/access-project/api-swagger","draft":false,"unlisted":false,"editUrl":"https://github.com/RegardsOss/RegardsOss.github.io/edit/master/versioned_docs/version-2.1.0/development/services/access-project/api-guides/rest/api-swagger.mdx","tags":[],"version":"2.1.0","frontMatter":{"id":"backend-access-project-api-swagger","title":"All endpoints (OpenAPI)","sidebar_label":"All endpoints (OpenAPI)","slug":"/development/services/access-project/api-swagger","hide_title":true,"hide_table_of_contents":true},"sidebar":"dev","previous":{"title":"How it works","permalink":"/docs/2.1.0/development/services/access-project/conception"},"next":{"title":"Importation/Exportation","permalink":"/docs/2.1.0/development/services/access-project/import-export"}}');var n=s(74848),o=s(28453),i=s(96191);const a=JSON.parse('{"components":{"schemas":{"AccessRequestDto":{"properties":{"accessGroups":{"items":{"type":"string"},"type":"array","uniqueItems":true},"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"maxQuota":{"format":"int64","type":"integer"},"metadata":{"items":{"$ref":"#/components/schemas/MetaData"},"type":"array"},"origin":{"type":"string"},"originUrl":{"type":"string"},"password":{"type":"string"},"requestLink":{"type":"string"},"roleName":{"type":"string"}},"required":["email"],"type":"object"},"ConfigurationDTO":{"properties":{"configuration":{"type":"string"}},"type":"object"},"DatesRangeRestriction":{"description":"Filter on last connection date","properties":{"after":{"description":"Keep entities having date greater than","format":"date-time","type":"string"},"before":{"description":"Keep entities having date less than","format":"date-time","type":"string"}},"type":"object"},"DownloadQuotaLimitsDto":{"properties":{"email":{"type":"string"},"maxQuota":{"format":"int64","type":"integer"},"rateLimit":{"format":"int64","type":"integer"}},"type":"object"},"DynamicTenantSettingDto":{"properties":{"defaultValue":{"type":"object"},"description":{"type":"string"},"name":{"type":"string"},"value":{"type":"object"}},"type":"object"},"DynamicTenantSettingDtoObject":{"properties":{"defaultValue":{"type":"object"},"description":{"type":"string"},"name":{"type":"string"},"value":{"type":"object"}},"type":"object"},"EntityModelConfigurationDTO":{"properties":{"content":{"$ref":"#/components/schemas/ConfigurationDTO"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"}},"type":"object"},"EntityModelDynamicTenantSettingDtoObject":{"properties":{"content":{"$ref":"#/components/schemas/DynamicTenantSettingDtoObject"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"}},"type":"object"},"EntityModelLinkUIPluginsDatasets":{"properties":{"content":{"$ref":"#/components/schemas/LinkUIPluginsDatasets"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"}},"type":"object"},"EntityModelMapStringMaintenanceInfo":{"properties":{"content":{"additionalProperties":{"$ref":"#/components/schemas/MaintenanceInfo"},"type":"object"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"}},"type":"object"},"EntityModelModule":{"properties":{"content":{"$ref":"#/components/schemas/Module"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"}},"type":"object"},"EntityModelPluginServiceDto":{"properties":{"content":{"$ref":"#/components/schemas/PluginServiceDto"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"}},"type":"object"}
2,"EntityModelProjectUserReadDto":{"properties":{"content":{"$ref":"#/components/schemas/ProjectUserReadDto"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"}},"type":"object"},"EntityModelResourcesAccess":{"properties":{"content":{"$ref":"#/components/schemas/ResourcesAccess"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"}},"type":"object"},"EntityModelSearchHistoryDto":{"properties":{"content":{"$ref":"#/components/schemas/SearchHistoryDto"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"}},"type":"object"},"EntityModelTheme":{"properties":{"content":{"$ref":"#/components/schemas/Theme"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"}},"type":"object"},"EntityModelToponymDTO":{"properties":{"content":{"$ref":"#/components/schemas/ToponymDTO"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"}},"type":"object"},"EntityModelUILayout":{"properties":{"content":{"$ref":"#/components/schemas/UILayout"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"}},"type":"object"},"EntityModelUIPluginConfiguration":{"properties":{"content":{"$ref":"#/components/schemas/UIPluginConfiguration"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"}},"type":"object"},"EntityModelUIPluginDefinition":{"properties":{"content":{"$ref":"#/components/schemas/UIPluginDefinition"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"}},"type":"object"},"EntityModelVoid":{"properties":{"content":{"type":"object"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"}},"type":"object"},"GenericResponseBody":{"properties":{"message":{"type":"string"},"properties":{"additionalProperties":{"type":"object"},"type":"object"}},"type":"object"},"IGeometry":{"properties":{"crs":{"type":"string","writeOnly":true},"type":{"description":"Geometry object type","enum":["Unlocated","Point","MultiPoint","LineString","MultiLineString","Polygon","MultiPolygon","GeometryCollection"],"type":"string"}},"type":"object"},"JsonArray":{"properties":{"asBigDecimal":{"type":"number"},"asBigInteger":{"type":"integer"},"asBoolean":{"type":"boolean"},"asByte":{"format":"byte","type":"string"},"asCharacter":{"deprecated":true,"type":"string"},"asDouble":{"format":"double","type":"number"},"asFloat":{"format":"float","type":"number"},"asInt":{"format":"int32","type":"integer"},"asJsonArray":{"$ref":"#/components/schemas/JsonArray"},"asJsonNull":{"$ref":"#/components/schemas/JsonNull"},"asJsonObject":{"$ref":"#/components/schemas/JsonObject"},"asJsonPrimitive":{"$ref":"#/components/schemas/JsonPrimitive"},"asLong":{"format":"int64","type":"integer"},"asNumber":{"type":"number"},"asShort":{"format":"int32","type":"integer"},"asString":{"type":"string"},"empty":{"type":"boolean"},"jsonArray":{"type":"boolean"},"jsonNull":{"type":"boolean"},"jsonObject":{"type":"boolean"},"jsonPrimitive":{"type":"boolean"}},"type":"object"},"JsonNull":{"properties":{"asBigDecimal":{"type":"number"},"asBigInteger":{"type":"integer"},"asBoolean":{"type":"boolean"},"asByte":{"format":"byte","type":"string"},"asCharacter":{"deprecated":true,"type":"string"},"asDouble":{"format":"double","type":"number"},"asFloat":{"format":"float","type":"number"},"asInt":{"format":"int32","type":"integer"},"asJsonArray":{"$ref":"#/components/schemas/JsonArray"},"asJsonNull":{"$ref":"#/components/schemas/JsonNull"},"asJsonObject":{"$ref":"#/components/schemas/JsonObject"},"asJsonPrimitive":{"$ref":"#/components/schemas/JsonPrimitive"},"asLong":{"format":"int64","type":"integer"},"asNumber":{"type":"number"},"asShort":{"format":"int32","type":"integer"},"asString":{"type":"string"},"jsonArray":{"type":"boolean"},"jsonNull":{"type":"boolean"},"jsonObject":{"type":"boolean"},"jsonPrimitive":{"type":"boolean"}},"type":"object"},"JsonObject":{"properties":{"asBigDecimal":{"type":"number"},"asBigInteger":{"type":"integer"},"asBoolean":{"type":"boolean"},"asByte":{"format":"byte","type":"string"},"asCharacter":{"deprecated":true,"type":"string"},"asDouble":{"format":"double","type":"number"},"asFloat":{"format":"float","type":"number"},"asInt":{"format":"int32","type":"integer"},"asJsonArray":{"$ref":"#/components/schemas/JsonArray"},"asJsonNull":{"$ref":"#/components/schemas/JsonNull"},"asJsonObject":{"$ref":"#/components/schemas/JsonObject"},"asJsonPrimitive":{"$ref":"#/components/schemas/JsonPrimitive"},"asLong":{"format":"int64","type":"integer"},"asNumber":{"type":"number"},"asShort":{"format":"int32","type":"integer"},"asString":{"type":"string"},"empty":{"type":"boolean"},"jsonArray":{"type":"boolean"},"jsonNull":{"type":"boolean"},"jsonObject":{"type":"boolean"},"jsonPrimitive":{"type":"boolean"}},"type":"object"},"JsonPrimitive":{"properties":{"asBigDecimal":{"type":"number"},"asBigInteger":{"type":"integer"},"asBoolean":{"type":"boolean"},"asByte":{"format":"byte","type":"string"},"asCharacter":{"deprecated":true,"type":"string"},"asDouble":{"format":"double","type":"number"},"asFloat":{"format":"float","type":"number"},"asInt":{"format":"int32","type":"integer"},"asJsonArray":{"$ref":"#/components/schemas/JsonArray"},"asJsonNull":{"$ref":"#/components/schemas/JsonNull"},"asJsonObject":{"$ref":"#/components/schemas/JsonObject"},"asJsonPrimitive":{"$ref":"#/components/schemas/JsonPrimitive"},"asLong":{"format":"int64","type":"integer"},"asNumber":{"type":"number"},"asShort":{"format":"int32","type":"integer"},"asString":{"type":"string"},"boolean":{"type":"boolean"},"jsonArray":{"type":"boolean"},"jsonNull":{"type":"boolean"},"jsonObject":{"type":"boolean"},"jsonPrimitive":{"type":"boolean"},"number":{"type":"boolean"},"string":{"type":"boolean"}},"type":"object"},"Link":{"properties":{"deprecation":{"type":"string"},"href":{"type":"string"},"hreflang":{"type":"string"},"media":{"type":"string"},"name":{"type":"string"},"profile":{"type":"string"},"rel":{"type":"string"},"title":{"type":"string"},"type":{"type":"string"}},"type":"object"},"LinkUIPluginsDatasets":{"properties":{"datasetId":{"type":"string"},"services":{"items":{"$ref":"#/components/schemas/UIPluginConfiguration"},"type":"array"}},"type":"object"},"MaintenanceInfo":{"properties":{"active":{"type":"boolean"},"lastUpdate":{"format":"date-time","type":"string"}},"type":"object"},"MetaData":{"properties":{"id":{"format":"int64","type":"integer"},"identifiable":{"type":"boolean"},"key":{"type":"string"},"value":{"type":"string"},"visibility":{"enum":["READABLE","WRITEABLE","HIDDEN"],"type":"string"}},"required":["key"],"type":"object"},"Module":{"properties":{"active":{"type":"boolean"},"applicationId":{"type":"string"},"conf":{"type":"string"},"container":{"type":"string"},"description":{"type":"string"},"id":{"format":"int64","type":"integer"},"page":{"$ref":"#/components/schemas/UIPage"},"type":{"type":"string"}},"required":["active","applicationId","container","description","type"],"type":"object"},"ModuleImportReport":{"properties":{"importErrors":{"items":{"type":"string"},"type":"array","uniqueItems":true}
2,"moduleInformation":{"$ref":"#/components/schemas/ModuleInformation"},"onlyErrors":{"type":"boolean"}},"type":"object"},"ModuleInformation":{"properties":{"author":{"type":"string"},"description":{"type":"string"},"documentation":{"type":"string"},"id":{"type":"string"},"legalOwner":{"type":"string"},"name":{"type":"string"},"version":{"type":"string"}},"required":["author","id","name","version"],"type":"object"},"ModuleReadinessReportObject":{"properties":{"ready":{"type":"boolean"},"reasons":{"items":{"type":"string"},"type":"array"},"specifications":{"type":"object"}},"type":"object"},"ModuleRestartReport":{"properties":{"messages":{"items":{"type":"string"},"type":"array"},"moduleInformation":{"$ref":"#/components/schemas/ModuleInformation"}},"type":"object"},"MultiValueMapStringString":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"properties":{"all":{"additionalProperties":{"type":"string"},"type":"object","writeOnly":true},"empty":{"type":"boolean"}},"type":"object"},"PageMetadata":{"properties":{"number":{"format":"int64","type":"integer"},"size":{"format":"int64","type":"integer"},"totalElements":{"format":"int64","type":"integer"},"totalPages":{"format":"int64","type":"integer"}},"type":"object"},"Pageable":{"properties":{"page":{"format":"int32","minimum":0,"type":"integer"},"size":{"format":"int32","minimum":1,"type":"integer"},"sort":{"items":{"type":"string"},"type":"array"}},"type":"object"},"PagedModelEntityModelModule":{"properties":{"content":{"items":{"$ref":"#/components/schemas/EntityModelModule"},"type":"array"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"},"page":{"$ref":"#/components/schemas/PageMetadata"}},"type":"object"},"PagedModelEntityModelProjectUserReadDto":{"properties":{"content":{"items":{"$ref":"#/components/schemas/EntityModelProjectUserReadDto"},"type":"array"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"},"page":{"$ref":"#/components/schemas/PageMetadata"}},"type":"object"},"PagedModelEntityModelSearchHistoryDto":{"properties":{"content":{"items":{"$ref":"#/components/schemas/EntityModelSearchHistoryDto"},"type":"array"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"},"page":{"$ref":"#/components/schemas/PageMetadata"}},"type":"object"},"PagedModelEntityModelTheme":{"properties":{"content":{"items":{"$ref":"#/components/schemas/EntityModelTheme"},"type":"array"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"},"page":{"$ref":"#/components/schemas/PageMetadata"}},"type":"object"},"PagedModelEntityModelUIPluginConfiguration":{"properties":{"content":{"items":{"$ref":"#/components/schemas/EntityModelUIPluginConfiguration"},"type":"array"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"},"page":{"$ref":"#/components/schemas/PageMetadata"}},"type":"object"},"PagedModelEntityModelUIPluginDefinition":{"properties":{"content":{"items":{"$ref":"#/components/schemas/EntityModelUIPluginDefinition"},"type":"array"},"links":{"items":{"$ref":"#/components/schemas/Link"},"type":"array"},"page":{"$ref":"#/components/schemas/PageMetadata"}},"type":"object"},"PluginServiceDto":{"properties":{"applicationModes":{"items":{"enum":["ONE","MANY"],"type":"string"},"type":"array","uniqueItems":true},"configId":{"type":"string"},"entityTypes":{"items":{"enum":["COLLECTION","DATA","DATASET"],"type":"string"},"type":"array","uniqueItems":true},"iconUrl":{"type":"string"},"label":{"type":"string"},"type":{"enum":["UI","CATALOG"],"type":"string"}},"type":"object"},"ProjectUserCreateDto":{"properties":{"accessGroups":{"items":{"type":"string"},"type":"array","uniqueItems":true},"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"maxQuota":{"format":"int64","type":"integer"},"metadata":{"items":{"$ref":"#/components/schemas/MetaData"},"type":"array"},"originUrl":{"type":"string"},"password":{"type":"string"},"permissions":{"items":{"$ref":"#/components/schemas/ResourcesAccess"},"type":"array"},"rateLimit":{"format":"int64","type":"integer"},"requestLink":{"type":"string"},"roleName":{"type":"string"}},"type":"object"},"ProjectUserReadDto":{"properties":{"accessGroups":{"items":{"type":"string"},"type":"array","uniqueItems":true},"created":{"format":"date-time","type":"string"},"currentQuota":{"format":"int64","type":"integer"},"currentRate":{"format":"int64","type":"integer"},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"format":"int64","type":"integer"},"lastConnection":{"format":"date-time","type":"string"},"lastName":{"type":"string"},"lastUpdate":{"format":"date-time","type":"string"},"licenseAccepted":{"type":"boolean"},"maxQuota":{"format":"int64","type":"integer"}
2,"metadata":{"items":{"$ref":"#/components/schemas/MetaData"},"type":"array"},"origin":{"type":"string"},"permissions":{"items":{"$ref":"#/components/schemas/ResourcesAccess"},"type":"array"},"rateLimit":{"format":"int64","type":"integer"},"role":{"$ref":"#/components/schemas/Role"},"status":{"enum":["WAITING_ACCESS","ACCESS_DENIED","ACCESS_GRANTED","ACCESS_INACTIVE","WAITING_ACCOUNT_ACTIVE"],"type":"string"}},"type":"object"},"ProjectUserUpdateDto":{"properties":{"accessGroups":{"items":{"type":"string"},"type":"array","uniqueItems":true},"email":{"type":"string"},"firstName":{"type":"string"},"id":{"format":"int64","type":"integer"},"lastName":{"type":"string"},"maxQuota":{"format":"int64","type":"integer"},"metadata":{"items":{"$ref":"#/components/schemas/MetaData"},"type":"array"},"permissions":{"items":{"$ref":"#/components/schemas/ResourcesAccess"},"type":"array"},"rateLimit":{"format":"int64","type":"integer"},"role":{"$ref":"#/components/schemas/Role"}},"type":"object"},"RecipientDto":{"properties":{"businessId":{"description":"Recipient business identifier","type":"string"},"description":{"description":"Recipient description","type":"string"},"recipientLabel":{"description":"Recipient label","type":"string"}},"type":"object"},"ResourceAccess":{"type":"object"},"ResourceMapping":{"properties":{"autorizedRoles":{"items":{"$ref":"#/components/schemas/RoleAuthority"},"type":"array"},"controllerSimpleName":{"type":"string"},"fullPath":{"type":"string"},"method":{"enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS","TRACE"],"type":"string"},"resourceAccess":{"$ref":"#/components/schemas/ResourceAccess"},"resourceMappingId":{"type":"string"}},"type":"object"},"ResourcesAccess":{"properties":{"controllerSimpleName":{"type":"string"},"defaultRole":{"enum":["INSTANCE_ADMIN","PROJECT_ADMIN","EXPLOIT","ADMIN","REGISTERED_USER","PUBLIC"],"type":"string"},"description":{"type":"string"},"id":{"format":"int64","type":"integer"},"identifiable":{"type":"boolean"},"microservice":{"type":"string"},"resource":{"type":"string"},"verb":{"enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS","TRACE"],"type":"string"}},"required":["controllerSimpleName","defaultRole","microservice","resource","verb"],"type":"object"},"Role":{"properties":{"authorizedAddresses":{"items":{"type":"string"},"type":"array"},"id":{"format":"int64","type":"integer"},"identifiable":{"type":"boolean"},"isDefault":{"type":"boolean"},"isNative":{"type":"boolean"},"name":{"type":"string"},"parentRole":{"$ref":"#/components/schemas/Role"},"permissions":{"items":{"$ref":"#/components/schemas/ResourcesAccess"},"type":"array","uniqueItems":true}},"required":["name"],"type":"object"},"RoleAuthority":{"properties":{"authority":{"type":"string"},"authorizedIpAdresses":{"items":{"type":"string"},"type":"array"},"roleName":{"type":"string"}},"type":"object"},"SearchHistoryDto":{"properties":{"configuration":{"description":"Configuration of the search history element.","type":"string"}
2,"id":{"description":"Identifier to track the search history element.","format":"int64","type":"integer"},"name":{"description":"Name of the search history element.","type":"string"}},"required":["configuration","name"],"type":"object"},"SearchProjectUserParameters":{"properties":{"accessGroups":{"$ref":"#/components/schemas/ValuesRestrictionString"},"creationDate":{"$ref":"#/components/schemas/DatesRangeRestriction"},"email":{"description":"Filter on user email","type":"string"},"firstName":{"description":"Filter on user firstName","type":"string"},"lastConnection":{"$ref":"#/components/schemas/DatesRangeRestriction"},"lastName":{"description":"Filter on user lastname","type":"string"},"origins":{"$ref":"#/components/schemas/ValuesRestrictionString"},"quotaWarningCount":{"description":"Filter on quota warning count","format":"int64","type":"integer"},"roles":{"$ref":"#/components/schemas/ValuesRestrictionString"},"status":{"$ref":"#/components/schemas/ValuesRestrictionUserStatus"}},"type":"object"},"Theme":{"properties":{"active":{"type":"boolean"},"configuration":{"type":"string"},"id":{"format":"int64","type":"integer"},"name":{"type":"string"},"visible":{"type":"boolean"}},"required":["configuration","name"],"type":"object"},"ToponymDTO":{"properties":{"boundingBox":{"type":"string"},"businessId":{"type":"string"},"copyright":{"type":"string"},"description":{"type":"string"},"geometry":{"$ref":"#/components/schemas/IGeometry"},"labelEn":{"type":"string"},"labelFr":{"type":"string"},"toponymMetadata":{"$ref":"#/components/schemas/ToponymMetadata"},"visible":{"type":"boolean"}},"type":"object"},"ToponymGeoJsonDTO":{"properties":{"toponym":{"type":"string"}},"type":"object"},"ToponymMetadata":{"properties":{"author":{"type":"string"},"creationDate":{"format":"date-time","type":"string"},"expirationDate":{"format":"date-time","type":"string"},"project":{"type":"string"}},"type":"object"},"UILayout":{"properties":{"applicationId":{"type":"string"},"id":{"format":"int64","type":"integer"},"layout":{"type":"string"}},"required":["applicationId","layout"],"type":"object"},"UIPage":{"properties":{"customIconURL":{"type":"string"},"home":{"type":"boolean"},"iconType":{"type":"string"},"title":{"type":"string"}},"type":"object"},"UIPluginConfiguration":{"properties":{"active":{"type":"boolean"},"conf":{"type":"string"},"id":{"format":"int64","type":"integer"},"label":{"type":"string"},"linkedToAllEntities":{"type":"boolean"},"pluginDefinition":{"$ref":"#/components/schemas/UIPluginDefinition"}},"required":["active","label","linkedToAllEntities","pluginDefinition"],"type":"object"},"UIPluginDefinition":{"properties":{"applicationModes":{"items":{"enum":["ONE","MANY"],"type":"string"},"type":"array","uniqueItems":true},"entityTypes":{"items":{"enum":["COLLECTION","DATA","DATASET"],"type":"string"},"type":"array","uniqueItems":true},"iconUrl":{"type":"string"},"id":{"format":"int64","type":"integer"},"name":{"type":"string"},"roleName":{"type":"string"},"sourcePath":{"type":"string"},"type":{"enum":["CRITERIA","SERVICE"],"type":"string"}},"required":["applicationModes","entityTypes","name","sourcePath","type"],"type":"object"},"UserCurrentQuotasDto":{"properties":{"currentQuota":{"format":"int64","type":"integer"},"currentRate":{"format":"int64","type":"integer"},"email":{"type":"string"},"maxQuota":{"format":"int64","type":"integer"},"rateLimit":{"format":"int64","type":"integer"}},"type":"object"},"ValuesRestrictionString":{"description":"Filter on access groups","properties":{"ignoreCase":{"description":"Only available for String resitrctions. Allow if true, to search values ignoring case. Default false","type":"boolean"},"matchMode":{"description":"Match mode to use, can be STRICT|STARTS_WITH|CONTAINS|ENDS_WITH (default STRICT)","enum":["STRICT","STARTS_WITH","CONTAINS","ENDS_WITH"],"type":"string"},"mode":{"description":"Restriction mode to use","enum":["INCLUDE","EXCLUDE"],"type":"string"},"values":{"description":"List of accepted or refused values (according to the mode)","items":{"description":"List of accepted or refused values (according to the mode)","type":"string"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["mode","values"],"type":"object"},"ValuesRestrictionUserStatus":{"description":"Filter on status","properties":{"ignoreCase":{"description":"Only available for String resitrctions. Allow if true, to search values ignoring case. Default false","type":"boolean"},"matchMode":{"description":"Match mode to use, can be STRICT|STARTS_WITH|CONTAINS|ENDS_WITH (default STRICT)","enum":["STRICT","STARTS_WITH","CONTAINS","ENDS_WITH"],"type":"string"},"mode":{"description":"Restriction mode to use","enum":["INCLUDE","EXCLUDE"],"type":"string"},"values":{"description":"List of accepted or refused values (according to the mode)","items":{"description":"List of accepted or refused values (according to the mode)","enum":["WAITING_ACCESS","ACCESS_DENIED","ACCESS_GRANTED","ACCESS_INACTIVE","WAITING_ACCOUNT_ACTIVE"],"type":"string"},"maxItems":1000,"minItems":0,"type":"array"}},"required":["mode","values"],"type":"object"}},"securitySchemes":{"REGARDS_OAUTH2":{"flows":{"password":{"scopes":{},"tokenUrl":"https://regardsoss.github.io/api/v1/rs-authentication/oauth/token"}},"type":"oauth2"}}},"info":{"description":"Configuration for project GUI","license":{"name":"GPL-3.0"},"title":"MICROSERVICE ACCESS","version":"2.2.0"},"openapi":"3.0.1","paths":{"/accesses":{"post":{"description":"Request a new access, i.e. the creation of a new project user","operationId":"requestAccess","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRequestDto"}}},"required":true},"responses":{"201":{"description":"Returns the status"}},"summary":"Request a new access","tags":["Registration controller"]}},"/accesses/external":{"post":{"description":"Request a new access, i.e. create a new project user with external authentication system","o
2perationId":"requestExternalAccess","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessRequestDto"}}},"required":true},"responses":{"201":{"description":"Returns the status"}},"summary":"Request a new access","tags":["Registration controller"]}},"/accesses/settings":{"get":{"description":"Retrieves the settings managing the access requests","operationId":"retrieveAccessSettings","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/EntityModelDynamicTenantSettingDtoObject"},"type":"array"}}},"description":"Returns the settings managing the access requests"}},"summary":"Retrieves the settings","tags":["Access settings controller"]}},"/accesses/settings/{name}":{"put":{"description":"Update the setting managing the access requests","operationId":"updateAccessSettings","parameters":[{"in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DynamicTenantSettingDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelDynamicTenantSettingDtoObject"}}},"description":"Returns the setting managing the access requests"}},"summary":"Update the settings","tags":["Access settings controller"]}},"/accesses/{access_id}":{"delete":{"operationId":"removeAccessRequest","parameters":[{"in":"path","name":"access_id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"description":"OK"}},"tags":["Registration controller"]}},"/accesses/{access_id}/accept":{"put":{"description":"Accept the access request with the given access identifier","operationId":"acceptAccessRequest","parameters":[{"in":"path","name":"access_id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"description":"OK"}},"summary":"Accept the access request","tags":["Registration controller"]}},"/accesses/{access_id}/active":{"put":{"description":"Activate an inactive user with the given access identifier","operationId":"activeAccess","parameters":[{"in":"path","name":"access_id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"description":"OK"}},"summary":"Activate an inactive user","tags":["Registration controller"]}},"/accesses/{access_id}/deny":{"put":{"description":"Deny the access request with the given access identifier","operationId":"denyAccessRequest","parameters":[{"in":"path","name":"access_id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"description":"OK"}},"summary":"Deny the access request","tags":["Registration controller"]}},"/accesses/{access_id}/inactive":{"put":{"description":"Deactivate access for the given project user","operationId":"inactiveAccess","parameters":[{"in":"path","name":"access_id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"description":"OK"}},"summary":"Deactivate an active user","tags":["Registration controller"]}},"/applications/{applicationId}/modules":{"get":{"description":"Retrieve UI modules for a given application.","operationId":"retrieveModules","parameters":[{"in":"path","name":"applicationId","required":true,"schema":{"type":"string"}},{"in":"query","name":"active","required":false,"schema":{"type":"string"}},{"in":"query","name":"type","required":false,"schema":{"type":"string"}},{"in":"query","name":"pageable","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelEntityModelModule"}}},"description":"Returns UI modules"}},"summary":"Retrieve UI modules","tags":["IHM Module controller"]},"post":{"description":"Save a new UI module for a given application","operationId":"saveModule","parameters":[{"in":"path","name":"applicationId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Module"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelModule"}}},"description":"Returns the saved module"}},"summary":"Register an UI module","tags":["IHM Module controller"]}},"/applications/{applicationId}/modules/{moduleId}":{"delete":{"description":"Delete an UI module by its identifier for a given application","operationId":"deleteModule","parameters":[{"in":"path","name":"applicationId","required":true,"schema":{"type":"string"}},{"in":"path","name":"moduleId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelVoid"}}},"description":"Returns the status"}},"summary":"Delete an UI module","tags":["IHM Module controller"]},"get":{"description":"Retrieve an UI module for a given application.","operationId":"retrieveModule","parameters":[{"in":"path","name":"applicationId","required":true,"schema":{"type":"string"}},{"in":"path","name":"moduleId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelModule"}}},"description":"Returns the IHM module"}},"summary":"Retrieve IHM module","tags":["IHM Module controller"]},"put":{"description":"Update an UI module by its identifier for a given application","operationId":"updateModule","parameters":[{"in":"path","name":"applicationId","required":true,"schema":{"type":"string"}},{"in":"path","name":"moduleId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/
2Module"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelModule"}}},"description":"Returns the updated UI module"}},"summary":"Update a UI module","tags":["IHM Module controller"]}},"/attribute/cache":{"delete":{"operationId":"refreshAttributeCache","responses":{"200":{"description":"OK"}},"tags":["attribute-cache-refresh-controller"]}},"/collections/search":{"get":{"description":"Perform an OpenSearch request on collections. Injects applicable UI Services and Catalog Services.","operationId":"searchCollections","parameters":[{"in":"query","name":"allParams","required":true,"schema":{"$ref":"#/components/schemas/MultiValueMapStringString"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/JsonObject"}}},"description":"Data in JSON format"}},"summary":"Search collections from catalogue","tags":["Access search controller"]}},"/configuration/{applicationId}":{"get":{"description":"Retrieve the UI configuration for the given application identifier","operationId":"retrieveConfiguration","parameters":[{"in":"path","name":"applicationId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelConfigurationDTO"}}},"description":"Returns the UI configuration"}},"summary":"Get the UI configuration","tags":["UI configuration controller"]},"post":{"description":"Add a new UI configuration","operationId":"addConfiguration","parameters":[{"in":"path","name":"applicationId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationDTO"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelConfigurationDTO"}}},"description":"Returns the created UI configuration"}},"summary":"Register a new UI configuration","tags":["UI configuration controller"]},"put":{"description":"Update an UI configuration","operationId":"updateConfiguration","parameters":[{"in":"path","name":"applicationId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigurationDTO"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelConfigurationDTO"}}},"description":"Returns the updated UI configuration"}},"summary":"Update an UI configuration","tags":["UI configuration controller"]}},"/dataobjects/datasets/search":{"get":{"description":"Perform an joined OpenSearch request. The search will be performed on dataobjects attributes, but will return the associated datasets. Injects applicable UI Services and Catalog Services.","operationId":"searchDataobjectsReturnDatasets","parameters":[{"in":"query","name":"allParams","required":true,"schema":{"$ref":"#/components/schemas/MultiValueMapStringString"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/JsonObject"}}},"description":"Data in JSON format"}},"summary":"Search for catalogue datasets using data objects criteria","tags":["Access search controller"]}},"/dataobjects/search":{"get":{"description":"Perform an OpenSearch request on dataobjects. Only return required facets. Injects applicable UI Services and Catalog Services.","operationId":"searchDataobjects","parameters":[{"in":"query","name":"allParams","required":true,"schema":{"$ref":"#/components/schemas/MultiValueMapStringString"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/JsonObject"}}},"description":"Data in JSON format"}},"summary":"Search products from catalogue","tags":["Access search controller"]}},"/datasets/search":{"get":{"description":"Perform an OpenSearch request on datasets. Injects applicable UI Services and Catalog Services.","operationId":"searchDatasets","parameters":[{"in":"query","name":"allParams","required":true,"schema":{"$ref":"#/components/schemas/MultiValueMapStringString"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/JsonObject"}}},"description":"Data in JSON format"}},"summary":"Search datasets from catalogue","tags":["Access search controller"]}},"/history":{"get":{"description":"Retrieve search history page using account email and module id","operationId":"retrieveSearchHistory","parameters":[{"in":"query","name":"accountEmail","required":true,"schema":{"type":"string"}},{"in":"query","name":"moduleId","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"query","name":"pageable","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PagedModelEntityModelSearchHistoryDto"}}},"description":"Search history page was successfully retrieved. Returns SearchHistoryDto page"},"403":{"content":{"application/html":{}},"description":"The endpoint is not accessible for the user."}},"summary":"Retrieve search history page","tags":["Search history controller"]},"post":{"description":"Create and save a search history from a search history dto, an account email and a module id","operationId":"createSearchHistory","parameters":[{"in":"query","name":"accountEmail","required":true,"schema":{"type":"string"}},{"in":"query","name":"moduleId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchHistoryDto"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntityModelSearchHistoryDto"}}},"description":"The searh history element was successfully saved. Returns SearchHistoryDto."},"403":{"content":{"application/html":{}},"description":"The endpoint is not accessible for the user."},"422":{"content":{"application/json":{}},"description":"The search history dto syntax is incorrect."}},"summary":"Create a search history element.","tags":["Search history controller"]}},"/history/{searchHistoryId}":{"delete":{"description":"Delete search history element using its id.","operationId":"deleteSearchHistory","parameters":[{"in":"path","name":"searchHistoryId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntityModelVoid"}}},"description":"The searh history element was successfully deleted"},"403":{"content":{"application/html":{}},"description":"The endpoint is not accessible for the user."}},"summary":"Delete a search history element.","tags":["Search history controller"]},"put":{"description":"Update search history element using its id.","operationId":"updateSearchHistory","parameters":[{"in":"path","name":"searchHistoryId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"Search history config to be processed","required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntityModelSearchHistoryDto"}}},"description":"The searh history element was successfully updated. Returns SearchHistoryDto."},"403":{"content":{"application/html":{}},"description":"The endpoint is not accessible for the user."}},"summary":"Update a search history element.","tags":["Search history controller"]}},"/layouts/{applicationId}":{"get":{"description":"Retrieve UI layout configuration for the given application identifier","operationId":"retrieveUILayout","parameters":[{"in":"path","name":"applicationId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelUILayout"}}},"description":"Returns the UI layout configuration"}},"summary":"Get an UI layout configuration","tags":["UI layout controller"]},"put":{"description":"Update the UI layout configuration for the given application identifier","operationId":"updateUILayout","parameters":[{"in":"path","name":"applicationId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UILayout"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelUILayout"}}},"description":"Returns the updated UI layout configuration"}},"summary":"Update an UI layout configuration","tags":["UI layout controller"]}},"/linkuiplugindataset/{datasetId}":{"get":{"operationId":"retrieveLink","parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntityModelLinkUIPluginsDatasets"}}},"description":"OK"}},"tags":["link-ui-plugins-datasets-controller"]},"put":{"operationId":"updateLink","parameters":[{"in":"path","name":"datasetId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkUIPluginsDatasets"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntityModelLinkUIPluginsDatasets"}}},"description":"OK"}},"tags":["link-ui-plugins-datasets-controller"]}},"/maintenance":{"get":{"operationId":"retrieveTenantsInMaintenance","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntityModelMapStringMaintenanceInfo"}}},"description":"OK"}},"tags":["maintenance-controller"]}},"/maintenance/{tenant}/disable":{"put":{"operationId":"unSetMaintenance","parameters":[{"in":"path","name":"tenant","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntityModelVoid"}}},"description":"OK"}},"tags":["maintenance-controller"]}},"/maintenance/{tenant}/enable":{"put":{"operationId":"setMaintenance","parameters":[{"in":"path","name":"tenant","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntityModelVoid"}}},"description":"OK"}},"tags":["maintenance-controller"]}},"/microservice/configuration":{"get":{"operationId":"exportConfiguration","responses":{"200":{"description":"OK"}},"tags":["module-manager-controller"]},"post":{"operationId":"importConfiguration","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"format":"binary","type":"string"}},"required":["file"],"type":"object"}}}},"responses":{"200":{"content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/
2ModuleImportReport"},"type":"array","uniqueItems":true}}},"description":"OK"}},"tags":["module-manager-controller"]}},"/microservice/configuration/enabled":{"get":{"operationId":"isConfigurationEnabled","responses":{"200":{"description":"OK"}},"tags":["module-manager-controller"]}},"/microservice/ready":{"get":{"operationId":"isReady","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ModuleReadinessReportObject"}}},"description":"OK"}},"tags":["module-manager-controller"]}},"/microservice/ready/enabled":{"get":{"operationId":"isReadyEnabled","responses":{"200":{"description":"OK"}},"tags":["module-manager-controller"]}},"/microservice/restart":{"get":{"operationId":"restart","responses":{"200":{"content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/ModuleRestartReport"},"type":"array","uniqueItems":true}}},"description":"OK"}},"tags":["module-manager-controller"]}},"/microservice/restart/enabled":{"get":{"operationId":"isRestartEnabled","responses":{"200":{"description":"OK"}},"tags":["module-manager-controller"]}},"/quota":{"get":{"operationId":"getQuotaLimits","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DownloadQuotaLimitsDto"}}},"description":"OK"}},"tags":["Storage download quota controller"]}},"/quota/current":{"get":{"operationId":"getCurrentQuotas","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserCurrentQuotasDto"}}},"description":"OK"}},"tags":["Storage download quota controller"]}},"/quota/{user_email}":{"get":{"operationId":"getQuotaLimits_1","parameters":[{"in":"path","name":"user_email","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DownloadQuotaLimitsDto"}}},"description":"OK"}},"tags":["Storage download quota controller"]},"put":{"operationId":"upsertQuotaLimits","parameters":[{"in":"path","name":"user_email","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadQuotaLimitsDto"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/DownloadQuotaLimitsDto"}}},"description":"OK"}},"tags":["Storage download quota controller"]}},"/recipients":{"get":{"description":"List all recipient if missing parameter, or only recipients enabling the direct notification or only them not enabling the direct notification","operationId":"findRecipients","parameters":[{"description":"Recipient enable or not the direct notification","in":"query","name":"directNotificationEnabled","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/RecipientDto"},"type":"array","uniqueItems":true}}},"description":"List of recipients"}},"summary":"List all recipient","tags":["Recipient controller"]}},"/regards/{tenant}/datasource/status":{"get":{"operationId":"getDataSourceStatus","parameters":[{"in":"path","name":"tenant","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericResponseBody"}}},"description":"OK"}},"tags":["jpa-multitenant-controller"]}},"/regards/{tenant}/datasource/test":{"get":{"operationId":"testTenantConnection","parameters":[{"in":"path","name":"tenant","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenericResponseBody"}}},"description":"OK"}},"tags":["jpa-multitenant-controller"]}},"/search":{"get":{"description":"Perform an OpenSearch request on all indexed data, regardless of the type. The return objects can be any mix of collection, dataset, dataobject and document. Injects applicable UI Services and Catalog Services.","operationId":"searchAll","responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/JsonObject"}}},"description":"Data in JSON format"}},"summary":"Search products, datasets and collections from catalogue","tags":["Access search controller"]}},"/security/resources":{"get":{"operationId":"getAllResources","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResourceMapping"},"type":"array"}}},"description":"OK"}},"tags":["security-resources-controller"]}},"/services":{"get":{"operationId":"retrieveServices","parameters":[{"in":"query","name":"dataset_id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/EntityModelUIPluginConfiguration"},"type":"array"}}},"description":"OK"}},"tags":["ui-plugin-service-controller"]}},"/services/aggregated":{"get":{"operationId":"retrieveServices_1","parameters":[{"in":"query","name":"datasetIpIds","required":false,"schema":{"items":{"type":"string"},"type":"array"}},{"in":"query","name":"applicationModes","required":false,"schema":{"items":{"enum":["ONE","MANY"],"type":"string"},"type":"array"}}],"responses":{"200":{"content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/EntityModelPluginServiceDto"},"type":"array"}}},"description":"OK"}},"tags":["services-aggregator-controller"]}},"/shutdown/immediate":{"post":{"operationId":"immediateShutdown","responses":{"200":{"description":"OK"}},"tags":["manager-controller"]}},"/themes":{"get":{"description":"Return a page of HMI themes","operationId":"retrieveThemes","parameters":[{"in":"query","name":"pageable","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelEntityModelTheme"}}},"description":"All HMI themes were retrieved."}},"summary":"Get HMI themes","tags":["Theme controller"]}
2,"post":{"description":"Save a new UI theme","operationId":"saveTheme","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Theme"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelTheme"}}},"description":"Return the new UI theme"}},"summary":"Register UI theme","tags":["Theme controller"]}},"/themes/{themeId}":{"delete":{"description":"Delete an UI theme by its identifier","operationId":"deleteTheme","parameters":[{"in":"path","name":"themeId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelVoid"}}},"description":"Return the status"}},"summary":"Delete UI theme","tags":["Theme controller"]},"get":{"description":"Retrieve an UI theme by its identifier","operationId":"retrieveTheme","parameters":[{"in":"path","name":"themeId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelTheme"}}},"description":"Returns the UI theme"}},"summary":"Get an UI theme","tags":["Theme controller"]},"put":{"description":"Update an UI theme","operationId":"updateTheme","parameters":[{"in":"path","name":"themeId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Theme"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelTheme"}}},"description":"Return the updated UI theme"}},"summary":"Update UI theme","tags":["Theme controller"]}},"/toponyms":{"post":{"description":"Endpoint to add a not visible toponym.","operationId":"createNotVisibleToponym","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ToponymGeoJsonDTO"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelToponymDTO"}}},"description":"Returns the created toponym"}},"summary":"Register a toponym","tags":["Toponyms controller"]}},"/toponyms/search":{"get":{"description":"Search for toponyms. Geometries are not retrieved and list content is limited to 100 entities.","operationId":"search","parameters":[{"in":"query","name":"partialLabel","required":false,"schema":{"type":"string"}},{"in":"query","name":"locale","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/EntityModelToponymDTO"},"type":"array"}}},"description":"Returns the list of toponyms"}},"summary":"Search toponyms","tags":["Toponyms controller"]}},"/toponyms/{businessId}":{"get":{"description":"Retrieve one toponym by its identifier","operationId":"get","parameters":[{"in":"path","name":"businessId","required":true,"schema":{"type":"string"}},{"in":"query","name":"simplified","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelToponymDTO"}}},"description":"Returns the toponym"}},"summary":"Get toponym","tags":["Toponyms controller"]}},"/uiplugins/configurations":{"get":{"operationId":"retrievePluginConfigurations","parameters":[{"in":"query","name":"isActive","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"isLinkedToAllEntities","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"type","required":false,"schema":{"enum":["CRITERIA","SERVICE"],"type":"string"}},{"in":"query","name":"pageable","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PagedModelEntityModelUIPluginConfiguration"}}},"description":"OK"}},"tags":["ui-plugin-configuration-controller"]},"post":{"operationId":"createPluginConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UIPluginConfiguration"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntityModelUIPluginConfiguration"}}},"description":"OK"}},"tags":["ui-plugin-configuration-controller"]}},"/uiplugins/configurations/{pluginConfId}":{"delete":{"operationId":"deletePluginConfiguration","parameters":[{"in":"path","name":"pluginConfId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntityModelVoid"}}},"description":"OK"}},"tags":["ui-plugin-configuration-controller"]},"get":{"operationId":"retrievePluginConfiguration","parameters":[{"in":"path","name":"pluginConfId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntityModelUIPluginConfiguration"}}},"description":"OK"}},"tags":["ui-plugin-configuration-controller"]},"put":{"operationId":"updatePluginConfiguration","parameters":[{"in":"path","name":"pluginConfId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UIPluginConfiguration"}}},"required":true},"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EntityModelUIPluginConfiguration"}}},"description":"OK"}},"tags":["ui-plugin-configuration-controller"]}},"/uiplugins/definition":{"get":{"description":"Return a page of UI Plugin definitions","operationId":"retrievePlugins","parameters":[{"in":"query","name":"type","required":false,"schema":{"enum":["CRITERIA","SERVICE"],"type":"string"}},{"in":"query","name":"pageable","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelEntityModelUIPluginDefinition"}}},"description":"All IHM plugins were retrieved."}},"summary":"Get UI Plugin definitions","tags":["ui-plugin-definition-controller"]},"post":{"operationId":"savePlugin","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UIPluginDefinition"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelUIPluginDefinition"}}},"description":"OK"}},"tags":["ui-plugin-definition-controller"]}},"/uiplugins/definition/{pluginId}":{"delete":{"operationId":"deletePlugin","parameters":[{"in":"path","name":"pluginId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelVoid"}}},"description":"OK"}},"tags":["ui-plugin-definition-controller"]},"get":{"operationId":"retrievePlugin","parameters":[{"in":"path","name":"pluginId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelUIPluginDefinition"}}},"description":"OK"}},"tags":["ui-plugin-definition-controller"]},"put":{"operationId":"updatePlugin","parameters":[{"in":"path","name":"pluginId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UIPluginDefinition"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelUIPluginDefinition"}}},"description":"OK"}},"tags":["ui-plugin-definition-controller"]}},"/uiplugins/{pluginId}/configurations":{"get":{"operationId":"retrievePluginConfigurationsByPlugin","parameters":[{"in":"path","name":"pluginId","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"query","name":"isActive","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"isLinkedToAllEntities","required":false,"schema":{"type":"boolean"}},{"in":"query","name":"pageable","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}}],"responses":{"200":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PagedModelEntityModelUIPluginConfiguration"}}},"description":"OK"}},"tags":["ui-plugin-configuration-controller"]}},"/users":{"post":{"description":"Create a project user by bypassing the registration process (Administrator feature)","operationId":"createUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectUserCreateDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelProjectUserReadDto"}}},"description":"Returns the created project user"}},"summary":"Create a project user","tags":["Project users controller"]}},"/users/email/{user_email}":{"get":{"description":"Retrieve the project user metadata by its emaila","operationId":"retrieveProjectUserByEmail","parameters":[{"in":"path","name":"user_email","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelProjectUserReadDto"}}},"description":"Returns the project user"}},"summary":"Get the project user","tags":["Project users controller"]}},"/users/email/{user_email}/admin":{"get":{"description":"Check if the user with the given email has administrator role","operationId":"isAdmin","parameters":[{"in":"path","name":"user_email","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"boolean"}}},"description":"True if the user has an administrator role, false otherwise"}},"summary":"Check the role of user","tags":["Project users controller"]}},"/users/myuser":{"get":{"description":"Retrieve the current authenticated project user metadata","operationId":"retrieveCurrentProjectUser","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelProjectUserReadDto"}}},"description":"Returns the current authenticated project user"}},"summary":"Get the current project user metadata","tags":["Project users controller"]},"put":{"description":"Update the currently authenticated project user","operationId":"updateCurrentProjectUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectUserUpdateDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelProjectUserReadDto"}}},"description":"Returns the currently authenticated project user"}},"summary":"Update the current project user","tags":["Project users controller"]}},"/users/pendingaccesses":{"get":{"description":"Retrieve a page containing a list of users with a pending access request","operationId":"retrieveAccessRequestList","parameters":[{"in":"query","name":"pageable","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelEntityModelProjectUserReadDto"}}},"description":"All users of the project with a pending access request were retrieved."}},"summary":"Get a list of users","tags":["Project users controller"]}},"/users/roles":{"get":{"description":"Retrieve a page containing the list of project users with the specified role name or a parent role","operationId":"retrieveRoleProjectUsersList","parameters":[{"in":"query","name":"role_name","required":true,"schema":{"type":"string"}},{"in":"query","name":"pageable","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelEntityModelProjectUserReadDto"}}},"description":"Returns the list of project users"}},"summary":"Get the list of project users","tags":["Project users controller"]}},"/users/roles/{role_id}":{"get":{"description":"Retrieve a page of project users with the specified role identifier or a parent role","operationId":"retrieveRoleProjectUserList","parameters":[{"in":"path","name":"role_id","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"query","name":"pageable","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelEntityModelProjectUserReadDto"}}},"description":"Returns the list of project users with the specified role or a parent role"}},"summary":"Get the list of project users","tags":["Project users controller"]}},"/users/search":{"post":{"description":"Return a page of users of the project matching criterias.","operationId":"retrieveProjectUserList","parameters":[{"description":"Sorting and page configuration","in":"query","name":"pageable","required":true,"schema":{"$ref":"#/components/schemas/Pageable"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchProjectUserParameters"}}},"description":"Set of search criterias.","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedModelEntityModelProjectUserReadDto"}}},"description":"All users of the project were retrieved."}},"summary":"Get users of the project","tags":["Project users controller"]}},"/users/{user_email}/resources":{"delete":{"operationId":"removeProjectUserResources","parameters":[{"in":"path","name":"user_email","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"}},"tags":["User resource controller"]},"get":{"operationId":"retrieveProjectUserResources","parameters":[{"in":"path","name":"user_email","required":true,"schema":{"type":"string"}},{"in":"query","name":"borrowedRoleName","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"*/*":{"schema":{"items":{"$ref":"#/components/schemas/EntityModelResourcesAccess"},"type":"array"}}},"description":"OK"}},"tags":["User resource controller"]},"put":{"operationId":"updateProjectUserResources","parameters":[{"in":"path","name":"user_email","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ResourcesAccess"},"type":"array"}}},"required":true},"responses":{"200":{"description":"OK"}},"tags":["User resource controller"]}},"/users/{user_id}":{"delete":{"description":"Delete the project user with the given identifier","operationId":"removeProjectUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"description":"OK"}},"summary":"Delete the project user","tags":["Project users controller"]},"get":{"description":"Retrieve the project user metadata by its identifier","operationId":"retrieveProjectUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelProjectUserReadDto"}}},"description":"The user metadata were retrieved."}},"summary":"Get a project user","tags":["Project users controller"]},"put":{"description":"Update the project user with the given identifier","operationId":"updateProjectUser","parameters":[{"in":"path","name":"user_id","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectUserUpdateDto"}}},"required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityModelProjectUserReadDto"}}},"description":"Return the updated project user"}},"summary":"Update the project user","tags":["Project users controller"]}}},"security":[{"REGARDS_OAUTH2":[]}],"servers":[{"description":"Generated server url","url":"https://regardsoss.github.io/api/v1/rs-access-project"}]}'),c={id:"backend-access-project-api-swagger",title:"All endpoints (OpenAPI)",sidebar_label:"All endpoints (OpenAPI)",slug:"/development/services/access-project/api-swagger",hide_title:!0,hide_table_of_contents:!0},p=void 0,m={},u=[];function l(e){return(0,n.jsx)(i.A,{spec:a})}function d(e={}){const{wrapper:t}={...(0,o.R)(),...e.components};return t?(0,n.jsx)(t,{...e,children:(0,n.jsx)(l,{...e})}):l()}},96191(e,t,s){"use strict";s.d(t,{A:()=>q});var r=s(96540),n=s(2151);function o(e){var t,s,r="";if(
2"string"==typeof e||"number"==typeof e)r+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;t<e.length;t++)e[t]&&(s=o(e[t]))&&(r&&(r+=" "),r+=s);else for(t in e)e[t]&&(r&&(r+=" "),r+=t);return r}const i=function(){for(var e,t,s=0,r="";s<arguments.length;)(e=arguments[s++])&&(t=o(e))&&(r&&(r+=" "),r+=t);return r};s(38193).default.canUseDOM&&(window.Prism=window.Prism||{},window.Prism.manual=!0);var a=s(28794),c=s(92303),p=s(66588),m=s(95293),u=s(55364),l=s.n(u);function d(e="theme-redoc",t){const s=(0,c.A)(),n="dark"===(0,m.G)().colorMode,o=(0,p.kh)("docusaurus-theme-redoc",{failfast:!0}),i=(0,p.P_)("docusaurus-theme-redoc",e)||Object.values(o)[0];return(0,r.useMemo)(()=>{const{lightTheme:e,darkTheme:r,options:o}=i,a={scrollYOffset:s||"string"!=typeof o.scrollYOffset?o.scrollYOffset:0},c=l()({...o,...a,theme:e},t),p=l()({...o,...a,theme:r},t);return{options:s&&n?p:c,darkThemeOptions:p,lightThemeOptions:c}},[s,n,i,t])}var y=s(63427),g=s(86025);let h=null;var f=s(74848);function I(e){return(0,f.jsx)("div",{className:"redocusaurus-styles"})}function b(e,t,s=""){t.forEach(t=>{if(e.collectAnchor(t.id),""!=s){const r=t.id.replace(`${s}/`,"");e.collectAnchor(r)}t.items.length>0&&b(e,t.items,t.id)})}const j=function(e){const{className:t,optionsOverrides:s,...n}=e,{store:o,darkThemeOptions:p,lightThemeOptions:u,hasLogo:l}=function({spec:e,url:t,themeId:s,normalizeUrl:n},o){const i=d(s,o),p=(0,g.Ay)(t,{absolute:!0}),u=n?p:t,l=(0,c.A)(),y="dark"===(0,m.G)().colorMode,f=(0,r.useMemo)(()=>(null!==h&&l&&h.dispose(),h=new a.AppStore(e,u,i.options),{...i,hasLogo:!!e.info?.["x-logo"],store:h}),[l,e,u,i]);return(0,r.useEffect)(()=>{f.store.onDidMount()},[f,l,y]),f}(n,s);return b((0,y.A)(),o.menu.items),(0,f.jsxs)(f.Fragment,{children:[(0,f.jsx)(I,{specProps:n,lightThemeOptions:u,darkThemeOptions:p}),(0,f.jsx)("div",{className:i(["redocusaurus",l&&"redocusaurus-has-logo",t]),children:(0,f.jsx)(a.Redoc,{store:o})})]})};const q=function(e){const t={...(0,n.A)(e.id,e.spec),...e},{spec:s,className:r,isSpecFile:o=null!=s,url:c,themeId:p,optionsOverrides:m}=t,{options:u}=d(p,m);return null!=s&&!0?(0,f.jsx)(j,{...t,spec:s}):(0,f.jsx)("div",{className:i(["redocusaurus",r]),children:(0,f.jsx)(a.RedocStandalone,{specUrl:c,options:u})})}},26903(){},14834(){},20922(){},32413(){}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.