{ "openapi": "3.0.4", "info": { "title": "Fenergo Nebula Authorization Query", "description": "**Authorization Query API**:\n\n
Authorization Command API provides methods related to the user authorization. Use the Authorization Command API to create and manage teams and user-team assignments. Use the Query API to retrieve Team aggregates, Access Layers and user profiles.\n\n
**Authorization Query API provides**:
", "version": "1.0" }, "servers": [ { "url": "/authorizationquery" } ], "paths": { "/api/access-layer": { "get": { "tags": [ "AccessLayer" ], "summary": "Get access layers", "description": "\nReturns all existing access layers.

Required permissions:
Following permissions are required: SecurityConfigAccess", "operationId": "GetAllAccessLayers", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of access layers is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessLayerDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } }, "deprecated": true } }, "/api/access-layer/{id}": { "get": { "tags": [ "AccessLayer" ], "summary": "Get access layer by id", "description": "\nReturns the access layer for a given id.

Required permissions:
Following permissions are required: SecurityConfigAccess", "operationId": "GetAccessLayer", "parameters": [ { "name": "id", "in": "path", "description": "Access layer id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Access layer is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessLayerDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Access layer with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/access-layer/{id}/users": { "get": { "tags": [ "AccessLayer" ], "summary": "Get users with given access layer assigned", "description": "\nReturns the list of user ids (upper cased) assigned to the access layer.

Required permissions:
Following permissions are required: SecurityConfigAccess", "operationId": "GetAccessLayerUsers", "parameters": [ { "name": "id", "in": "path", "description": "Access layer Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list user ids is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/access-layer/configuration": { "get": { "tags": [ "AccessLayer" ], "summary": "Get access layers configuration", "description": "\nReturns access layers-related configuration options.", "operationId": "GetAccessLayersConfiguration", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The configuration options", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessLayersConfigurationDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/dynamic-configuration": { "get": { "tags": [ "DynamicConfiguration" ], "summary": "Get dynamic configurations", "description": "\nReturns existing dynamic configurations.

Required permissions:
Following permissions are required: SecurityConfigAccess", "operationId": "GetDynamicConfigurationsPage", "parameters": [ { "name": "PageSize", "in": "query", "description": "Size of the page (result set)", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "description": "Size of the page (result set)", "format": "int32", "example": 100 }, "example": 100 }, { "name": "PaginationToken", "in": "query", "description": "Position token for the search results to start\n(leave empty to start from the 1st item)", "schema": { "type": "string", "description": "Position token for the search results to start\n(leave empty to start from the 1st item)", "nullable": true, "example": null }, "example": null }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The page of access layers is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynamicConfigurationPageDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/dynamic-configuration/{id}": { "get": { "tags": [ "DynamicConfiguration" ], "summary": "Get dynamic configuration by id", "description": "\nReturns the dynamic configuration for a given id.

Required permissions:
Following permissions are required: SecurityConfigAccess", "operationId": "GetDynamicConfigurationById", "parameters": [ { "name": "id", "in": "path", "description": "Dynamic configuration id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Dynamic configuration is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DynamicConfigurationDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Access layer with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/reference-data": { "get": { "tags": [ "ReferenceData" ], "summary": "Get reference data", "description": "\nReturns all authorization related reference data.", "operationId": "GetReferenceData", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The reference data is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceDataDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/reference-data/users": { "get": { "tags": [ "ReferenceData" ], "summary": "Get users names", "description": "", "operationId": "GetUsersNames", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of users names is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserNameDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/reference-data/teams": { "get": { "tags": [ "ReferenceData" ], "summary": "Get teams names", "description": "\nReturns all existing teams names.", "operationId": "GetTeamsNames", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of teams names is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamNameDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/reference-data/team/{id}": { "get": { "tags": [ "ReferenceData" ], "summary": "Get team with users by id", "description": "\nReturns the team for a given id.", "operationId": "GetTeamWithUsersById", "parameters": [ { "name": "id", "in": "path", "description": "Team id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Team is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamWithUsersDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Team with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/reference-data/access-layers": { "get": { "tags": [ "ReferenceData" ], "summary": "Get access layers light", "description": "\nReturns all existing access layers light.", "operationId": "GetAccessLayersLight", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of access layers is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessLayerLightReferenceDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/related-party-access-layers-inheritance-configuration": { "get": { "tags": [ "RelatedPartyAccessLayersInheritanceConfiguration" ], "summary": "Get access layers inheritance configuration", "description": "\nReturns access layers-related inheritance configuration options.

Required permissions:
Following permissions are required: SecurityConfigAccess", "operationId": "GetRelatedPartyAccessLayersInheritanceConfiguration", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The configuration options", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetConfigurationByTenantIdResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/team": { "get": { "tags": [ "Team" ], "summary": "Get teams", "description": "\nReturns all existing teams.", "operationId": "GetAllTeams", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of teams is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } }, "deprecated": true } }, "/api/team/{id}": { "get": { "tags": [ "Team" ], "summary": "Get team by id", "description": "\nReturns the team for a given id.

Required permissions:
Following permissions are required: SecurityConfigAccess", "operationId": "GetTeam", "parameters": [ { "name": "id", "in": "path", "description": "Team id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. Team is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. Team with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/team/{id}/users": { "get": { "tags": [ "Team" ], "summary": "Get user teams", "description": "\nReturns the list of user ids (upper cased) assigned to the team.

Required permissions:
Following permissions are required: SecurityConfigAccess", "operationId": "GetTeamUsers", "parameters": [ { "name": "id", "in": "path", "description": "Team Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list user ids is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/user": { "get": { "tags": [ "User" ], "summary": "Get users", "description": "

Required permissions:
At least one of the following permissions is required: UserAdministration, SecurityConfigAccess", "operationId": "GetAllUsers", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. The list of users is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDtoIEnumerableServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/user/{id}/profile": { "get": { "tags": [ "User" ], "summary": "Get user by id", "description": "

Required permissions:
Following permissions are required: UserAdministration", "operationId": "GetUserById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. User is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. User with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/user/authorization-profile": { "get": { "tags": [ "User" ], "summary": "Get current user authorization profile", "description": "\nReturns current user authorization profile. The user id is read from JWT token (sub property).", "operationId": "GetCurrentUserAuthorizationProfile", "parameters": [ { "name": "includeTeamDefinitions", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeAccessLayersDefinitions", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeUsername", "in": "query", "schema": { "type": "boolean" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. User authorization profile is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAuthorizationProfileDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/user/{id}/authorization-profile": { "get": { "tags": [ "User" ], "summary": "Get current user authorization profile by user id", "description": "\nReturns current user authorization profile for given user id.

Required permissions:
Following permissions are required: UserAdministration", "operationId": "GetUserAuthorizationProfileById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "includeTeamDefinitions", "in": "query", "schema": { "type": "boolean" } }, { "name": "includeAccessLayersDefinitions", "in": "query", "schema": { "type": "boolean" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. User authorization profile is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAuthorizationProfileDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/user/{id}/extended-profile": { "get": { "tags": [ "User" ], "summary": "Get user extended profile by id", "description": "

Required permissions:
Following permissions are required: UserAdministration", "operationId": "GetUserExtendedProfileById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "Success. User is returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserExtendedProfileDtoServiceResponse" } } } }, "400": { "description": "Bad request. The request has missing/invalid values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found. User with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal server exception. Please, contact your provider.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": null, "messages": [ { "message": "Internal server exception. Please, contact your provider.", "type": "Error", "errorCode": "INTERNAL_SERVER_ERROR" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } } }, "components": { "schemas": { "AccessLayerDataTypeDto": { "enum": [ "Field", "DataGroup", "Entity", "Journey", "Document", "Search", "Product", "ProductField" ], "type": "string" }, "AccessLayerDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the team", "format": "uuid", "example": "e4ec4810-6386-4610-a605-0d636f393daf" }, "name": { "type": "string", "description": "Name of the access layer\nThe value is calculated based on dataKey, type and dataType fields", "nullable": true, "example": "Private Banking - Business Related - Search" }, "dataKey": { "type": "string", "description": "Data key of the access layer", "nullable": true, "example": "PrivateBanking" }, "label": { "type": "string", "description": "Label of the access layer", "nullable": true, "example": "Private Banking" }, "description": { "type": "string", "description": "Description of the access layer", "nullable": true, "example": "Business related access layer for entities" }, "type": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerTypeDto" } ], "description": "Type of the access layer", "example": "Business Related" }, "dataType": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDataTypeDto" } ], "description": "Data type of the access layer", "example": "Search" }, "sensitiveDataKind": { "allOf": [ { "$ref": "#/components/schemas/SensitiveDataKindDto" } ], "description": "Value indicating if this access layer should be used to restrict access to Sensitive Data data", "example": "SensitiveDataDelegate" }, "users": { "type": "array", "items": { "type": "string" }, "description": "List of user ids assigned to the access layer", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Entity", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing access layer data" }, "AccessLayerDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AccessLayerDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "AccessLayerDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "AccessLayerLightReferenceDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the team", "format": "uuid", "example": "e4ec4810-6386-4610-a605-0d636f393daf" }, "dataKey": { "type": "string", "description": "Data key of the access layer", "nullable": true, "example": "PrivateBanking" }, "label": { "type": "string", "description": "Label of the access layer", "nullable": true, "example": "Private Banking" }, "type": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerTypeDto" } ], "description": "Type of the access layer", "example": "Business Related" }, "dataType": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDataTypeDto" } ], "description": "Data type of the access layer", "example": "Search" }, "sensitiveDataKind": { "allOf": [ { "$ref": "#/components/schemas/SensitiveDataKindDto" } ], "description": "Value indicating if this access layer should be used to restrict access to Sensitive Data", "example": "SensitiveDataDelegate" } }, "additionalProperties": false, "description": "Response DTO representing access layer data" }, "AccessLayerLightReferenceDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AccessLayerLightReferenceDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "AccessLayerReferenceDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the access layer", "nullable": true, "example": "e4ec4810-6386-4610-a605-0d636f393daf" }, "label": { "type": "string", "description": "Label of the access layer", "nullable": true, "example": "Private Banking" }, "dataKey": { "type": "string", "description": "Data key of the access layer", "nullable": true, "example": "PrivateBanking" }, "type": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerTypeDto" } ], "description": "Type of the access layer", "example": "Business Related" }, "dataType": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDataTypeDto" } ], "description": "Data type of the access layer", "example": "Search" } }, "additionalProperties": false, "description": "Response DTO representing access layer reference data" }, "AccessLayerTypeDto": { "enum": [ "Geographic", "BusinessRelated" ], "type": "string" }, "AccessLayersConfigurationDto": { "type": "object", "properties": { "populateDefaultAccessLayers": { "type": "boolean", "description": "If set to true default access layers (Enterprise, Global) will be populated automatically when creating a new entity", "example": true }, "enableDynamicAccessLayers": { "type": "boolean", "description": "If set to true automatic access layer evaluation engine will be enabled", "example": true }, "enableSensitiveData": { "type": "boolean", "description": "If set to true sensitive data handling will be enabled (fields masked with reveal capability)", "example": true }, "enableDynamicAccessLayersOnDraftUpdate": { "type": "boolean", "description": "If set to true automatic access layer evaluation engine will be enabled additionally for EntityDraftUpdated", "example": true }, "enableDynamicAccessLayersOnProduct": { "type": "boolean", "description": "If set to true automatic access layer evaluation engine will be enabled additionally for products", "example": true }, "version": { "type": "integer", "description": "Current version of the access layers-related configuration where the changes needs to be applied. This parameter is required \nto guarantee consistency and conflicts detection. If it is not provided, it will save new changes\non top of latest without conflicts checking", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing access layers configuration" }, "AccessLayersConfigurationDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AccessLayersConfigurationDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "AccessLayersConfigurationReferenceDto": { "type": "object", "properties": { "populateDefaultAccessLayers": { "type": "boolean", "description": "If set to true default access layers (Enterprise, Global) will be populated automatically when creating a new entity", "example": true }, "enableDynamicAccessLayers": { "type": "boolean", "description": "If set to true automatic access layer evaluation engine will be enabled", "example": true }, "enableDynamicAccessLayersOnDraftUpdate": { "type": "boolean", "description": "If set to true automatic access layer evaluation engine will be enabled additionally for EntityDraftUpdated", "example": true }, "enableSensitiveData": { "type": "boolean", "description": "If set to true sensitive data handling will be enabled (fields masked with reveal capability)" }, "enableDynamicAccessLayersOnProduct": { "type": "boolean", "description": "If set to true automatic access layer evaluation engine will be enabled additionally for product", "example": true } }, "additionalProperties": false }, "ConditionDefinitionDto": { "type": "object", "properties": { "fieldName": { "type": "string", "description": "Name of the field to evaluate", "nullable": true, "example": "EntityType" }, "value": { "type": "array", "items": { "type": "string" }, "description": "List of values", "nullable": true }, "valueId": { "type": "array", "items": { "type": "string" }, "description": "List of value ids", "nullable": true }, "valueType": { "type": "string", "description": "Type of the value", "nullable": true, "example": "text" }, "dataSource": { "type": "string", "description": "Data source from which field is retrieved. If empty then Entity Data properties will be used.", "nullable": true, "example": "entityDataMetadata" }, "operation": { "type": "string", "description": "Logical operation to be performed to match the values", "nullable": true, "example": "equal" }, "logicalOperation": { "type": "string", "description": "Logical operation to be performed on the operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true }, "valueField": { "allOf": [ { "$ref": "#/components/schemas/ValueField" } ], "description": "Field value used for conditional limit validation", "nullable": true } }, "additionalProperties": false, "description": "Represents condition" }, "ConditionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the condition", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "The name of the condition", "nullable": true, "example": "Company-type only" }, "description": { "type": "string", "description": "The description of the condition", "nullable": true, "example": "Applicable only when EntityType=Company" }, "logicalOperation": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true } }, "additionalProperties": false, "description": "Represents condition root" }, "ConditionalValueDto": { "allOf": [ { "$ref": "#/components/schemas/StringConditionalValueDto" }, { "type": "object", "properties": { "valueId": { "type": "string", "description": "Value Id that should be returned when conditions are met", "nullable": true, "example": "RM" } }, "additionalProperties": false } ] }, "ConditionalValueDto`1": { "allOf": [ { "$ref": "#/components/schemas/ConditionDto" }, { "type": "object", "properties": { "value": { "allOf": [ { "$ref": "#/components/schemas/T`1" } ], "description": "Value that should be returned when conditions are met", "nullable": true }, "priority": { "type": "integer", "description": "Priority of the value in case when multiple conditional values are evaluated", "format": "int32", "example": 1 } }, "additionalProperties": false } ] }, "DynamicConfigurationAccessLayerDto": { "type": "object", "properties": { "accessLayerId": { "type": "string", "description": "UiD of the associated access layer", "format": "uuid", "example": "e4ec4810-6386-4610-a605-0d636f393daf" }, "dataKey": { "type": "string", "description": "DataKey of the associated access layer", "nullable": true, "example": "Canada" } }, "additionalProperties": false }, "DynamicConfigurationDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the team", "format": "uuid", "example": "c22cd44f-492a-4f67-bd9f-c85a3084341e" }, "name": { "type": "string", "description": "Name of the dynamic configuration", "nullable": true, "example": "Canada rule" }, "description": { "type": "string", "description": "Description of the dynamic configuration", "nullable": true, "example": "Rule for Canada Private Banking" }, "geographicAccessLayer": { "allOf": [ { "$ref": "#/components/schemas/DynamicConfigurationAccessLayerDto" } ], "description": "Referenced Geographic access layer", "nullable": true }, "businessRelatedAccessLayer": { "allOf": [ { "$ref": "#/components/schemas/DynamicConfigurationAccessLayerDto" } ], "description": "Referenced Business related access layer", "nullable": true }, "dataType": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDataTypeDto" } ], "description": "Data type of the dynamic configuration\nBoth referenced access layers must be of that type\nOnly Entity, Journey and Product are supported", "example": "Entity" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Conditions under which the dynamic configuration is assigned", "nullable": true }, "modifiedBy": { "type": "string", "description": "UiD of the user who last modified the record\nMay be null if was modified by MTLS client", "nullable": true, "example": "6e769824-9346-45b7-8969-c9b29723069b" }, "modified": { "type": "string", "description": "Date of last modification of the record", "format": "date-time", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Entity", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing dynamic configuration data" }, "DynamicConfigurationDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DynamicConfigurationDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "DynamicConfigurationPageDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DynamicConfigurationDto" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DynamicConfigurationPageDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/DynamicConfigurationPageDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "GetConfigurationByTenantIdResponseDto": { "type": "object", "properties": { "inheritanceEnabled": { "type": "boolean", "description": "Flag indicating if inheritance is enabled or disabled" } }, "additionalProperties": false, "description": "Request DTO representing current related party access layers inheritance configuration data" }, "GetConfigurationByTenantIdResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetConfigurationByTenantIdResponseDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ReferenceDataDto": { "type": "object", "properties": { "accessLayers": { "type": "array", "items": { "$ref": "#/components/schemas/AccessLayerReferenceDto" }, "description": "Collection of access layer reference data", "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserReferenceDto" }, "description": "Collection of user reference data", "nullable": true }, "teams": { "type": "array", "items": { "$ref": "#/components/schemas/TeamReferenceDto" }, "description": "Collection of user reference data", "nullable": true }, "accessLayersConfiguration": { "allOf": [ { "$ref": "#/components/schemas/AccessLayersConfigurationReferenceDto" } ], "description": "Access layers configuration", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing reference data" }, "ReferenceDataDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/ReferenceDataDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "SensitiveDataKindDto": { "enum": [ "None", "SensitiveData", "SensitiveDataDelegate" ], "type": "string", "description": "Set of possible values for Sensitive Data parameter" }, "ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "description": "The message", "nullable": true, "example": "Success" }, "type": { "type": "string", "description": "Type of the message\nOne of Info, Warning, Error, Forbidden", "nullable": true, "example": "Info" }, "errorCode": { "type": "string", "description": "Error Code", "nullable": true, "example": "INTERNAL_SERVER_ERROR" } }, "additionalProperties": false, "description": "The message associated to the service response" }, "StringConditionalValueDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the condition", "format": "uuid", "example": "118313c6-91e6-4b05-a537-5a1ab906418f" }, "name": { "type": "string", "description": "The name of the condition", "nullable": true, "example": "Company-type only" }, "description": { "type": "string", "description": "The description of the condition", "nullable": true, "example": "Applicable only when EntityType=Company" }, "logicalOperation": { "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection", "nullable": true, "example": "AND" }, "operands": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDefinitionDto" }, "description": "Collection of operands for given condition. These might contain additional, nested conditions of type Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDefinitionDto", "nullable": true }, "value": { "type": "string", "description": "Value that should be returned when conditions are met", "nullable": true, "example": "Relationship Manager" }, "priority": { "type": "integer", "description": "Priority of the value in case when multiple conditional values are evaluated", "format": "int32", "example": 1 } }, "additionalProperties": false }, "StringIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "string" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "T`1": { "type": "object", "additionalProperties": false }, "TeamDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the team", "format": "uuid", "example": "1bb44eba-d489-4138-8cfa-eee3d49250c9" }, "name": { "type": "string", "description": "Name of the team", "nullable": true, "example": "Onboarding Team" }, "description": { "type": "string", "description": "Team description", "nullable": true, "example": "Team handling onboarding for new clients" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "List of permissions the team should have", "nullable": true }, "users": { "type": "array", "items": { "type": "string" }, "description": "List of user ids assigned to the team", "nullable": true }, "version": { "type": "integer", "description": "Version number for given Entity", "format": "int32", "example": 1 }, "defaultLandingPage": { "type": "string", "description": "Default landing page for team members when logging in", "nullable": true, "example": "teamManagement" } }, "additionalProperties": false, "description": "Response DTO representing team data" }, "TeamDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TeamDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "TeamDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/TeamDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "TeamNameDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the team", "format": "uuid", "example": "1bb44eba-d489-4138-8cfa-eee3d49250c9" }, "name": { "type": "string", "description": "Name of the team", "nullable": true, "example": "Onboarding Team" } }, "additionalProperties": false, "description": "Response DTO representing team data" }, "TeamNameDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TeamNameDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "TeamReferenceDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the team", "nullable": true, "example": "b347a919-4d5d-4502-ad21-1aeb82979619" }, "name": { "type": "string", "description": "Name of the team", "nullable": true, "example": "Onboarding Team" }, "users": { "type": "array", "items": { "type": "string" }, "description": "List of user ids assigned to the team", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing team reference data" }, "TeamWithUsersDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the team", "format": "uuid", "example": "1bb44eba-d489-4138-8cfa-eee3d49250c9" }, "name": { "type": "string", "description": "Name of the team", "nullable": true, "example": "Onboarding Team" }, "users": { "type": "array", "items": { "type": "string" }, "description": "List of user ids assigned to the team", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing team data" }, "TeamWithUsersDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/TeamWithUsersDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "UserAccessLayerDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the access layer", "format": "uuid", "example": "1bb44eba-d489-4138-8cfa-eee3d49250c9" }, "dataKey": { "type": "string", "description": "Value of the access layer", "nullable": true, "example": "PrivateBanking" }, "label": { "type": "string", "description": "Label of the access layer", "nullable": true, "example": "Private Banking" }, "type": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerTypeDto" } ], "description": "Type of the access layer", "nullable": true, "example": "Business Related" }, "dataType": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerDataTypeDto" } ], "description": "Data type of the access layer", "nullable": true, "example": "Search" }, "sensitiveDataKind": { "allOf": [ { "$ref": "#/components/schemas/SensitiveDataKindDto" } ], "description": "Value indicating if this access layer should be used to restrict access to Sensitive Data data" } }, "additionalProperties": false, "description": "Response DTO representing user profile access layer data" }, "UserAuthorizationProfileDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the user", "nullable": true, "example": "1bb44eba-d489-4138-8cfa-eee3d49250c9" }, "userName": { "type": "string", "description": "Username", "nullable": true, "example": "John Doe" }, "teams": { "type": "array", "items": { "$ref": "#/components/schemas/UserProfileTeamDto" }, "description": "List of teams user belongs to", "nullable": true }, "accessLayers": { "type": "array", "items": { "$ref": "#/components/schemas/UserAccessLayerDto" }, "description": "List of access layers assigned to the user", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing user authorization profile data" }, "UserAuthorizationProfileDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UserAuthorizationProfileDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "UserDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the user", "nullable": true, "example": "1bb44eba-d489-4138-8cfa-eee3d49250c9" }, "username": { "type": "string", "description": "Username", "nullable": true, "example": "user.name@fenergo.com" }, "email": { "type": "string", "description": "User email", "nullable": true, "example": "user.name@fenergo.com" } }, "additionalProperties": false, "description": "Response DTO representing user data" }, "UserDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "UserDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UserDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "UserExtendedProfileDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the user", "nullable": true, "example": "1bb44eba-d489-4138-8cfa-eee3d49250c9" }, "username": { "type": "string", "description": "Username", "nullable": true, "example": "user.name@fenergo.com" }, "email": { "type": "string", "description": "User email", "nullable": true, "example": "user.name@fenergo.com" }, "givenName": { "type": "string", "description": "Given name", "nullable": true }, "familyName": { "type": "string", "description": "FamilyName", "nullable": true }, "customProperties": { "type": "object", "additionalProperties": { "nullable": true }, "description": "Arbitrary set of custom properties set by the client.", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing user data" }, "UserExtendedProfileDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UserExtendedProfileDto" } ], "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "UserNameDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the user", "nullable": true, "example": "1bb44eba-d489-4138-8cfa-eee3d49250c9" }, "username": { "type": "string", "description": "Username", "nullable": true, "example": "user.name@fenergo.com" } }, "additionalProperties": false, "description": "Response DTO representing user data" }, "UserNameDtoIEnumerableServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserNameDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "UserProfileTeamDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the team", "format": "uuid", "example": "1bb44eba-d489-4138-8cfa-eee3d49250c9" }, "name": { "type": "string", "description": "Name of the team", "nullable": true, "example": "Onboarding Team" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "List of permissions the team have", "nullable": true }, "defaultLandingPage": { "type": "string", "description": "Default landing page of the team", "nullable": true } }, "additionalProperties": false, "description": "Response DTO representing user profile team data" }, "UserReferenceDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the user", "nullable": true, "example": "86059e9a-4910-476b-bdb5-71d77fc966fd" }, "label": { "type": "string", "description": "Display name of the user", "nullable": true, "example": "John Doe" } }, "additionalProperties": false, "description": "Response DTO representing user reference data" }, "ValidationErrorModel": { "type": "object", "properties": { "propertyName": { "type": "string", "description": "Name of the property", "nullable": true, "example": "data" }, "errorMessage": { "type": "string", "description": "User friendly error message", "nullable": true, "example": "Data is required" }, "attemptedValue": { "description": "Invalid value", "nullable": true }, "errorCode": { "type": "string", "description": "Internal error code", "nullable": true, "example": "NotNullValidator" } }, "additionalProperties": false, "description": "Represents the details of validation error" }, "ValidationErrorModelListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorModel" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data", "example": { "data": [ { "propertyName": "data", "errorMessage": "Data is required", "attemptedValue": "", "errorCode": "NotNullValidator" } ], "messages": [ { "message": "Data is required", "type": "Error", "errorCode": "Error Code" } ] } }, "ValueField": { "type": "object", "properties": { "dataSource": { "type": "string", "description": "Value of DataSource used to filter field values", "nullable": true }, "field": { "type": "string", "description": "Field value used to validate conditional value", "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }