{ "openapi": "3.0.4", "info": { "title": "Fenergo Nebula Authorization Command", "description": "**Authorization Command 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 created aggregates and user profiles.\n\n
**Authorization Command API provides**:
", "version": "1.0" }, "servers": [ { "url": "/authorizationcommand" } ], "paths": { "/api/access-layer": { "post": { "tags": [ "AccessLayer" ], "summary": "Create access layer", "description": "\nCreates a new access layer\n

Required permissions:
Following permissions are required: SecurityConfigCreate", "operationId": "CreateAccessLayer", "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" } ], "requestBody": { "description": "Create access layer request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccessLayerRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Access layer created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccessLayerResponseDtoServiceResponse" } } } }, "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/{id}": { "put": { "tags": [ "AccessLayer" ], "summary": "Update access layer", "description": "\nUpdates access layer

Required permissions:
Following permissions are required: SecurityConfigEdit", "operationId": "UpdateAccessLayer", "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" } ], "requestBody": { "description": "Update access layer request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccessLayerRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Access layer updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccessLayerResponseDtoServiceResponse" } } } }, "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" } ] } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "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" } ] } } } } } }, "delete": { "tags": [ "AccessLayer" ], "summary": "Delete access layer", "description": "\nDeletes access layer

Required permissions:
Following permissions are required: SecurityConfigDelete", "operationId": "DeleteAccessLayer", "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": { "202": { "description": "Success. Access layer deleted" }, "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" } ] } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "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}/user/{userId}": { "put": { "tags": [ "AccessLayer" ], "summary": "Assign user to the access layer", "description": "\nAdds user to an existing access layer.

Required permissions:
Following permissions are required: UserAdministration", "operationId": "AssignUserToAccessLayer", "parameters": [ { "name": "id", "in": "path", "description": "Access layer Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "description": "User 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": { "202": { "description": "Success. User added to the access layer" }, "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" } ] } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "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" } ] } } } } } }, "delete": { "tags": [ "AccessLayer" ], "summary": "Unassign user from the access layer", "description": "\nRemoves user from an existing access layer.

Required permissions:
Following permissions are required: UserAdministration", "operationId": "UnassignUserFromAccessLayer", "parameters": [ { "name": "id", "in": "path", "description": "Access layer Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "description": "User 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": { "202": { "description": "Success. User removed from the access layer" }, "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" } ] } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "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/users/{userId}/batch": { "put": { "tags": [ "AccessLayer" ], "summary": "Batch update user access layers", "description": "

Required permissions:
Following permissions are required: UserAdministration", "operationId": "BatchUpdateUserAccessLayers", "parameters": [ { "name": "userId", "in": "path", "description": "User 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" } ], "requestBody": { "description": "The request containing id's of users that should have the access layer assigned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateUserAccessLayersRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. User access layers updated" }, "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/configuration": { "put": { "tags": [ "AccessLayer" ], "summary": "Update access layers-related configuration", "description": "\nUpdates access layers-related configuration.

Required permissions:
Following permissions are required: SecurityConfigEdit", "operationId": "UpdateAccessLayersConfiguration", "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" } ], "requestBody": { "description": "The request containing new configuration values", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAccessLayersConfigurationRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Configuration updated" }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "400": { "description": "Bad request. The request has missing/invalid values" }, "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": { "post": { "tags": [ "DynamicConfiguration" ], "summary": "Create dynamic configuration", "description": "\nCreates a new dynamic configuration\n

Required permissions:
Following permissions are required: SecurityConfigCreate", "operationId": "CreateDynamicConfiguration", "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" } ], "requestBody": { "description": "Create dynamic configuration request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDynamicConfigurationRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Dynamic configuration created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDynamicConfigurationResponseDtoServiceResponse" } } } }, "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}/clone": { "post": { "tags": [ "DynamicConfiguration" ], "summary": "Clone dynamic configuration", "description": "\nCreates a new dynamic configuration\n

Required permissions:
Following permissions are required: SecurityConfigCreate", "operationId": "CloneDynamicConfiguration", "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" } ], "requestBody": { "description": "Create dynamic configuration request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneDynamicConfigurationRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Dynamic configuration created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneDynamicConfigurationResponseDtoServiceResponse" } } } }, "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}": { "put": { "tags": [ "DynamicConfiguration" ], "summary": "Update dynamic configuration", "description": "\nUpdates dynamic configuration

Required permissions:
Following permissions are required: SecurityConfigEdit", "operationId": "UpdateDynamicConfiguration", "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" } ], "requestBody": { "description": "Update dynamic configuration request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDynamicConfigurationRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Dynamic configuration updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDynamicConfigurationResponseDtoServiceResponse" } } } }, "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. Dynamic configuration with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "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" } ] } } } } } }, "delete": { "tags": [ "DynamicConfiguration" ], "summary": "Delete dynamic configuration", "description": "\nDeletes dynamic configuration

Required permissions:
Following permissions are required: SecurityConfigDelete", "operationId": "DeleteDynamicConfiguration", "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": { "202": { "description": "Success. Dynamic configuration deleted" }, "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. Dynamic configuration with given id does not exist", "type": "Error", "errorCode": "Error Code" } ] } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "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/update": { "put": { "tags": [ "RelatedPartyAccessLayersInheritanceConfiguration" ], "summary": "Update access layers inheritance configuration", "description": "\nUpdates the configuration

Required permissions:
Following permissions are required: SecurityConfigEdit", "operationId": "UpdateRelatedPartyAccessLayersInheritanceConfiguration", "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" } ], "requestBody": { "description": "Update configuration request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInheritanceConfigurationRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Access layers inheritance configuration updated" }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "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": { "post": { "tags": [ "Team" ], "summary": "Create team", "description": "\nCreates a new team\n

Required permissions:
Following permissions are required: SecurityConfigCreate", "operationId": "CreateTeam", "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" } ], "requestBody": { "description": "Create team request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTeamRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Team created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTeamResponseDtoServiceResponse" } } } }, "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/{id}": { "put": { "tags": [ "Team" ], "summary": "Update team", "description": "\nUpdates an existing team.

Required permissions:
Following permissions are required: SecurityConfigEdit", "operationId": "UpdateTeam", "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" } ], "requestBody": { "description": "Update team request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTeamRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Team updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTeamResponseDtoServiceResponse" } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "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" } ] } } } } } }, "delete": { "tags": [ "Team" ], "summary": "Delete team", "description": "\nDeletes an existing team.

Required permissions:
Following permissions are required: SecurityConfigDelete", "operationId": "DeleteTeam", "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": { "202": { "description": "Success. Team deleted" }, "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" } ] } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "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}/clone": { "post": { "tags": [ "Team" ], "summary": "Clone team", "description": "

Required permissions:
Following permissions are required: SecurityConfigCreate", "operationId": "CloneTeam", "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" } ], "requestBody": { "description": "Clone team request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneTeamRequestDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. Team cloned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneTeamResponseDtoServiceResponse" } } } }, "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}/user/{userId}": { "put": { "tags": [ "Team" ], "summary": "Add User to the team", "description": "\nAdds user to an existing team.

Required permissions:
Following permissions are required: UserAdministration", "operationId": "AddUserToTeam", "parameters": [ { "name": "id", "in": "path", "description": "Team Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "description": "User 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": { "202": { "description": "Success. User added to the team" }, "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" } ] } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "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" } ] } } } } } }, "delete": { "tags": [ "Team" ], "summary": "Remove user from the team", "description": "\nRemoves user from an existing team.

Required permissions:
Following permissions are required: UserAdministration", "operationId": "RemoveUserFromTeam", "parameters": [ { "name": "id", "in": "path", "description": "Team Id", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "path", "description": "User 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": { "202": { "description": "Success. User removed from the team" }, "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" } ] } } } }, "409": { "description": "Conflict saving changes in expected version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "There are conflicts that cannot be resolved automatically, get latest and apply your changes", "type": "Error", "errorCode": "CONFLICT" } ] } } } }, "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/users/{userId}/batch": { "put": { "tags": [ "Team" ], "summary": "Batch update user teams", "description": "

Required permissions:
Following permissions are required: UserAdministration", "operationId": "BatchUpdateUsers", "parameters": [ { "name": "userId", "in": "path", "description": "User 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" } ], "requestBody": { "description": "The request containing id's of users that should be part of the team", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpdateUsersRequestsDtoServiceRequest" } } } }, "responses": { "202": { "description": "Success. User teams updated" }, "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" } ] } } } } } } } }, "components": { "schemas": { "AccessLayerDataTypeDto": { "enum": [ "Field", "Entity", "Journey", "Document", "Search", "Product", "ProductField" ], "type": "string" }, "AccessLayerTypeDto": { "enum": [ "Geographic", "BusinessRelated" ], "type": "string" }, "BatchUpdateUserAccessLayersRequestDto": { "type": "object", "properties": { "accessLayers": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "List of IDs of access layers that should be assigned to user", "nullable": true } }, "additionalProperties": false, "description": "Batch update users request data" }, "BatchUpdateUserAccessLayersRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BatchUpdateUserAccessLayersRequestDto" } }, "additionalProperties": false, "description": "Service request data" }, "BatchUpdateUsersRequestsDto": { "type": "object", "properties": { "teams": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "List of IDs of teams that should be assigned to", "nullable": true } }, "additionalProperties": false, "description": "Batch update users request data" }, "BatchUpdateUsersRequestsDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BatchUpdateUsersRequestsDto" } }, "additionalProperties": false, "description": "Service request data" }, "CloneDynamicConfigurationRequestDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of cloned dynamic configuration", "nullable": true, "example": "Canada configuration - clone" } }, "additionalProperties": false, "description": "Request DTO representing dynamic configuration data to clone" }, "CloneDynamicConfigurationRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CloneDynamicConfigurationRequestDto" } }, "additionalProperties": false, "description": "Service request data" }, "CloneDynamicConfigurationResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the cloned dynamic configuration", "format": "uuid", "example": "d7f592a5-3feb-4607-bf39-ab9e81c45db0" } }, "additionalProperties": false, "description": "Response DTO representing cloned dynamic configuration data" }, "CloneDynamicConfigurationResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CloneDynamicConfigurationResponseDto" }, "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" }, "CloneTeamRequestDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of cloned team", "nullable": true, "example": "My Awesome Team - clone" } }, "additionalProperties": false, "description": "Request DTO representing team data to clone" }, "CloneTeamRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CloneTeamRequestDto" } }, "additionalProperties": false, "description": "Service request data" }, "CloneTeamResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of the cloned team", "format": "uuid", "example": "d7f592a5-3feb-4607-bf39-ab9e81c45db0" } }, "additionalProperties": false, "description": "Response DTO representing cloned team data" }, "CloneTeamResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CloneTeamResponseDto" }, "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" }, "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": { "$ref": "#/components/schemas/ValueField" } }, "additionalProperties": false, "description": "Represents condition" }, "ConditionDto": { "required": [ "logicalOperation", "operands" ], "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": { "minLength": 1, "type": "string", "description": "Logical operation on the Fenergo.Nebula.Platform.LogicEngine.Model.Dto.ConditionDto.Operands collection", "example": "AND" }, "operands": { "minItems": 1, "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" } }, "additionalProperties": false, "description": "Represents condition root" }, "CreateAccessLayerRequestDto": { "type": "object", "properties": { "dataKey": { "type": "string", "description": "Data key of the access layer\nThe property is immutable", "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": { "$ref": "#/components/schemas/AccessLayerTypeDto" }, "dataType": { "$ref": "#/components/schemas/AccessLayerDataTypeDto" }, "users": { "type": "array", "items": { "type": "string" }, "description": "List of user ids assigned to the access layer", "nullable": true }, "sensitiveDataKind": { "$ref": "#/components/schemas/SensitiveDataKindDto" } }, "additionalProperties": false, "description": "Request DTO representing access layer data to create" }, "CreateAccessLayerRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateAccessLayerRequestDto" } }, "additionalProperties": false, "description": "Service request data" }, "CreateAccessLayerResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of created access layer", "format": "uuid", "example": "1bb44eba-d489-4138-8cfa-eee3d49250c9" } }, "additionalProperties": false, "description": "Response DTO representing created access layer" }, "CreateAccessLayerResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateAccessLayerResponseDto" }, "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" }, "CreateDynamicConfigurationRequestDto": { "type": "object", "properties": { "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" }, "geographicAccessLayerId": { "type": "string", "description": "UiD of the referenced Geographic access layer\nThe access layer DataType must match the dynamic configuration DataType property", "format": "uuid", "nullable": true, "example": "4e63e0ee-c5f8-4115-a1e6-a980dadcacd1" }, "businessRelatedAccessLayerId": { "type": "string", "description": "UiD of the referenced Business related access layer\nThe access layer DataType must match the dynamic configuration DataType property", "format": "uuid", "nullable": true, "example": "ec7c05d2-fc98-442c-ba5b-51652b59738c" }, "dataType": { "$ref": "#/components/schemas/AccessLayerDataTypeDto" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Conditions under which the dynamic configuration is assigned", "nullable": true } }, "additionalProperties": false, "description": "Request DTO representing dynamic configuration to create" }, "CreateDynamicConfigurationRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateDynamicConfigurationRequestDto" } }, "additionalProperties": false, "description": "Service request data" }, "CreateDynamicConfigurationResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of created dynamic configuration", "format": "uuid", "example": "c1009239-898f-41e7-a1cb-3c9513487234" } }, "additionalProperties": false, "description": "Response DTO representing created dynamic configuration" }, "CreateDynamicConfigurationResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateDynamicConfigurationResponseDto" }, "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" }, "CreateTeamRequestDto": { "type": "object", "properties": { "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 }, "defaultLandingPage": { "enum": [ "TeamManagement", "TasksDashboard", "JourneysDashboard", "PeriodicReviews", "CommandCentreOverview", "CommandCentreFinCrime", "CommandCentreOperations", "CommandCentreAgentGovernance", "CommandCentreCustomViews", "AlertsDashboard" ], "type": "string", "description": "Default landing page for team members when logging in", "nullable": true, "example": "TeamManagement" } }, "additionalProperties": false, "description": "Request DTO representing team data to create" }, "CreateTeamRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateTeamRequestDto" } }, "additionalProperties": false, "description": "Service request data" }, "CreateTeamResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The UiD of created team", "format": "uuid", "example": "1bb44eba-d489-4138-8cfa-eee3d49250c9" } }, "additionalProperties": false, "description": "Response DTO representing created team" }, "CreateTeamResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CreateTeamResponseDto" }, "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" }, "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" }, "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" }, "UpdateAccessLayerRequestDto": { "type": "object", "properties": { "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": { "$ref": "#/components/schemas/AccessLayerTypeDto" }, "dataType": { "$ref": "#/components/schemas/AccessLayerDataTypeDto" }, "sensitiveDataKind": { "$ref": "#/components/schemas/SensitiveDataKindDto" }, "version": { "type": "integer", "description": "Current version of the access layer 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", "default": -1, "example": 1 } }, "additionalProperties": false, "description": "Request DTO representing access layer data to update" }, "UpdateAccessLayerRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateAccessLayerRequestDto" } }, "additionalProperties": false, "description": "Service request data" }, "UpdateAccessLayerResponseDto": { "type": "object", "properties": { "version": { "type": "integer", "description": "Version of access layer after update", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing updated access layer" }, "UpdateAccessLayerResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateAccessLayerResponseDto" }, "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" }, "UpdateAccessLayersConfigurationRequestDto": { "required": [ "enableDynamicAccessLayers", "enableDynamicAccessLayersOnDraftUpdate", "enableDynamicAccessLayersOnProduct", "enableSensitiveData", "populateDefaultAccessLayers" ], "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", "default": false, "example": true }, "enableDynamicAccessLayers": { "type": "boolean", "description": "If set to true automatic access layer evaluation engine will be enabled", "default": false, "example": true }, "enableSensitiveData": { "type": "boolean", "description": "If set to true sensitive data handling will be enabled (fields masked with reveal capability)", "default": false, "example": true }, "enableDynamicAccessLayersOnDraftUpdate": { "type": "boolean", "description": "If set to true automatic access layer evaluation engine will be enabled additionally for EntityDraftUpdated", "default": false, "example": true }, "enableDynamicAccessLayersOnProduct": { "type": "boolean", "description": "If set to true automatic access layer evaluation engine will be enabled additionally for Products", "default": false, "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", "default": -1, "example": 1 } }, "additionalProperties": false }, "UpdateAccessLayersConfigurationRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateAccessLayersConfigurationRequestDto" } }, "additionalProperties": false, "description": "Service request data" }, "UpdateDynamicConfigurationRequestDto": { "type": "object", "properties": { "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" }, "geographicAccessLayerId": { "type": "string", "description": "UiD of the referenced Geographic access layer\nThe access layer DataType must match the dynamic configuration DataType property", "format": "uuid", "nullable": true, "example": "4e63e0ee-c5f8-4115-a1e6-a980dadcacd1" }, "businessRelatedAccessLayerId": { "type": "string", "description": "UiD of the referenced Business related access layer\nThe access layer DataType must match the dynamic configuration DataType property", "format": "uuid", "nullable": true, "example": "ec7c05d2-fc98-442c-ba5b-51652b59738c" }, "dataType": { "$ref": "#/components/schemas/AccessLayerDataTypeDto" }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/ConditionDto" }, "description": "Conditions under which the dynamic configuration is assigned", "nullable": true }, "version": { "type": "integer", "description": "Current version of the dynamic 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", "default": -1, "example": 1 } }, "additionalProperties": false, "description": "Request DTO representing dynamic configuration data to update" }, "UpdateDynamicConfigurationRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateDynamicConfigurationRequestDto" } }, "additionalProperties": false, "description": "Service request data" }, "UpdateDynamicConfigurationResponseDto": { "type": "object", "properties": { "version": { "type": "integer", "description": "Version of dynamic configuration after update", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing updated dynamic configuration" }, "UpdateDynamicConfigurationResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateDynamicConfigurationResponseDto" }, "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" }, "UpdateInheritanceConfigurationRequestDto": { "type": "object", "properties": { "inheritanceEnabled": { "type": "boolean", "description": "Flag indicating if inheritance should be enabled or disabled" } }, "additionalProperties": false, "description": "Request DTO representing related party access layers inheritance configuration data to update" }, "UpdateInheritanceConfigurationRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateInheritanceConfigurationRequestDto" } }, "additionalProperties": false, "description": "Service request data" }, "UpdateTeamRequestDto": { "type": "object", "properties": { "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 }, "version": { "type": "integer", "description": "Current version of the team 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", "default": -1, "example": 1 }, "defaultLandingPage": { "enum": [ "TeamManagement", "TasksDashboard", "JourneysDashboard", "PeriodicReviews", "CommandCentreOverview", "CommandCentreFinCrime", "CommandCentreOperations", "CommandCentreAgentGovernance", "CommandCentreCustomViews", "AlertsDashboard" ], "type": "string", "description": "Default landing page for team members when logging in", "nullable": true, "example": "TeamManagement" } }, "additionalProperties": false, "description": "Request DTO representing team data to update" }, "UpdateTeamRequestDtoServiceRequest": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateTeamRequestDto" } }, "additionalProperties": false, "description": "Service request data" }, "UpdateTeamResponseDto": { "type": "object", "properties": { "version": { "type": "integer", "description": "Version of team after update", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing updated team" }, "UpdateTeamResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UpdateTeamResponseDto" }, "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" }, "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": [ ] } ] }