openapi: 3.2.0 info: title: Fenergo Portal Role API version: '4.0' description: 'Operations tagged PortalRole across 2 of this provider''s published API definitions: fenergo-portaltenantcommand-v4-0-openapi.json, fenergo-portaltenantquery-v4-0-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: /portaltenantcommand - url: /portaltenantquery security: - Bearer: [] tags: - name: PortalRole paths: /api/portal-roles/updateroledetails: put: tags: - PortalRole summary: Updates portal user role editable config description: 'Updates 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 servers: - url: /portaltenantcommand /api/portal-roles/setdefaultrole/{id}: put: tags: - PortalRole summary: Set portal user role as default description: 'Sets 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 servers: - url: /portaltenantcommand /api/portal-roles/createrole: post: tags: - PortalRole summary: Creates user role description: 'Creates 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 servers: - url: /portaltenantcommand /api/portal-roles/delete/{id}: delete: tags: - PortalRole summary: Deletes portal role description: 'Deletes 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 servers: - url: /portaltenantcommand /api/portal-roles/portalrole/{id}: get: tags: - PortalRole summary: Gets role with the corresponding Id description: 'Required permissions: Following permissions are required: UserRoleAccess' operationId: GetPortalRoleById parameters: - name: id in: path description: The Role identifier. required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalRoleDto__Fenergo.Nebula.Portal.Tenant.Shared__Version_4.1.6.0__Culture_neutral__PublicKeyToken_null' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.String__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /portaltenantquery /api/portal-roles/portalroles: get: tags: - PortalRole summary: Gets portal available roles description: 'Required permissions: At least one of the following permissions is required: UserRoleAccess, PortalTenantUserAdmin' operationId: GetPortalRoles parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Collections.Generic.List_1__Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalRoleDto__Fenergo.Nebula.Portal.Tenant.Shared__Version_4.1.6.0__Culture_neutral__PublicKeyToken_null____System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.String__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /portaltenantquery components: schemas: ? 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 messages: type: - array - 'null' 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 additionalProperties: false description: Service response data Fenergo.Nebula.Portal.Tenant.Shared.Dto.FrontOfficeConfigDto: type: object properties: notificationDisplayEntityName: type: - boolean - 'null' notificationSendCancelledJourneyEmail: type: - boolean - 'null' newRequestDetailsCategory: type: - string - 'null' productRequestDetailsCategory: type: - string - 'null' dashboardDetailsCategories: type: - array - 'null' items: type: string productRequestsEnabled: type: - boolean - 'null' enforceProductCaptureNewClients: type: - boolean - 'null' enforceProductCaptureMaintenance: type: - boolean - 'null' additionalProperties: false Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.ExternalDataConfig: type: object properties: isEnabled: type: boolean providerId: type: - string - 'null' searchFieldKey: type: - string - 'null' isCountryRequired: type: boolean countrySearchFieldKey: type: - string - 'null' defaultCountrySearch: type: - string - 'null' primarySearchResultFieldKeys: type: - array - 'null' items: type: string secondarySearchResultFieldKeys: type: - array - 'null' items: type: string populateNewRequestDetails: type: boolean additionalProperties: false Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalRoleEditableConfigDto: type: object properties: isNewClientRequestEnabled: type: boolean entityTypes: type: - array - 'null' items: type: string journeyTypes: type: - array - 'null' items: type: string lastUpdatedDate: type: - string - 'null' format: date-time dashboardId: type: - string - 'null' isAddingUserEnabled: type: boolean receiveOutreachEmailNotification: type: - boolean - 'null' journeyAccessEnabled: type: - boolean - 'null' portalType: type: - string - 'null' frontOfficeNotificationSendCancelledJourneyEmail: type: - boolean - 'null' frontOfficeNotificationDisplayEntityName: type: - boolean - 'null' entityTypeDisplay: type: - string - 'null' showLegalEntityDeleteButton: type: - boolean - 'null' 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 - 'null' enableProductFieldAccessLayers: type: - boolean - 'null' journeyConfig: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.JourneyConfig' 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.Models.Role.JourneyConfig: type: object properties: isCompletedAndCancelledJourneysHidingEnabled: type: boolean isHideCancelledJourneysEnabled: type: boolean isHideWaivedDocumentsEnabled: type: boolean isHideDeferredDocumentsEnabled: type: boolean additionalProperties: false Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponseMessage: type: object properties: message: type: - string - 'null' description: The message example: Success type: type: - string - 'null' description: 'Type of the message One of Info, Warning, Error, Forbidden' example: Info errorCode: type: - string - 'null' description: Error Code example: INTERNAL_SERVER_ERROR additionalProperties: false description: The message associated to the service response Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.InvestmentAccountPageConfig: required: - investmentAccountsSections type: object properties: investmentAccountsFilteringEnabled: type: - boolean - 'null' investmentAccountsSections: minItems: 1 type: array items: type: string investmentAccountDataCategory: type: - array - 'null' items: type: string investmentAccountDocumentType: type: - array - 'null' items: type: string additionalProperties: false Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1: type: object properties: data: $ref: '#/components/schemas/T' messages: type: - array - 'null' 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 additionalProperties: false description: Service response data Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.UpdatePortalRoleDto: type: object properties: id: type: - string - 'null' description: Unique identifier of the portal role example: rol_1tsrNuKp7vJbd91k roleName: type: - string - 'null' description: Name of the portal role example: Administrator isNewClientRequestEnabled: type: boolean description: Value indicating whether new client request functionality is enabled example: true entityTypes: type: - array - 'null' items: type: string description: List of entity types associated with the role example: - Company - Individual journeyTypes: type: - array - 'null' items: type: string description: List of journey types associated with the role example: - Client Onboarding - Maintenance dashboardId: type: - string - 'null' description: Dashboard identifier associated with the role 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 - 'null' description: Type of portal associated with the role 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 - 'null' description: Display configuration for entity type 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.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 - 'null' 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 additionalProperties: false description: Service response data Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.ProductPageConfig: type: object properties: productsDetailsCategories: type: - array - 'null' items: type: string additionalProperties: false Fenergo.Nebula.Platform.Core.Models.Validation.ValidationErrorModel: type: object properties: propertyName: type: - string - 'null' description: Name of the property example: data errorMessage: type: - string - 'null' description: User friendly error message example: Data is required attemptedValue: description: Invalid value errorCode: type: - string - 'null' description: Internal error code example: NotNullValidator additionalProperties: false description: Represents the details of validation error Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.MaintenanceRequestConfig: type: object properties: isEnabled: type: boolean businessCategory: type: - string - 'null' journeyType: type: - string - 'null' additionalProperties: false Fenergo.Nebula.Portal.Tenant.Shared.Dto.ExternalDataConfigDto: type: object properties: isEnabled: type: boolean providerId: type: - string - 'null' searchFieldKey: type: - string - 'null' isCountryRequired: type: boolean countrySearchFieldKey: type: - string - 'null' defaultCountrySearch: type: - string - 'null' primarySearchResultFieldKeys: type: - array - 'null' items: type: string secondarySearchResultFieldKeys: type: - array - 'null' items: type: string populateNewRequestDetails: type: boolean additionalProperties: false ? 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 - 'null' description: The service response DTO messages: type: - array - 'null' 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 additionalProperties: false description: Service response data Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalRoleDto: type: object properties: id: type: - string - 'null' name: type: - string - 'null' 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.EntityPageConfigDto: type: object properties: entityPageDataReqCategory: type: - string - 'null' showEntityProfilePageV2: type: - boolean - 'null' entityPageDisplayDocuments: type: - boolean - 'null' entityPageDocumentTypes: type: - array - 'null' items: type: string 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 - 'null' items: type: string orderCompanyDetailsCategoriesAlphabetically: type: boolean individualDetailsDisplayCategories: type: - array - 'null' items: type: string orderIndividualDetailsCategoriesAlphabetically: type: boolean otherEntityDisplayCategories: type: - array - 'null' items: type: string orderOtherEntityDetailsCategoriesAlphabetically: type: boolean productPageConfig: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.ProductPageConfig' additionalProperties: false ? 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.Portal.Tenant.Shared.Dto.MaintenanceRequestConfigDto: type: object properties: isEnabled: type: boolean businessCategory: type: - string - 'null' journeyType: type: - string - 'null' additionalProperties: false T: type: object additionalProperties: false ? 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 - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Validation.ValidationErrorModel' description: The service response DTO messages: type: - array - 'null' 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 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.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.Portal.Tenant.Shared.Models.Role.EntityPageConfig: type: object properties: entityPageDataReqCategory: type: - string - 'null' showEntityProfilePageV2: type: - boolean - 'null' entityPageDisplayDocuments: type: - boolean - 'null' entityPageDocumentTypes: type: - array - 'null' items: type: string 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 - 'null' items: type: string orderCompanyDetailsCategoriesAlphabetically: type: boolean individualDetailsDisplayCategories: type: - array - 'null' items: type: string orderIndividualDetailsCategoriesAlphabetically: type: boolean otherEntityDisplayCategories: type: - array - 'null' items: type: string orderOtherEntityDetailsCategoriesAlphabetically: type: boolean productPageConfig: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.ProductPageConfig' additionalProperties: false Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.CreatePortalRoleDto: type: object properties: roleName: type: - string - 'null' description: Name of the portal role example: Client entityTypes: type: - array - 'null' items: type: string description: List of entity types associated with the role example: - Company - Individual journeyTypes: type: - array - 'null' items: type: string description: List of journey types associated with the role example: - Client Onboarding - Offboarding isNewClientRequestEnabled: type: boolean description: Value indicating whether new client request functionality is enabled example: true dashboardId: type: - string - 'null' description: Dashboard identifier associated with the role 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 - 'null' description: Type of portal associated with the role example: Front Office showLegalEntityDeleteButton: type: boolean description: Value indicating whether legal entity delete button is shown example: true entityTypeDisplay: type: - string - 'null' description: Display configuration for entity type 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.Platform.Core.Models.Response.ServiceResponse_1__System.Collections.Generic.List_1__Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalRoleDto__Fenergo.Nebula.Portal.Tenant.Shared__Version_4.1.6.0__Culture_neutral__PublicKeyToken_null____System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e : type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalRoleDto' description: The service response DTO messages: type: - array - 'null' 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 additionalProperties: false description: Service response data Fenergo.Nebula.Portal.Tenant.Shared.Models.Role.InvestmentAccountPageConfig_2: type: object properties: investmentAccountsFilteringEnabled: type: - boolean - 'null' investmentAccountsSections: type: - array - 'null' items: type: string investmentAccountDataCategory: type: - array - 'null' items: type: string investmentAccountDocumentType: type: - array - 'null' items: type: string additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header x-refined-from: - fenergo-portaltenantcommand-v4-0-openapi.json - fenergo-portaltenantquery-v4-0-openapi.json