{
"openapi": "3.0.4",
"info": {
"title": "Fenergo Nebula Portal Tenant Command",
"description": "**Portal Tenant API**:\n\n
Portal Tenant API provides methods related to the Portal Users. It should be used to create, update and remove Portal Users. The Portal Tenant API can also be used to link or unlink Portal Users to legal entities, once a user is linked to an entity then can access it from the Fen-X Portal.\n\n",
"version": "4.0"
},
"servers": [
{
"url": "/portaltenantcommand"
}
],
"paths": {
"/api/dashboard/entitytypedashboardconfig": {
"put": {
"tags": [
"Dashboard"
],
"summary": "Upserts dashboard config with fields grouped by entity type",
"description": "\nUpserts dashboard config with fields grouped by entity type.
Required permissions:
Following permissions are required: DashboardEdit",
"operationId": "UpsertEntityTypeDashboardConfig",
"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": "EntityTypeDashboardConfigDto dto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpsertEntityTypeDashboardConfigDto, Fenergo.Nebula.Portal.Tenant.Command.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"
}
}
}
},
"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`1[[System.Collections.Generic.List`1[[Fenergo.Nebula.Platform.Core.Models.Validation.ValidationErrorModel, Fenergo.Nebula.Platform.Core.Models, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"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": {
"put": {
"tags": [
"Domain"
],
"summary": "Updates 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"
}
],
"requestBody": {
"description": "Email domain id and sender address to apply",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateBrandEmailSettingsDto, Fenergo.Nebula.Portal.Tenant.Command.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateBrandEmailSettingsDto, Fenergo.Nebula.Portal.Tenant.Command.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateBrandEmailSettingsDto, Fenergo.Nebula.Portal.Tenant.Command.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"204": {
"description": "No Content"
},
"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/sendemail": {
"post": {
"tags": [
"Email"
],
"summary": "Sends Email using configured Outreach Email Domain",
"description": "
Required permissions:
Following permissions are required: PortalTenantAccess",
"operationId": "SendEmail",
"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": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.SendEmailDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"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]]"
}
}
}
},
"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": {
"post": {
"tags": [
"EmailTemplate"
],
"summary": "Creates a new Email Template",
"description": "
Required permissions:
Following permissions are required: PortalTenantEdit",
"operationId": "AddEmailTemplate",
"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": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.EmailTemplate.AddEmailTemplateDto"
}
}
}
},
"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]]"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse"
}
}
}
},
"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}": {
"put": {
"tags": [
"EmailTemplate"
],
"summary": "Updates an Email Template's content",
"description": "
Required permissions:
Following permissions are required: PortalTenantEdit",
"operationId": "UpdateEmailTemplate",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "portalUrl",
"in": "query",
"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"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.EmailTemplate.UpdateEmailTemplateContentDto"
}
}
}
},
"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": {
"put": {
"tags": [
"GlobalSettings"
],
"summary": "Updates the global portal tenant settings",
"description": "
Required permissions:
Following permissions are required: PortalTenantEdit",
"operationId": "UpdateGlobalPortalTenantSettings",
"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": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateGlobalPortalTenantSettingsDto"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse"
}
}
}
},
"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/updateroledetails": {
"put": {
"tags": [
"PortalRole"
],
"summary": "Updates portal user role editable config",
"description": "\nUpdates portal user role editable config.
Required permissions:
Following permissions are required: UserRoleConfiguration",
"operationId": "UpdateRoleDetails",
"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": "UpdatePortalRoleDto dto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdatePortalRoleDto, Fenergo.Nebula.Portal.Tenant.Command.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"
}
}
}
},
"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`1[[System.Collections.Generic.List`1[[Fenergo.Nebula.Platform.Core.Models.Validation.ValidationErrorModel, Fenergo.Nebula.Platform.Core.Models, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"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/setdefaultrole/{id}": {
"put": {
"tags": [
"PortalRole"
],
"summary": "Set portal user role as default",
"description": "\nSets portal user role as default.
Required permissions:
Following permissions are required: UserRoleConfiguration",
"operationId": "SetDefaultRole",
"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"
}
}
}
},
"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`1[[System.Collections.Generic.List`1[[Fenergo.Nebula.Platform.Core.Models.Validation.ValidationErrorModel, Fenergo.Nebula.Platform.Core.Models, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"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/createrole": {
"post": {
"tags": [
"PortalRole"
],
"summary": "Creates user role",
"description": "\nCreates user role.
Required permissions:
Following permissions are required: UserRoleConfiguration",
"operationId": "CreateRole",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "Create role request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.CreatePortalRoleDto, Fenergo.Nebula.Portal.Tenant.Command.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.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. Tenant or Dashboard with given id does not exist.",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values or roles limit has been exceeded",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Collections.Generic.List`1[[Fenergo.Nebula.Platform.Core.Models.Validation.ValidationErrorModel, Fenergo.Nebula.Platform.Core.Models, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"202": {
"description": "Success. Role created"
},
"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/delete/{id}": {
"delete": {
"tags": [
"PortalRole"
],
"summary": "Deletes portal role",
"description": "\nDeletes portal role.
Required permissions:
Following permissions are required: UserRoleDelete",
"operationId": "DeletePortalRole",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Role 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": {
"204": {
"description": "No Content"
},
"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`1[[System.Collections.Generic.List`1[[Fenergo.Nebula.Platform.Core.Models.Validation.ValidationErrorModel, Fenergo.Nebula.Platform.Core.Models, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"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/adduserentitylinks": {
"post": {
"tags": [
"PortalUsers"
],
"summary": "Links portal user to entities",
"description": "\nCreates a link between portal user and entities.
Required permissions:
Following permissions are required: PortalTenantUserAdmin",
"operationId": "AddUserEntityLinks",
"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": "Link portal user to entity request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.AddUserEntityLinkDto, Fenergo.Nebula.Portal.Tenant.Command.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[[System.Collections.Generic.IEnumerable`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.AddUserEntityLinkDto, Fenergo.Nebula.Portal.Tenant.Command.Application, Version=4.1.0.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"
}
]
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Collections.Generic.List`1[[Fenergo.Nebula.Platform.Core.Models.Validation.ValidationErrorModel, Fenergo.Nebula.Platform.Core.Models, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"202": {
"description": "Success. User Entity Link created"
},
"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/updateuserstatus": {
"put": {
"tags": [
"PortalUsers"
],
"summary": "Changes portal user active status",
"description": "\nActivate or deactivate portal user.
Required permissions:
Following permissions are required: PortalTenantUserAdmin",
"operationId": "UpdateUserStatus",
"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": "ChangeUserStatus dto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateUserStatusDto, Fenergo.Nebula.Portal.Tenant.Command.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.Shared.Dto.PortalUserLightDto, 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"
}
]
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Collections.Generic.List`1[[Fenergo.Nebula.Platform.Core.Models.Validation.ValidationErrorModel, Fenergo.Nebula.Platform.Core.Models, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"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/deleteuserentitylink/{id}": {
"delete": {
"tags": [
"PortalUsers"
],
"summary": "Deletes User EntityLink",
"description": "\nDeletes a link between entity and portal user.
Required permissions:
Following permissions are required: PortalTenantUserAdmin",
"operationId": "DeleteUserEntityLink",
"parameters": [
{
"name": "id",
"in": "path",
"description": "User Entity Link 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[[System.String, 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/createuser": {
"post": {
"tags": [
"PortalUsers"
],
"summary": "Creates portal user",
"description": "\nCreates portal user.
Required permissions:
Following permissions are required: PortalTenantUserAdmin",
"operationId": "CreateUser",
"parameters": [
{
"name": "X-TENANT-ID",
"in": "header",
"description": "The UiD of the tenant representing organization",
"required": true,
"schema": {
"type": "string"
},
"example": "b11f8be3-f29b-4959-8964-956d4af7c468"
}
],
"requestBody": {
"description": "Create user request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.CreateUserDto, Fenergo.Nebula.Portal.Tenant.Command.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.Shared.Dto.PortalUserLightDto, Fenergo.Nebula.Portal.Tenant.Shared, Version=4.1.6.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"403": {
"description": "Forbidden. Portal authentication flow type restricts from creating new users",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse"
}
}
}
},
"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. Tenant with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"409": {
"description": "Conflict saving changes in expected version",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/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": "There are conflicts that cannot be resolved automatically, get latest and apply your changes",
"type": "Error",
"errorCode": "CONFLICT"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Collections.Generic.List`1[[Fenergo.Nebula.Platform.Core.Models.Validation.ValidationErrorModel, Fenergo.Nebula.Platform.Core.Models, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"202": {
"description": "Success. User created"
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"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/remove/{id}": {
"delete": {
"tags": [
"PortalUsers"
],
"summary": "Deletes portal user",
"description": "\nDeletes portal user.
Required permissions:
Following permissions are required: PortalTenantUserAdmin, PortalTenantUserAdminDelete",
"operationId": "RemovePortalUser",
"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": {
"204": {
"description": "No Content"
},
"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/updateuserdetails": {
"put": {
"tags": [
"PortalUsers"
],
"summary": "Updates Portal user details",
"description": "\nUpdates Portal user details.
Required permissions:
Following permissions are required: PortalTenantUserAdmin",
"operationId": "UpdateUserDetails",
"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": "UpdateUserDetails dto",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateUserDetailsRequestDto, Fenergo.Nebula.Portal.Tenant.Command.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.Command.Application.Dto.UpdateUserDetailsResponseDto, Fenergo.Nebula.Portal.Tenant.Command.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`1[[System.Collections.Generic.List`1[[Fenergo.Nebula.Platform.Core.Models.Validation.ValidationErrorModel, Fenergo.Nebula.Platform.Core.Models, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"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/createuserwithentitieslinks": {
"post": {
"tags": [
"PortalUsers"
],
"summary": "Creates portal user or uses existing one and links it with entities",
"description": "\nCreates portal user or uses existing one and links it with entities.
Required permissions:
At least one of the following permissions is required: QuickLinkEdit, PortalTenantUserAdmin",
"operationId": "CreateUserWithEntitiesLinks",
"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": "Creates portal user or uses existing one and links it with entities request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.CreateUserWithEntitiesLinksDto, Fenergo.Nebula.Portal.Tenant.Command.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"responses": {
"200": {
"description": "Success. Entities links created for newly created or existing user",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.CreateUserWithEntitiesLinksResponseDto, Fenergo.Nebula.Portal.Tenant.Command.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]"
}
}
}
},
"403": {
"description": "Forbidden. Portal authentication flow type restricts from creating new users",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse"
}
}
}
},
"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. Tenant with given id does not exist",
"type": "Error",
"errorCode": "Error Code"
}
]
}
}
}
},
"409": {
"description": "Conflict saving changes in expected version",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/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": "There are conflicts that cannot be resolved automatically, get latest and apply your changes",
"type": "Error",
"errorCode": "CONFLICT"
}
]
}
}
}
},
"400": {
"description": "Bad request. The request has missing/invalid values",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse`1[[System.Collections.Generic.List`1[[Fenergo.Nebula.Platform.Core.Models.Validation.ValidationErrorModel, Fenergo.Nebula.Platform.Core.Models, Version=4.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]"
}
}
}
},
"401": {
"description": "User is not authorized to perform this request",
"content": {
"application/json": {
"example": {
"message": "Unauthorized"
}
}
}
},
"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.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.AddUserEntityLinkDto, Fenergo.Nebula.Portal.Tenant.Command.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.AddUserEntityLinkDto"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.CreatePortalRoleDto, Fenergo.Nebula.Portal.Tenant.Command.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.CreatePortalRoleDto"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.CreateUserDto, Fenergo.Nebula.Portal.Tenant.Command.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.CreateUserDto"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.CreateUserWithEntitiesLinksDto, Fenergo.Nebula.Portal.Tenant.Command.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.CreateUserWithEntitiesLinksDto"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateBrandEmailSettingsDto, Fenergo.Nebula.Portal.Tenant.Command.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateBrandEmailSettingsDto"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdatePortalRoleDto, Fenergo.Nebula.Portal.Tenant.Command.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdatePortalRoleDto"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateUserDetailsRequestDto, Fenergo.Nebula.Portal.Tenant.Command.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateUserDetailsRequestDto"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateUserStatusDto, Fenergo.Nebula.Portal.Tenant.Command.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateUserStatusDto"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpsertEntityTypeDashboardConfigDto, Fenergo.Nebula.Portal.Tenant.Command.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpsertEntityTypeDashboardConfigDto"
}
},
"additionalProperties": false,
"description": "Service request data"
},
"Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest`1[[Fenergo.Nebula.Portal.Tenant.Shared.Dto.SendEmailDto, 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.SendEmailDto"
}
},
"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": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/T"
},
"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.Command.Application.Dto.CreateUserWithEntitiesLinksResponseDto, Fenergo.Nebula.Portal.Tenant.Command.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.CreateUserWithEntitiesLinksResponseDto"
},
"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.Command.Application.Dto.UpdateUserDetailsResponseDto, Fenergo.Nebula.Portal.Tenant.Command.Application, Version=4.1.0.0, Culture=neutral, PublicKeyToken=null]]": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateUserDetailsResponseDto"
},
"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.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.PortalUserLightDto, 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.PortalUserLightDto"
},
"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.IEnumerable`1[[Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.AddUserEntityLinkDto, Fenergo.Nebula.Portal.Tenant.Command.Application, Version=4.1.0.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.Command.Application.Dto.AddUserEntityLinkDto"
},
"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.Platform.Core.Models.Validation.ValidationErrorModel, Fenergo.Nebula.Platform.Core.Models, Version=4.0.0.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.Platform.Core.Models.Validation.ValidationErrorModel"
},
"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",
"example": {
"data": [
{
"propertyName": "data",
"errorMessage": "Data is required",
"attemptedValue": "",
"errorCode": "NotNullValidator"
}
],
"messages": [
{
"message": "Data is required",
"type": "Error",
"errorCode": "Error Code"
}
]
}
},
"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.Core.Models.Validation.ValidationErrorModel": {
"type": "object",
"properties": {
"propertyName": {
"type": "string",
"description": "Name of the property",
"nullable": true,
"example": "data"
},
"errorMessage": {
"type": "string",
"description": "User friendly error message",
"nullable": true,
"example": "Data is required"
},
"attemptedValue": {
"description": "Invalid value",
"nullable": true
},
"errorCode": {
"type": "string",
"description": "Internal error code",
"nullable": true,
"example": "NotNullValidator"
}
},
"additionalProperties": false,
"description": "Represents the details of validation error"
},
"Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.AddUserEntityLinkDto": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "Id of a portal user",
"nullable": true,
"example": "auth0|62d80dff81333797e736099a"
},
"entityIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of entities to link",
"nullable": true,
"example": [
"4f474c1a-6926-4f1b-8f4f-f294c45524a3"
]
},
"journeyId": {
"type": "string",
"description": "Journey the user is being linked from. When supplied and the user has a Front Office role,\nan outreach user journey link is created in addition to the entity link.",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request DTO representing entities to link to portal user"
},
"Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.CreatePortalRoleDto": {
"type": "object",
"properties": {
"roleName": {
"type": "string",
"description": "Name of the portal role",
"nullable": true,
"example": "Client"
},
"entityTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of entity types associated with the role",
"nullable": true,
"example": [
"Company",
"Individual"
]
},
"journeyTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of journey types associated with the role",
"nullable": true,
"example": [
"Client Onboarding",
"Offboarding"
]
},
"isNewClientRequestEnabled": {
"type": "boolean",
"description": "Value indicating whether new client request functionality is enabled",
"example": true
},
"dashboardId": {
"type": "string",
"description": "Dashboard identifier associated with the role",
"nullable": true,
"example": "12345678-1234-1234-1234-323456789012"
},
"isAddingUserEnabled": {
"type": "boolean",
"description": "Value indicating whether adding users is enabled for this role",
"example": false
},
"receiveOutreachEmailNotification": {
"type": "boolean",
"description": "Value indicating whether the role receives outreach email notifications",
"example": false
},
"journeyAccessEnabled": {
"type": "boolean",
"description": "Value indicating whether journey access is enabled",
"example": false
},
"portalType": {
"type": "string",
"description": "Type of portal associated with the role",
"nullable": true,
"example": "Front Office"
},
"showLegalEntityDeleteButton": {
"type": "boolean",
"description": "Value indicating whether legal entity delete button is shown",
"example": true
},
"entityTypeDisplay": {
"type": "string",
"description": "Display configuration for entity type",
"nullable": true,
"example": "Dropdown"
},
"externalDataConfig": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.ExternalDataConfigDto"
},
"maintenanceRequestConfig": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.MaintenanceRequestConfigDto"
},
"frontOfficeConfig": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.FrontOfficeConfigDto"
},
"entityPageConfig": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.EntityPageConfigDto"
},
"enableAccessLayers": {
"type": "boolean",
"description": "Value indicating whether access layers are enabled",
"example": true
},
"enableProductFieldAccessLayers": {
"type": "boolean",
"description": "Value indicating whether product field access layers are enabled",
"example": true
},
"journeyConfig": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneyConfigDto"
},
"frontOfficeNotificationSendCancelledJourneyEmail": {
"type": "boolean",
"description": "Value indicating whether front office notifications send cancelled journey emails",
"example": false
},
"frontOfficeNotificationDisplayEntityName": {
"type": "boolean",
"description": "Value indicating whether front office notifications display entity name",
"example": true
}
},
"additionalProperties": false,
"description": "DTO for creating a new portal role"
},
"Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.CreateUserDto": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "User email",
"nullable": true,
"example": "example@fenergo.com"
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Roles to be assigned to the user",
"nullable": true
}
},
"additionalProperties": false,
"description": "DTO representing user data"
},
"Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.CreateUserWithEntitiesLinksDto": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "User email",
"nullable": true,
"example": "example@fenergo.com"
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Roles to be assigned to the user",
"nullable": true
},
"entitiesIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Entity ID",
"nullable": true,
"example": [
"941a59d5-4835-4755-9da9-efff70598ba0"
]
},
"firstName": {
"type": "string",
"description": "First name of the portal user (stored in Auth0 user_metadata)",
"nullable": true
},
"lastName": {
"type": "string",
"description": "Last name of the portal user (stored in Auth0 user_metadata)",
"nullable": true
},
"journeyId": {
"type": "string",
"description": "Journey the user is being linked from. When supplied and the resolved role is Front Office,\nan outreach user journey link is created in addition to the entity link.",
"nullable": true
}
},
"additionalProperties": false,
"description": "DTO representing request data for linking an entity to a created or existing user"
},
"Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.CreateUserWithEntitiesLinksResponseDto": {
"type": "object",
"properties": {
"portalUser": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserLightDto"
},
"isAttemptToCreateDuplicatedLinks": {
"type": "boolean",
"description": "'True' means that portal user has already been linked to at least one entity which was requested"
}
},
"additionalProperties": false,
"description": "Response DTO representing light data of Portal user and list of warning messages if there were potential duplication of links between a user and entities"
},
"Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateBrandEmailSettingsDto": {
"type": "object",
"properties": {
"emailDomainId": {
"type": "string",
"format": "uuid",
"nullable": true
},
"emailSender": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateGlobalPortalTenantSettingsDto": {
"type": "object",
"properties": {
"userManagement": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateUserManagementSettingsDto"
}
},
"additionalProperties": false
},
"Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdatePortalRoleDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the portal role",
"nullable": true,
"example": "rol_1tsrNuKp7vJbd91k"
},
"roleName": {
"type": "string",
"description": "Name of the portal role",
"nullable": true,
"example": "Administrator"
},
"isNewClientRequestEnabled": {
"type": "boolean",
"description": "Value indicating whether new client request functionality is enabled",
"example": true
},
"entityTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of entity types associated with the role",
"nullable": true,
"example": [
"Company",
"Individual"
]
},
"journeyTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of journey types associated with the role",
"nullable": true,
"example": [
"Client Onboarding",
"Maintenance"
]
},
"dashboardId": {
"type": "string",
"description": "Dashboard identifier associated with the role",
"nullable": true,
"example": "12345678-1234-1234-1234-123456789012"
},
"isAddingUserEnabled": {
"type": "boolean",
"description": "Value indicating whether adding users is enabled for this role",
"example": false
},
"receiveOutreachEmailNotification": {
"type": "boolean",
"description": "Value indicating whether the role receives outreach email notifications",
"example": true
},
"journeyAccessEnabled": {
"type": "boolean",
"description": "Value indicating whether journey access is enabled",
"example": true
},
"portalType": {
"type": "string",
"description": "Type of portal associated with the role",
"nullable": true,
"example": "Standard"
},
"frontOfficeNotificationSendCancelledJourneyEmail": {
"type": "boolean",
"description": "Value indicating whether front office notifications send cancelled journey emails",
"example": false
},
"frontOfficeNotificationDisplayEntityName": {
"type": "boolean",
"description": "Value indicating whether front office notifications display entity name",
"example": true
},
"entityTypeDisplay": {
"type": "string",
"description": "Display configuration for entity type",
"nullable": true,
"example": "Radio Button"
},
"showLegalEntityDeleteButton": {
"type": "boolean",
"description": "Value indicating whether legal entity delete button is shown",
"example": false
},
"externalDataConfig": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.ExternalDataConfigDto"
},
"maintenanceRequestConfig": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.MaintenanceRequestConfigDto"
},
"frontOfficeConfig": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.FrontOfficeConfigDto"
},
"entityPageConfig": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.EntityPageConfigDto"
},
"enableAccessLayers": {
"type": "boolean",
"description": "Value indicating whether access layers are enabled",
"example": true
},
"enableProductFieldAccessLayers": {
"type": "boolean",
"description": "Value indicating whether product field access layers are enabled",
"example": true
},
"journeyConfig": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneyConfigDto"
}
},
"additionalProperties": false,
"description": "DTO for updating portal role configuration"
},
"Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateUserDetailsRequestDto": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "Id of a portal user",
"nullable": true,
"example": "auth0|62d80dff81333797e736099a"
},
"languageInfo": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.LanguageInfoDto"
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Roles to be assigned to the user",
"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"
},
"firstName": {
"type": "string",
"description": "First name of the portal user",
"nullable": true
},
"lastName": {
"type": "string",
"description": "Last name of the portal user",
"nullable": true
}
},
"additionalProperties": false,
"description": "Request DTO for updating user details"
},
"Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateUserDetailsResponseDto": {
"type": "object",
"properties": {
"languageInfo": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.LanguageInfoDto"
},
"roles": {
"type": "array",
"items": {
"type": "string"
},
"description": "Roles assigned to the user",
"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"
},
"firstName": {
"type": "string",
"description": "First name of the portal user",
"nullable": true
},
"lastName": {
"type": "string",
"description": "Last name of the portal user",
"nullable": true
}
},
"additionalProperties": false,
"description": "Response DTO representing the result of updating user details"
},
"Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateUserManagementSettingsDto": {
"type": "object",
"properties": {
"capturePortalUserName": {
"type": "boolean"
}
},
"additionalProperties": false
},
"Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdateUserStatusDto": {
"type": "object",
"properties": {
"isActive": {
"type": "boolean",
"description": "Information if user is active",
"example": false
},
"userId": {
"type": "string",
"description": "Id of a portal user",
"nullable": true,
"example": "auth0|62d80dff81333797e736099a"
}
},
"additionalProperties": false,
"description": "Request DTO representing property which define a status of a user"
},
"Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpsertEntityTypeDashboardConfigDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Dashboard Config Id",
"nullable": true,
"example": "3f3df0f2-2c54-4ebd-83e8-5ec8e2684138"
},
"name": {
"type": "string",
"description": "Dashboard Config Name",
"nullable": true,
"example": "3f3df0f2-2c54-4ebd-83e8-5ec8e2684138"
},
"fields": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardFieldDto"
},
"description": "Dashboard Fields List",
"nullable": true
},
"dashboardType": {
"type": "string",
"description": "Dashboard Type",
"nullable": true
},
"entityTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "List of entity types for the Search Dashboard. \nValid values: \"Company\", \"Individual\".\nRequired when dashboard type is Search.",
"nullable": true,
"example": [
"Company",
"Individual"
]
},
"displayJourneyData": {
"type": "boolean",
"description": "A boolean property indicating whether journey data should be displayed on the dashboard."
},
"displayJourneyState": {
"type": "boolean",
"description": "A boolean property indicating whether journey data displayed on the dashboard should include a column with Journey State."
},
"dashboardFieldsConfig": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.DashboardFieldsConfigDto"
},
"description": "Dashboard Fields Config for given Entity Type",
"nullable": true
},
"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.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.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.AddEmailTemplateDto": {
"required": [
"defaults",
"name",
"type"
],
"type": "object",
"properties": {
"name": {
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"type": {
"minLength": 1,
"type": "string"
},
"defaults": {
"$ref": "#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.EmailTemplate.EmailTemplateContentDto"
}
},
"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.EmailTemplate.UpdateEmailTemplateContentDto": {
"required": [
"buttonText",
"mainText",
"subject",
"subText"
],
"type": "object",
"properties": {
"subject": {
"maxLength": 200,
"minLength": 1,
"type": "string"
},
"mainText": {
"maxLength": 5000,
"minLength": 1,
"type": "string"
},
"subText": {
"maxLength": 5000,
"type": "string"
},
"buttonText": {
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"footerText": {
"type": "string",
"nullable": true
},
"isEnabled": {
"type": "boolean",
"nullable": true
}
},
"additionalProperties": false
},
"Fenergo.Nebula.Portal.Tenant.Shared.Dto.EntityPageConfigDto": {
"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.Dto.ExternalDataConfigDto": {
"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.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.JourneyConfigDto": {
"type": "object",
"properties": {
"isCompletedAndCancelledJourneysHidingEnabled": {
"type": "boolean"
},
"isHideCancelledJourneysEnabled": {
"type": "boolean"
},
"isHideWaivedDocumentsEnabled": {
"type": "boolean"
},
"isHideDeferredDocumentsEnabled": {
"type": "boolean"
}
},
"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.MaintenanceRequestConfigDto": {
"type": "object",
"properties": {
"isEnabled": {
"type": "boolean"
},
"businessCategory": {
"type": "string",
"nullable": true
},
"journeyType": {
"type": "string",
"nullable": true
}
},
"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.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.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": {
"required": [
"fieldKey"
],
"type": "object",
"properties": {
"fieldKey": {
"minLength": 1,
"type": "string"
},
"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.Dto.SendEmailDto": {
"type": "object",
"properties": {
"to": {
"type": "string",
"nullable": true
},
"templateName": {
"type": "string",
"nullable": true
},
"variables": {
"type": "object",
"additionalProperties": {
"type": "string",
"nullable": true
},
"nullable": true
},
"journeyId": {
"type": "string",
"nullable": true
},
"isJourneyCancelled": {
"type": "boolean"
},
"entityName": {
"type": "string",
"nullable": true
},
"portalUrl": {
"type": "string",
"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": {
"required": [
"investmentAccountsSections"
],
"type": "object",
"properties": {
"investmentAccountsFilteringEnabled": {
"type": "boolean",
"nullable": true
},
"investmentAccountsSections": {
"minItems": 1,
"type": "array",
"items": {
"type": "string"
}
},
"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
},
"T": {
"type": "object",
"additionalProperties": false
}
},
"securitySchemes": {
"Bearer": {
"type": "apiKey",
"description": "Please insert JWT with Bearer into field",
"name": "Authorization",
"in": "header"
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}