{ "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": "3.0" }, "servers": [ { "url": "/authorizationquery" } ], "paths": { "/api/v3/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/v3/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/v3/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/v3/access-layer": { "get": { "tags": [ "AccessLayer" ], "summary": "Get paged access layers", "description": "\nReturns all existing access layers.

Required permissions:
Following permissions are required: SecurityConfigAccess", "operationId": "GetAccessLayersPaged", "parameters": [ { "name": "PaginationToken", "in": "query", "description": "Pagination token", "schema": { "type": "string", "description": "Pagination token", "nullable": true } }, { "name": "PageSize", "in": "query", "description": "Page size", "schema": { "maximum": 500, "minimum": 1, "type": "integer", "description": "Page size", "format": "int32", "example": 30 }, "example": 30 }, { "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/AccessLayerLightDtoItemsPageServiceResponse" } } } }, "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/v3/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/v3/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/v3/team": { "get": { "tags": [ "Team" ], "summary": "Get paged teams", "description": "\nReturns all existing teams.", "operationId": "GetAllTeamsPaged", "parameters": [ { "name": "PaginationToken", "in": "query", "description": "Pagination token", "schema": { "type": "string" } }, { "name": "PageSize", "in": "query", "description": "Page size", "schema": { "type": "integer", "format": "int32", "example": 30 }, "example": 30 }, { "name": "excludeUsersCount", "in": "query", "schema": { "type": "boolean", "default": false } }, { "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/TeamLightWithUsersCountDtoItemsPageServiceResponse" } } } }, "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" } ] } } } } } } } }, "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" }, "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" }, "AccessLayerLightDto": { "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" }, "usersCount": { "type": "integer", "description": "Number of users assigned to access layer", "format": "int32", "example": 10 }, "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" }, "version": { "type": "integer", "description": "Version number for given Entity", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing access layer data" }, "AccessLayerLightDtoItemsPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccessLayerLightDto" }, "description": "The items result set", "nullable": true }, "paginationToken": { "type": "string", "description": "The token for retrieving the next page of results", "nullable": true } }, "additionalProperties": false, "description": "Query Result Page" }, "AccessLayerLightDtoItemsPageServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/AccessLayerLightDtoItemsPage" } ], "description": "Query Result Page", "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" }, "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" }, "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" }, "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" }, "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" }, "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" }, "TeamLightDto": { "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" }, "version": { "type": "integer", "description": "Version number for given Entity", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing team data" }, "TeamLightWithUsersCountDto": { "allOf": [ { "$ref": "#/components/schemas/TeamLightDto" }, { "type": "object", "properties": { "usersCount": { "type": "integer", "description": "The number of the users in the team", "format": "int32" } }, "additionalProperties": false } ], "description": "Response DTO representing team data" }, "TeamLightWithUsersCountDtoItemsPage": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TeamLightWithUsersCountDto" }, "description": "The items result set", "nullable": true }, "paginationToken": { "type": "string", "description": "The token for retrieving the next page of results", "nullable": true } }, "additionalProperties": false, "description": "Query Result Page" }, "TeamLightWithUsersCountDtoItemsPageServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/TeamLightWithUsersCountDtoItemsPage" } ], "description": "Query Result Page", "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" }, "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" } ] } } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }