Every API here is available over the APIs.io API and to AI agents over MCP.
{
"openapi": "3.0.4",
"info": {
"title": "Fenergo Nebula Portal Tenant Command",
"description": "**Portal Tenant API**:\n\n<br> 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.<br /><br /><b>Required permissions:</b><br />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": "<br /><br /><b>Required permissions:</b><br />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": "<br /><br /><b>Required permissions:</b><br />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": "<br /><br /><b>Required permissions:</b><br />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": "<br /><br /><b>Required permissions:</b><br />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.<br /><br /><b>Required permissions:</b><br />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": {
# --- truncated at 32 KB (159 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fenergo/refs/heads/main/openapi/fenergo-portaltenantcommand-v4-0-openapi.json