{ "openapi": "3.0.4", "info": { "title": "Fenergo Nebula Portal Tenant Query", "description": "**Portal Tenant Query API**:\n\n
Portal Tenant Query API provides methods related to the Portal Users. Use the Portal Tenant Query API to retrieve list of Users, user details and get password reset ticket. Use the Portal Tenant Query API to retrieve list of Entities linked to portal user.\n\n
**Portal Tenant Query API provides**:
", "version": "4.0" }, "servers": [ { "url": "/portaltenantquery" } ], "paths": { "/api/auth0/passwordresetticket/{id}": { "get": { "tags": [ "Auth0" ], "summary": "Gets password reset ticket", "description": "\nGets a password reset ticket for a given user id.

Required permissions:
Following permissions are required: PortalTenantUserAdmin", "operationId": "GetPasswordResetTicket", "parameters": [ { "name": "id", "in": "path", "description": "Portal user identifier for which the ticket is to be created.", "required": true, "schema": { "type": "string" } }, { "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PasswordResetTicketDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/dashboard/dashboardconfig/{id}": { "get": { "tags": [ "Dashboard" ], "summary": "Gets dashboard config with the corresponding Id.", "description": "This endpoint is obsolete and was terminated on 2024-08-27. Use /api/dashboard/entitytypedashboardconfig/{id} instead.


Required permissions:
Following permissions are required: DashboardAccess", "operationId": "GetDashboardConfigById", "parameters": [ { "name": "id", "in": "path", "description": "The Dashboard Config identifier.", "required": true, "schema": { "type": "string" } }, { "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardConfigDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } }, "deprecated": true } }, "/api/dashboard/entitytypedashboardconfig/{id}": { "get": { "tags": [ "Dashboard" ], "summary": "Gets dashboard config with the corresponding Id returning fields grouped by entity type.", "description": "

Required permissions:
Following permissions are required: DashboardAccess", "operationId": "GetEntityTypeDashboardConfigById", "parameters": [ { "name": "id", "in": "path", "description": "The Dashboard Config identifier.", "required": true, "schema": { "type": "string" } }, { "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.EntityTypeDashboardConfigDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/dashboard/dashboardconfigs": { "get": { "tags": [ "Dashboard" ], "summary": "Gets dashboard configs", "description": "

Required permissions:
At least one of the following permissions is required: UserRoleAccess, DashboardAccess", "operationId": "GetDashboardConfigs", "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Collections.Generic.List`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardConfigDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/domains/{portalTenantId}": { "get": { "tags": [ "Domain" ], "summary": "Returns the list of portal domains for a given tenant.", "parameters": [ { "name": "portalTenantId", "in": "path", "description": "Tenant identifier", "required": true, "schema": { "type": "string" } }, { "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Collections.Generic.List`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalDomainLightDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/domains/brand-config": { "get": { "tags": [ "Domain" ], "summary": "Returns the brand configuration for a specific domain and tenant.", "parameters": [ { "name": "portalUrl", "in": "query", "description": "Brand Configuration portal url", "required": true, "schema": { "type": "string" } }, { "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.DomainBrandConfigurationDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/domains/brand-email-settings": { "get": { "tags": [ "Domain" ], "summary": "Returns brand email settings (email domain and sender) for a given portal URL.", "parameters": [ { "name": "portalUrl", "in": "query", "description": "Portal URL identifying the brand", "required": true, "schema": { "type": "string" } }, { "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.BrandEmailSettingsDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/email/emailprovider": { "get": { "tags": [ "Email" ], "summary": "Gets Tenant's Email Provider", "description": "

Required permissions:
Following permissions are required: PortalTenantAccess", "operationId": "GetEmailProvider", "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.OutreachEmailDomainDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse" } } } }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/email-templates": { "get": { "tags": [ "EmailTemplate" ], "summary": "Gets all Email Templates for the tenant", "description": "

Required permissions:
Following permissions are required: PortalTenantAccess", "operationId": "GetEmailTemplates", "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" } }, { "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Collections.Generic.List`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.EmailTemplate.EmailTemplateDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse" } } } }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/email-templates/{id}": { "get": { "tags": [ "EmailTemplate" ], "summary": "Gets an Email Template by ID", "description": "

Required permissions:
Following permissions are required: PortalTenantAccess", "operationId": "GetEmailTemplateById", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.EmailTemplate.EmailTemplateDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse" } } } }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/tenant-global-settings": { "get": { "tags": [ "GlobalSettings" ], "summary": "Gets the global portal tenant settings", "description": "

Required permissions:
Following permissions are required: PortalTenantAccess", "operationId": "GetGlobalPortalTenantSettings", "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.GlobalPortalTenantSettingsDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse" } } } }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/portal-roles/portalrole/{id}": { "get": { "tags": [ "PortalRole" ], "summary": "Gets role with the corresponding Id.", "description": "

Required permissions:
Following permissions are required: UserRoleAccess", "operationId": "GetPortalRoleById", "parameters": [ { "name": "id", "in": "path", "description": "The Role identifier.", "required": true, "schema": { "type": "string" } }, { "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalRoleDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/portal-roles/portalroles": { "get": { "tags": [ "PortalRole" ], "summary": "Gets portal available roles", "description": "

Required permissions:
At least one of the following permissions is required: UserRoleAccess, PortalTenantUserAdmin", "operationId": "GetPortalRoles", "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Collections.Generic.List`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalRoleDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/portal-users/portalusers": { "post": { "tags": [ "PortalUsers" ], "summary": "Gets Portal Users", "description": "\nReturns list of users.

Required permissions:
Following permissions are required: PortalTenantUserAdmin", "operationId": "GetPortalUsers", "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": "Query portal user request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserQueryPagedDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserResultDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse" } } } }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/portal-users/userdetails/{id}": { "get": { "tags": [ "PortalUsers" ], "summary": "Gets Portal User details", "description": "\nReturns details of portal user.

Required permissions:
Following permissions are required: PortalTenantUserAdmin", "operationId": "GetPortalUserDetails", "parameters": [ { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } }, { "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/portal-users/portaluserslinked/{entityId}": { "get": { "tags": [ "PortalUsers" ], "summary": "Gets Portal Users linked to entity", "description": "\nReturns list of linked portal users.

Required permissions:
At least one of the following permissions is required: QuickLinkAccess, PortalTenantUserAdmin", "operationId": "GetPortalUsersLinkedToEntity", "parameters": [ { "name": "entityId", "in": "path", "description": "Entity 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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserLinkedResultDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/portal-users/searchportaluserslinked/{entityId}": { "post": { "tags": [ "PortalUsers" ], "summary": "Search Portal Users linked to entity", "description": "\nReturns list of linked portal users.

Required permissions:
At least one of the following permissions is required: QuickLinkAccess, PortalTenantUserAdmin", "operationId": "SearchPortalUsersLinkedToEntity", "parameters": [ { "name": "entityId", "in": "path", "description": "Entity 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": "Request Body", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchPortalUsersLinkedToEntityDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserLinkedResultDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/portal-users/searchforlinklecandidates": { "post": { "tags": [ "PortalUsers" ], "summary": "Searches for Legal Entities List to be linked to a Portal User", "description": "\nReturns list of possible entities to be linked to portal user.

Required permissions:
Following permissions are required: PortalTenantUserAdmin", "operationId": "SearchForLinkLeCandidates", "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": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchForLinkLeCandidatesDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.LeCandidatesResultDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/portal-users/userdetails/{id}/nolinks": { "get": { "tags": [ "PortalUsers" ], "summary": "Gets Portal User details without linked entities", "description": "\nReturns details of portal user without linked entities.

Required permissions:
Following permissions are required: PortalTenantUserAdmin", "operationId": "GetPortalUserDetailsWithoutLinkedEntities", "parameters": [ { "name": "id", "in": "path", "description": "User id", "required": true, "schema": { "type": "string" } }, { "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": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserWithoutLinkedEntitiesDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } }, "/api/portal-users/searchlinkedentities": { "post": { "tags": [ "PortalUsers" ], "summary": "Searches for Legal Entities linked to a Portal User", "description": "\nReturns paginated list of Legal Entities linked to Portal User.

Required permissions:
Following permissions are required: PortalTenantUserAdmin", "operationId": "SearchLinkedEntities", "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": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchLinkedEntitiesRequestDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchLinkedEntitiesResponseDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "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/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } } } } }, "components": { "schemas": { "Fenergo.Nebula.Outreach.Query.DotNetClient.ReceivingDnsRecordDto": { "type": "object", "properties": { "recordType": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true }, "priority": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Outreach.Query.DotNetClient.SendingDnsRecordDto": { "type": "object", "properties": { "recordType": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserQueryPagedDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": { "required": [ "data" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserQueryPagedDto" } }, "additionalProperties": false, "description": "Service request data" }, "Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchForLinkLeCandidatesDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": { "required": [ "data" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchForLinkLeCandidatesDto" } }, "additionalProperties": false, "description": "Service request data" }, "Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchLinkedEntitiesRequestDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": { "required": [ "data" ], "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchLinkedEntitiesRequestDto" } }, "additionalProperties": false, "description": "Service request data" }, "Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchPortalUsersLinkedToEntityDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchPortalUsersLinkedToEntityDto" } }, "additionalProperties": false, "description": "Service request data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.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" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.BrandEmailSettingsDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.BrandEmailSettingsDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.DomainBrandConfigurationDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.DomainBrandConfigurationDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.GlobalPortalTenantSettingsDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.GlobalPortalTenantSettingsDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.LeCandidatesResultDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.LeCandidatesResultDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.OutreachEmailDomainDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.OutreachEmailDomainDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PasswordResetTicketDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PasswordResetTicketDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserLinkedResultDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserLinkedResultDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserResultDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserResultDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchLinkedEntitiesResponseDto, Fenergo.Nebula.Portal.Tenant.Query.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchLinkedEntitiesResponseDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardConfigDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardConfigDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.EmailTemplate.EmailTemplateDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.EmailTemplate.EmailTemplateDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.EntityTypeDashboardConfigDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.EntityTypeDashboardConfigDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalRoleDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalRoleDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserWithoutLinkedEntitiesDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]]": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserWithoutLinkedEntitiesDto" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Collections.Generic.List`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardConfigDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardConfigDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Collections.Generic.List`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.EmailTemplate.EmailTemplateDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.EmailTemplate.EmailTemplateDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Collections.Generic.List`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalDomainLightDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalDomainLightDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Collections.Generic.List`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalRoleDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalRoleDto" }, "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": { "type": "object", "properties": { "data": { "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]": { "type": "object", "properties": { "data": { "type": "string", "description": "The service response DTO", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage" }, "description": "List of Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage associated to the service response", "nullable": true } }, "additionalProperties": false, "description": "Service response data" }, "Fenergo.Nebula.Platform.Data.Abstractions.Search.Pager.PagerDto": { "type": "object", "properties": { "size": { "minimum": 0, "exclusiveMinimum": true, "type": "integer", "description": "Size of the page (result set)", "format": "int32", "example": 5 }, "from": { "minimum": 0, "type": "integer", "description": "Position for the search results to start", "format": "int32", "example": 0 }, "sortBy": { "type": "string", "description": "Column to sort by", "nullable": true, "example": "created" }, "sortOrder": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Data.Abstractions.Search.Pager.SortOrder" } }, "additionalProperties": false, "description": "Specification of search result page" }, "Fenergo.Nebula.Platform.Data.Abstractions.Search.Pager.SortOrder": { "enum": [ 0, 1 ], "type": "integer", "description": "Sort Order (Ascending or Descending)", "format": "int32" }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.BrandEmailSettingsDto": { "type": "object", "properties": { "emailDomainId": { "type": "string", "format": "uuid", "nullable": true }, "emailSender": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.AccessRequestReceiptMessagesDto": { "type": "object", "properties": { "mainHeading": { "type": "string", "nullable": true }, "subtext": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.DomainBrandConfigurationDto": { "type": "object", "properties": { "portalName": { "type": "string", "description": "Name of the portal", "nullable": true, "example": "FenX Vortex Portal" }, "footerExtensionText": { "type": "string", "description": "Footer extension text displayed at the bottom of the portal", "nullable": true }, "emailDomainId": { "type": "string", "description": "Email domain identifier", "format": "uuid", "nullable": true }, "emailSender": { "type": "string", "description": "Email sender name (the local part before @ in the from email address)", "nullable": true }, "footerLinks": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.FooterLinkDto" }, "description": "Collection of footer links displayed in the portal footer", "nullable": true }, "screenMessages": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.ScreenMessagesDto" }, "imageUrls": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.ImageUrlsDto" }, "theme": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.ThemeDto" }, "emailTemplates": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.EmailTemplatesDto" }, "fonts": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.FontDto" }, "description": "Collection of custom fonts to be used in the portal", "nullable": true }, "ssoConnectionName": { "type": "string", "description": "Name of the SSO connection to use for this brand.", "nullable": true }, "isVectorDomain": { "type": "boolean", "description": "True when this domain serves the Vector Portal UI rather than the Legacy Portal UI." } }, "additionalProperties": false, "description": "DTO representing brand configuration" }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.EmailTemplateDto": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "mainText": { "type": "string", "nullable": true }, "subText": { "type": "string", "nullable": true }, "buttonText": { "type": "string", "nullable": true }, "footerText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.EmailTemplatesDto": { "type": "object", "properties": { "resetEmailTemplate": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.EmailTemplateDto" }, "verifyEmailTemplate": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.EmailTemplateDto" }, "outreachJourneyInProgressTemplate": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.EmailTemplateDto" }, "delegatedUserEmailTemplate": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.SwitchableEmailTemplateDto" }, "outreachJourneyInProgressTemplateTwo": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.EmailTemplateDto" }, "outreachJourneyInProgressTemplateThree": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.EmailTemplateDto" }, "outreachJourneyInProgressTemplateFour": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.EmailTemplateDto" }, "outreachJourneyInProgressTemplateFive": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.EmailTemplateDto" } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.FontDto": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "style": { "type": "string", "nullable": true }, "weight": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.FooterLinkDto": { "type": "object", "properties": { "label": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.ImageUrlsDto": { "type": "object", "properties": { "logo": { "type": "string", "nullable": true }, "backgroundImage": { "type": "string", "nullable": true }, "dashboardBackground": { "type": "string", "nullable": true }, "watermark": { "type": "string", "nullable": true }, "contrastLogo": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.LandingPageMessagesDto": { "type": "object", "properties": { "mainHeading": { "type": "string", "nullable": true }, "subtext": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.LoginPageMessagesDto": { "type": "object", "properties": { "termsOfServiceUrl": { "type": "string", "nullable": true }, "privacyPolicyUrl": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.NoAccessMessagesDto": { "type": "object", "properties": { "mainHeading": { "type": "string", "nullable": true }, "subtext": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.ReceiptConfirmationMessagesDto": { "type": "object", "properties": { "mainHeading": { "type": "string", "nullable": true }, "subtext": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.ScreenMessagesDto": { "type": "object", "properties": { "landingPage": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.LandingPageMessagesDto" }, "accessRequestReceipt": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.AccessRequestReceiptMessagesDto" }, "receiptConfirmation": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.ReceiptConfirmationMessagesDto" }, "loginPage": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.LoginPageMessagesDto" }, "noAccess": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.NoAccessMessagesDto" } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.SwitchableEmailTemplateDto": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "mainText": { "type": "string", "nullable": true }, "subText": { "type": "string", "nullable": true }, "buttonText": { "type": "string", "nullable": true }, "footerText": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.ThemeDto": { "type": "object", "properties": { "primaryColor": { "type": "string", "nullable": true }, "headerColor": { "type": "string", "nullable": true }, "errorColor": { "type": "string", "nullable": true }, "warningColor": { "type": "string", "nullable": true }, "infoColor": { "type": "string", "nullable": true }, "successColor": { "type": "string", "nullable": true }, "hyperlinkColor": { "type": "string", "nullable": true }, "headerUnderlineColor": { "type": "string", "nullable": true }, "customCss": { "type": "string", "nullable": true }, "customCssAccessible": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.UserManagementSettingsDto": { "type": "object", "properties": { "capturePortalUserName": { "type": "boolean" } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.EntityViewModelDto": { "type": "object", "properties": { "properties": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PropertyViewModelDto" }, "description": "Entity properties to search", "nullable": true, "example": { "firstName": { "value": "John", "type": "text" }, "lastName": { "value": "", "type": "text" }, "nationality": { "value": "Ireland", "type": "multiselect" } } }, "type": { "type": "string", "description": "Entity type", "nullable": true, "example": "Individual" } }, "additionalProperties": false, "description": "Request DTO representing entity model to search" }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.GlobalPortalTenantSettingsDto": { "type": "object", "properties": { "userManagement": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.Config.UserManagementSettingsDto" } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.LeCandidatesResultDto": { "type": "object", "properties": { "legalEntitiesCandidates": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.LegalEntitiesResponseDto" }, "description": "List of possible Legal Entities to be linked to a Portal User.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int64", "example": 1 } }, "additionalProperties": false, "description": "Response DTO to return LE Candidates list with Total Items found number" }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.LegalEntitiesResponseDto": { "type": "object", "properties": { "entityId": { "type": "string", "description": "The Id of the entity", "format": "uuid", "example": "315df981-38a0-4145-836b-8d22745887b6" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.LegalEntityPropertyDto" }, "description": "List of entity properties", "nullable": true } }, "additionalProperties": false, "description": "Response DTO to return legal entity" }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.LegalEntityPropertyDto": { "type": "object", "properties": { "key": { "type": "string", "description": "Entity property key", "nullable": true, "example": "firstName" }, "value": { "type": "string", "description": "Entity property value", "nullable": true, "example": "John" } }, "additionalProperties": false, "description": "Request DTO representing entity properties" }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.OutreachEmailDomainDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "nullable": true }, "name": { "type": "string", "nullable": true }, "state": { "type": "string", "nullable": true }, "enabled": { "type": "boolean" }, "receivingDnsRecords": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Outreach.Query.DotNetClient.ReceivingDnsRecordDto" }, "nullable": true }, "sendingDnsRecords": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Outreach.Query.DotNetClient.SendingDnsRecordDto" }, "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PagingInfoDto": { "type": "object", "properties": { "count": { "type": "integer", "description": "Number of elements per page", "format": "int32" }, "page": { "type": "integer", "description": "Page Number", "format": "int32" } }, "additionalProperties": false, "description": "DTO representing paging information" }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PasswordResetTicketDto": { "type": "object", "properties": { "url": { "type": "string", "description": "The URL that represents the ticket.", "nullable": true, "example": "https://portal.eu.auth0.com/u/reset-password?ticket=Mkz83N164Y5o2d9WsklH0UVlbgAi3htV#" }, "expirationDate": { "type": "string", "description": "The ticket's expiration date.", "nullable": true, "example": "2022-08-02T13:50:08.2847430Z" } }, "additionalProperties": false, "description": "Response DTO representing password reset ticket" }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserLinkedResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserLinkedDto" }, "description": "Items for the current page.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing paged list of portal users result with linked entity" }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserQueryPagedDto": { "type": "object", "properties": { "pager": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Data.Abstractions.Search.Pager.PagerDto" }, "searchCriteria": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUsersSearchCriteriaDto" } }, "additionalProperties": false, "description": "Request DTO to query for a paged list of portal users" }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserResultDto": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserLightDto" }, "description": "Items for the current page.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Response DTO representing paged list of portal users result" }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUsersSearchCriteriaDto": { "type": "object", "properties": { "email": { "type": "string", "description": "User email", "nullable": true, "example": "example@fenergo.com" }, "username": { "type": "string", "description": "Username", "nullable": true, "example": "example@fenergo.com" }, "status": { "type": "string", "description": "User status", "nullable": true, "example": "ActivationRequired" } }, "additionalProperties": false, "description": "Request DTO to query for users" }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PropertyViewModelDto": { "type": "object", "properties": { "value": { "type": "string", "description": "Entity property value", "nullable": true, "example": "Poland" }, "type": { "type": "string", "description": "Entity property type", "nullable": true, "example": "multiselect" } }, "additionalProperties": false, "description": "Request DTO representing entity properties to search" }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchForLinkLeCandidatesDto": { "type": "object", "properties": { "userId": { "type": "string", "description": "Id of a portal user", "nullable": true, "example": "auth0|62d80dff81333797e736099a" }, "entityViewModel": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.EntityViewModelDto" }, "visibleColumns": { "type": "array", "items": { "type": "string" }, "description": "List of columns", "nullable": true, "example": [ "firstName", "dateOfBirth", "middleName", "lastName", "nationality" ] }, "pager": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Data.Abstractions.Search.Pager.PagerDto" } }, "additionalProperties": false, "description": "Request DTO to query for a legal entities candidates to link with portal user" }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchLinkedEntitiesRequestDto": { "type": "object", "properties": { "userId": { "type": "string", "description": "Id of a portal user", "nullable": true, "example": "auth0|62d80dff81333797e736099a" }, "entityViewModel": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.EntityViewModelDto" }, "pager": { "$ref": "#/components/schemas/Fenergo.Nebula.Platform.Data.Abstractions.Search.Pager.PagerDto" } }, "additionalProperties": false, "description": "Request DTO to query for a legal entities candidates to link with portal user" }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchLinkedEntitiesResponseDto": { "type": "object", "properties": { "entities": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.LinkedEntitiesDto" }, "description": "List of Legal Entities linked to a Portal User.", "nullable": true }, "totalItems": { "type": "integer", "description": "Total count of items.", "format": "int64", "example": 1 } }, "additionalProperties": false, "description": "Response DTO to return Legal Entities list with Total Items found number" }, "Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchPortalUsersLinkedToEntityDto": { "type": "object", "properties": { "userName": { "type": "string", "description": "User Name", "nullable": true }, "pagingInfo": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PagingInfoDto" } }, "additionalProperties": false, "description": "DTO representing search portal users linked to entity" }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.AccessLayersConfigMetadataDto": { "type": "object", "properties": { "accessLayerIds": { "type": "array", "items": { "type": "string" }, "nullable": true }, "productFieldAccessLayerIds": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardConfigDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardFieldDto" }, "nullable": true }, "lastUpdatedDate": { "type": "string", "format": "date-time", "nullable": true }, "dashboardType": { "type": "string", "nullable": true }, "entityTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "displayJourneyData": { "type": "boolean" }, "displayJourneyState": { "type": "boolean" }, "searchDashboardConfig": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardConfigDto" }, "journeysDashboardConfig": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardConfigDto" } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardFieldDto": { "type": "object", "properties": { "fieldKey": { "type": "string", "nullable": true }, "label": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "typeLinkId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardFieldsConfigDto": { "type": "object", "properties": { "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardFieldDto" }, "nullable": true }, "entityType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.EmailTemplate.EmailTemplateContentDto": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "mainText": { "type": "string", "nullable": true }, "subText": { "type": "string", "nullable": true }, "buttonText": { "type": "string", "nullable": true }, "footerText": { "type": "string", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.EmailTemplate.EmailTemplateDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "templateKey": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "isSystemTemplate": { "type": "boolean" }, "isEnabled": { "type": "boolean", "nullable": true }, "defaults": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.EmailTemplate.EmailTemplateContentDto" }, "brandOverrides": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.EmailTemplate.EmailTemplateContentDto" }, "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "isValid": { "type": "boolean", "nullable": true }, "validationError": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.EntityTypeDashboardConfigDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardFieldDto" }, "nullable": true }, "lastUpdatedDate": { "type": "string", "format": "date-time", "nullable": true }, "dashboardType": { "type": "string", "nullable": true }, "entityTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "displayJourneyData": { "type": "boolean" }, "displayJourneyState": { "type": "boolean" }, "searchDashboardConfig": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardConfigDto" }, "journeysDashboardConfig": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardConfigDto" }, "dashboardFieldsConfig": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardFieldsConfigDto" }, "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.FrontOfficeConfigDto": { "type": "object", "properties": { "notificationDisplayEntityName": { "type": "boolean", "nullable": true }, "notificationSendCancelledJourneyEmail": { "type": "boolean", "nullable": true }, "newRequestDetailsCategory": { "type": "string", "nullable": true }, "productRequestDetailsCategory": { "type": "string", "nullable": true }, "dashboardDetailsCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "productRequestsEnabled": { "type": "boolean", "nullable": true }, "enforceProductCaptureNewClients": { "type": "boolean", "nullable": true }, "enforceProductCaptureMaintenance": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardConfigDto": { "type": "object", "properties": { "viewId": { "type": "string", "nullable": true }, "isPrefilterEnabled": { "type": "boolean" }, "prefilterFieldKey": { "type": "string", "nullable": true }, "prefilterFieldType": { "type": "string", "nullable": true }, "prefilterFieldSource": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardFieldDto": { "type": "object", "properties": { "fieldKey": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true }, "fieldValues": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardMetadataDto": { "type": "object", "properties": { "dashboardIdPrefilterFields": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardFieldDto" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.LanguageInfoDto": { "type": "object", "properties": { "isoCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.LinkedEntitiesDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "entityId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "createdDate": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalDomainLightDto": { "type": "object", "properties": { "portalUrl": { "type": "string", "nullable": true }, "portalName": { "type": "string", "nullable": true }, "isDefaultDomain": { "type": "boolean" } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalRoleDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "isDefaultRole": { "type": "boolean" }, "editableConfig": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalRoleEditableConfigDto" }, "wasCreatedManually": { "type": "boolean" } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalRoleEditableConfigDto": { "type": "object", "properties": { "isNewClientRequestEnabled": { "type": "boolean" }, "entityTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "journeyTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "lastUpdatedDate": { "type": "string", "format": "date-time", "nullable": true }, "dashboardId": { "type": "string", "nullable": true }, "isAddingUserEnabled": { "type": "boolean" }, "receiveOutreachEmailNotification": { "type": "boolean", "nullable": true }, "journeyAccessEnabled": { "type": "boolean", "nullable": true }, "portalType": { "type": "string", "nullable": true }, "frontOfficeNotificationSendCancelledJourneyEmail": { "type": "boolean", "nullable": true }, "frontOfficeNotificationDisplayEntityName": { "type": "boolean", "nullable": true }, "entityTypeDisplay": { "type": "string", "nullable": true }, "showLegalEntityDeleteButton": { "type": "boolean", "nullable": true }, "externalDataConfig": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.ExternalDataConfig" }, "maintenanceRequestConfig": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.MaintenanceRequestConfig" }, "frontOfficeConfig": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.FrontOfficeConfigDto" }, "entityPageConfig": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.EntityPageConfig" }, "enableAccessLayers": { "type": "boolean", "nullable": true }, "enableProductFieldAccessLayers": { "type": "boolean", "nullable": true }, "journeyConfig": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.JourneyConfig" } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "roles": { "type": "array", "items": { "type": "string" }, "nullable": true }, "searchDashboardMetadata": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardMetadataDto" }, "journeysDashboardMetadata": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardMetadataDto" }, "accessLayersConfig": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.AccessLayersConfigMetadataDto" }, "linkedEntities": { "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.LinkedEntitiesDto" }, "nullable": true }, "passwordResetTicketExpirationDate": { "type": "string", "nullable": true }, "languageInfo": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.LanguageInfoDto" } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserLightDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "roles": { "type": "array", "items": { "type": "string" }, "nullable": true }, "searchDashboardMetadata": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardMetadataDto" }, "journeysDashboardMetadata": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardMetadataDto" }, "accessLayersConfig": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.AccessLayersConfigMetadataDto" } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserLinkedDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "roles": { "type": "array", "items": { "type": "string" }, "nullable": true }, "searchDashboardMetadata": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardMetadataDto" }, "journeysDashboardMetadata": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardMetadataDto" }, "accessLayersConfig": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.AccessLayersConfigMetadataDto" }, "userEntityLinkId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserWithoutLinkedEntitiesDto": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "lastLogin": { "type": "string", "format": "date-time", "nullable": true }, "roles": { "type": "array", "items": { "type": "string" }, "nullable": true }, "searchDashboardMetadata": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardMetadataDto" }, "journeysDashboardMetadata": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardMetadataDto" }, "accessLayersConfig": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.AccessLayersConfigMetadataDto" }, "hasLinkedEntities": { "type": "boolean" }, "passwordResetTicketExpirationDate": { "type": "string", "nullable": true }, "languageInfo": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.LanguageInfoDto" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardConfigDto": { "type": "object", "properties": { "isSearchPrefilterEnabled": { "type": "boolean" }, "searchPrefilterFieldKey": { "type": "string", "nullable": true }, "searchPrefilterFieldType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardFieldDto": { "type": "object", "properties": { "fieldKey": { "type": "string", "nullable": true }, "fieldValue": { "type": "string", "nullable": true }, "fieldValues": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardMetadataDto": { "type": "object", "properties": { "prefilterValue": { "type": "string", "nullable": true, "deprecated": true }, "dashboardIdPrefilterFields": { "type": "object", "additionalProperties": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardFieldDto" }, "nullable": true }, "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.EntityPageConfig": { "type": "object", "properties": { "entityPageDataReqCategory": { "type": "string", "nullable": true }, "showEntityProfilePageV2": { "type": "boolean", "nullable": true }, "entityPageDisplayDocuments": { "type": "boolean", "nullable": true }, "entityPageDocumentTypes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "displayProductsEnabled": { "type": "boolean" }, "entityPageDisplayInvestmentAccounts": { "type": "boolean" }, "investmentAccountPageConfig": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.InvestmentAccountPageConfig" }, "uploadDocumentsEnabled": { "type": "boolean" }, "enrichDocumentsEnabled": { "type": "boolean" }, "companyDetailsDisplayCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "orderCompanyDetailsCategoriesAlphabetically": { "type": "boolean" }, "individualDetailsDisplayCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "orderIndividualDetailsCategoriesAlphabetically": { "type": "boolean" }, "otherEntityDisplayCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "orderOtherEntityDetailsCategoriesAlphabetically": { "type": "boolean" }, "productPageConfig": { "$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.ProductPageConfig" } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.ExternalDataConfig": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "providerId": { "type": "string", "nullable": true }, "searchFieldKey": { "type": "string", "nullable": true }, "isCountryRequired": { "type": "boolean" }, "countrySearchFieldKey": { "type": "string", "nullable": true }, "defaultCountrySearch": { "type": "string", "nullable": true }, "primarySearchResultFieldKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "secondarySearchResultFieldKeys": { "type": "array", "items": { "type": "string" }, "nullable": true }, "populateNewRequestDetails": { "type": "boolean" } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.FrontOfficeConfig": { "type": "object", "properties": { "newRequestDetailsCategory": { "type": "string", "nullable": true }, "productRequestDetailsCategory": { "type": "string", "nullable": true }, "dashboardDetailsCategories": { "type": "array", "items": { "type": "string" }, "nullable": true }, "productRequestsEnabled": { "type": "boolean", "nullable": true }, "enforceProductCaptureNewClients": { "type": "boolean", "nullable": true }, "enforceProductCaptureMaintenance": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.InvestmentAccountPageConfig": { "type": "object", "properties": { "investmentAccountsFilteringEnabled": { "type": "boolean", "nullable": true }, "investmentAccountsSections": { "type": "array", "items": { "type": "string" }, "nullable": true }, "investmentAccountDataCategory": { "type": "array", "items": { "type": "string" }, "nullable": true }, "investmentAccountDocumentType": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.JourneyConfig": { "type": "object", "properties": { "isCompletedAndCancelledJourneysHidingEnabled": { "type": "boolean" }, "isHideCancelledJourneysEnabled": { "type": "boolean" }, "isHideWaivedDocumentsEnabled": { "type": "boolean" }, "isHideDeferredDocumentsEnabled": { "type": "boolean" } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.MaintenanceRequestConfig": { "type": "object", "properties": { "isEnabled": { "type": "boolean" }, "businessCategory": { "type": "string", "nullable": true }, "journeyType": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.ProductPageConfig": { "type": "object", "properties": { "productsDetailsCategories": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }