openapi: 3.2.0 info: title: Fenergo Portal Users API version: '4.0' description: 'Operations tagged PortalUsers 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: PortalUsers paths: /api/portal-users/adduserentitylinks: post: tags: - PortalUsers summary: Links portal user to entities description: 'Creates 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 servers: - url: /portaltenantcommand /api/portal-users/updateuserstatus: put: tags: - PortalUsers summary: Changes portal user active status description: 'Activate 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 servers: - url: /portaltenantcommand /api/portal-users/deleteuserentitylink/{id}: delete: tags: - PortalUsers summary: Deletes User EntityLink description: 'Deletes 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 servers: - url: /portaltenantcommand /api/portal-users/createuser: post: tags: - PortalUsers summary: Creates portal user description: 'Creates 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 servers: - url: /portaltenantcommand /api/portal-users/remove/{id}: delete: tags: - PortalUsers summary: Deletes portal user description: 'Deletes 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 servers: - url: /portaltenantcommand /api/portal-users/updateuserdetails: put: tags: - PortalUsers summary: Updates Portal user details description: 'Updates 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 servers: - url: /portaltenantcommand /api/portal-users/createuserwithentitieslinks: post: tags: - PortalUsers summary: Creates portal user or uses existing one and links it with entities description: 'Creates 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 servers: - url: /portaltenantcommand /api/portal-users/portalusers: post: tags: - PortalUsers summary: Gets Portal Users description: 'Returns list of users. Required permissions: Following permissions are required: PortalTenantUserAdmin' operationId: GetPortalUsers parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Query portal user request content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserQueryPagedDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserResultDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.String__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /portaltenantquery /api/portal-users/userdetails/{id}: get: tags: - PortalUsers summary: Gets Portal User details description: 'Returns details of portal user. Required permissions: Following permissions are required: PortalTenantUserAdmin' operationId: GetPortalUserDetails parameters: - name: id in: path description: User id required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserDto__Fenergo.Nebula.Portal.Tenant.Shared__Version_4.1.6.0__Culture_neutral__PublicKeyToken_null' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.String__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /portaltenantquery /api/portal-users/portaluserslinked/{entityId}: get: tags: - PortalUsers summary: Gets Portal Users linked to entity description: 'Returns list of linked portal users. Required permissions: At least one of the following permissions is required: QuickLinkAccess, PortalTenantUserAdmin' operationId: GetPortalUsersLinkedToEntity parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserLinkedResultDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.String__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /portaltenantquery /api/portal-users/searchportaluserslinked/{entityId}: post: tags: - PortalUsers summary: Search Portal Users linked to entity description: 'Returns list of linked portal users. Required permissions: At least one of the following permissions is required: QuickLinkAccess, PortalTenantUserAdmin' operationId: SearchPortalUsersLinkedToEntity parameters: - name: entityId in: path description: Entity id required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchPortalUsersLinkedToEntityDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserLinkedResultDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.String__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /portaltenantquery /api/portal-users/searchforlinklecandidates: post: tags: - PortalUsers summary: Searches for Legal Entities List to be linked to a Portal User description: 'Returns list of possible entities to be linked to portal user. Required permissions: Following permissions are required: PortalTenantUserAdmin' operationId: SearchForLinkLeCandidates parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchForLinkLeCandidatesDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.LeCandidatesResultDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.String__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /portaltenantquery /api/portal-users/userdetails/{id}/nolinks: get: tags: - PortalUsers summary: Gets Portal User details without linked entities description: 'Returns details of portal user without linked entities. Required permissions: Following permissions are required: PortalTenantUserAdmin' operationId: GetPortalUserDetailsWithoutLinkedEntities parameters: - name: id in: path description: User id required: true schema: type: string - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserWithoutLinkedEntitiesDto__Fenergo.Nebula.Portal.Tenant.Shared__Version_4.1.6.0__Culture_neutral__PublicKeyToken_null' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.String__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /portaltenantquery /api/portal-users/searchlinkedentities: post: tags: - PortalUsers summary: Searches for Legal Entities linked to a Portal User description: 'Returns paginated list of Legal Entities linked to Portal User. Required permissions: Following permissions are required: PortalTenantUserAdmin' operationId: SearchLinkedEntities parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchLinkedEntitiesRequestDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchLinkedEntitiesResponseDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null' '404': description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: Not Found type: Error errorCode: Error Code '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.Object__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__System.String__System.Private.CoreLib__Version_8.0.0.0__Culture_neutral__PublicKeyToken_7cec85d7bea7798e' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT servers: - url: /portaltenantquery components: schemas: Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.AddUserEntityLinkDto: type: object properties: userId: type: - string - 'null' description: Id of a portal user example: auth0|62d80dff81333797e736099a entityIds: type: - array - 'null' items: type: string description: List of entities to link example: - 4f474c1a-6926-4f1b-8f4f-f294c45524a3 journeyId: type: - string - 'null' description: 'Journey the user is being linked from. When supplied and the user has a Front Office role, an outreach user journey link is created in addition to the entity link.' additionalProperties: false description: Request DTO representing entities to link to portal user 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 - 'null' description: Id of a portal user example: auth0|62d80dff81333797e736099a additionalProperties: false description: Request DTO representing property which define a status of a user Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.CreateUserDto: type: object properties: email: type: - string - 'null' description: User email example: example@fenergo.com roles: type: - array - 'null' items: type: string description: Roles to be assigned to the user additionalProperties: false description: DTO representing user 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.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.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.Platform.Core.Models.Response.ServiceResponse: 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.Command.Application.Dto.CreateUserWithEntitiesLinksDto: type: object properties: email: type: - string - 'null' description: User email example: example@fenergo.com roles: type: - array - 'null' items: type: string description: Roles to be assigned to the user entitiesIds: type: - array - 'null' items: type: string description: Entity ID example: - 941a59d5-4835-4755-9da9-efff70598ba0 firstName: type: - string - 'null' description: First name of the portal user (stored in Auth0 user_metadata) lastName: type: - string - 'null' description: Last name of the portal user (stored in Auth0 user_metadata) journeyId: type: - string - 'null' description: 'Journey the user is being linked from. When supplied and the resolved role is Front Office, an outreach user journey link is created in addition to the entity link.' additionalProperties: false description: DTO representing request data for linking an entity to a created or existing user ? 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 - '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.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.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.Portal.Tenant.Shared.Dto.AccessLayersConfigMetadataDto: type: object properties: accessLayerIds: type: - array - 'null' items: type: string productFieldAccessLayerIds: type: - array - 'null' items: type: string additionalProperties: false ? 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 - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Command.Application.Dto.AddUserEntityLinkDto' 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.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.Portal.Tenant.Shared.Dto.JourneysDashboardMetadataDto: type: object properties: dashboardIdPrefilterFields: type: - object - 'null' additionalProperties: uniqueItems: true type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardFieldDto' 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.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.PortalUserLightDto: type: object properties: id: type: - string - 'null' email: type: - string - 'null' username: type: - string - 'null' status: type: - string - 'null' lastLogin: type: - string - 'null' format: date-time firstName: type: - string - 'null' lastName: type: - string - 'null' roles: type: - array - 'null' items: type: string 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.SearchDashboardMetadataDto: type: object properties: prefilterValue: type: - string - 'null' deprecated: true dashboardIdPrefilterFields: type: - object - 'null' additionalProperties: uniqueItems: true type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardFieldDto' additionalProperties: false Fenergo.Nebula.Portal.Tenant.Shared.Dto.LanguageInfoDto: type: object properties: isoCode: type: - string - 'null' additionalProperties: false ? 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 - '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.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.UpdateUserDetailsRequestDto: type: object properties: userId: type: - string - 'null' description: Id of a portal user example: auth0|62d80dff81333797e736099a languageInfo: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.LanguageInfoDto' roles: type: - array - 'null' items: type: string description: Roles to be assigned to the user 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 - 'null' description: First name of the portal user lastName: type: - string - 'null' description: Last name of the portal user additionalProperties: false description: Request DTO for updating user details ? 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.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.Portal.Tenant.Command.Application.Dto.UpdateUserDetailsResponseDto: type: object properties: languageInfo: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.LanguageInfoDto' roles: type: - array - 'null' items: type: string description: Roles assigned to the user 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 - 'null' description: First name of the portal user lastName: type: - string - 'null' description: Last name of the portal user additionalProperties: false description: Response DTO representing the result of updating user details Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardFieldDto: required: - fieldKey type: object properties: fieldKey: minLength: 1 type: string fieldValue: type: - string - 'null' fieldValues: type: - array - 'null' items: type: string additionalProperties: false Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardFieldDto: type: object properties: fieldKey: type: - string - 'null' fieldValue: type: - string - 'null' fieldValues: type: - array - 'null' items: type: string additionalProperties: false ? 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 - '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.Query.Application.Dto.PropertyViewModelDto: type: object properties: value: type: - string - 'null' description: Entity property value example: Poland type: type: - string - 'null' description: Entity property type example: multiselect additionalProperties: false description: Request DTO representing entity properties to search Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserLinkedResultDto: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserLinkedDto' description: Items for the current page. totalItems: type: integer description: Total count of items. format: int32 example: 1 additionalProperties: false description: Response DTO representing paged list of portal users result with linked entity ? Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserWithoutLinkedEntitiesDto__Fenergo.Nebula.Portal.Tenant.Shared__Version_4.1.6.0__Culture_neutral__PublicKeyToken_null : type: object properties: data: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserWithoutLinkedEntitiesDto' messages: type: - array - '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.Query.Application.Dto.PortalUserResultDto: type: object properties: items: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserLightDto' description: Items for the current page. totalItems: type: integer description: Total count of items. format: int32 example: 1 additionalProperties: false description: Response DTO representing paged list of portal users result Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserDto: type: object properties: id: type: - string - 'null' email: type: - string - 'null' username: type: - string - 'null' status: type: - string - 'null' lastLogin: type: - string - 'null' format: date-time firstName: type: - string - 'null' lastName: type: - string - 'null' roles: type: - array - 'null' items: type: string searchDashboardMetadata: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardMetadataDto' journeysDashboardMetadata: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardMetadataDto' accessLayersConfig: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.AccessLayersConfigMetadataDto' linkedEntities: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.LinkedEntitiesDto' passwordResetTicketExpirationDate: type: - string - 'null' languageInfo: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.LanguageInfoDto' additionalProperties: false Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUsersSearchCriteriaDto: type: object properties: email: type: - string - 'null' description: User email example: example@fenergo.com username: type: - string - 'null' description: Username example: example@fenergo.com status: type: - string - 'null' description: User status example: ActivationRequired additionalProperties: false description: Request DTO to query for users ? Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchLinkedEntitiesRequestDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null : required: - data type: object properties: data: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchLinkedEntitiesRequestDto' additionalProperties: false description: Service request data ? Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserQueryPagedDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null : required: - data type: object properties: data: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserQueryPagedDto' additionalProperties: false description: Service request data Fenergo.Nebula.Portal.Tenant.Shared.Dto.LinkedEntitiesDto: type: object properties: id: type: string format: uuid entityId: type: string format: uuid name: type: - string - 'null' type: type: - string - 'null' createdDate: type: - string - 'null' format: date-time additionalProperties: false ? Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchPortalUsersLinkedToEntityDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null : type: object properties: data: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchPortalUsersLinkedToEntityDto' additionalProperties: false description: Service request data Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.EntityViewModelDto: type: object properties: properties: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PropertyViewModelDto' description: Entity properties to search example: firstName: value: John type: text lastName: value: '' type: text nationality: value: Ireland type: multiselect type: type: - string - 'null' description: Entity type example: Individual additionalProperties: false description: Request DTO representing entity model to search ? Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserLinkedResultDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null : type: object properties: data: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserLinkedResultDto' messages: type: - array - '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.Query.Application.Dto.SearchPortalUsersLinkedToEntityDto: type: object properties: userName: type: - string - 'null' description: User Name pagingInfo: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PagingInfoDto' additionalProperties: false description: DTO representing search portal users linked to entity ? Fenergo.Nebula.Platform.Core.Models.Request.ServiceRequest_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchForLinkLeCandidatesDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null : required: - data type: object properties: data: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchForLinkLeCandidatesDto' additionalProperties: false description: Service request data Fenergo.Nebula.Platform.Data.Abstractions.Search.Pager.PagerDto: type: object properties: size: type: integer description: Size of the page (result set) format: int32 example: 5 exclusiveMinimum: 0 from: minimum: 0 type: integer description: Position for the search results to start format: int32 example: 0 sortBy: type: - string - 'null' description: Column to sort by example: created sortOrder: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Data.Abstractions.Search.Pager.SortOrder' additionalProperties: false description: Specification of search result page Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchLinkedEntitiesResponseDto: type: object properties: entities: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.LinkedEntitiesDto' description: List of Legal Entities linked to a Portal User. totalItems: type: integer description: Total count of items. format: int64 example: 1 additionalProperties: false description: Response DTO to return Legal Entities list with Total Items found number Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PagingInfoDto: type: object properties: count: type: integer description: Number of elements per page format: int32 page: type: integer description: Page Number format: int32 additionalProperties: false description: DTO representing paging information Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserQueryPagedDto: type: object properties: pager: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Data.Abstractions.Search.Pager.PagerDto' searchCriteria: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUsersSearchCriteriaDto' additionalProperties: false description: Request DTO to query for a paged list of portal users ? Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchLinkedEntitiesResponseDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null : type: object properties: data: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchLinkedEntitiesResponseDto' messages: type: - array - '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.Query.Application.Dto.LegalEntityPropertyDto: type: object properties: key: type: - string - 'null' description: Entity property key example: firstName value: type: - string - 'null' description: Entity property value example: John additionalProperties: false description: Request DTO representing entity properties Fenergo.Nebula.Platform.Data.Abstractions.Search.Pager.SortOrder: enum: - 0 - 1 type: integer description: Sort Order (Ascending or Descending) format: int32 Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.LeCandidatesResultDto: type: object properties: legalEntitiesCandidates: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.LegalEntitiesResponseDto' description: List of possible Legal Entities to be linked to a Portal User. totalItems: type: integer description: Total count of items. format: int64 example: 1 additionalProperties: false description: Response DTO to return LE Candidates list with Total Items found number Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.SearchLinkedEntitiesRequestDto: type: object properties: userId: type: - string - 'null' description: Id of a portal user example: auth0|62d80dff81333797e736099a entityViewModel: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.EntityViewModelDto' pager: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Data.Abstractions.Search.Pager.PagerDto' additionalProperties: false description: Request DTO to query for a legal entities candidates to link with portal user Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.LegalEntitiesResponseDto: type: object properties: entityId: type: string description: The Id of the entity format: uuid example: 315df981-38a0-4145-836b-8d22745887b6 properties: type: - array - 'null' items: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.LegalEntityPropertyDto' description: List of entity properties additionalProperties: false description: Response DTO to return legal entity ? Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserDto__Fenergo.Nebula.Portal.Tenant.Shared__Version_4.1.6.0__Culture_neutral__PublicKeyToken_null : type: object properties: data: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserDto' messages: type: - array - '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.Query.Application.Dto.SearchForLinkLeCandidatesDto: type: object properties: userId: type: - string - 'null' description: Id of a portal user example: auth0|62d80dff81333797e736099a entityViewModel: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.EntityViewModelDto' visibleColumns: type: - array - 'null' items: type: string description: List of columns example: - firstName - dateOfBirth - middleName - lastName - nationality pager: $ref: '#/components/schemas/Fenergo.Nebula.Platform.Data.Abstractions.Search.Pager.PagerDto' additionalProperties: false description: Request DTO to query for a legal entities candidates to link with portal user ? Fenergo.Nebula.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.LeCandidatesResultDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null : type: object properties: data: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.LeCandidatesResultDto' messages: type: - array - '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.Platform.Core.Models.Response.ServiceResponse_1__Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserResultDto__Fenergo.Nebula.Portal.Tenant.Query.Application__Version_4.1.0.0__Culture_neutral__PublicKeyToken_null : type: object properties: data: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Query.Application.Dto.PortalUserResultDto' messages: type: - array - '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.SearchDashboardFieldDto_2: type: object properties: fieldKey: type: - string - 'null' fieldValue: type: - string - 'null' fieldValues: type: - array - 'null' items: type: string additionalProperties: false Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserLinkedDto: type: object properties: id: type: - string - 'null' email: type: - string - 'null' username: type: - string - 'null' status: type: - string - 'null' lastLogin: type: - string - 'null' format: date-time firstName: type: - string - 'null' lastName: type: - string - 'null' roles: type: - array - 'null' items: type: string searchDashboardMetadata: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardMetadataDto' journeysDashboardMetadata: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardMetadataDto' accessLayersConfig: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.AccessLayersConfigMetadataDto' userEntityLinkId: type: string format: uuid additionalProperties: false Fenergo.Nebula.Portal.Tenant.Shared.Dto.PortalUserWithoutLinkedEntitiesDto: type: object properties: id: type: - string - 'null' email: type: - string - 'null' username: type: - string - 'null' status: type: - string - 'null' lastLogin: type: - string - 'null' format: date-time roles: type: - array - 'null' items: type: string searchDashboardMetadata: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.SearchDashboardMetadataDto' journeysDashboardMetadata: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.JourneysDashboardMetadataDto' accessLayersConfig: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.AccessLayersConfigMetadataDto' hasLinkedEntities: type: boolean passwordResetTicketExpirationDate: type: - string - 'null' languageInfo: $ref: '#/components/schemas/Fenergo.Nebula.Portal.Tenant.Shared.Dto.LanguageInfoDto' firstName: type: - string - 'null' lastName: type: - string - 'null' 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