Other API Documents
\r\n \r\n{{user_name}} has completed {{training_name}}
"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Certificate.CertificateDetailRestDTO" }, "example": {"availableForRequests":[],"name":"Security Awareness Completion Certificate","description":"Awarded upon successful completion of the security awareness training program.","template":"{{user_name}} has completed {{training_name}}
"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Certificate.CertificateDetailRestDTO" }, "example": {"availableForRequests":[],"name":"Security Awareness Completion Certificate","description":"Awarded upon successful completion of the security awareness training program.","template":"{{user_name}} has completed {{training_name}}
"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Certificate.CertificateDetailRestDTO" }, "example": {"availableForRequests":[],"name":"Security Awareness Completion Certificate","description":"Awarded upon successful completion of the security awareness training program.","template":"{{user_name}} has completed {{training_name}}
"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ServiceResult`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } }, "delete": { "tags": [ "Awareness Training" ], "summary": "Permanently deletes a certificate template by its resource ID.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the certificate template to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/certificates/search/export": { "post": { "tags": [ "Awareness Training" ], "summary": "Exports the list of certificate templates matching the search criteria to a downloadable file (e.g., CSV, Excel).", "requestBody": { "description": "Export criteria including filters, sorting, and the desired export format.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/certificates": { "post": { "tags": [ "Awareness Training" ], "summary": "Creates a new certificate template with custom HTML design and availability settings for use in training enrollments.", "requestBody": { "description": "The certificate template payload including HTML template, name, and availability settings.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Certificate.CertificateDetailRestDTO" }, "example": {"availableForRequests":[],"name":"Security Awareness Completion Certificate","description":"Awarded upon successful completion of the security awareness training program.","template":"{{user_name}} has completed {{training_name}}
"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Certificate.CertificateDetailRestDTO" }, "example": {"availableForRequests":[],"name":"Security Awareness Completion Certificate","description":"Awarded upon successful completion of the security awareness training program.","template":"{{user_name}} has completed {{training_name}}
"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Certificate.CertificateDetailRestDTO" }, "example": {"availableForRequests":[],"name":"Security Awareness Completion Certificate","description":"Awarded upon successful completion of the security awareness training program.","template":"{{user_name}} has completed {{training_name}}
"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Certificate.CertificateDetailRestDTO" }, "example": {"availableForRequests":[],"name":"Security Awareness Completion Certificate","description":"Awarded upon successful completion of the security awareness training program.","template":"{{user_name}} has completed {{training_name}}
"} } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/certificates/{resourceId}/default": { "post": { "tags": [ "Awareness Training" ], "summary": "Sets the specified certificate template as the default for the current company, used when no specific certificate is assigned to an enrollment.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the certificate template to set as default.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ServiceResult`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/certificates/default-template": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves the system default certificate template used when no custom certificate is assigned to an enrollment.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Certificate.CertificateDetailDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/certificates/test-email": { "post": { "tags": [ "Awareness Training" ], "summary": "Sends a test certificate email using the specified template to a given email address, allowing administrators to preview the certificate before using it in enrollments.", "requestBody": { "description": "The test email request including the target email address and certificate template configuration.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Certificate.CertificateTestEmailRequest" }, "example": {"template":"{{user_name}} has completed {{training_name}}
","email":"test@example.com"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Certificate.CertificateTestEmailRequest" }, "example": {"template":"{{user_name}} has completed {{training_name}}
","email":"test@example.com"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Certificate.CertificateTestEmailRequest" }, "example": {"template":"{{user_name}} has completed {{training_name}}
","email":"test@example.com"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Certificate.CertificateTestEmailRequest" }, "example": {"template":"{{user_name}} has completed {{training_name}}
","email":"test@example.com"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Certificate.CertificateTestEmailDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/communities": { "post": { "tags": [ "Awareness Training" ], "summary": "Creates a new threat intelligence sharing community with the specified privacy level (1=Public, 2=Private, 3=Hidden).", "requestBody": { "description": "The community creation payload including name, description, and privacy status.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CreateCommunityRequest" }, "example": {"name":"Financial Services Security Community","description":"A community for sharing phishing threat intelligence and best practices in the financial services industry.","industryResourceId":"In7Kp3mR5xLn","privacyStatusId":1,"isTermsAndConditionsAccepted":true} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CreateCommunityRequest" }, "example": {"name":"Financial Services Security Community","description":"A community for sharing phishing threat intelligence and best practices in the financial services industry.","industryResourceId":"In7Kp3mR5xLn","privacyStatusId":1,"isTermsAndConditionsAccepted":true} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CreateCommunityRequest" }, "example": {"name":"Financial Services Security Community","description":"A community for sharing phishing threat intelligence and best practices in the financial services industry.","industryResourceId":"In7Kp3mR5xLn","privacyStatusId":1,"isTermsAndConditionsAccepted":true} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CreateCommunityRequest" }, "example": {"name":"Financial Services Security Community","description":"A community for sharing phishing threat intelligence and best practices in the financial services industry.","industryResourceId":"In7Kp3mR5xLn","privacyStatusId":1,"isTermsAndConditionsAccepted":true} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/communities/{resourceId}": { "put": { "tags": [ "Awareness Training" ], "summary": "Updates an existing community's name, description, and privacy level (1=Public, 2=Private, 3=Hidden).", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the community to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated community payload including name, description, and privacy status.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.UpdateCommunityRequest" }, "example": {"name":"Financial Services Security Community","description":"A community for sharing phishing threat intelligence, incident response playbooks, and security awareness best practices.","industryResourceId":"In7Kp3mR5xLn","privacyStatusId":2} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.UpdateCommunityRequest" }, "example": {"name":"Financial Services Security Community","description":"A community for sharing phishing threat intelligence, incident response playbooks, and security awareness best practices.","industryResourceId":"In7Kp3mR5xLn","privacyStatusId":2} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.UpdateCommunityRequest" }, "example": {"name":"Financial Services Security Community","description":"A community for sharing phishing threat intelligence, incident response playbooks, and security awareness best practices.","industryResourceId":"In7Kp3mR5xLn","privacyStatusId":2} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.UpdateCommunityRequest" }, "example": {"name":"Financial Services Security Community","description":"A community for sharing phishing threat intelligence, incident response playbooks, and security awareness best practices.","industryResourceId":"In7Kp3mR5xLn","privacyStatusId":2} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Awareness Training" ], "summary": "Permanently deletes a community along with all its associated posts/incidents and membership records.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the community to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves the full details of an existing community by its resource ID, including membership status and privacy settings.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the community to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Community.Dto.CommunityDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/communities/search/all": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches and retrieves a paginated list of all communities, including public, private, and hidden ones visible to the current user.", "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CommunitySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CommunityName","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CommunitySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CommunityName","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CommunitySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CommunityName","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CommunitySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CommunityName","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.Community.Dto.SearchCommunityDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/communities/search/my": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches and retrieves a paginated list of communities that the current user's company owns or is a member of.", "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CommunitySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CommunityName","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CommunitySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CommunityName","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CommunitySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CommunityName","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CommunitySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CommunityName","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.Community.Dto.SearchCommunityDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/communities/{resourceId}/join": { "post": { "tags": [ "Awareness Training" ], "summary": "Sends a request to join a community. Public communities grant immediate membership; private communities require approval from the owner company.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the community to join.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/communities/{resourceId}/membershiprequest": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches and retrieves a paginated list of pending membership requests for a specific community.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the community.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CommunityMembershipSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CommunityMembershipSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CommunityMembershipSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CommunityMembershipSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.Community.Dto.SearchCommunityMembershipResultDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/communities/{resourceId}/member": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches and retrieves a paginated list of current members of a specific community.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the community.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CommunityMembershipSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CommunityMembershipSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CommunityMembershipSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.CommunityMembershipSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.Community.Dto.SearchCommunityMembershipResultDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/communities/membershiprequest/{resourceId}/accept": { "put": { "tags": [ "Awareness Training" ], "summary": "Accepts a pending membership join request, granting the requesting company access to the community.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the membership request to accept.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/communities/membershiprequest/{resourceId}/refuse": { "put": { "tags": [ "Awareness Training" ], "summary": "Refuses a pending membership join request, denying the requesting company access to the community.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the membership request to refuse.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/communities/membershiprequest/{resourceId}/cancel": { "put": { "tags": [ "Awareness Training" ], "summary": "Cancels a previously submitted membership join request to a community.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the membership request to cancel.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/communities/{resourceId}/invite": { "post": { "tags": [ "Awareness Training" ], "summary": "Invites companies by email addresses to join a community. A maximum of 5 email addresses can be provided per request.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the community to invite users to.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The invitation request containing an array of email addresses to invite.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.InviteToCommunityRequest" }, "example": {"emailArray":["john.doe@example.com","jane.smith@example.com"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.InviteToCommunityRequest" }, "example": {"emailArray":["john.doe@example.com","jane.smith@example.com"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.InviteToCommunityRequest" }, "example": {"emailArray":["john.doe@example.com","jane.smith@example.com"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.InviteToCommunityRequest" }, "example": {"emailArray":["john.doe@example.com","jane.smith@example.com"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.Community.Dto.InviteToCommunityDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/communities/my-invitations": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves all pending community invitations received by the current user's company.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.Community.Dto.CommunityInvitationDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/communities/{resourceId}/membershiprequest-count": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves the count of active (pending) membership requests for a specific community.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the community.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Community.Dto.MembershipRequestCountDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/communities/my-invitations-count": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves the total count of pending community invitations received by the current user's company.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Community.Dto.InvitationCountDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/communities/suggested": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves a list of suggested communities that the current user's company may be interested in joining.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.Community.Dto.SuggestedCommunityDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/communities/{resourceId}/appoint-owner": { "post": { "tags": [ "Awareness Training" ], "summary": "Appoints a member company as co-owner of the specified community, granting them administrative privileges.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the community.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The appointment request including the company to be made owner.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.AppointCommunityOwnerRequest" }, "example": {"appointedCompanyResourceId":"65BVv1136Vnp"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.AppointCommunityOwnerRequest" }, "example": {"appointedCompanyResourceId":"65BVv1136Vnp"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.AppointCommunityOwnerRequest" }, "example": {"appointedCompanyResourceId":"65BVv1136Vnp"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.AppointCommunityOwnerRequest" }, "example": {"appointedCompanyResourceId":"65BVv1136Vnp"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/communities/{resourceId}/remove-member": { "delete": { "tags": [ "Awareness Training" ], "summary": "Removes a member company from the specified community, revoking their access to community posts and data.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the community.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The removal request identifying the company to remove.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.RemoveCommunityMemberRequest" }, "example": {"removedCompanyResourceId":"65BVv1136Vnp"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.RemoveCommunityMemberRequest" }, "example": {"removedCompanyResourceId":"65BVv1136Vnp"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.RemoveCommunityMemberRequest" }, "example": {"removedCompanyResourceId":"65BVv1136Vnp"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Community.RemoveCommunityMemberRequest" }, "example": {"removedCompanyResourceId":"65BVv1136Vnp"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/communities/{resourceId}/leave": { "post": { "tags": [ "Awareness Training" ], "summary": "Removes the current user's company from a community. If the company is the community owner, another owner must be appointed before leaving.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the community to leave.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/communities/invitations/{resourceId}/accept": { "put": { "tags": [ "Awareness Training" ], "summary": "Accepts a pending community invitation, granting the current user's company membership in the community.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the invitation to accept.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/communities/invitations/{resourceId}/decline": { "put": { "tags": [ "Awareness Training" ], "summary": "Declines a pending community invitation, rejecting the membership offer for the current user's company.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the invitation to decline.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/community-posts/{resourceId}": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves the full details of a community post by its resource ID, including threat indicators and analysis results.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the community post to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.CommunityPost.Dto.GetCommunityPostDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "put": { "tags": [ "Awareness Training" ], "summary": "Updates an existing community post's content, threat indicators, or metadata.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the community post to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated post payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.UpdateCommunityPostRequest" }, "example": {"communityPostEmail":{"resourceId":"65BVv1136Vnp","editableBody":"Please review the attached invoice.","visibleBody":"Please review the attached invoice.","isFromHidden":false,"isFromFlagged":true,"isSubjectHidden":false,"isSubjectFlagged":true,"isToHidden":true,"isToFlagged":false,"isCcHidden":false,"isCcFlagged":false,"isBccHidden":false,"isBccFlagged":false,"urls":[{"name":"View Invoice","url":"https://fake-vendor.com/invoice","isHidden":false,"isFlagged":true}],"attachments":[{"resourceId":"Qw4Rt6yU8iOp","isHidden":false,"isFlagged":true}],"emailTexts":[{"text":"Please review the attached invoice.","isHidden":false,"isFlagged":false}]},"title":"Updated: Suspicious Invoice Email","description":"Updated description with additional IOC details from threat analysis.","categoryResourceIdArray":["Kp3mR5xLn7Wq"],"discoveryAndDetection":"Reported via Keepnet Phishing Reporter add-in","affectArea":["Finance","Procurement"],"scope":"Organization-wide","isAnonymous":false,"securityLabelResourceIdArray":["Xn8Jp2qR4mLv"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.UpdateCommunityPostRequest" }, "example": {"communityPostEmail":{"resourceId":"65BVv1136Vnp","editableBody":"Please review the attached invoice.","visibleBody":"Please review the attached invoice.","isFromHidden":false,"isFromFlagged":true,"isSubjectHidden":false,"isSubjectFlagged":true,"isToHidden":true,"isToFlagged":false,"isCcHidden":false,"isCcFlagged":false,"isBccHidden":false,"isBccFlagged":false,"urls":[{"name":"View Invoice","url":"https://fake-vendor.com/invoice","isHidden":false,"isFlagged":true}],"attachments":[{"resourceId":"Qw4Rt6yU8iOp","isHidden":false,"isFlagged":true}],"emailTexts":[{"text":"Please review the attached invoice.","isHidden":false,"isFlagged":false}]},"title":"Updated: Suspicious Invoice Email","description":"Updated description with additional IOC details from threat analysis.","categoryResourceIdArray":["Kp3mR5xLn7Wq"],"discoveryAndDetection":"Reported via Keepnet Phishing Reporter add-in","affectArea":["Finance","Procurement"],"scope":"Organization-wide","isAnonymous":false,"securityLabelResourceIdArray":["Xn8Jp2qR4mLv"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.UpdateCommunityPostRequest" }, "example": {"communityPostEmail":{"resourceId":"65BVv1136Vnp","editableBody":"Please review the attached invoice.","visibleBody":"Please review the attached invoice.","isFromHidden":false,"isFromFlagged":true,"isSubjectHidden":false,"isSubjectFlagged":true,"isToHidden":true,"isToFlagged":false,"isCcHidden":false,"isCcFlagged":false,"isBccHidden":false,"isBccFlagged":false,"urls":[{"name":"View Invoice","url":"https://fake-vendor.com/invoice","isHidden":false,"isFlagged":true}],"attachments":[{"resourceId":"Qw4Rt6yU8iOp","isHidden":false,"isFlagged":true}],"emailTexts":[{"text":"Please review the attached invoice.","isHidden":false,"isFlagged":false}]},"title":"Updated: Suspicious Invoice Email","description":"Updated description with additional IOC details from threat analysis.","categoryResourceIdArray":["Kp3mR5xLn7Wq"],"discoveryAndDetection":"Reported via Keepnet Phishing Reporter add-in","affectArea":["Finance","Procurement"],"scope":"Organization-wide","isAnonymous":false,"securityLabelResourceIdArray":["Xn8Jp2qR4mLv"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.UpdateCommunityPostRequest" }, "example": {"communityPostEmail":{"resourceId":"65BVv1136Vnp","editableBody":"Please review the attached invoice.","visibleBody":"Please review the attached invoice.","isFromHidden":false,"isFromFlagged":true,"isSubjectHidden":false,"isSubjectFlagged":true,"isToHidden":true,"isToFlagged":false,"isCcHidden":false,"isCcFlagged":false,"isBccHidden":false,"isBccFlagged":false,"urls":[{"name":"View Invoice","url":"https://fake-vendor.com/invoice","isHidden":false,"isFlagged":true}],"attachments":[{"resourceId":"Qw4Rt6yU8iOp","isHidden":false,"isFlagged":true}],"emailTexts":[{"text":"Please review the attached invoice.","isHidden":false,"isFlagged":false}]},"title":"Updated: Suspicious Invoice Email","description":"Updated description with additional IOC details from threat analysis.","categoryResourceIdArray":["Kp3mR5xLn7Wq"],"discoveryAndDetection":"Reported via Keepnet Phishing Reporter add-in","affectArea":["Finance","Procurement"],"scope":"Organization-wide","isAnonymous":false,"securityLabelResourceIdArray":["Xn8Jp2qR4mLv"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Awareness Training" ], "summary": "Permanently deletes a community post and all its associated comments and likes.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the community post to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/community-posts/{resourceId}/edit": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves the full details of a community post in edit mode, returning editable fields and raw content for modification.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the community post to edit.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.CommunityPost.Dto.GetCommunityPostDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/community-posts/{resourceId}/preview": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves a read-only preview of a community post, suitable for displaying to users before publishing or sharing.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the community post to preview.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.CommunityPost.Dto.GetCommunityPostDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/community-posts": { "post": { "tags": [ "Awareness Training" ], "summary": "Creates a new threat incident post in a community, sharing email-based threat intelligence with community members.", "requestBody": { "description": "The post creation payload including community ID, threat details, and email content.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.CreateCommunityPostRequest" }, "example": {"communityResourceId":"65BVv1136Vnp","emailPreview":{"initialBody":"Please review the attached invoice.","editableBody":"Please review the attached invoice.","visibleBody":"Please review the attached invoice.","from":"accounts@fake-vendor.com","isFromHidden":false,"isFromFlagged":true,"subject":"Urgent: Invoice #INV-2026-0042","isSubjectHidden":false,"isSubjectFlagged":true,"to":["finance@example.com"],"isToHidden":true,"isToFlagged":false,"cc":["manager@example.com"],"isCcHidden":false,"isCcFlagged":false,"bcc":[],"isBccHidden":false,"isBccFlagged":false,"sentTime":"2026-03-10 09:00:00","urls":[{"url":"https://fake-vendor.com/invoice","isHidden":false,"isFlagged":true,"name":"View Invoice"}],"attachments":[{"resourceId":"Qw4Rt6yU8iOp","name":"invoice.pdf","sha512":"abc123def456","md5":"d41d8cd98f00b204e9800998ecf8427e","contentType":"application/pdf","isHidden":false,"isFlagged":true}],"emailTexts":[{"text":"Please review the attached invoice.","isHidden":false,"isFlagged":false}]},"title":"Suspicious Invoice Email","description":"A phishing email impersonating a vendor was reported by multiple employees requesting wire transfer.","categoryResourceIdArray":["Kp3mR5xLn7Wq"],"discoveryAndDetection":"Reported via Keepnet Phishing Reporter add-in","affectArea":["Finance","Procurement"],"scope":"Organization-wide","isAnonymous":false,"isTermsAndConditionsAccepted":true,"securityLabelResourceIdArray":["Xn8Jp2qR4mLv"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.CreateCommunityPostRequest" }, "example": {"communityResourceId":"65BVv1136Vnp","emailPreview":{"initialBody":"Please review the attached invoice.","editableBody":"Please review the attached invoice.","visibleBody":"Please review the attached invoice.","from":"accounts@fake-vendor.com","isFromHidden":false,"isFromFlagged":true,"subject":"Urgent: Invoice #INV-2026-0042","isSubjectHidden":false,"isSubjectFlagged":true,"to":["finance@example.com"],"isToHidden":true,"isToFlagged":false,"cc":["manager@example.com"],"isCcHidden":false,"isCcFlagged":false,"bcc":[],"isBccHidden":false,"isBccFlagged":false,"sentTime":"2026-03-10 09:00:00","urls":[{"url":"https://fake-vendor.com/invoice","isHidden":false,"isFlagged":true,"name":"View Invoice"}],"attachments":[{"resourceId":"Qw4Rt6yU8iOp","name":"invoice.pdf","sha512":"abc123def456","md5":"d41d8cd98f00b204e9800998ecf8427e","contentType":"application/pdf","isHidden":false,"isFlagged":true}],"emailTexts":[{"text":"Please review the attached invoice.","isHidden":false,"isFlagged":false}]},"title":"Suspicious Invoice Email","description":"A phishing email impersonating a vendor was reported by multiple employees requesting wire transfer.","categoryResourceIdArray":["Kp3mR5xLn7Wq"],"discoveryAndDetection":"Reported via Keepnet Phishing Reporter add-in","affectArea":["Finance","Procurement"],"scope":"Organization-wide","isAnonymous":false,"isTermsAndConditionsAccepted":true,"securityLabelResourceIdArray":["Xn8Jp2qR4mLv"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.CreateCommunityPostRequest" }, "example": {"communityResourceId":"65BVv1136Vnp","emailPreview":{"initialBody":"Please review the attached invoice.","editableBody":"Please review the attached invoice.","visibleBody":"Please review the attached invoice.","from":"accounts@fake-vendor.com","isFromHidden":false,"isFromFlagged":true,"subject":"Urgent: Invoice #INV-2026-0042","isSubjectHidden":false,"isSubjectFlagged":true,"to":["finance@example.com"],"isToHidden":true,"isToFlagged":false,"cc":["manager@example.com"],"isCcHidden":false,"isCcFlagged":false,"bcc":[],"isBccHidden":false,"isBccFlagged":false,"sentTime":"2026-03-10 09:00:00","urls":[{"url":"https://fake-vendor.com/invoice","isHidden":false,"isFlagged":true,"name":"View Invoice"}],"attachments":[{"resourceId":"Qw4Rt6yU8iOp","name":"invoice.pdf","sha512":"abc123def456","md5":"d41d8cd98f00b204e9800998ecf8427e","contentType":"application/pdf","isHidden":false,"isFlagged":true}],"emailTexts":[{"text":"Please review the attached invoice.","isHidden":false,"isFlagged":false}]},"title":"Suspicious Invoice Email","description":"A phishing email impersonating a vendor was reported by multiple employees requesting wire transfer.","categoryResourceIdArray":["Kp3mR5xLn7Wq"],"discoveryAndDetection":"Reported via Keepnet Phishing Reporter add-in","affectArea":["Finance","Procurement"],"scope":"Organization-wide","isAnonymous":false,"isTermsAndConditionsAccepted":true,"securityLabelResourceIdArray":["Xn8Jp2qR4mLv"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.CreateCommunityPostRequest" }, "example": {"communityResourceId":"65BVv1136Vnp","emailPreview":{"initialBody":"Please review the attached invoice.","editableBody":"Please review the attached invoice.","visibleBody":"Please review the attached invoice.","from":"accounts@fake-vendor.com","isFromHidden":false,"isFromFlagged":true,"subject":"Urgent: Invoice #INV-2026-0042","isSubjectHidden":false,"isSubjectFlagged":true,"to":["finance@example.com"],"isToHidden":true,"isToFlagged":false,"cc":["manager@example.com"],"isCcHidden":false,"isCcFlagged":false,"bcc":[],"isBccHidden":false,"isBccFlagged":false,"sentTime":"2026-03-10 09:00:00","urls":[{"url":"https://fake-vendor.com/invoice","isHidden":false,"isFlagged":true,"name":"View Invoice"}],"attachments":[{"resourceId":"Qw4Rt6yU8iOp","name":"invoice.pdf","sha512":"abc123def456","md5":"d41d8cd98f00b204e9800998ecf8427e","contentType":"application/pdf","isHidden":false,"isFlagged":true}],"emailTexts":[{"text":"Please review the attached invoice.","isHidden":false,"isFlagged":false}]},"title":"Suspicious Invoice Email","description":"A phishing email impersonating a vendor was reported by multiple employees requesting wire transfer.","categoryResourceIdArray":["Kp3mR5xLn7Wq"],"discoveryAndDetection":"Reported via Keepnet Phishing Reporter add-in","affectArea":["Finance","Procurement"],"scope":"Organization-wide","isAnonymous":false,"isTermsAndConditionsAccepted":true,"securityLabelResourceIdArray":["Xn8Jp2qR4mLv"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/community-posts/notified-email-preview/{resourceId}": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves a preview of a previously notified/reported email, including its parsed headers, body, and metadata.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the notified email to preview.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.CommunityPost.Dto.CreateCommunityPostEmailDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/community-posts/message-file-preview": { "post": { "tags": [ "Awareness Training" ], "summary": "Parses and previews an uploaded email message file (.eml/.msg), extracting headers, body, and attachment information.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "File": { "type": "string", "description": "Uploaded message file (e.g., .eml or .msg) to be parsed for preview.", "format": "binary" } } }, "encoding": { "File": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.CommunityPost.Dto.CreateCommunityPostEmailDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/community-posts/search": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches and returns a paginated list of community posts across all communities the user's company is a member of or owns.", "requestBody": { "description": "Search criteria including filters, pagination, sorting, and optional company filter.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.SearchCommunityPostRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"PostedTime","ascending":false,"postedCompanyResourceId":"65BVv1136Vnp"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.SearchCommunityPostRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"PostedTime","ascending":false,"postedCompanyResourceId":"65BVv1136Vnp"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.SearchCommunityPostRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"PostedTime","ascending":false,"postedCompanyResourceId":"65BVv1136Vnp"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.SearchCommunityPostRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"PostedTime","ascending":false,"postedCompanyResourceId":"65BVv1136Vnp"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.CommunityPost.Dto.SearchCommunityPostDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/community-posts/search/{communityResourceId}": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches and returns a paginated list of posts within a specific community that the user's company has access to.", "parameters": [ { "name": "communityResourceId", "in": "path", "description": "The unique resource identifier of the community to search posts in.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including filters, pagination, sorting, and optional company filter.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.SearchCommunityPostRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"PostedTime","ascending":false,"postedCompanyResourceId":"65BVv1136Vnp"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.SearchCommunityPostRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"PostedTime","ascending":false,"postedCompanyResourceId":"65BVv1136Vnp"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.SearchCommunityPostRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"PostedTime","ascending":false,"postedCompanyResourceId":"65BVv1136Vnp"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.SearchCommunityPostRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"PostedTime","ascending":false,"postedCompanyResourceId":"65BVv1136Vnp"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.CommunityPost.Dto.SearchCommunityPostDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/community-posts/{resourceId}/like": { "post": { "tags": [ "Awareness Training" ], "summary": "Toggles a like on a community post. If the post is already liked by the current user, the like is removed; otherwise, a like is added.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the community post to like/unlike.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/community-posts/{communityPostResourceId}/comments": { "post": { "tags": [ "Awareness Training" ], "summary": "Creates a new comment on a community post that the user's company has access to.", "parameters": [ { "name": "communityPostResourceId", "in": "path", "description": "The unique resource identifier of the community post to comment on.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The comment creation payload including the comment text.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.CreateCommunityPostCommentRequest" }, "example": {"comment":"We observed a similar campaign targeting our organization last week."} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.CreateCommunityPostCommentRequest" }, "example": {"comment":"We observed a similar campaign targeting our organization last week."} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.CreateCommunityPostCommentRequest" }, "example": {"comment":"We observed a similar campaign targeting our organization last week."} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.CreateCommunityPostCommentRequest" }, "example": {"comment":"We observed a similar campaign targeting our organization last week."} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves all comments on a specific community post, ordered by creation date.", "parameters": [ { "name": "communityPostResourceId", "in": "path", "description": "The unique resource identifier of the community post.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.CommunityPost.Dto.CommunityPostCommentDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/community-posts/comments/{resourceId}": { "put": { "tags": [ "Awareness Training" ], "summary": "Updates an existing comment's text. Only the comment author or the community owner company's users can update a comment.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the comment to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated comment payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.UpdateCommunityPostCommentRequest" }, "example": {"comment":"Updated: We confirmed this is part of the BEC campaign tracked as TA-2026-0315."} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.UpdateCommunityPostCommentRequest" }, "example": {"comment":"Updated: We confirmed this is part of the BEC campaign tracked as TA-2026-0315."} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.UpdateCommunityPostCommentRequest" }, "example": {"comment":"Updated: We confirmed this is part of the BEC campaign tracked as TA-2026-0315."} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.UpdateCommunityPostCommentRequest" }, "example": {"comment":"Updated: We confirmed this is part of the BEC campaign tracked as TA-2026-0315."} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Awareness Training" ], "summary": "Deletes a comment from a community post. Only the comment author or the community owner company's users can delete a comment.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the comment to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/community-posts/my-last-posts": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves the current user's last 10 community posts, useful for displaying recent activity on the user's profile.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.CommunityPost.Dto.GetUsersLastPostDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/community-posts/top-posts": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves the top 10 most popular community posts from communities the user's company is a member of or owns, ranked by engagement.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.CommunityPost.Dto.GetTopPostsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/community-posts/{resourceId}/share": { "post": { "tags": [ "Awareness Training" ], "summary": "Shares a community post via email with specified recipients. A maximum of 5 email addresses can be provided per request.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the community post to share.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The share request containing an array of recipient email addresses.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.SharePostRequest" }, "example": {"emailArray":["john.doe@example.com","jane.smith@example.com"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.SharePostRequest" }, "example": {"emailArray":["john.doe@example.com","jane.smith@example.com"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.SharePostRequest" }, "example": {"emailArray":["john.doe@example.com","jane.smith@example.com"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.SharePostRequest" }, "example": {"emailArray":["john.doe@example.com","jane.smith@example.com"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/community-posts/parse-email-url": { "post": { "tags": [ "Awareness Training" ], "summary": "Parses an HTML email body and extracts all URLs contained within it, useful for threat analysis and indicator extraction.", "requestBody": { "description": "The parse request containing the HTML body to extract URLs from.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.ParseEmailUrlRequest" }, "example": {"htmlBody":"Click here"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.ParseEmailUrlRequest" }, "example": {"htmlBody":"Click here"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.ParseEmailUrlRequest" }, "example": {"htmlBody":"Click here"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CommunityPost.ParseEmailUrlRequest" }, "example": {"htmlBody":"Click here"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.EmailParser.EmlParser+Uri, KeepnetLabs.EmailParser, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/enrollments/phone-number": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves available SMS provider phone numbers that can be used for sending enrollment SMS notifications to target users.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.PhishingScenario.Dto.SmsPhoneNumberDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/enrollments": { "post": { "tags": [ "Awareness Training" ], "summary": "Creates a new training enrollment, assigning trainings to target user groups with scheduling, reminder, and auto-enroll settings.", "requestBody": { "description": "The enrollment configuration including training ID, target groups, scheduling, and notification settings.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EnrollmentStartDTO" }, "example": {"companyId":0,"trainingId":"Tr5Kp2mR7xLv","name":"Security Awareness Q1 2026","targetGroupResourceIds":["Tg8Wp3nQ5vXm"],"languageIds":["0"],"awardCertificate":true,"certificateConfigSendType":"SendOnFirstAttempt","markedAsTest":false,"sendTeamsNotification":false,"sendTemplatesInPreferredLanguage":false,"distributionDelayEvery":0,"distributionDelayTimeTypeId":0,"sendingLimit":0,"isScormProxy":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EnrollmentStartDTO" }, "example": {"companyId":0,"trainingId":"Tr5Kp2mR7xLv","name":"Security Awareness Q1 2026","targetGroupResourceIds":["Tg8Wp3nQ5vXm"],"languageIds":["0"],"awardCertificate":true,"certificateConfigSendType":"SendOnFirstAttempt","markedAsTest":false,"sendTeamsNotification":false,"sendTemplatesInPreferredLanguage":false,"distributionDelayEvery":0,"distributionDelayTimeTypeId":0,"sendingLimit":0,"isScormProxy":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EnrollmentStartDTO" }, "example": {"companyId":0,"trainingId":"Tr5Kp2mR7xLv","name":"Security Awareness Q1 2026","targetGroupResourceIds":["Tg8Wp3nQ5vXm"],"languageIds":["0"],"awardCertificate":true,"certificateConfigSendType":"SendOnFirstAttempt","markedAsTest":false,"sendTeamsNotification":false,"sendTemplatesInPreferredLanguage":false,"distributionDelayEvery":0,"distributionDelayTimeTypeId":0,"sendingLimit":0,"isScormProxy":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EnrollmentStartDTO" }, "example": {"companyId":0,"trainingId":"Tr5Kp2mR7xLv","name":"Security Awareness Q1 2026","targetGroupResourceIds":["Tg8Wp3nQ5vXm"],"languageIds":["0"],"awardCertificate":true,"certificateConfigSendType":"SendOnFirstAttempt","markedAsTest":false,"sendTeamsNotification":false,"sendTemplatesInPreferredLanguage":false,"distributionDelayEvery":0,"distributionDelayTimeTypeId":0,"sendingLimit":0,"isScormProxy":false} } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EnrollmentDetailDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/enrollments/scorm-proxy": { "post": { "tags": [ "Awareness Training" ], "summary": "Creates a SCORM proxy enrollment and returns the SCORM package as a downloadable ZIP file for use in external LMS platforms.", "requestBody": { "description": "The SCORM proxy enrollment request including training ID, name, and optional language.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.CreateScormProxyServiceRequest" }, "example": {"trainingId":"Tr5Kp2mR7xLv","languageId":"0","name":"SCORM Proxy Enrollment"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.CreateScormProxyServiceRequest" }, "example": {"trainingId":"Tr5Kp2mR7xLv","languageId":"0","name":"SCORM Proxy Enrollment"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.CreateScormProxyServiceRequest" }, "example": {"trainingId":"Tr5Kp2mR7xLv","languageId":"0","name":"SCORM Proxy Enrollment"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.CreateScormProxyServiceRequest" }, "example": {"trainingId":"Tr5Kp2mR7xLv","languageId":"0","name":"SCORM Proxy Enrollment"} } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EnrollmentDetailDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/enrollments/downloadscormproxy/{enrollmentId}": { "post": { "tags": [ "Awareness Training" ], "summary": "Downloads the SCORM proxy package for an existing enrollment as a ZIP file for use in external LMS platforms.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment to download the SCORM proxy for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/enrollments/search": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches for active enrollments using the provided criteria and returns a paginated result list.", "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchEnrollmentRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"StartDate","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchEnrollmentRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"StartDate","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchEnrollmentRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"StartDate","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchEnrollmentRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"StartDate","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.PagedResults`1[[KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EnrollmentSearchRestView, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/enrollments/{resourceId}": { "delete": { "tags": [ "Awareness Training" ], "summary": "Archives an active enrollment by setting its status to Archived. Archived enrollments can later be restored or permanently deleted.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the enrollment to archive.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves the full details of an enrollment by its resource ID, including scheduling, reminder, and auto-enroll configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the enrollment to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.GetEnrollmentByIdResponse, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "put": { "tags": [ "Awareness Training" ], "summary": "Updates an existing enrollment's configuration, including scheduling, reminder, and auto-enroll settings.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the enrollment to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated enrollment configuration payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EditEnrollmentServiceRequest" }, "example": {"name":"Updated Enrollment Name","markedAsTest":false,"distributionDays":30} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EditEnrollmentServiceRequest" }, "example": {"name":"Updated Enrollment Name","markedAsTest":false,"distributionDays":30} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EditEnrollmentServiceRequest" }, "example": {"name":"Updated Enrollment Name","markedAsTest":false,"distributionDays":30} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EditEnrollmentServiceRequest" }, "example": {"name":"Updated Enrollment Name","markedAsTest":false,"distributionDays":30} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EnrollmentDetailDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/enrollments/archive/search": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches for archived enrollments using the provided criteria and returns a paginated result list.", "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchEnrollmentRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"StartDate","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchEnrollmentRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"StartDate","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchEnrollmentRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"StartDate","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchEnrollmentRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"StartDate","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.PagedResults`1[[KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EnrollmentSearchRestView, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/enrollments/{enrollmentId}/certificates/search": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches for certificates issued within a specific enrollment, returning a paginated list of certificate records.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment to search certificates for.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EnrollmentCertificateSearchRequest" }, "example": {"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":true,"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]}} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EnrollmentCertificateSearchRequest" }, "example": {"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":true,"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]}} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EnrollmentCertificateSearchRequest" }, "example": {"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":true,"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]}} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EnrollmentCertificateSearchRequest" }, "example": {"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":true,"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]}} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.PagedResults`1[[KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EnrollmentCertificateSearchResult, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/enrollments/resend-certificate": { "post": { "tags": [ "Awareness Training" ], "summary": "Resends training completion certificates via email to the specified target users for their respective enrollments.", "requestBody": { "description": "A list of target user and enrollment pairs identifying which certificates to resend.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.ResendCertificateRequest" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.ResendCertificateRequest" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.ResendCertificateRequest" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.ResendCertificateRequest" } } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ServiceResult`1[[KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.ResendCertificateData, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ServiceResult`1[[KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.ResendCertificateData, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ServiceResult`1[[KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.ResendCertificateData, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/enrollments/archive/{resourceId}": { "delete": { "tags": [ "Awareness Training" ], "summary": "Permanently deletes an enrollment that has been previously archived. Only enrollments with Archived status can be deleted.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the archived enrollment to permanently delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/enrollments/archive/{resourceId}/restore": { "post": { "tags": [ "Awareness Training" ], "summary": "Restores a previously archived enrollment back to active status, allowing it to resume sending notifications and tracking progress.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the archived enrollment to restore.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/enrollments/search/export": { "post": { "tags": [ "Awareness Training" ], "summary": "Exports the list of enrollments matching the search criteria to a downloadable file (e.g., CSV, Excel).", "requestBody": { "description": "Export criteria including filters, sorting, and the desired export format.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ExportEnrollmentRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"StartDate","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ExportEnrollmentRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"StartDate","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ExportEnrollmentRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"StartDate","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ExportEnrollmentRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"StartDate","ascending":false,"reportAllPages":false,"exportType":"Excel"} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/enrollments/{resourceId}/languages": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves the list of languages available for training content within a specific enrollment.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.Collections.Generic.List`1[[KeepnetLabs.AwarenessEducator.Core.Models.Language.LanguageDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/enrollments/{resourceId}/stop": { "post": { "tags": [ "Awareness Training" ], "summary": "Stops an active enrollment, halting all pending notifications and further training delivery to target users.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the enrollment to stop.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/enrollments/{enrollmentId}/stop-reminder": { "post": { "tags": [ "Awareness Training" ], "summary": "Stops the reminder notifications for an enrollment, preventing any further reminder emails from being sent to target users.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment whose reminders should be stopped.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EnrollmentDetailDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/enrollments/{enrollmentId}/stop-autoenroll": { "post": { "tags": [ "Awareness Training" ], "summary": "Stops the auto-enroll feature for an enrollment, preventing new users added to target groups from being automatically enrolled.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment whose auto-enroll should be stopped.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EnrollmentDetailDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/enrollments/{resourceId}/send": { "post": { "tags": [ "Awareness Training" ], "summary": "Triggers immediate sending of enrollment notifications to all target users, bypassing any scheduled delivery time.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the enrollment to send immediately.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/enrollments/{resourceId}/content": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves the training content details for an enrollment, including white-labeling and phishing campaign customization. This anonymous endpoint is used by the training player.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the enrollment whose content to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.EnrollmentContent.EnrollmentContentResultDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/enrollments/form-details": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves all enum types and their values used in enrollment forms, including notification types, scheduling options, and delivery methods.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.EnrollmentEnumTypesDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/enrollments/send-sms": { "post": { "tags": [ "Awareness Training" ], "summary": "Sends enrollment notification to target users via SMS using the configured SMS provider.", "requestBody": { "description": "The SMS request including enrollment details and target user information.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.SendEnrollmentSmsRequest" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","mobilePhoneNumber":"+15551234567","textTemplate":"You have been enrolled in a security training. Please complete it at {{training_url}}","smsProviderNumberResourceId":"Sp3Kp2mR7xLv"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.SendEnrollmentSmsRequest" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","mobilePhoneNumber":"+15551234567","textTemplate":"You have been enrolled in a security training. Please complete it at {{training_url}}","smsProviderNumberResourceId":"Sp3Kp2mR7xLv"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.SendEnrollmentSmsRequest" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","mobilePhoneNumber":"+15551234567","textTemplate":"You have been enrolled in a security training. Please complete it at {{training_url}}","smsProviderNumberResourceId":"Sp3Kp2mR7xLv"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.SendEnrollmentSmsRequest" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","mobilePhoneNumber":"+15551234567","textTemplate":"You have been enrolled in a security training. Please complete it at {{training_url}}","smsProviderNumberResourceId":"Sp3Kp2mR7xLv"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.SendEnrollmentSmsResponse, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/enrollments/send-teams": { "post": { "tags": [ "Awareness Training" ], "summary": "Sends enrollment notification to target users via Microsoft Teams. This anonymous endpoint supports Teams bot integration.", "requestBody": { "description": "The Teams notification request including enrollment details and target user information.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.SendEnrollmentTeamsRequest" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","companyId":0,"enrollmentId":"En8Wp3nQ5vXm","fullname":"John Doe","trainingUrl":"https://training.example.com/start","trainingTitle":"Security Awareness Training","trainingName":"Phishing Awareness 2026"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.SendEnrollmentTeamsRequest" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","companyId":0,"enrollmentId":"En8Wp3nQ5vXm","fullname":"John Doe","trainingUrl":"https://training.example.com/start","trainingTitle":"Security Awareness Training","trainingName":"Phishing Awareness 2026"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.SendEnrollmentTeamsRequest" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","companyId":0,"enrollmentId":"En8Wp3nQ5vXm","fullname":"John Doe","trainingUrl":"https://training.example.com/start","trainingTitle":"Security Awareness Training","trainingName":"Phishing Awareness 2026"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.SendEnrollmentTeamsRequest" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","companyId":0,"enrollmentId":"En8Wp3nQ5vXm","fullname":"John Doe","trainingUrl":"https://training.example.com/start","trainingTitle":"Security Awareness Training","trainingName":"Phishing Awareness 2026"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.SendEnrollmentTeamsResponse, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/enrollments/resend-teams": { "post": { "tags": [ "Awareness Training" ], "summary": "Resends a previously failed Microsoft Teams enrollment notification to target users.", "requestBody": { "description": "The resend request identifying which Teams notifications to retry.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.ResendEnrollmentTeamsRequest" }, "example": {"notificationActivityLogId":12345} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.ResendEnrollmentTeamsRequest" }, "example": {"notificationActivityLogId":12345} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.ResendEnrollmentTeamsRequest" }, "example": {"notificationActivityLogId":12345} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.ResendEnrollmentTeamsRequest" }, "example": {"notificationActivityLogId":12345} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Enrollment.SendEnrollmentTeamsResponse, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/gamificationreport/top-performance/{targetUserResourceId}": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves the top gamification performance data for a specific target user over the last month.", "parameters": [ { "name": "targetUserResourceId", "in": "path", "description": "The unique resource identifier of the target user to retrieve performance for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.GamificationPointScale.Dto.GamificationViewResultDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/gamificationreport/phishing-result/{targetUserResourceId}": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves the phishing simulation test results summary for a specific target user, including pass/fail rates across campaigns.", "parameters": [ { "name": "targetUserResourceId", "in": "path", "description": "The unique resource identifier of the target user.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.GamificationPointScale.Dto.PhishingTestResultSummaryDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/gamificationreport/learning/{targetUserResourceId}": { "post": { "tags": [ "Awareness Training" ], "summary": "Retrieves the learning progress for a specific target user, including completed trainings, scores, and engagement metrics.", "parameters": [ { "name": "targetUserResourceId", "in": "path", "description": "The unique resource identifier of the target user.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Learning request parameters including filters and pagination options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.MyLearningRequestParameter" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false}} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.MyLearningRequestParameter" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false}} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.MyLearningRequestParameter" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false}} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.MyLearningRequestParameter" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false}} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.GamificationPointScale.Dto.MyLearningResultDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/gamificationreport/user-info/{targetUserResourceId}": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves basic profile information for a specific target user, including email, department, phone, and preferred language.", "parameters": [ { "name": "targetUserResourceId", "in": "path", "description": "The unique resource identifier of the target user.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/gamificationreport/badges/{targetUserResourceId}": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves all earned gamification badges for a specific target user based on their training and phishing simulation performance.", "parameters": [ { "name": "targetUserResourceId", "in": "path", "description": "The unique resource identifier of the target user.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.GamificationPointScale.Dto.BadgeInfoDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/gamificationreport/calculate-badges": { "post": { "tags": [ "Awareness Training" ], "summary": "Triggers background badge calculation for multiple target users. Returns immediately while calculation continues asynchronously.", "requestBody": { "description": "Request containing target user resource IDs to calculate badges for (maximum 100 users per request).", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.CalculateBadgesRequest" }, "example": {"targetUserResourceIds":["Tu5Kp2mR7xLv","Tu8Wp3nQ5vXm"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.CalculateBadgesRequest" }, "example": {"targetUserResourceIds":["Tu5Kp2mR7xLv","Tu8Wp3nQ5vXm"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.CalculateBadgesRequest" }, "example": {"targetUserResourceIds":["Tu5Kp2mR7xLv","Tu8Wp3nQ5vXm"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.CalculateBadgesRequest" }, "example": {"targetUserResourceIds":["Tu5Kp2mR7xLv","Tu8Wp3nQ5vXm"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/gamificationreport/badges-cached/{targetUserResourceId}": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves pre-calculated badges from cache for a specific user. Returns completed=false if the background calculation has not finished yet.", "parameters": [ { "name": "targetUserResourceId", "in": "path", "description": "The unique resource identifier of the target user.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.GamificationPointScale.Dto.GetBadgesResponse, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/leaderboard/form-details": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves the gamification form details including available date periods, point scales, and configuration options for the leaderboard UI.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.GamificationPointScale.Dto.GamificationFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/leaderboard/get-top-performers": { "post": { "tags": [ "Awareness Training" ], "summary": "Retrieves the top-performing users on the gamification leaderboard for the specified date period.", "requestBody": { "description": "Search parameters including date period, optional custom date range, and filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardSearchRequestParameter" }, "example": {"datePeriod":"LastMonth","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":true}} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardSearchRequestParameter" }, "example": {"datePeriod":"LastMonth","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":true}} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardSearchRequestParameter" }, "example": {"datePeriod":"LastMonth","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":true}} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardSearchRequestParameter" }, "example": {"datePeriod":"LastMonth","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":true}} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.GamificationPointScale.Dto.GamificationViewResultDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/leaderboard/get-user-timeline": { "post": { "tags": [ "Awareness Training" ], "summary": "Retrieves the gamification performance timeline for a specific user, showing score progression over time.", "requestBody": { "description": "Timeline request parameters including target user, date range, and grouping options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserTimelineRequestParameter" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","datePeriod":"LastMonth","pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false},"showOnlyFailedEvents":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserTimelineRequestParameter" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","datePeriod":"LastMonth","pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false},"showOnlyFailedEvents":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserTimelineRequestParameter" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","datePeriod":"LastMonth","pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false},"showOnlyFailedEvents":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserTimelineRequestParameter" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","datePeriod":"LastMonth","pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false},"showOnlyFailedEvents":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.GamificationPointScale.Dto.GamificationUserTimeLineViewResultDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/leaderboard/get-all": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches and returns the full paginated leaderboard performance list with ranking, scores, and user details.", "requestBody": { "description": "Search parameters including date period, filters, and pagination options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardSearchRequestParameter" }, "example": {"datePeriod":"LastMonth","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":true}} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardSearchRequestParameter" }, "example": {"datePeriod":"LastMonth","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":true}} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardSearchRequestParameter" }, "example": {"datePeriod":"LastMonth","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":true}} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardSearchRequestParameter" }, "example": {"datePeriod":"LastMonth","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":true}} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.GamificationPointScale.Dto.GamificationViewResultDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/leaderboard/get-all/export": { "post": { "tags": [ "Awareness Training" ], "summary": "Exports the leaderboard performance data to a downloadable file (e.g., CSV, Excel).", "requestBody": { "description": "Export parameters including date period, filters, and the desired export format.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardSearchExportRequestParameter" }, "example": {"exportType":"Excel","reportAllPages":false,"datePeriod":"LastMonth","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":true}} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardSearchExportRequestParameter" }, "example": {"exportType":"Excel","reportAllPages":false,"datePeriod":"LastMonth","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":true}} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardSearchExportRequestParameter" }, "example": {"exportType":"Excel","reportAllPages":false,"datePeriod":"LastMonth","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":true}} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardSearchExportRequestParameter" }, "example": {"exportType":"Excel","reportAllPages":false,"datePeriod":"LastMonth","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":true}} } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/leaderboard/get-user-timeline/export": { "post": { "tags": [ "Awareness Training" ], "summary": "Exports the user performance timeline data to a downloadable file (e.g., CSV, Excel).", "requestBody": { "description": "Export parameters including user, date range, and the desired export format.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserTimelineExportRequestParameter" }, "example": {"exportType":"Excel","reportAllPages":false,"targetUserResourceId":"Tu5Kp2mR7xLv","datePeriod":"LastMonth","pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false},"showOnlyFailedEvents":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserTimelineExportRequestParameter" }, "example": {"exportType":"Excel","reportAllPages":false,"targetUserResourceId":"Tu5Kp2mR7xLv","datePeriod":"LastMonth","pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false},"showOnlyFailedEvents":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserTimelineExportRequestParameter" }, "example": {"exportType":"Excel","reportAllPages":false,"targetUserResourceId":"Tu5Kp2mR7xLv","datePeriod":"LastMonth","pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false},"showOnlyFailedEvents":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserTimelineExportRequestParameter" }, "example": {"exportType":"Excel","reportAllPages":false,"targetUserResourceId":"Tu5Kp2mR7xLv","datePeriod":"LastMonth","pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false},"showOnlyFailedEvents":false} } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/leaderboard/user-performance": { "post": { "tags": [ "Awareness Training" ], "summary": "Retrieves detailed gamification performance breakdown for a specific user, including per-activity scores and point sources.", "requestBody": { "description": "Request parameters including the target user and date period.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserRequestParameter" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","datePeriod":"LastMonth"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserRequestParameter" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","datePeriod":"LastMonth"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserRequestParameter" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","datePeriod":"LastMonth"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserRequestParameter" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","datePeriod":"LastMonth"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.GamificationPointScale.Dto.GamificationUserPerformanceViewResultDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/leaderboard/search-with-timeline": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches users with gamification data and timeline in a single request, combining user search and timeline retrieval for efficiency.", "requestBody": { "description": "Search parameters including user filters (FirstName, LastName, Email, Department, ResourceId) and timeline options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserSearchWithTimelineRequestParameter" }, "example": {"datePeriod":"LastMonth","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"showOnlyFailedEvents":false,"userPagination":{"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":true},"timelinePagination":{"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":false},"includeTimeline":true} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserSearchWithTimelineRequestParameter" }, "example": {"datePeriod":"LastMonth","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"showOnlyFailedEvents":false,"userPagination":{"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":true},"timelinePagination":{"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":false},"includeTimeline":true} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserSearchWithTimelineRequestParameter" }, "example": {"datePeriod":"LastMonth","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"showOnlyFailedEvents":false,"userPagination":{"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":true},"timelinePagination":{"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":false},"includeTimeline":true} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserSearchWithTimelineRequestParameter" }, "example": {"datePeriod":"LastMonth","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"showOnlyFailedEvents":false,"userPagination":{"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":true},"timelinePagination":{"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":false},"includeTimeline":true} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardSearchWithTimelineResultDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/scorm/lmsinitialize": { "post": { "tags": [ "Awareness Training" ], "summary": "Initializes a new SCORM learning session for a target user, establishing the session context and returning initial LMS data.", "requestBody": { "description": "The SCORM initialization request including enrollment content ID and target user information.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSInitializeServiceRequest" }, "example": {"enrollmentContentResourceId":"Ec5Kp2mR7xLn","lmsLearnerId":"Lr3Wp8nQ4vXm"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSInitializeServiceRequest" }, "example": {"enrollmentContentResourceId":"Ec5Kp2mR7xLn","lmsLearnerId":"Lr3Wp8nQ4vXm"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSInitializeServiceRequest" }, "example": {"enrollmentContentResourceId":"Ec5Kp2mR7xLn","lmsLearnerId":"Lr3Wp8nQ4vXm"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSInitializeServiceRequest" }, "example": {"enrollmentContentResourceId":"Ec5Kp2mR7xLn","lmsLearnerId":"Lr3Wp8nQ4vXm"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ServiceResult`1[[KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSInitializeDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/scorm/lmsgetvalue": { "post": { "tags": [ "Awareness Training" ], "summary": "Retrieves a specific SCORM data model element value from the current LMS session (e.g., cmi.core.lesson_status, cmi.core.score.raw).", "requestBody": { "description": "The get-value request including session ID and the SCORM data model element name.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSGetValueServiceRequest" }, "example": {"name":"cmi.core.lesson_status","enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSGetValueServiceRequest" }, "example": {"name":"cmi.core.lesson_status","enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSGetValueServiceRequest" }, "example": {"name":"cmi.core.lesson_status","enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSGetValueServiceRequest" }, "example": {"name":"cmi.core.lesson_status","enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/scorm/lmssetvalue": { "post": { "tags": [ "Awareness Training" ], "summary": "Sets a single SCORM data model element value in the current LMS session by queuing the update for asynchronous processing.", "requestBody": { "description": "The set-value request including session ID, element name, and the value to set.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSSetValueServiceRequest" }, "example": {"name":"cmi.core.lesson_status","value":"completed","enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSSetValueServiceRequest" }, "example": {"name":"cmi.core.lesson_status","value":"completed","enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSSetValueServiceRequest" }, "example": {"name":"cmi.core.lesson_status","value":"completed","enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSSetValueServiceRequest" }, "example": {"name":"cmi.core.lesson_status","value":"completed","enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ServiceResult`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/scorm/lmscommit": { "post": { "tags": [ "Awareness Training" ], "summary": "Commits multiple SCORM data model element values in a single batch operation, queuing all updates for asynchronous processing.", "requestBody": { "description": "The commit request including session ID and a collection of element name-value pairs to set.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSSetValuesRequest" }, "example": {"namesAndValues":[{"name":"cmi.core.lesson_status","value":"completed","timestamp":1710000000000},{"name":"cmi.core.score.raw","value":"85","timestamp":1710000001000}],"enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSSetValuesRequest" }, "example": {"namesAndValues":[{"name":"cmi.core.lesson_status","value":"completed","timestamp":1710000000000},{"name":"cmi.core.score.raw","value":"85","timestamp":1710000001000}],"enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSSetValuesRequest" }, "example": {"namesAndValues":[{"name":"cmi.core.lesson_status","value":"completed","timestamp":1710000000000},{"name":"cmi.core.score.raw","value":"85","timestamp":1710000001000}],"enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSSetValuesRequest" }, "example": {"namesAndValues":[{"name":"cmi.core.lesson_status","value":"completed","timestamp":1710000000000},{"name":"cmi.core.score.raw","value":"85","timestamp":1710000001000}],"enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ServiceResult`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/scorm/lmsfinish": { "post": { "tags": [ "Awareness Training" ], "summary": "Terminates the current SCORM learning session, persisting all tracked progress and marking the session as complete.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "TargetUserResourceId": { "type": "string" }, "EnrollmentSessionId": { "type": "string" }, "ScormSessionId": { "type": "string" } } }, "example": { "TargetUserResourceId": "Tu5Kp2mR7xLv", "EnrollmentSessionId": "Es7Kp2mR9xLn", "ScormSessionId": "Ss4Wp8nQ3vXm" }, "encoding": { "TargetUserResourceId": { "style": "form" }, "EnrollmentSessionId": { "style": "form" }, "ScormSessionId": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ServiceResult`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/scorm/lmslog": { "post": { "tags": [ "Awareness Training" ], "summary": "Records a diagnostic log entry from the SCORM player for troubleshooting and auditing LMS interactions.", "requestBody": { "description": "The log request including session ID, log level, and log message content.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSLogServiceRequest" }, "example": {"level":"info","message":"SCORM content loaded successfully","scormSessionId":"Ss4Wp8nQ3vXm","targetUserResourceId":"Tu5Kp2mR7xLv"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSLogServiceRequest" }, "example": {"level":"info","message":"SCORM content loaded successfully","scormSessionId":"Ss4Wp8nQ3vXm","targetUserResourceId":"Tu5Kp2mR7xLv"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSLogServiceRequest" }, "example": {"level":"info","message":"SCORM content loaded successfully","scormSessionId":"Ss4Wp8nQ3vXm","targetUserResourceId":"Tu5Kp2mR7xLv"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSLogServiceRequest" }, "example": {"level":"info","message":"SCORM content loaded successfully","scormSessionId":"Ss4Wp8nQ3vXm","targetUserResourceId":"Tu5Kp2mR7xLv"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ServiceResult`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/scormproxy/lmsinitialize": { "post": { "tags": [ "Awareness Training" ], "summary": "Initializes a new SCORM proxy session for external LMS integrations, establishing session context and returning initial LMS data.", "requestBody": { "description": "The SCORM initialization request including enrollment content ID and target user information.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSInitializeServiceRequest" }, "example": {"enrollmentContentResourceId":"Ec5Kp2mR7xLn","lmsLearnerId":"Lr3Wp8nQ4vXm"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSInitializeServiceRequest" }, "example": {"enrollmentContentResourceId":"Ec5Kp2mR7xLn","lmsLearnerId":"Lr3Wp8nQ4vXm"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSInitializeServiceRequest" }, "example": {"enrollmentContentResourceId":"Ec5Kp2mR7xLn","lmsLearnerId":"Lr3Wp8nQ4vXm"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSInitializeServiceRequest" }, "example": {"enrollmentContentResourceId":"Ec5Kp2mR7xLn","lmsLearnerId":"Lr3Wp8nQ4vXm"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ServiceResult`1[[KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSInitializeDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/scormproxy/lmsgetvalue": { "post": { "tags": [ "Awareness Training" ], "summary": "Retrieves a specific SCORM data model element value from the current proxy LMS session.", "requestBody": { "description": "The get-value request including session ID and the SCORM data model element name.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSGetValueServiceRequest" }, "example": {"name":"cmi.core.lesson_status","enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSGetValueServiceRequest" }, "example": {"name":"cmi.core.lesson_status","enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSGetValueServiceRequest" }, "example": {"name":"cmi.core.lesson_status","enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSGetValueServiceRequest" }, "example": {"name":"cmi.core.lesson_status","enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/scormproxy/lmssetvalue": { "post": { "tags": [ "Awareness Training" ], "summary": "Sets a single SCORM data model element value in the current proxy LMS session by queuing the update for asynchronous processing.", "requestBody": { "description": "The set-value request including session ID, element name, and the value to set.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSSetValueServiceRequest" }, "example": {"name":"cmi.core.lesson_status","value":"completed","enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSSetValueServiceRequest" }, "example": {"name":"cmi.core.lesson_status","value":"completed","enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSSetValueServiceRequest" }, "example": {"name":"cmi.core.lesson_status","value":"completed","enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSSetValueServiceRequest" }, "example": {"name":"cmi.core.lesson_status","value":"completed","enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ServiceResult`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/scormproxy/lmscommit": { "post": { "tags": [ "Awareness Training" ], "summary": "Commits multiple SCORM data model element values in a single batch operation for the proxy LMS session.", "requestBody": { "description": "The commit request including session ID and a collection of element name-value pairs to set.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSSetValuesRequest" }, "example": {"namesAndValues":[{"name":"cmi.core.lesson_status","value":"completed","timestamp":1710000000000},{"name":"cmi.core.score.raw","value":"85","timestamp":1710000001000}],"enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSSetValuesRequest" }, "example": {"namesAndValues":[{"name":"cmi.core.lesson_status","value":"completed","timestamp":1710000000000},{"name":"cmi.core.score.raw","value":"85","timestamp":1710000001000}],"enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSSetValuesRequest" }, "example": {"namesAndValues":[{"name":"cmi.core.lesson_status","value":"completed","timestamp":1710000000000},{"name":"cmi.core.score.raw","value":"85","timestamp":1710000001000}],"enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSSetValuesRequest" }, "example": {"namesAndValues":[{"name":"cmi.core.lesson_status","value":"completed","timestamp":1710000000000},{"name":"cmi.core.score.raw","value":"85","timestamp":1710000001000}],"enrollmentSessionId":"Es7Kp2mR9xLn","scormSessionId":"Ss4Wp8nQ3vXm"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ServiceResult`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/scormproxy/lmsfinish": { "post": { "tags": [ "Awareness Training" ], "summary": "Terminates the current SCORM proxy session, persisting all tracked progress and marking the session as complete.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "TargetUserResourceId": { "type": "string" }, "EnrollmentSessionId": { "type": "string" }, "ScormSessionId": { "type": "string" } } }, "example": { "TargetUserResourceId": "Tu5Kp2mR7xLv", "EnrollmentSessionId": "Es7Kp2mR9xLn", "ScormSessionId": "Ss4Wp8nQ3vXm" }, "encoding": { "TargetUserResourceId": { "style": "form" }, "EnrollmentSessionId": { "style": "form" }, "ScormSessionId": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ServiceResult`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/scormproxy/lmslog": { "post": { "tags": [ "Awareness Training" ], "summary": "Records a diagnostic log entry from the SCORM proxy player for troubleshooting and auditing LMS proxy interactions.", "requestBody": { "description": "The log request including session ID, log level, and log message content.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSLogServiceRequest" }, "example": {"level":"info","message":"SCORM content loaded successfully","scormSessionId":"Ss4Wp8nQ3vXm","targetUserResourceId":"Tu5Kp2mR7xLv"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSLogServiceRequest" }, "example": {"level":"info","message":"SCORM content loaded successfully","scormSessionId":"Ss4Wp8nQ3vXm","targetUserResourceId":"Tu5Kp2mR7xLv"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSLogServiceRequest" }, "example": {"level":"info","message":"SCORM content loaded successfully","scormSessionId":"Ss4Wp8nQ3vXm","targetUserResourceId":"Tu5Kp2mR7xLv"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSLogServiceRequest" }, "example": {"level":"info","message":"SCORM content loaded successfully","scormSessionId":"Ss4Wp8nQ3vXm","targetUserResourceId":"Tu5Kp2mR7xLv"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ServiceResult`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/trainings/{resourceId}": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves the full details of an existing training by its unique resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the training to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingDetailDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Awareness Training" ], "summary": "Permanently deletes a training and all its associated content by resource ID.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the training to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "put": { "tags": [ "Awareness Training" ], "summary": "Updates an existing training's details and content, submitted as multipart form data.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the training to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "CoverImage": { "type": "string", "format": "binary" }, "TrainingDetail.CoverImageUrl": { "maxLength": 2000, "minLength": 0, "type": "string" }, "TrainingDetail.Type": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingTypeEnum" }, "TrainingDetail.Status": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingStatusEnum" }, "TrainingDetail.TrainingContents": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingContentDTO" } }, "TrainingDetail.AvailableForRequests": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.EntityAvailableFor.EntityAvailableForRequest" } }, "TrainingDetail.VendorId": { "type": "string" }, "TrainingDetail.TrainingGroups": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingGroupDTO" } }, "TrainingDetail.RoleIds": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingTargetAudienceEnum" } }, "TrainingDetail.CategoryIds": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingCategoryEnum" } }, "TrainingDetail.Name": { "maxLength": 256, "minLength": 0, "type": "string" }, "TrainingDetail.Description": { "maxLength": 300, "minLength": 0, "type": "string" }, "TrainingDetail.Category": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingCategoryEnum" }, "TrainingDetail.TargetAudience": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingTargetAudienceEnum" }, "TrainingDetail.Behaviours": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingBehaviourDTO" } }, "TrainingDetail.Compliances": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingComplianceDTO" } }, "TrainingDetail.TagNames": { "type": "array", "items": { "type": "string" } }, "TrainingDetail.HasQuiz": { "type": "boolean" }, "TrainingDetail.Duration": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingDurationEnum" }, "TrainingDetail.Level": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingLevelEnum" }, "TrainingDetail.DurationDisplayName": { "type": "string" }, "TrainingDetail.LevelDisplayName": { "type": "string" } } }, "encoding": { "CoverImage": { "style": "form" }, "TrainingDetail.CoverImageUrl": { "style": "form" }, "TrainingDetail.Type": { "style": "form" }, "TrainingDetail.Status": { "style": "form" }, "TrainingDetail.TrainingContents": { "style": "form" }, "TrainingDetail.AvailableForRequests": { "style": "form" }, "TrainingDetail.VendorId": { "style": "form" }, "TrainingDetail.TrainingGroups": { "style": "form" }, "TrainingDetail.RoleIds": { "style": "form" }, "TrainingDetail.CategoryIds": { "style": "form" }, "TrainingDetail.Name": { "style": "form" }, "TrainingDetail.Description": { "style": "form" }, "TrainingDetail.Category": { "style": "form" }, "TrainingDetail.TargetAudience": { "style": "form" }, "TrainingDetail.Behaviours": { "style": "form" }, "TrainingDetail.Compliances": { "style": "form" }, "TrainingDetail.TagNames": { "style": "form" }, "TrainingDetail.HasQuiz": { "style": "form" }, "TrainingDetail.Duration": { "style": "form" }, "TrainingDetail.Level": { "style": "form" }, "TrainingDetail.DurationDisplayName": { "style": "form" }, "TrainingDetail.LevelDisplayName": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ServiceResult`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/trainings/get-training-type-count": { "post": { "tags": [ "Awareness Training" ], "summary": "Returns a count summary of trainings grouped by type, filtered by the provided search criteria.", "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchTrainingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchTrainingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchTrainingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchTrainingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.Collections.Generic.List`1[[KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingNumberSummaryRestView, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/trainings/search": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches for trainings using the provided criteria and returns a paginated list of results.", "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchTrainingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchTrainingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchTrainingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchTrainingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.PagedResults`1[[KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingSearchRestView, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/trainings/search-summary": { "post": { "tags": [ "Awareness Training" ], "summary": "Returns a lightweight paginated list of training IDs and names matching the search criteria, suitable for dropdowns and selection lists.", "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.PagedResults`1[[KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingSearchSummaryRestView, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/trainings/search/export": { "post": { "tags": [ "Awareness Training" ], "summary": "Exports the list of trainings matching the search criteria to a downloadable file (e.g., CSV, Excel).", "requestBody": { "description": "Export criteria including filters, sorting, and the desired export format.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ExportTrainingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ExportTrainingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ExportTrainingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ExportTrainingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/trainings/draft": { "post": { "tags": [ "Awareness Training" ], "summary": "Creates a new training in draft status, allowing further editing before publishing.", "requestBody": { "description": "The training detail payload including name, content, and availability settings.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingDetailDraftRequest" }, "example": {"availableForRequests":[{"type":"Company"}],"name":"Security Awareness Training","description":"Comprehensive security awareness training for employees","category":"None","targetAudience":"None","tagNames":["security","awareness"],"hasQuiz":true} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingDetailDraftRequest" }, "example": {"availableForRequests":[{"type":"Company"}],"name":"Security Awareness Training","description":"Comprehensive security awareness training for employees","category":"None","targetAudience":"None","tagNames":["security","awareness"],"hasQuiz":true} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingDetailDraftRequest" }, "example": {"availableForRequests":[{"type":"Company"}],"name":"Security Awareness Training","description":"Comprehensive security awareness training for employees","category":"None","targetAudience":"None","tagNames":["security","awareness"],"hasQuiz":true} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingDetailDraftRequest" }, "example": {"availableForRequests":[{"type":"Company"}],"name":"Security Awareness Training","description":"Comprehensive security awareness training for employees","category":"None","targetAudience":"None","tagNames":["security","awareness"],"hasQuiz":true} } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/trainings": { "post": { "tags": [ "Awareness Training" ], "summary": "Creates a new training with full content uploaded as multipart form data and publishes it.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "CoverImage": { "type": "string", "format": "binary" }, "TrainingGroups": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingGroupDTO" } }, "AvailableForRequests": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.EntityAvailableFor.EntityAvailableForRequest" } }, "Type": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingTypeEnum" }, "RoleIds": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingTargetAudienceEnum" } }, "CategoryIds": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingCategoryEnum" } }, "Name": { "maxLength": 256, "minLength": 0, "type": "string" }, "Description": { "maxLength": 300, "minLength": 0, "type": "string" }, "Category": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingCategoryEnum" }, "TargetAudience": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingTargetAudienceEnum" }, "Behaviours": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingBehaviourDTO" } }, "Compliances": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingComplianceDTO" } }, "TagNames": { "type": "array", "items": { "type": "string" } }, "HasQuiz": { "type": "boolean" }, "Duration": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingDurationEnum" }, "Level": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingLevelEnum" }, "DurationDisplayName": { "type": "string" }, "LevelDisplayName": { "type": "string" } } }, "encoding": { "CoverImage": { "style": "form" }, "TrainingGroups": { "style": "form" }, "AvailableForRequests": { "style": "form" }, "Type": { "style": "form" }, "RoleIds": { "style": "form" }, "CategoryIds": { "style": "form" }, "Name": { "style": "form" }, "Description": { "style": "form" }, "Category": { "style": "form" }, "TargetAudience": { "style": "form" }, "Behaviours": { "style": "form" }, "Compliances": { "style": "form" }, "TagNames": { "style": "form" }, "HasQuiz": { "style": "form" }, "Duration": { "style": "form" }, "Level": { "style": "form" }, "DurationDisplayName": { "style": "form" }, "LevelDisplayName": { "style": "form" } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/trainings/{resourceId}/upload-content": { "post": { "tags": [ "Awareness Training" ], "summary": "Uploads a SCORM-compliant ZIP package as training content for a specific training.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the training to upload content for.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "LanguageId", "ZipFile" ], "type": "object", "properties": { "ZipFile": { "type": "string", "format": "binary" }, "LanguageId": { "type": "string" }, "VendorId": { "type": "string" }, "Type": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingTypeEnum" } } }, "encoding": { "ZipFile": { "style": "form" }, "LanguageId": { "style": "form" }, "VendorId": { "style": "form" }, "Type": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingContentUploadResult, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/trainings/{resourceId}/upload-content/initiate": { "post": { "tags": [ "Awareness Training" ], "summary": "Starts a chunked SCORM ZIP upload for packages that exceed the edge request size limit.\r\nThe existing single-request upload-content endpoint remains available for smaller files.", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingChunkedUploadInitiateRequest" }, "example": {"fileName":"security-awareness-scorm12.zip","fileSize":314572800,"languageId":"f9288272-d0a1-4edc-93d3-534e56983e4f","vendorId":"Cp4Wn8mT2xRv"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingChunkedUploadInitiateRequest" }, "example": {"fileName":"security-awareness-scorm12.zip","fileSize":314572800,"languageId":"f9288272-d0a1-4edc-93d3-534e56983e4f","vendorId":"Cp4Wn8mT2xRv"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingChunkedUploadInitiateRequest" }, "example": {"fileName":"security-awareness-scorm12.zip","fileSize":314572800,"languageId":"f9288272-d0a1-4edc-93d3-534e56983e4f","vendorId":"Cp4Wn8mT2xRv"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingChunkedUploadInitiateRequest" }, "example": {"fileName":"security-awareness-scorm12.zip","fileSize":314572800,"languageId":"f9288272-d0a1-4edc-93d3-534e56983e4f","vendorId":"Cp4Wn8mT2xRv"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingChunkedUploadInitiateResult, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/trainings/{resourceId}/upload-content/part": { "post": { "tags": [ "Awareness Training" ], "summary": "Uploads a single 75MB or smaller chunk of a SCORM ZIP package through the API.", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "Chunk", "PartNumber", "UploadId" ], "type": "object", "properties": { "UploadId": { "type": "string" }, "PartNumber": { "type": "integer", "format": "int32" }, "Chunk": { "type": "string", "format": "binary" } } }, "encoding": { "UploadId": { "style": "form" }, "PartNumber": { "style": "form" }, "Chunk": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingChunkedUploadPartResult, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/trainings/{resourceId}/upload-content/complete": { "post": { "tags": [ "Awareness Training" ], "summary": "Completes a chunked SCORM ZIP upload, assembles the package, and runs the existing content processing flow.", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingChunkedUploadCompleteRequest" }, "example": {"uploadId":"a1b2c3d4e5f64789a0b1c2d3e4f50617"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingChunkedUploadCompleteRequest" }, "example": {"uploadId":"a1b2c3d4e5f64789a0b1c2d3e4f50617"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingChunkedUploadCompleteRequest" }, "example": {"uploadId":"a1b2c3d4e5f64789a0b1c2d3e4f50617"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingChunkedUploadCompleteRequest" }, "example": {"uploadId":"a1b2c3d4e5f64789a0b1c2d3e4f50617"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingUpdateDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse" } } } } } } }, "/api/trainings/{resourceId}/upload-content/abort": { "post": { "tags": [ "Awareness Training" ], "summary": "Aborts a chunked SCORM ZIP upload and deletes any staged parts so they are not billed.", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingChunkedUploadAbortRequest" }, "example": {"uploadId":"a1b2c3d4e5f64789a0b1c2d3e4f50617"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingChunkedUploadAbortRequest" }, "example": {"uploadId":"a1b2c3d4e5f64789a0b1c2d3e4f50617"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingChunkedUploadAbortRequest" }, "example": {"uploadId":"a1b2c3d4e5f64789a0b1c2d3e4f50617"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingChunkedUploadAbortRequest" }, "example": {"uploadId":"a1b2c3d4e5f64789a0b1c2d3e4f50617"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/trainings/{resourceId}/upload-file-content": { "post": { "tags": [ "Awareness Training" ], "summary": "Uploads a non-SCORM file (e.g., video, PDF) as training content for a specific training.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the training to upload content for.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "File", "LanguageId" ], "type": "object", "properties": { "File": { "type": "string", "format": "binary" }, "LanguageId": { "type": "string" }, "VendorId": { "type": "string" }, "Type": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingTypeEnum" } } }, "encoding": { "File": { "style": "form" }, "LanguageId": { "style": "form" }, "VendorId": { "style": "form" }, "Type": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Training.TrainingContentUploadResult, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/trainings/{resourceId}/content/{languageId}": { "delete": { "tags": [ "Awareness Training" ], "summary": "Deletes a specific language version of training content from a training.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the training.", "required": true, "schema": { "type": "string" } }, { "name": "languageId", "in": "path", "description": "The language identifier of the content version to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse" } } } } } } }, "/api/trainings/{resourceId}/duplicate": { "post": { "tags": [ "Awareness Training" ], "summary": "Creates a duplicate copy of an existing training, including all its content and settings.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the training to duplicate.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/trainings/{resourceId}/customization/images": { "get": { "tags": [ "Awareness Training" ], "summary": "Lists the images found inside a SCORM training package so the user can pick which of them to replace with their own logo, and reports whether the package layout allows its button colours to be rewritten.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the SCORM training to inspect.", "required": true, "schema": { "type": "string" } }, { "name": "languageId", "in": "query", "description": "Optional language version to inspect. Defaults to the first content version of the training.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.ApplicationService.Models.Training.ScormCustomization.ScormCustomizationImagesDTO, KeepnetLabs.AwarenessEducator.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/trainings/{resourceId}/customization/images/content": { "get": { "tags": [ "Awareness Training" ], "summary": "Returns the bytes of one image inside a SCORM training package, so the client can draw a logo onto it and send back the result. Serving it here rather than letting the browser read the content CDN directly is what makes that possible: the CDN does not allow cross origin reads, and an image loaded from it cannot be exported from a canvas.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the SCORM training.", "required": true, "schema": { "type": "string" } }, { "name": "relativePath", "in": "query", "description": "Path of the image inside the package, exactly as listed by the customization images endpoint.", "schema": { "type": "string" } }, { "name": "languageId", "in": "query", "description": "Optional language version. Defaults to the first content version of the training.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/trainings/{resourceId}/customization": { "post": { "tags": [ "Awareness Training" ], "summary": "Creates a branded copy of a SCORM training for the acting company: replaces the selected images inside the package with the supplied logo and optionally rewrites the quiz and player button colours. The source training is not modified.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the SCORM training to brand.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Images to replace and, optionally, the button colour to apply.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.Training.ScormCustomization.ScormCustomizationRequest" }, "example": {"languageId":"79276617-3e2b-409d-b2d1-52eb0f4a6ec6","buttonColor":"#3273F6","images":[{"relativePath":"res/data/img0.png","content":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="},{"relativePath":"res/data/img3.png","content":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.Training.ScormCustomization.ScormCustomizationRequest" }, "example": {"languageId":"79276617-3e2b-409d-b2d1-52eb0f4a6ec6","buttonColor":"#3273F6","images":[{"relativePath":"res/data/img0.png","content":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="},{"relativePath":"res/data/img3.png","content":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.Training.ScormCustomization.ScormCustomizationRequest" }, "example": {"languageId":"79276617-3e2b-409d-b2d1-52eb0f4a6ec6","buttonColor":"#3273F6","images":[{"relativePath":"res/data/img0.png","content":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="},{"relativePath":"res/data/img3.png","content":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.Training.ScormCustomization.ScormCustomizationRequest" }, "example": {"languageId":"79276617-3e2b-409d-b2d1-52eb0f4a6ec6","buttonColor":"#3273F6","images":[{"relativePath":"res/data/img0.png","content":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="},{"relativePath":"res/data/img3.png","content":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="}]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.ApplicationService.Models.Training.ScormCustomization.ScormCustomizationResultDTO, KeepnetLabs.AwarenessEducator.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/trainings/categories": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves all available training categories used for classifying trainings (e.g., Compliance, Security). Response is cached for 1 hour.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.Collections.Generic.List`1[[KeepnetLabs.AwarenessEducator.Core.Models.Base.EnumResult, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/trainings/target-audiences": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves all available target audience types for trainings (e.g., All Employees, IT Staff). Response is cached for 1 hour.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.Collections.Generic.List`1[[KeepnetLabs.AwarenessEducator.Core.Models.Base.EnumResult, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/trainings/types": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves all available training types (e.g., SCORM, Video, Document). Response is cached for 1 hour.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.Collections.Generic.List`1[[KeepnetLabs.AwarenessEducator.Core.Models.Base.EnumResult, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/trainings/levels": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves all available training difficulty levels (e.g., Beginner, Intermediate, Advanced). Response is cached for 1 hour.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.Collections.Generic.List`1[[KeepnetLabs.AwarenessEducator.Core.Models.Base.EnumResult, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/trainings/durations": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves all available training duration ranges. Response is cached for 1 hour.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.Collections.Generic.List`1[[KeepnetLabs.AwarenessEducator.Core.Models.Base.EnumResult, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/trainings/vendors": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves all available training content vendors/providers. Response is cached for 1 hour.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.Collections.Generic.List`1[[KeepnetLabs.AwarenessEducator.Core.Models.Training.VendorDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/trainings/behaviours": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves all available security behaviour categories that trainings can address. Response is cached for 1 hour.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.Collections.Generic.List`1[[KeepnetLabs.AwarenessEducator.Core.Models.Training.BehaviourDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/trainings/compliances": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves all available compliance frameworks that trainings can satisfy (e.g., GDPR, HIPAA, PCI-DSS). Response is cached for 1 hour.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.Collections.Generic.List`1[[KeepnetLabs.AwarenessEducator.Core.Models.Training.ComplianceDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/trainings/languages": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves all supported languages for training content localization. Response is cached for 1 hour.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.Collections.Generic.List`1[[KeepnetLabs.AwarenessEducator.Core.Models.Language.LanguageDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/trainings/scorm": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves the SCORM training launch URL for a specific enrollment content and target user. This anonymous endpoint is used by the SCORM player.", "parameters": [ { "name": "enrollmentContentId", "in": "query", "description": "The unique identifier of the enrollment content to launch.", "schema": { "type": "string" } }, { "name": "targetUserResourceId", "in": "query", "description": "The unique resource identifier of the target user taking the training.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Training.SCORMTrainingURLDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/trainings/scorm/preview": { "post": { "tags": [ "Awareness Training" ], "summary": "Retrieves the SCORM training preview URL, allowing administrators to preview training content before enrolling users.", "requestBody": { "description": "The preview request including training and language identifiers.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.SCORMTrainingURLPreviewRequest" }, "example": {"trainingId":"Tr5Kp2mR7xLv","languageId":"0"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.SCORMTrainingURLPreviewRequest" }, "example": {"trainingId":"Tr5Kp2mR7xLv","languageId":"0"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.SCORMTrainingURLPreviewRequest" }, "example": {"trainingId":"Tr5Kp2mR7xLv","languageId":"0"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.SCORMTrainingURLPreviewRequest" }, "example": {"trainingId":"Tr5Kp2mR7xLv","languageId":"0"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Training.SCORMTrainingURLDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/trainings/download": { "post": { "tags": [ "Awareness Training" ], "summary": "Downloads the training content file for a specified training and language, scoped to the current company group.", "requestBody": { "description": "The download request including training ID and language preference.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.DownloadTrainingContentRequest" }, "example": {"trainingId":"Tr5Kp2mR7xLv","languageId":"0"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.DownloadTrainingContentRequest" }, "example": {"trainingId":"Tr5Kp2mR7xLv","languageId":"0"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.DownloadTrainingContentRequest" }, "example": {"trainingId":"Tr5Kp2mR7xLv","languageId":"0"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.Training.DownloadTrainingContentRequest" }, "example": {"trainingId":"Tr5Kp2mR7xLv","languageId":"0"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/trainings/download-content": { "get": { "tags": [ "Awareness Training" ], "summary": "Downloads training content while tracking the target user's progress. This anonymous endpoint records that the user accessed the content.", "parameters": [ { "name": "enrollmentContentId", "in": "query", "description": "The unique identifier of the enrollment content to download.", "schema": { "type": "string" } }, { "name": "targetUserResourceId", "in": "query", "description": "The unique resource identifier of the target user downloading the content.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/trainings/template-merge-tags": { "get": { "tags": [ "Awareness Training" ], "summary": "Retrieves the list of available merge tags that can be used in training email templates for dynamic content substitution.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/trainings/{trainingId}/favourite": { "post": { "tags": [ "Awareness Training" ], "summary": "Adds a training to the current user's favourites list for quick access.", "parameters": [ { "name": "trainingId", "in": "path", "description": "The unique resource identifier of the training to add to favourites.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Awareness Training" ], "summary": "Removes a training from the current user's favourites list.", "parameters": [ { "name": "trainingId", "in": "path", "description": "The unique resource identifier of the training to remove from favourites.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/trainings/{resourceId}/available-for-change-impact": { "post": { "tags": [ "Awareness Training" ], "summary": "Checks the impact of changing availability settings for a training. Returns the list of companies with active enrollments that would lose access.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the training.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The proposed availability settings to evaluate.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.Training.AvailableForChangeImpactRequest" }, "example": {"availableForRequests":[{"type":"Company","resourceId":"Cp4Wn8mT2xRv"},{"type":"Group","resourceId":"Gp7Rm3nK5wLx"}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.Training.AvailableForChangeImpactRequest" }, "example": {"availableForRequests":[{"type":"Company","resourceId":"Cp4Wn8mT2xRv"},{"type":"Group","resourceId":"Gp7Rm3nK5wLx"}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.Training.AvailableForChangeImpactRequest" }, "example": {"availableForRequests":[{"type":"Company","resourceId":"Cp4Wn8mT2xRv"},{"type":"Group","resourceId":"Gp7Rm3nK5wLx"}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.Training.AvailableForChangeImpactRequest" }, "example": {"availableForRequests":[{"type":"Company","resourceId":"Cp4Wn8mT2xRv"},{"type":"Group","resourceId":"Gp7Rm3nK5wLx"}]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.ApplicationService.Models.Training.AvailableForChangeImpactResponse, KeepnetLabs.AwarenessEducator.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/training-reports/{enrollmentId}/summary": { "get": { "tags": [ "Awareness Training" ], "summary": "Returns the summary report for an enrollment, including completion rates, delivery status, and training progress statistics.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment to summarize.", "required": true, "schema": { "type": "string" } }, { "name": "trainingType", "in": "query", "description": "Optional training type filter to narrow the summary by specific training type.", "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingTypeRequestEnum" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.TrainingSummary.EnrollmentSummaryReportDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/{enrollmentId}/users/search": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches target users within an enrollment and returns a paginated training report showing each user's status and progress.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment to report on.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchUsersRestRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"LastInteractionDate","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchUsersRestRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"LastInteractionDate","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchUsersRestRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"LastInteractionDate","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchUsersRestRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"LastInteractionDate","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.PagedResults`1[[KeepnetLabs.Domain.Models.TrainingReport.TrainingReportUsersSearchView, KeepnetLabs.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/{enrollmentId}/users/resend": { "post": { "tags": [ "Awareness Training" ], "summary": "Resends the training notification email to selected target users within an enrollment.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The resend request identifying which target users should receive the training again.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/{enrollmentId}/opened-emails/search": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches and returns a paginated report of target users who opened the training email within an enrollment.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.PagedResults`1[[KeepnetLabs.Domain.Models.TrainingReport.TrainingReportOpenedEmailSearchView, KeepnetLabs.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/{enrollmentId}/opened-emails/resend": { "post": { "tags": [ "Awareness Training" ], "summary": "Resends training emails to target users who previously opened the email but have not completed the training.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The resend request identifying which users should be re-notified.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/{enrollmentId}/clicked-emails/search": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches and returns a paginated report of target users who clicked the training link within an enrollment email.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.PagedResults`1[[KeepnetLabs.Domain.Models.TrainingReport.TrainingReportClickedLinkSearchView, KeepnetLabs.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/{enrollmentId}/clicked-emails/resend": { "post": { "tags": [ "Awareness Training" ], "summary": "Resends training emails to target users who clicked the training link but have not completed the training.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The resend request identifying which users should be re-notified.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/{enrollmentId}/progress/search": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches and returns a paginated report of target user training progress (completion percentage) within an enrollment.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.PagedResults`1[[KeepnetLabs.Domain.Models.TrainingReport.TrainingReportProgressSearchView, KeepnetLabs.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/{enrollmentId}/progress/resend": { "post": { "tags": [ "Awareness Training" ], "summary": "Resends training to target users filtered by their progress status within an enrollment.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The resend request identifying which users should be re-notified.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/{enrollmentId}/exam-results/search": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches and returns a paginated report of target user exam/quiz results within an enrollment.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including filters, pagination, sorting, and exam status filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchExamResultsRestRequest" }, "example": {"showByExamStatus":"FirstAttempt","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"ExamResultDate","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchExamResultsRestRequest" }, "example": {"showByExamStatus":"FirstAttempt","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"ExamResultDate","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchExamResultsRestRequest" }, "example": {"showByExamStatus":"FirstAttempt","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"ExamResultDate","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchExamResultsRestRequest" }, "example": {"showByExamStatus":"FirstAttempt","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"ExamResultDate","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.PagedResults`1[[KeepnetLabs.Domain.Models.TrainingReport.TrainingReportExamResultsSearchView, KeepnetLabs.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/{enrollmentId}/exam-results/resend": { "post": { "tags": [ "Awareness Training" ], "summary": "Resends training to target users filtered by their exam result status within an enrollment.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The resend request identifying which users should be re-notified.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/{enrollmentId}/no-response/search": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches and returns a paginated report of target users who have not responded to the training email within an enrollment.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.PagedResults`1[[KeepnetLabs.Domain.Models.TrainingReport.TrainingReportNoResponseSearchView, KeepnetLabs.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/{enrollmentId}/no-response/resend": { "post": { "tags": [ "Awareness Training" ], "summary": "Resends training to target users who have not responded to the enrollment notification.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The resend request identifying which non-responsive users should be re-notified.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/{enrollmentId}/sending-report/search": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches and returns a paginated sending report showing email delivery status for each target user within an enrollment.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.PagedResults`1[[KeepnetLabs.Domain.Models.TrainingReport.TrainingReportSendingReportSearchView, KeepnetLabs.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/{enrollmentId}/sending-report/resend": { "post": { "tags": [ "Awareness Training" ], "summary": "Resends training emails to target users based on the sending report filter within an enrollment.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The resend request identifying which users should be re-notified based on delivery status.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ResendRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"selectAll":false,"selectedItems":["Xn8Jp2qR4mLv"],"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/{enrollmentId}/users/search/export": { "post": { "tags": [ "Awareness Training" ], "summary": "Exports the target user training report for an enrollment to a downloadable file (e.g., CSV, Excel).", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment to export.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Export criteria including filters, sorting, and the desired export format.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ExportUsersSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"LastInteractionDate","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ExportUsersSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"LastInteractionDate","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ExportUsersSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"LastInteractionDate","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.ExportUsersSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"LastInteractionDate","ascending":false,"reportAllPages":false,"exportType":"Excel"} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/training-reports/{enrollmentId}/export": { "post": { "tags": [ "Awareness Training" ], "summary": "Exports the complete training report for an enrollment as an Excel file, including all report tabs.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment to export.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/training-reports/{enrollmentId}/opened-emails/search/export": { "post": { "tags": [ "Awareness Training" ], "summary": "Exports the opened-email training report for an enrollment to a downloadable file.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Export criteria including filters, sorting, and the desired export format.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/training-reports/{enrollmentId}/clicked-emails/search/export": { "post": { "tags": [ "Awareness Training" ], "summary": "Exports the clicked-link training report for an enrollment to a downloadable file.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Export criteria including filters, sorting, and the desired export format.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/training-reports/{enrollmentId}/progress/search/export": { "post": { "tags": [ "Awareness Training" ], "summary": "Exports the training progress report for an enrollment to a downloadable file.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Export criteria including filters, sorting, and the desired export format.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/training-reports/{enrollmentId}/exam-results/search/export": { "post": { "tags": [ "Awareness Training" ], "summary": "Exports the exam results training report for an enrollment to a downloadable file.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Export criteria including filters, sorting, and the desired export format.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/training-reports/{enrollmentId}/no-response/search/export": { "post": { "tags": [ "Awareness Training" ], "summary": "Exports the no-response training report for an enrollment to a downloadable file.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Export criteria including filters, sorting, and the desired export format.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/training-reports/{enrollmentId}/sending-report/search/export": { "post": { "tags": [ "Awareness Training" ], "summary": "Exports the sending report for an enrollment to a downloadable file, showing email delivery status.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Export criteria including filters, sorting, and the desired export format.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/training-reports/{enrollmentId}/interactions/{targetUserResourceId}": { "get": { "tags": [ "Awareness Training" ], "summary": "Returns the list of interactions (email opens, link clicks, training starts, completions) for a specific user within an enrollment.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } }, { "name": "targetUserResourceId", "in": "path", "description": "The unique resource identifier of the target user.", "required": true, "schema": { "type": "string" } }, { "name": "emailEventType", "in": "query", "description": "Optional filter by email event type (e.g., delivered, opened, clicked).", "schema": { "$ref": "#/components/schemas/KeepnetLabs.Mailer.Domain.Enums.EmailEventTypeEnum" } }, { "name": "trainingType", "in": "query", "description": "Optional filter by training type.", "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Enums.TrainingTypeRequestEnum" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.Collections.Generic.List`1[[KeepnetLabs.AwarenessEducator.Core.Models.TrainingSummary.InteractionDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/training-reports/{enrollmentId}/progress-details/{targetUserResourceId}": { "get": { "tags": [ "Awareness Training" ], "summary": "Returns detailed training progress information for a specific user within an enrollment, broken down by content module.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } }, { "name": "targetUserResourceId", "in": "path", "description": "The unique resource identifier of the target user.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.Collections.Generic.List`1[[KeepnetLabs.AwarenessEducator.Core.Models.TrainingSummary.ProgressDetailDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/training-reports/{enrollmentId}/exam-result-details/{targetUserResourceId}": { "get": { "tags": [ "Awareness Training" ], "summary": "Returns detailed exam/quiz result information for a specific user within an enrollment, including scores and pass/fail status.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } }, { "name": "targetUserResourceId", "in": "path", "description": "The unique resource identifier of the target user.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.Collections.Generic.List`1[[KeepnetLabs.AwarenessEducator.Core.Models.TrainingSummary.ExamResultDetailDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/training-reports/form-details": { "get": { "tags": [ "Awareness Training" ], "summary": "Returns all enum types and their values used in training report filters and forms. Response is cached for 1 hour.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.Collections.Generic.Dictionary`2[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.Collections.Generic.List`1[[KeepnetLabs.AwarenessEducator.Core.Models.Base.EnumResult, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/training-reports/{enrollmentId}/email-event/{targetUserResourceId}": { "get": { "tags": [ "Awareness Training" ], "summary": "Returns SendGrid email delivery events (delivered, bounced, deferred, etc.) for a specific user within an enrollment.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } }, { "name": "targetUserResourceId", "in": "path", "description": "The unique resource identifier of the target user.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.Collections.Generic.List`1[[KeepnetLabs.AwarenessEducator.Core.Models.TrainingSummary.InteractionDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/training-reports/{enrollmentId}/email-event/{userMailId}/reminder": { "get": { "tags": [ "Awareness Training" ], "summary": "Returns SendGrid email delivery events for a specific reminder mail identified by user mail ID within an enrollment.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } }, { "name": "userMailId", "in": "path", "description": "The unique identifier of the user's reminder mail to retrieve events for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.Collections.Generic.List`1[[KeepnetLabs.AwarenessEducator.Core.Models.TrainingSummary.InteractionDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/training-reports/certificate/{certificateId}": { "post": { "tags": [ "Awareness Training" ], "summary": "Retrieves the HTML template of a company's certificate by its ID for rendering in training completion reports.", "parameters": [ { "name": "certificateId", "in": "path", "description": "The unique identifier of the certificate template to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.Certificate.CertificateDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/{enrollmentId}/resend": { "post": { "tags": [ "Awareness Training" ], "summary": "Resends training notifications to selected target users within an enrollment, filtered by specific training report types.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The resend request specifying which report types and users to target.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.TrainingSummary.ResendEnrollmentByTypesDTO" }, "example": {"resendTypes":[1,2]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.TrainingSummary.ResendEnrollmentByTypesDTO" }, "example": {"resendTypes":[1,2]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.TrainingSummary.ResendEnrollmentByTypesDTO" }, "example": {"resendTypes":[1,2]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.Core.Models.TrainingSummary.ResendEnrollmentByTypesDTO" }, "example": {"resendTypes":[1,2]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.IdResult, KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/{enrollmentId}/reminder-mails/search": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches and returns a paginated list of reminder mail records sent for an enrollment, including delivery status and timestamps.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRestServiceRequest" }, "example": {"reportAllPages":false,"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRestServiceRequest" }, "example": {"reportAllPages":false,"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRestServiceRequest" }, "example": {"reportAllPages":false,"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRestServiceRequest" }, "example": {"reportAllPages":false,"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.PagedResults`1[[KeepnetLabs.Domain.Models.TrainingReport.TrainingReportReminderMailSearchDTO, KeepnetLabs.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/anonymous/{enrollmentId}/summary": { "get": { "tags": [ "Awareness Training" ], "summary": "Returns the anonymous (non-target-user) training progress summary for an enrollment, showing aggregated completion statistics.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.AnonymousTrainingSummary.AnonymousTrainingProgresstReportDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/anonymous/{enrollmentId}": { "post": { "tags": [ "Awareness Training" ], "summary": "Returns the anonymous user-level training report for an enrollment, listing individual anonymous participants and their status.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.AnonymousTrainingSummary.AnonymousTrainingUserReportDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/anonymous/{enrollmentId}/user-detail/{targetuserresultId}": { "post": { "tags": [ "Awareness Training" ], "summary": "Returns detailed training report for a specific anonymous user result within an enrollment.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } }, { "name": "targetuserresultId", "in": "path", "description": "The unique identifier of the anonymous target user result.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.AnonymousTrainingSummary.AnonymousTrainingUserReportDetailDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/anonymous/{enrollmentId}/progress": { "post": { "tags": [ "Awareness Training" ], "summary": "Returns the anonymous training progress report for an enrollment, showing completion status per anonymous participant.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.AnonymousTrainingSummary.AnonymousTrainingProgresstReportDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/anonymous/{enrollmentId}/progress-detail/{targetuserresultId}": { "post": { "tags": [ "Awareness Training" ], "summary": "Returns detailed training progress information for a specific anonymous user result within an enrollment.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } }, { "name": "targetuserresultId", "in": "path", "description": "The unique identifier of the anonymous target user result.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.AnonymousTrainingSummary.AnonymousTrainingProgressReportDetailDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/anonymous/{enrollmentId}/result": { "post": { "tags": [ "Awareness Training" ], "summary": "Returns the anonymous exam/quiz result report for an enrollment, showing scores and pass/fail status per participant.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.AnonymousTrainingSummary.AnonymousTrainingResultReportDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/anonymous/{enrollmentId}/result-detail/{targetuserresultId}": { "post": { "tags": [ "Awareness Training" ], "summary": "Returns detailed exam/quiz result information for a specific anonymous user result within an enrollment.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } }, { "name": "targetuserresultId", "in": "path", "description": "The unique identifier of the anonymous target user result.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.AwarenessEducator.ApplicationService.Models.SearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.AwarenessEducator.Core.Models.AnonymousTrainingSummary.AnonymousTrainingResultReportDetailDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/training-reports/{enrollmentId}/exam-result-sessions/{targetUserResourceId}": { "get": { "tags": [ "Awareness Training" ], "summary": "Returns the question-answer interaction details from SCORM exam sessions for a specific user within an enrollment.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "The unique resource identifier of the enrollment.", "required": true, "schema": { "type": "string" } }, { "name": "targetUserResourceId", "in": "path", "description": "The unique resource identifier of the target user whose exam interactions to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[System.Collections.Generic.List`1[[KeepnetLabs.AwarenessEducator.Core.Models.SCORM.LMSScormSessionInteractionDTO, KeepnetLabs.AwarenessEducator.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/training-reports/activity-users/search": { "post": { "tags": [ "Awareness Training" ], "summary": "Searches for training activity users within a specified date range, returning a paginated list of users with their training engagement data.", "requestBody": { "description": "The search request including date range, filters, pagination, and sorting options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.TrainingReport.SearchTrainingUsersByDateRangeRequest" }, "example": {"startDate":"2026-01-01 00:00:00","endDate":"2026-03-31 23:59:59","groupByUser":true,"filter":{"searchInputTextValue":"acme.com","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsCompleted","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"Email","ascending":true} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.TrainingReport.SearchTrainingUsersByDateRangeRequest" }, "example": {"startDate":"2026-01-01 00:00:00","endDate":"2026-03-31 23:59:59","groupByUser":true,"filter":{"searchInputTextValue":"acme.com","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsCompleted","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"Email","ascending":true} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.TrainingReport.SearchTrainingUsersByDateRangeRequest" }, "example": {"startDate":"2026-01-01 00:00:00","endDate":"2026-03-31 23:59:59","groupByUser":true,"filter":{"searchInputTextValue":"acme.com","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsCompleted","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"Email","ascending":true} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.TrainingReport.SearchTrainingUsersByDateRangeRequest" }, "example": {"startDate":"2026-01-01 00:00:00","endDate":"2026-03-31 23:59:59","groupByUser":true,"filter":{"searchInputTextValue":"acme.com","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsCompleted","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"Email","ascending":true} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Common.Core.Models.DataResponse`1[[KeepnetLabs.Common.Core.Models.PagedResults`1[[KeepnetLabs.Domain.Models.TrainingReport.TrainingActivityUsersSearchView, KeepnetLabs.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Common.Core, Version=1.4.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign/form-details": { "get": { "tags": [ "Callback Phishing" ], "summary": "Retrieves the form details needed to create or edit a callback phishing campaign, including available options and default values.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Callback.Model.CallbackCampaignFormDetailsModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign": { "post": { "tags": [ "Callback Phishing" ], "summary": "Creates a new callback phishing campaign for the authenticated company, including target groups, scheduling, and email delivery settings.", "requestBody": { "description": "The callback campaign creation payload containing name, scenario, targets, schedule, and delivery configuration.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignCreateRequest" }, "example": {"name":"Q1 2026 Callback Campaign","description":"Callback phishing simulation for IT department","scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"distributionStartTypeId":1,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionStartTime":"09:00:00","distributionEndTime":"17:00:00","distributionDays":31,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"frequency":"OneTime","phishingScenarios":[{"phishingScenarioResourceId":"Cb4Kx7mN2wRt","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"smtpSettingResourceId":"Sm8pW3nR5vQx","distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"emailDeliverySettingType":1} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignCreateRequest" }, "example": {"name":"Q1 2026 Callback Campaign","description":"Callback phishing simulation for IT department","scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"distributionStartTypeId":1,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionStartTime":"09:00:00","distributionEndTime":"17:00:00","distributionDays":31,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"frequency":"OneTime","phishingScenarios":[{"phishingScenarioResourceId":"Cb4Kx7mN2wRt","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"smtpSettingResourceId":"Sm8pW3nR5vQx","distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"emailDeliverySettingType":1} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignCreateRequest" }, "example": {"name":"Q1 2026 Callback Campaign","description":"Callback phishing simulation for IT department","scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"distributionStartTypeId":1,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionStartTime":"09:00:00","distributionEndTime":"17:00:00","distributionDays":31,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"frequency":"OneTime","phishingScenarios":[{"phishingScenarioResourceId":"Cb4Kx7mN2wRt","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"smtpSettingResourceId":"Sm8pW3nR5vQx","distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"emailDeliverySettingType":1} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignCreateRequest" }, "example": {"name":"Q1 2026 Callback Campaign","description":"Callback phishing simulation for IT department","scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"distributionStartTypeId":1,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionStartTime":"09:00:00","distributionEndTime":"17:00:00","distributionDays":31,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"frequency":"OneTime","phishingScenarios":[{"phishingScenarioResourceId":"Cb4Kx7mN2wRt","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"smtpSettingResourceId":"Sm8pW3nR5vQx","distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"emailDeliverySettingType":1} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/callback-simulator/campaign/{resourceId}": { "delete": { "tags": [ "Callback Phishing" ], "summary": "Deletes a callback phishing campaign identified by its unique resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the callback campaign to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Callback Phishing" ], "summary": "Retrieves the full details of an existing callback phishing campaign by its unique resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the callback campaign to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Callback.Model.CallbackCampaignModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign/search": { "post": { "tags": [ "Callback Phishing" ], "summary": "Searches and returns a paginated list of callback phishing campaigns with optional filtering and sorting.", "requestBody": { "description": "The search request containing pagination parameters, sort order, and optional filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.Callback.Model.CallbackCampaignSearchModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign/search/export": { "post": { "tags": [ "Callback Phishing" ], "summary": "Exports the callback phishing campaign list as a downloadable file in the specified format (e.g., Excel, CSV).", "requestBody": { "description": "The export request containing pagination, filters, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Export.Dto.ExportServiceResult" } } } } } } }, "/api/callback-simulator/campaign/preview/{resourceId}": { "get": { "tags": [ "Callback Phishing" ], "summary": "Generates a preview of a callback phishing campaign, showing how the campaign email and scenario will appear to target users.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the callback campaign to preview.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Callback.Model.CallbackCampaignPreviewModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign/bulk-delete": { "delete": { "tags": [ "Callback Phishing" ], "summary": "Deletes multiple callback phishing campaigns in a single bulk operation.", "requestBody": { "description": "The bulk delete request containing a list of campaign resource identifiers to delete.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignDeleteRequest" }, "example": {"items":["Cb9Lm3vR7nKp","Cb5Tp8kW2xNv"],"selectAll":false,"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignDeleteRequest" }, "example": {"items":["Cb9Lm3vR7nKp","Cb5Tp8kW2xNv"],"selectAll":false,"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignDeleteRequest" }, "example": {"items":["Cb9Lm3vR7nKp","Cb5Tp8kW2xNv"],"selectAll":false,"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignDeleteRequest" }, "example": {"items":["Cb9Lm3vR7nKp","Cb5Tp8kW2xNv"],"selectAll":false,"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign/calculate-sending-info": { "post": { "tags": [ "Callback Phishing" ], "summary": "Calculates the estimated sending information for a callback campaign, including total email count and delivery timeline.", "requestBody": { "description": "The sending info calculation request containing target group and delivery parameters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCalculateSendingInfoRequest" }, "example": {"sendingLimit":50,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"totalTargetUserCount":250,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCalculateSendingInfoRequest" }, "example": {"sendingLimit":50,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"totalTargetUserCount":250,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCalculateSendingInfoRequest" }, "example": {"sendingLimit":50,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"totalTargetUserCount":250,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCalculateSendingInfoRequest" }, "example": {"sendingLimit":50,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"totalTargetUserCount":250,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Callback.Model.CallbackCampaignSendingInfoModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign/calculate-schedule-info": { "post": { "tags": [ "Callback Phishing" ], "summary": "Calculates the schedule information for a callback campaign, determining when emails will be sent based on the configured frequency and time windows.", "requestBody": { "description": "The schedule info calculation request containing frequency settings and time window parameters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCalculateScheduleInfoRequest" }, "example": {"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","frequency":1,"callbackScenarioResourceIds":["Cb4Kx7mN2wRt"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCalculateScheduleInfoRequest" }, "example": {"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","frequency":1,"callbackScenarioResourceIds":["Cb4Kx7mN2wRt"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCalculateScheduleInfoRequest" }, "example": {"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","frequency":1,"callbackScenarioResourceIds":["Cb4Kx7mN2wRt"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCalculateScheduleInfoRequest" }, "example": {"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","frequency":1,"callbackScenarioResourceIds":["Cb4Kx7mN2wRt"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Callback.Model.CallBackCampaignScheduleInfoModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign/email-delivery-settings": { "get": { "tags": [ "Callback Phishing" ], "summary": "Retrieves the available email delivery settings for callback campaigns, including configured SMTP servers and direct email creation settings.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaign.Dto.EmailDeliverySettingModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign/root-company-shared-smtp-resource-id": { "get": { "tags": [ "Callback Phishing" ], "summary": "Returns the resource identifier of the most recently created shared SMTP settings from the root (parent) company.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign-job/form-details": { "get": { "tags": [ "Callback Phishing" ], "summary": "Retrieves the form details needed to create or configure a callback campaign job, including available options and default values.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Callback.Model.CallbackCampaignJobFormDetailsModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/campaign-job/start/{resourceId}/{instanceGroup}": { "post": { "tags": [ "Callback Phishing" ], "summary": "Starts a new callback campaign job instance for an existing campaign, identified by its resource identifier and instance group number.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the callback campaign to start.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number indicating which campaign frequency group to execute.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign-job/start": { "post": { "tags": [ "Callback Phishing" ], "summary": "Creates a new callback campaign job instance with the provided configuration and immediately starts sending emails to targets.", "requestBody": { "description": "The campaign instance request containing target groups, schedule, and delivery configuration.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignInstanceRequest" }, "example": {"excludeFromReports":false,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","scheduleTypeId":3,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"distributionStartTypeId":1,"distributionStartTime":"09:00:00","distributionEndTime":"17:00:00","distributionDays":31,"campaignResourceId":"Cb9Lm3vR7nKp"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignInstanceRequest" }, "example": {"excludeFromReports":false,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","scheduleTypeId":3,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"distributionStartTypeId":1,"distributionStartTime":"09:00:00","distributionEndTime":"17:00:00","distributionDays":31,"campaignResourceId":"Cb9Lm3vR7nKp"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignInstanceRequest" }, "example": {"excludeFromReports":false,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","scheduleTypeId":3,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"distributionStartTypeId":1,"distributionStartTime":"09:00:00","distributionEndTime":"17:00:00","distributionDays":31,"campaignResourceId":"Cb9Lm3vR7nKp"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignInstanceRequest" }, "example": {"excludeFromReports":false,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","scheduleTypeId":3,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"distributionStartTypeId":1,"distributionStartTime":"09:00:00","distributionEndTime":"17:00:00","distributionDays":31,"campaignResourceId":"Cb9Lm3vR7nKp"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign-job/stop/{resourceId}/{instanceGroup}": { "patch": { "tags": [ "Callback Phishing" ], "summary": "Stops an active callback campaign job, halting any pending email deliveries for the specified campaign and instance group.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the callback campaign whose job should be stopped.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job to stop.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign-job/{resourceId}/{instanceGroup}": { "delete": { "tags": [ "Callback Phishing" ], "summary": "Deletes a callback campaign job and its associated data for the specified campaign and instance group.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the callback campaign whose job should be deleted.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job to delete.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign-job/resend/{resourceId}/{instanceGroup}": { "post": { "tags": [ "Callback Phishing" ], "summary": "Resends the callback campaign job emails to users filtered by activity type (e.g., not opened, not clicked) for the specified campaign and instance group.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the callback campaign to resend.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job to resend.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The resend request containing the list of user activity types to target for resending.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobToUserResendRequest" }, "example": {"types":["NoResponse"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobToUserResendRequest" }, "example": {"types":["NoResponse"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobToUserResendRequest" }, "example": {"types":["NoResponse"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobToUserResendRequest" }, "example": {"types":["NoResponse"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign-job/resend/users/{resourceId}/{instanceGroup}": { "post": { "tags": [ "Callback Phishing" ], "summary": "Resends the callback campaign job emails to a specific set of users identified individually or by selection criteria.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the callback campaign to resend.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job to resend.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The resend request containing user selection criteria (individual items, select-all with exclusions, or filter-based).", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobToUsersResendRequest" }, "example": {"items":["Tu3Kp8mR7xLv","Tu6Wn4vT9nQs"],"selectAll":false,"excludedItems":[],"searchType":"NoResponse"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobToUsersResendRequest" }, "example": {"items":["Tu3Kp8mR7xLv","Tu6Wn4vT9nQs"],"selectAll":false,"excludedItems":[],"searchType":"NoResponse"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobToUsersResendRequest" }, "example": {"items":["Tu3Kp8mR7xLv","Tu6Wn4vT9nQs"],"selectAll":false,"excludedItems":[],"searchType":"NoResponse"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobToUsersResendRequest" }, "example": {"items":["Tu3Kp8mR7xLv","Tu6Wn4vT9nQs"],"selectAll":false,"excludedItems":[],"searchType":"NoResponse"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign-job/search/{resourceId}": { "post": { "tags": [ "Callback Phishing" ], "summary": "Searches and returns a paginated list of campaign job instances belonging to a specific callback campaign, with optional filtering and sorting.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the parent callback campaign.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The search request containing pagination parameters, frequency group filter, sort order, and optional filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false,"phishingCampaignFrequencyGroup":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false,"phishingCampaignFrequencyGroup":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false,"phishingCampaignFrequencyGroup":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false,"phishingCampaignFrequencyGroup":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.Callback.Model.CallbackCampaignJobSearchModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign-job/export/{resourceId}": { "post": { "tags": [ "Callback Phishing" ], "summary": "Exports the list of campaign job instances for a specific callback campaign as a downloadable file in the specified format (e.g., Excel, CSV).", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the parent callback campaign to export jobs for.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The export request containing pagination, filters, export type, frequency group, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobExportRequest" }, "example": {"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","phishingCampaignFrequencyGroup":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobExportRequest" }, "example": {"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","phishingCampaignFrequencyGroup":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobExportRequest" }, "example": {"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","phishingCampaignFrequencyGroup":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobExportRequest" }, "example": {"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","phishingCampaignFrequencyGroup":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Export.Dto.ExportServiceResult" } } } } } } }, "/api/callback-simulator/campaign-job-report/summary/{resourceId}/{instanceGroup}": { "get": { "tags": [ "Callback Phishing" ], "summary": "Retrieves the summary details for a callback campaign job, including statistics on email delivery, opens, clicks, and user responses.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the callback campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job to retrieve the summary for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Callback.Model.CallbackCampaignSummaryModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign-job-report/summary/target-groups/{resourceId}/{instanceGroup}": { "get": { "tags": [ "Callback Phishing" ], "summary": "Retrieves the target groups and a summary of their user counts for a specific callback campaign job instance.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the callback campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.Callback.Model.CallbackCampaignTargetGroupModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/callback-simulator/campaign-job-report/export/{resourceId}/{instanceGroup}": { "get": { "tags": [ "Callback Phishing" ], "summary": "Exports a detailed report of a callback campaign job as an Excel file, including per-user activity and response data.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the callback campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job to export.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Export.Dto.ExportServiceResult" } } } } } } }, "/api/callback-simulator/campaign-job-report/{searchType}/search/{resourceId}/{instanceGroup}": { "post": { "tags": [ "Callback Phishing" ], "summary": "Searches and returns a paginated list of users in a callback campaign job, filtered by user search type (e.g., all users, opened, clicked, reported).", "parameters": [ { "name": "searchType", "in": "path", "description": "The type of user activity to filter by (e.g., all, email opened, link clicked, reported).", "required": true, "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Callback.Enums.CallbackCampaignJobUserSearchType" } }, { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the callback campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The search request containing pagination parameters, sort order, activity type, and optional filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobUsersSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"LastSendingTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobUsersSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"LastSendingTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobUsersSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"LastSendingTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobUsersSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"LastSendingTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.CustomPhishingCampaignJobUsersPagedResults`1[[KeepnetLabs.ApplicationService.Callback.Model.CallbackCampaignJobUsersSearchModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign-job-report/{searchType}/search/export/{resourceId}/{instanceGroup}": { "post": { "tags": [ "Callback Phishing" ], "summary": "Exports the list of users in a callback campaign job as a downloadable file, filtered by user search type and activity.", "parameters": [ { "name": "searchType", "in": "path", "description": "The type of user activity to filter by (e.g., all, email opened, link clicked, reported).", "required": true, "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Callback.Enums.CallbackCampaignJobUserSearchType" } }, { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the callback campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The export request containing pagination, filters, export format, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Export.Dto.ExportServiceResult" } } } } } } }, "/api/callback-simulator/campaign-job-report/search-email-opened/{resourceId}": { "post": { "tags": [ "Callback Phishing" ], "summary": "Searches and returns detailed email open event records for a specific user in a callback campaign job.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the campaign job user record.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The search request containing pagination parameters, activity type, and optional filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobUserSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"LastSendingTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobUserSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"LastSendingTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobUserSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"LastSendingTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobUserSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"LastSendingTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Callback.Model.CallbackCampaignJobUserEmailSearchOpenedModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign-job-report/search-email-reported/{resourceId}": { "post": { "tags": [ "Callback Phishing" ], "summary": "Searches and returns detailed email reported event records for a specific user in a callback campaign job.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the campaign job user record.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The search request containing pagination parameters and optional filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobUserSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"LastSendingTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobUserSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"LastSendingTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobUserSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"LastSendingTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCampaignJobUserSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"LastSendingTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Callback.Model.CallbackCampaignJobUserSearchEmailReportedModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/campaign-job-report/search-email-activity/{resourceId}": { "get": { "tags": [ "Callback Phishing" ], "summary": "Retrieves the full email activity trail for a specific user in a callback campaign, showing delivery, open, click, and report events.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the campaign job user record to retrieve activity for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.EmailEventInfoModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/email-template": { "post": { "tags": [ "Callback Phishing" ], "summary": "Creates a new email template for the callback phishing simulator with click-only category and callback phishing type.", "requestBody": { "description": "The email template creation payload containing subject, body HTML, sender details, and optional attachment.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackEmailTemplateCreateRequest" }, "example": {"name":"IT Support Callback Template","description":"Callback email template simulating IT helpdesk communication","difficultyResourceId":"Df3Kp8mR7xLv","languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["callback","helpdesk"],"subject":"Action Required: Verify Your Account","fromName":"IT Support","fromAddress":"it-support@example.com","template":"Please call us to verify your account.
","isPhishingFileModified":false,"isDuplicated":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackEmailTemplateCreateRequest" }, "example": {"name":"IT Support Callback Template","description":"Callback email template simulating IT helpdesk communication","difficultyResourceId":"Df3Kp8mR7xLv","languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["callback","helpdesk"],"subject":"Action Required: Verify Your Account","fromName":"IT Support","fromAddress":"it-support@example.com","template":"Please call us to verify your account.
","isPhishingFileModified":false,"isDuplicated":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackEmailTemplateCreateRequest" }, "example": {"name":"IT Support Callback Template","description":"Callback email template simulating IT helpdesk communication","difficultyResourceId":"Df3Kp8mR7xLv","languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["callback","helpdesk"],"subject":"Action Required: Verify Your Account","fromName":"IT Support","fromAddress":"it-support@example.com","template":"Please call us to verify your account.
","isPhishingFileModified":false,"isDuplicated":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackEmailTemplateCreateRequest" }, "example": {"name":"IT Support Callback Template","description":"Callback email template simulating IT helpdesk communication","difficultyResourceId":"Df3Kp8mR7xLv","languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["callback","helpdesk"],"subject":"Action Required: Verify Your Account","fromName":"IT Support","fromAddress":"it-support@example.com","template":"Please call us to verify your account.
","isPhishingFileModified":false,"isDuplicated":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/callback-simulator/email-template/{resourceId}": { "put": { "tags": [ "Callback Phishing" ], "summary": "Updates an existing email template for the callback phishing simulator, identified by its resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the email template to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The email template update payload containing updated subject, body HTML, sender details, and optional attachment.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.UpdatePsEmailTemplateRequest" }, "example": {"name":"Updated IT Password Reset Notice","description":"Updated phishing simulation for IT password reset notification","categoryResourceId":"Ct4Kp8mR7xLn","difficultyResourceId":"Df3Kp8mR7xLv","languageTypeResourceId":"Ln2Kp5mR7vWx","tags":["password-reset","credential-harvesting"],"subject":"Urgent: Your Password Will Expire Soon","fromName":"IT Service Desk","fromAddress":"it-support@example-corp.com","template":"Your password will expire in 12 hours. Click here to reset it immediately.
","isPhishingFileModified":false,"phishingTypeId":1,"isAssistedByAI":false,"isPlainText":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.UpdatePsEmailTemplateRequest" }, "example": {"name":"Updated IT Password Reset Notice","description":"Updated phishing simulation for IT password reset notification","categoryResourceId":"Ct4Kp8mR7xLn","difficultyResourceId":"Df3Kp8mR7xLv","languageTypeResourceId":"Ln2Kp5mR7vWx","tags":["password-reset","credential-harvesting"],"subject":"Urgent: Your Password Will Expire Soon","fromName":"IT Service Desk","fromAddress":"it-support@example-corp.com","template":"Your password will expire in 12 hours. Click here to reset it immediately.
","isPhishingFileModified":false,"phishingTypeId":1,"isAssistedByAI":false,"isPlainText":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.UpdatePsEmailTemplateRequest" }, "example": {"name":"Updated IT Password Reset Notice","description":"Updated phishing simulation for IT password reset notification","categoryResourceId":"Ct4Kp8mR7xLn","difficultyResourceId":"Df3Kp8mR7xLv","languageTypeResourceId":"Ln2Kp5mR7vWx","tags":["password-reset","credential-harvesting"],"subject":"Urgent: Your Password Will Expire Soon","fromName":"IT Service Desk","fromAddress":"it-support@example-corp.com","template":"Your password will expire in 12 hours. Click here to reset it immediately.
","isPhishingFileModified":false,"phishingTypeId":1,"isAssistedByAI":false,"isPlainText":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.UpdatePsEmailTemplateRequest" }, "example": {"name":"Updated IT Password Reset Notice","description":"Updated phishing simulation for IT password reset notification","categoryResourceId":"Ct4Kp8mR7xLn","difficultyResourceId":"Df3Kp8mR7xLv","languageTypeResourceId":"Ln2Kp5mR7vWx","tags":["password-reset","credential-harvesting"],"subject":"Urgent: Your Password Will Expire Soon","fromName":"IT Service Desk","fromAddress":"it-support@example-corp.com","template":"Your password will expire in 12 hours. Click here to reset it immediately.
","isPhishingFileModified":false,"phishingTypeId":1,"isAssistedByAI":false,"isPlainText":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Callback Phishing" ], "summary": "Retrieves the full details of an existing callback phishing email template by its unique resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the email template to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PsEmailTemplate.Dto.PsEmailTemplateDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Callback Phishing" ], "summary": "Deletes an existing callback phishing email template identified by its unique resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the email template to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/email-template/bulk-delete": { "delete": { "tags": [ "Callback Phishing" ], "summary": "Deletes multiple callback phishing email templates in a single bulk operation.", "requestBody": { "description": "The bulk delete request containing a list of email template resource identifiers to delete.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/email-template/search": { "post": { "tags": [ "Callback Phishing" ], "summary": "Searches and returns a paginated list of callback phishing email templates for the authenticated company, with optional filtering and sorting.", "requestBody": { "description": "The search request containing pagination parameters, sort order, and optional filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.Search.PsEmailTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"MethodTypeId","operator":"eq","value":"1"}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"IsPlainText","operator":"eq","value":"false"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"phishingTypeId":1} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.Search.PsEmailTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"MethodTypeId","operator":"eq","value":"1"}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"IsPlainText","operator":"eq","value":"false"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"phishingTypeId":1} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.Search.PsEmailTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"MethodTypeId","operator":"eq","value":"1"}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"IsPlainText","operator":"eq","value":"false"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"phishingTypeId":1} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.Search.PsEmailTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"MethodTypeId","operator":"eq","value":"1"}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"IsPlainText","operator":"eq","value":"false"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"phishingTypeId":1} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.CallbackTemplate.Dto.SearchCallbackTemplateDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/email-template/search/export": { "post": { "tags": [ "Callback Phishing" ], "summary": "Exports the list of callback phishing email templates as a downloadable file in the specified format (e.g., Excel, CSV).", "requestBody": { "description": "The export request containing pagination, filters, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Export.Dto.ExportServiceResult" } } } } } } }, "/api/callback-simulator/email-template/merge-tags": { "get": { "tags": [ "Callback Phishing" ], "summary": "Retrieves the list of available merge tags that can be used in callback phishing email templates for dynamic content substitution.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/callback-simulator/email-template/download-attachment/{resourceId}": { "get": { "tags": [ "Callback Phishing" ], "summary": "Downloads the attachment file associated with an existing callback phishing email template.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the email template whose attachment should be downloaded.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Export.Dto.ExportServiceResult" } } } } } } }, "/api/callback-simulator/scenario": { "post": { "tags": [ "Callback Phishing" ], "summary": "Creates a new callback phishing scenario for the authenticated company, defining the landing page and response behavior for callback simulations.", "requestBody": { "description": "The scenario creation payload containing name, description, landing page configuration, and callback behavior settings.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackScenarioCreateRequest" }, "example": {"name":"IT Helpdesk Callback Scenario","description":"Simulates a callback from IT helpdesk requesting password verification","languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["callback","social-engineering"],"callbackTemplateId":1,"emailTemplateId":1} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackScenarioCreateRequest" }, "example": {"name":"IT Helpdesk Callback Scenario","description":"Simulates a callback from IT helpdesk requesting password verification","languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["callback","social-engineering"],"callbackTemplateId":1,"emailTemplateId":1} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackScenarioCreateRequest" }, "example": {"name":"IT Helpdesk Callback Scenario","description":"Simulates a callback from IT helpdesk requesting password verification","languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["callback","social-engineering"],"callbackTemplateId":1,"emailTemplateId":1} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackScenarioCreateRequest" }, "example": {"name":"IT Helpdesk Callback Scenario","description":"Simulates a callback from IT helpdesk requesting password verification","languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["callback","social-engineering"],"callbackTemplateId":1,"emailTemplateId":1} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/callback-simulator/scenario/{resourceId}": { "put": { "tags": [ "Callback Phishing" ], "summary": "Updates an existing callback phishing scenario identified by its unique resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the scenario to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The scenario update payload containing updated name, description, landing page, and callback behavior settings.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackScenarioUpdateRequest" }, "example": {"name":"Updated IT Helpdesk Callback Scenario","description":"Updated callback scenario for IT helpdesk simulation","languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["callback","social-engineering"],"callbackTemplateId":1,"emailTemplateId":2} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackScenarioUpdateRequest" }, "example": {"name":"Updated IT Helpdesk Callback Scenario","description":"Updated callback scenario for IT helpdesk simulation","languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["callback","social-engineering"],"callbackTemplateId":1,"emailTemplateId":2} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackScenarioUpdateRequest" }, "example": {"name":"Updated IT Helpdesk Callback Scenario","description":"Updated callback scenario for IT helpdesk simulation","languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["callback","social-engineering"],"callbackTemplateId":1,"emailTemplateId":2} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackScenarioUpdateRequest" }, "example": {"name":"Updated IT Helpdesk Callback Scenario","description":"Updated callback scenario for IT helpdesk simulation","languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["callback","social-engineering"],"callbackTemplateId":1,"emailTemplateId":2} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Callback Phishing" ], "summary": "Deletes a callback phishing scenario identified by its unique resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the callback scenario to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Callback Phishing" ], "summary": "Retrieves the full details of an existing callback phishing scenario by its unique resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the callback scenario to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Callback.Model.CallbackScenarioModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/scenario/bulk-delete": { "delete": { "tags": [ "Callback Phishing" ], "summary": "Deletes multiple callback phishing scenarios in a single bulk operation.", "requestBody": { "description": "The bulk delete request containing a list of scenario resource identifiers to delete.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/scenario/export": { "post": { "tags": [ "Callback Phishing" ], "summary": "Exports the callback phishing scenario list as a downloadable file in the specified format (e.g., Excel, CSV).", "requestBody": { "description": "The export request containing pagination, filters, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Export.Dto.ExportServiceResult" } } } } } } }, "/api/callback-simulator/scenario/preview/{resourceId}": { "get": { "tags": [ "Callback Phishing" ], "summary": "Generates a preview of a callback phishing scenario, showing how the landing page and callback flow will appear to target users.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the callback scenario to preview.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Callback.Model.CallbackScenarioPreviewModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/scenario/search": { "post": { "tags": [ "Callback Phishing" ], "summary": "Searches and returns a paginated list of callback phishing scenarios with optional filtering, sorting, and campaign association.", "requestBody": { "description": "The search request containing pagination parameters, sort order, optional filter criteria, and optional campaign resource identifier.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.PhishingScenarioSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"templateTypes":[],"roleResourceIds":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.PhishingScenarioSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"templateTypes":[],"roleResourceIds":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.PhishingScenarioSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"templateTypes":[],"roleResourceIds":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.PhishingScenarioSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"templateTypes":[],"roleResourceIds":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.Callback.Model.CallbackScenarioSearchModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/agentic-ai/activities": { "post": { "tags": [ "Company & Settings" ], "summary": "Only runs when company ExecutionMode is ApprovalGated (1): saves to AgenticAIActivity (WaitingForApproval). Otherwise returns an error message.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.CreateAgenticAIActivityRequest" }, "example": {"batchResourceId":"65BVv1136Vnp","activityType":1,"scenarioResourceId":"Kp3mR5xLn7Wq","trainingResourceId":"","targetUserResourceId":"Xn8Jp2qR4mLv","targetGroupResourceId":"Qw4Rt6yU8iOp","contentCategory":"Credential Harvesting","campaignPayload":{"Name":"AI Generated Campaign","SendingType":1},"enrollmentPayload":} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.CreateAgenticAIActivityRequest" }, "example": {"batchResourceId":"65BVv1136Vnp","activityType":1,"scenarioResourceId":"Kp3mR5xLn7Wq","trainingResourceId":"","targetUserResourceId":"Xn8Jp2qR4mLv","targetGroupResourceId":"Qw4Rt6yU8iOp","contentCategory":"Credential Harvesting","campaignPayload":{"Name":"AI Generated Campaign","SendingType":1},"enrollmentPayload":} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.CreateAgenticAIActivityRequest" }, "example": {"batchResourceId":"65BVv1136Vnp","activityType":1,"scenarioResourceId":"Kp3mR5xLn7Wq","trainingResourceId":"","targetUserResourceId":"Xn8Jp2qR4mLv","targetGroupResourceId":"Qw4Rt6yU8iOp","contentCategory":"Credential Harvesting","campaignPayload":{"Name":"AI Generated Campaign","SendingType":1},"enrollmentPayload":} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.CreateAgenticAIActivityRequest" }, "example": {"batchResourceId":"65BVv1136Vnp","activityType":1,"scenarioResourceId":"Kp3mR5xLn7Wq","trainingResourceId":"","targetUserResourceId":"Xn8Jp2qR4mLv","targetGroupResourceId":"Qw4Rt6yU8iOp","contentCategory":"Credential Harvesting","campaignPayload":{"Name":"AI Generated Campaign","SendingType":1},"enrollmentPayload":} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/agentic-ai/activities/approve": { "post": { "tags": [ "Company & Settings" ], "summary": "Approves multiple activities. Parses PayloadJson, creates campaigns/enrollments, and updates activity status.\r\nOnly WaitingForApproval activities are processed. Partial success is supported.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.ApproveAgenticAIActivitiesRequest" }, "example": {"resourceIds":["65BVv1136Vnp","Kp3mR5xLn7Wq"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.ApproveAgenticAIActivitiesRequest" }, "example": {"resourceIds":["65BVv1136Vnp","Kp3mR5xLn7Wq"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.ApproveAgenticAIActivitiesRequest" }, "example": {"resourceIds":["65BVv1136Vnp","Kp3mR5xLn7Wq"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.ApproveAgenticAIActivitiesRequest" }, "example": {"resourceIds":["65BVv1136Vnp","Kp3mR5xLn7Wq"]} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/agentic-ai/activities/reject": { "post": { "tags": [ "Company & Settings" ], "summary": "Rejects multiple activities. Only WaitingForApproval activities belonging to the company are rejected.\r\nSkipped: not found, wrong company, or already not WaitingForApproval.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.RejectAgenticAIActivitiesRequest" }, "example": {"resourceIds":["65BVv1136Vnp","Kp3mR5xLn7Wq"],"declineForRetry":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.RejectAgenticAIActivitiesRequest" }, "example": {"resourceIds":["65BVv1136Vnp","Kp3mR5xLn7Wq"],"declineForRetry":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.RejectAgenticAIActivitiesRequest" }, "example": {"resourceIds":["65BVv1136Vnp","Kp3mR5xLn7Wq"],"declineForRetry":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.RejectAgenticAIActivitiesRequest" }, "example": {"resourceIds":["65BVv1136Vnp","Kp3mR5xLn7Wq"],"declineForRetry":false} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/agentic-ai/activities/{resourceId}": { "get": { "tags": [ "Company & Settings" ], "summary": "Gets a single activity detail by ResourceId", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/agentic-ai/batch/{batchResourceId}": { "get": { "tags": [ "Company & Settings" ], "summary": "Gets all activities in a batch with their details", "parameters": [ { "name": "batchResourceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/agentic-ai/batch/approve": { "post": { "tags": [ "Company & Settings" ], "summary": "Approves all WaitingForApproval activities in a batch. Parses PayloadJson, creates campaigns/enrollments, and updates activity status.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.AgenticAI.Dto.ApproveBatchRequest" }, "example": {"batchResourceId":"Bt7Kp2mR9xLn"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.AgenticAI.Dto.ApproveBatchRequest" }, "example": {"batchResourceId":"Bt7Kp2mR9xLn"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.AgenticAI.Dto.ApproveBatchRequest" }, "example": {"batchResourceId":"Bt7Kp2mR9xLn"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.AgenticAI.Dto.ApproveBatchRequest" }, "example": {"batchResourceId":"Bt7Kp2mR9xLn"} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/agentic-ai/batch/reject": { "post": { "tags": [ "Company & Settings" ], "summary": "Rejects all WaitingForApproval activities in a batch.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.AgenticAI.Dto.RejectBatchRequest" }, "example": {"batchResourceId":"Bt7Kp2mR9xLn","declineForRetry":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.AgenticAI.Dto.RejectBatchRequest" }, "example": {"batchResourceId":"Bt7Kp2mR9xLn","declineForRetry":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.AgenticAI.Dto.RejectBatchRequest" }, "example": {"batchResourceId":"Bt7Kp2mR9xLn","declineForRetry":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.AgenticAI.Dto.RejectBatchRequest" }, "example": {"batchResourceId":"Bt7Kp2mR9xLn","declineForRetry":false} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/agentic-ai/activities/stats": { "get": { "tags": [ "Company & Settings" ], "summary": "Returns activity status distribution (WaitingForApproval, Approved, Rejected, Executed, Error)\r\nfor the last 24 hours, last 7 days, and last 30 days.", "responses": { "200": { "description": "OK" } } } }, "/api/agentic-ai/activities/search": { "post": { "tags": [ "Company & Settings" ], "summary": "Search and filter Agentic AI activities with pagination.\r\nWhen IsGroupedByBatch is true, results are grouped by BatchResourceId sorted by the most recent activity's CreateTime descending.\r\nPagination is always at activity level (PageSize = 10 means 10 activities, which may span multiple batches).", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.AgenticAIActivitySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"isGroupedByBatch":false,"includeAutonomous":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.AgenticAIActivitySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"isGroupedByBatch":false,"includeAutonomous":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.AgenticAIActivitySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"isGroupedByBatch":false,"includeAutonomous":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.AgenticAIActivitySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"isGroupedByBatch":false,"includeAutonomous":false} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/agentic-ai/tasks": { "post": { "tags": [ "Company & Settings" ], "summary": "Creates a new scheduled AI task definition.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.CreateAgenticAITaskRequest" }, "example": {"name":"IT Department Weekly Phishing","activityType":1,"targetGroupResourceId":"Cp4Wn8mT2xRv","contentCategory":"Social Engineering","difficultyLevel":2,"languageCode":"en","frequencyType":2,"schedule":"2026-10-26 09:00:00","scheduledDateTimeZoneId":"Europe/Istanbul","isRegionAwareTimeZone":true,"maxOccurrences":52,"endDate":"2027-10-26 09:00:00"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.CreateAgenticAITaskRequest" }, "example": {"name":"IT Department Weekly Phishing","activityType":1,"targetGroupResourceId":"Cp4Wn8mT2xRv","contentCategory":"Social Engineering","difficultyLevel":2,"languageCode":"en","frequencyType":2,"schedule":"2026-10-26 09:00:00","scheduledDateTimeZoneId":"Europe/Istanbul","isRegionAwareTimeZone":true,"maxOccurrences":52,"endDate":"2027-10-26 09:00:00"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.CreateAgenticAITaskRequest" }, "example": {"name":"IT Department Weekly Phishing","activityType":1,"targetGroupResourceId":"Cp4Wn8mT2xRv","contentCategory":"Social Engineering","difficultyLevel":2,"languageCode":"en","frequencyType":2,"schedule":"2026-10-26 09:00:00","scheduledDateTimeZoneId":"Europe/Istanbul","isRegionAwareTimeZone":true,"maxOccurrences":52,"endDate":"2027-10-26 09:00:00"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.CreateAgenticAITaskRequest" }, "example": {"name":"IT Department Weekly Phishing","activityType":1,"targetGroupResourceId":"Cp4Wn8mT2xRv","contentCategory":"Social Engineering","difficultyLevel":2,"languageCode":"en","frequencyType":2,"schedule":"2026-10-26 09:00:00","scheduledDateTimeZoneId":"Europe/Istanbul","isRegionAwareTimeZone":true,"maxOccurrences":52,"endDate":"2027-10-26 09:00:00"} } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DataResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.BaseResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.BaseResponse" } } } } } } }, "/api/agentic-ai/tasks/{resourceId}": { "get": { "tags": [ "Company & Settings" ], "summary": "Gets a single scheduled task detail by ResourceId.", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DataResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.BaseResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.BaseResponse" } } } } } }, "delete": { "tags": [ "Company & Settings" ], "summary": "Soft-deletes a scheduled task by ResourceId. Sets status to Cancelled.", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.BaseResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.BaseResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.BaseResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.BaseResponse" } } } } } } }, "/api/agentic-ai/tasks/search": { "post": { "tags": [ "Company & Settings" ], "summary": "Searches scheduled AI tasks with pagination, filtering, and sorting.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.AgenticAITaskSearchRequest" }, "example": {"filter":{"condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Status","operator":"=","value":"Active"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.AgenticAITaskSearchRequest" }, "example": {"filter":{"condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Status","operator":"=","value":"Active"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.AgenticAITaskSearchRequest" }, "example": {"filter":{"condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Status","operator":"=","value":"Active"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.AgenticAI.AgenticAITaskSearchRequest" }, "example": {"filter":{"condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Status","operator":"=","value":"Active"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DataResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.BaseResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/agentic-ai/tasks/{resourceId}/runs": { "get": { "tags": [ "Company & Settings" ], "summary": "Gets the run history for a specific scheduled task.", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 25 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DataResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.BaseResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.BaseResponse" } } } } } } }, "/api/callback-simulator/settings/usage": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the callback phone number usage statistics for the current company, including allocated and consumed phone number quotas.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Callback.Model.CallbackUsageModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/settings/search/export": { "post": { "tags": [ "Company & Settings" ], "summary": "Exports the company's callback phone number pool to a downloadable file in the requested format (CSV, Excel, etc.).", "requestBody": { "description": "Export criteria including pagination, filter, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Export.Dto.ExportServiceResult" } } } } } } }, "/api/callback-simulator/settings/search": { "post": { "tags": [ "Company & Settings" ], "summary": "Searches and retrieves a paginated list of callback phone numbers in the company's pool with optional filtering and sorting.", "requestBody": { "description": "Search criteria including pagination and optional filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCompanyPoolSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"FreeOnDate","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCompanyPoolSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"FreeOnDate","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCompanyPoolSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"FreeOnDate","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Callback.CallbackCompanyPoolSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"FreeOnDate","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.Callback.Model.CallbackSearchCompanyPoolModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/settings/map-numbers": { "post": { "tags": [ "Company & Settings" ], "summary": "Maps (assigns) one or more provider phone numbers to the company's callback phone pool for use in callback phishing simulations.", "requestBody": { "description": "A list of provider phone number identifiers to map to the company.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/settings/exchange-number/{oldProviderNumberId}/{newProviderNumberId}": { "post": { "tags": [ "Company & Settings" ], "summary": "Exchanges (swaps) one callback phone number for another in the company's pool, replacing the old number with a new one from the available pool.", "parameters": [ { "name": "oldProviderNumberId", "in": "path", "description": "The provider number identifier of the phone number to replace.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "newProviderNumberId", "in": "path", "description": "The provider number identifier of the new phone number to assign.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/settings/available-numbers": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the list of available (unassigned) callback phone numbers that can be mapped to the company's pool.", "parameters": [ { "name": "companyResourceId", "in": "query", "description": "Optional company resource identifier to filter available numbers for a specific company.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Callback.Model.CallbackNumberAvailableModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/callback-simulator/settings/number-delete/{numberId}": { "delete": { "tags": [ "Company & Settings" ], "summary": "Deletes a callback phone number from the company's pool, returning it to the available numbers for reassignment.", "parameters": [ { "name": "numberId", "in": "path", "description": "The internal numeric identifier of the phone number to delete.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies": { "post": { "tags": [ "Company & Settings" ], "summary": "Creates a new company (tenant) in the platform with the specified name, license, and configuration details.", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "CountryResourceId", "DateFormat", "IndustryResourceId", "LicensePeriodTypeResourceId", "LicenseTypeResourceId", "Name", "NumberOfUsers", "TimeFormat", "TimeZoneId" ], "type": "object", "properties": { "File": { "type": "string", "description": "Company logo image file to upload.", "format": "binary" }, "Name": { "maxLength": 64, "type": "string", "description": "Display name of the company. Required. Maximum 64 characters." }, "Description": { "maxLength": 300, "type": "string", "description": "Brief description of the company. Maximum 300 characters." }, "IndustryResourceId": { "type": "string", "description": "Resource identifier of the company's industry. Required." }, "CountryResourceId": { "type": "string", "description": "Resource identifier of the company's country. Required." }, "Address": { "maxLength": 200, "type": "string", "description": "Physical address of the company. Maximum 200 characters." }, "WebsiteUrl": { "maxLength": 2000, "type": "string", "description": "Company website URL. Maximum 2000 characters." }, "LicenseTypeResourceId": { "type": "string", "description": "Resource identifier of the license type assigned to the company. Required." }, "LicenseModuleResourceIdArray": { "type": "array", "items": { "type": "string" }, "description": "Array of resource identifiers for the licensed modules available to the company." }, "LicensePeriodTypeResourceId": { "type": "string", "description": "Resource identifier of the license period type (e.g., monthly, yearly). Required." }, "LicenseStartDate": { "type": "string", "description": "Start date of the license period.", "format": "date-time" }, "LicenseEndDate": { "type": "string", "description": "End date of the license period.", "format": "date-time" }, "IsNumberOfUsersLimited": { "type": "boolean", "description": "Whether the company has a limit on the number of users." }, "NumberOfUsers": { "type": "integer", "description": "Maximum number of users allowed under the license. Required.", "format": "int32" }, "NotificationTemplateTypeResourceId": { "type": "string", "description": "Resource identifier for the notification template type preference." }, "TrainingContentTypeResourceId": { "type": "string", "description": "Resource identifier for the training content type preference." }, "SmtpConfigurationTypeResourceId": { "type": "string", "description": "Resource identifier for the SMTP configuration type preference." }, "PreferredLanguageTypeResourceId": { "type": "string", "description": "Resource identifier for the company's preferred language." }, "IsVersionVisible": { "type": "boolean", "description": "Whether the platform version number is visible to the company's users." }, "IsReleaseNotesVisible": { "type": "boolean", "description": "Whether the release notes section is visible to the company's users." }, "ReleaseNotesUrl": { "maxLength": 2000, "type": "string", "description": "URL pointing to the release notes page. Maximum 2000 characters." }, "CompanyGroupResourceIdArray": { "type": "array", "items": { "type": "string" }, "description": "Array of resource identifiers for the company groups this company belongs to." }, "BaseManHourCost": { "type": "integer", "description": "Base cost per man-hour used in ROI calculations. Defaults to 20.", "format": "int32" }, "BaseManHour": { "type": "integer", "description": "Base number of man-hours used for ROI calculations. Defaults to 100.", "format": "int32" }, "StatusId": { "type": "integer", "description": "Status identifier for the company (e.g., active, inactive).", "format": "int32" }, "TimeZoneId": { "type": "string", "description": "IANA time zone identifier for the company (e.g., \"Europe/Istanbul\"). Required." }, "DateFormat": { "type": "string", "description": "Date format preference for the company. Required. Defaults to \"DD/MM/YYYY\"." }, "TimeFormat": { "type": "string", "description": "Time format preference for the company (e.g., \"24h\", \"12h\"). Required. Defaults to \"24h\"." }, "CallBackNumberBookingCount": { "type": "integer", "description": "Number of callback phone numbers the company can book for vishing campaigns.", "format": "int32" }, "Tags": { "type": "array", "items": { "type": "string" }, "description": "List of tags associated with the company for categorization." }, "RegionCode": { "maxLength": 40, "type": "string", "description": "Optional data-residency region code (Azure region slug, e.g., \"canadacentral\",\r\n\"germanywestcentral\"). When set, the company's TargetUser PII is dual-written\r\nto the regional database configured under RegionalDatabases:{RegionCode}.\r\nLeave null/empty for central-only storage. Maximum 40 characters.\r\nRoot-only: a non-root caller supplying a RegionCode is rejected (403);\r\nregion assignment is a Root-only act (same as POST .../sovereignty/migrate)." } } }, "example": { "Name": "Acme Corporation", "Description": "Global cybersecurity awareness training provider", "IndustryResourceId": "In4Dp7vR2mNx", "CountryResourceId": "Ct5Rp8nK3wLm", "Address": "123 Security Blvd, Suite 400, San Francisco, CA 94105", "WebsiteUrl": "https://www.acmecorp.com", "LicenseTypeResourceId": "Lt6Kn9mR4xWp", "LicenseModuleResourceIdArray": [ "Lm7Rp3nK5wVx", "Lm8Wn4xK6pRv" ], "LicensePeriodTypeResourceId": "Lp9Rm5nT7vKx", "LicenseStartDate": "2026-01-01T00:00:00Z", "LicenseEndDate": "2027-01-01T00:00:00Z", "IsNumberOfUsersLimited": true, "NumberOfUsers": 500, "NotificationTemplateTypeResourceId": "Nt2Wm6xK8pRv", "TrainingContentTypeResourceId": "Tc3Rn7vL9mKw", "SmtpConfigurationTypeResourceId": "Sc4Wp8nR2xLm", "PreferredLanguageTypeResourceId": "Pl5Kn9mR3vWx", "IsVersionVisible": true, "IsReleaseNotesVisible": true, "ReleaseNotesUrl": "https://www.acmecorp.com/release-notes", "CompanyGroupResourceIdArray": [ "Cg6Rp2nK4wLm" ], "BaseManHourCost": 25, "BaseManHour": 120, "StatusId": 1, "TimeZoneId": "America/New_York", "DateFormat": "MM/DD/YYYY", "TimeFormat": "12h", "CallBackNumberBookingCount": 5, "Tags": [ "enterprise", "north-america" ], "RegionCode": "canadacentral" }, "encoding": { "File": { "style": "form" }, "Name": { "style": "form" }, "Description": { "style": "form" }, "IndustryResourceId": { "style": "form" }, "CountryResourceId": { "style": "form" }, "Address": { "style": "form" }, "WebsiteUrl": { "style": "form" }, "LicenseTypeResourceId": { "style": "form" }, "LicenseModuleResourceIdArray": { "style": "form" }, "LicensePeriodTypeResourceId": { "style": "form" }, "LicenseStartDate": { "style": "form" }, "LicenseEndDate": { "style": "form" }, "IsNumberOfUsersLimited": { "style": "form" }, "NumberOfUsers": { "style": "form" }, "NotificationTemplateTypeResourceId": { "style": "form" }, "TrainingContentTypeResourceId": { "style": "form" }, "SmtpConfigurationTypeResourceId": { "style": "form" }, "PreferredLanguageTypeResourceId": { "style": "form" }, "IsVersionVisible": { "style": "form" }, "IsReleaseNotesVisible": { "style": "form" }, "ReleaseNotesUrl": { "style": "form" }, "CompanyGroupResourceIdArray": { "style": "form" }, "BaseManHourCost": { "style": "form" }, "BaseManHour": { "style": "form" }, "StatusId": { "style": "form" }, "TimeZoneId": { "style": "form" }, "DateFormat": { "style": "form" }, "TimeFormat": { "style": "form" }, "CallBackNumberBookingCount": { "style": "form" }, "Tags": { "style": "form" }, "RegionCode": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/{resourceId}": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves a company's full details by its unique resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the company.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Company.Dto.CompanyDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "put": { "tags": [ "Company & Settings" ], "summary": "Updates an existing company's details such as name, license, contact information, and branding.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the company to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "CountryResourceId", "DateFormat", "IndustryResourceId", "LicensePeriodTypeResourceId", "LicenseTypeResourceId", "Name", "NumberOfUsers", "TimeFormat", "TimeZoneId" ], "type": "object", "properties": { "File": { "type": "string", "description": "Company logo image file to upload.", "format": "binary" }, "LogoUrl": { "type": "string", "description": "URL of the existing company logo. Used when no new file is uploaded." }, "Name": { "maxLength": 64, "type": "string", "description": "Display name of the company. Required. Maximum 64 characters." }, "Description": { "maxLength": 300, "type": "string", "description": "Brief description of the company. Maximum 300 characters." }, "IndustryResourceId": { "type": "string", "description": "Resource identifier of the company's industry. Required." }, "CountryResourceId": { "type": "string", "description": "Resource identifier of the company's country. Required." }, "Address": { "maxLength": 200, "type": "string", "description": "Physical address of the company. Maximum 200 characters." }, "WebsiteUrl": { "maxLength": 2000, "type": "string", "description": "Company website URL. Maximum 2000 characters." }, "LicenseTypeResourceId": { "type": "string", "description": "Resource identifier of the license type assigned to the company. Required." }, "LicenseModuleResourceIdArray": { "type": "array", "items": { "type": "string" }, "description": "Array of resource identifiers for the licensed modules available to the company." }, "LicensePeriodTypeResourceId": { "type": "string", "description": "Resource identifier of the license period type (e.g., monthly, yearly). Required." }, "LicenseStartDate": { "type": "string", "description": "Start date of the license period.", "format": "date-time" }, "LicenseEndDate": { "type": "string", "description": "End date of the license period.", "format": "date-time" }, "IsNumberOfUsersLimited": { "type": "boolean", "description": "Whether the company has a limit on the number of users." }, "NumberOfUsers": { "type": "integer", "description": "Maximum number of users allowed under the license. Required.", "format": "int32" }, "NotificationTemplateTypeResourceId": { "type": "string", "description": "Resource identifier for the notification template type preference." }, "TrainingContentTypeResourceId": { "type": "string", "description": "Resource identifier for the training content type preference." }, "SmtpConfigurationTypeResourceId": { "type": "string", "description": "Resource identifier for the SMTP configuration type preference." }, "PreferredLanguageTypeResourceId": { "type": "string", "description": "Resource identifier for the company's preferred language." }, "IsVersionVisible": { "type": "boolean", "description": "Whether the platform version number is visible to the company's users." }, "IsReleaseNotesVisible": { "type": "boolean", "description": "Whether the release notes section is visible to the company's users." }, "ReleaseNotesUrl": { "maxLength": 2000, "type": "string", "description": "URL pointing to the release notes page. Maximum 2000 characters." }, "CompanyGroupResourceIdArray": { "type": "array", "items": { "type": "string" }, "description": "Array of resource identifiers for the company groups this company belongs to." }, "StatusId": { "type": "integer", "description": "Status identifier for the company (e.g., active, inactive).", "format": "int32" }, "TimeZoneId": { "type": "string", "description": "IANA time zone identifier for the company (e.g., \"Europe/Istanbul\"). Required." }, "DateFormat": { "type": "string", "description": "Date format preference for the company (e.g., \"DD/MM/YYYY\"). Required." }, "TimeFormat": { "type": "string", "description": "Time format preference for the company (e.g., \"24h\", \"12h\"). Required." }, "CallBackNumberBookingCount": { "type": "integer", "description": "Number of callback phone numbers the company can book for vishing campaigns.", "format": "int32" }, "Tags": { "type": "array", "items": { "type": "string" }, "description": "List of tags associated with the company for categorization." } } }, "example": { "LogoUrl": "https://cdn.acmecorp.com/logos/acme-logo.png", "Name": "Acme Corporation", "Description": "Leading cybersecurity awareness and training platform", "IndustryResourceId": "In4Dp7vR2mNx", "CountryResourceId": "Ct5Rp8nK3wLm", "Address": "456 Cyber Ave, Suite 800, New York, NY 10001", "WebsiteUrl": "https://www.acmecorp.com", "LicenseTypeResourceId": "Lt6Kn9mR4xWp", "LicenseModuleResourceIdArray": [ "Lm7Rp3nK5wVx", "Lm8Wn4xK6pRv" ], "LicensePeriodTypeResourceId": "Lp9Rm5nT7vKx", "LicenseStartDate": "2026-01-01T00:00:00Z", "LicenseEndDate": "2027-01-01T00:00:00Z", "IsNumberOfUsersLimited": true, "NumberOfUsers": 750, "NotificationTemplateTypeResourceId": "Nt2Wm6xK8pRv", "TrainingContentTypeResourceId": "Tc3Rn7vL9mKw", "SmtpConfigurationTypeResourceId": "Sc4Wp8nR2xLm", "PreferredLanguageTypeResourceId": "Pl5Kn9mR3vWx", "IsVersionVisible": true, "IsReleaseNotesVisible": true, "ReleaseNotesUrl": "https://www.acmecorp.com/release-notes", "CompanyGroupResourceIdArray": [ "Cg6Rp2nK4wLm" ], "StatusId": 1, "TimeZoneId": "America/New_York", "DateFormat": "MM/DD/YYYY", "TimeFormat": "12h", "CallBackNumberBookingCount": 10, "Tags": [ "enterprise", "north-america", "premium" ] }, "encoding": { "File": { "style": "form" }, "LogoUrl": { "style": "form" }, "Name": { "style": "form" }, "Description": { "style": "form" }, "IndustryResourceId": { "style": "form" }, "CountryResourceId": { "style": "form" }, "Address": { "style": "form" }, "WebsiteUrl": { "style": "form" }, "LicenseTypeResourceId": { "style": "form" }, "LicenseModuleResourceIdArray": { "style": "form" }, "LicensePeriodTypeResourceId": { "style": "form" }, "LicenseStartDate": { "style": "form" }, "LicenseEndDate": { "style": "form" }, "IsNumberOfUsersLimited": { "style": "form" }, "NumberOfUsers": { "style": "form" }, "NotificationTemplateTypeResourceId": { "style": "form" }, "TrainingContentTypeResourceId": { "style": "form" }, "SmtpConfigurationTypeResourceId": { "style": "form" }, "PreferredLanguageTypeResourceId": { "style": "form" }, "IsVersionVisible": { "style": "form" }, "IsReleaseNotesVisible": { "style": "form" }, "ReleaseNotesUrl": { "style": "form" }, "CompanyGroupResourceIdArray": { "style": "form" }, "StatusId": { "style": "form" }, "TimeZoneId": { "style": "form" }, "DateFormat": { "style": "form" }, "TimeFormat": { "style": "form" }, "CallBackNumberBookingCount": { "style": "form" }, "Tags": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Company & Settings" ], "summary": "Permanently deletes a company and all its associated data by resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the company to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/getcompany/{companyId}": { "get": { "tags": [ "Company & Settings" ], "summary": "Returns the company's date and time format settings as a Tuple(DateFormat, TimeFormat).", "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Tuple`2[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/companies/{resourceId}/logo": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the company's logo image file by resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the company.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Company.Dto.GetCompanyLogoServiceResponse, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/limited": { "put": { "tags": [ "Company & Settings" ], "summary": "Performs a limited update on company properties that non-admin users are allowed to modify, such as display name and contact info.", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "CountryResourceId", "IndustryResourceId", "Name", "ResourceId" ], "type": "object", "properties": { "File": { "type": "string", "description": "Company logo image file to upload.", "format": "binary" }, "Name": { "maxLength": 64, "type": "string", "description": "Display name of the company. Required. Maximum 64 characters." }, "Description": { "maxLength": 300, "type": "string", "description": "Brief description of the company. Maximum 300 characters." }, "IndustryResourceId": { "type": "string", "description": "Resource identifier of the company's industry. Required." }, "CountryResourceId": { "type": "string", "description": "Resource identifier of the company's country. Required." }, "Address": { "maxLength": 200, "type": "string", "description": "Physical address of the company. Maximum 200 characters." }, "WebsiteUrl": { "maxLength": 2000, "type": "string", "description": "Company website URL. Maximum 2000 characters." }, "PreferredLanguageTypeResourceId": { "type": "string", "description": "Resource identifier for the company's preferred language." }, "TimeZoneId": { "type": "string", "description": "IANA time zone identifier for the company (e.g., \"Europe/Istanbul\")." }, "ResourceId": { "type": "string", "description": "Resource identifier of the company being updated. Required." } } }, "example": { "Name": "Acme Corporation", "Description": "Global cybersecurity awareness training provider", "IndustryResourceId": "In4Dp7vR2mNx", "CountryResourceId": "Ct5Rp8nK3wLm", "Address": "123 Security Blvd, Suite 400, San Francisco, CA 94105", "WebsiteUrl": "https://www.acmecorp.com", "PreferredLanguageTypeResourceId": "Pl5Kn9mR3vWx", "TimeZoneId": "Europe/London", "ResourceId": "Hs7Kp2mR4xLn" }, "encoding": { "File": { "style": "form" }, "Name": { "style": "form" }, "Description": { "style": "form" }, "IndustryResourceId": { "style": "form" }, "CountryResourceId": { "style": "form" }, "Address": { "style": "form" }, "WebsiteUrl": { "style": "form" }, "PreferredLanguageTypeResourceId": { "style": "form" }, "TimeZoneId": { "style": "form" }, "ResourceId": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/search": { "post": { "tags": [ "Company & Settings" ], "summary": "Searches and retrieves a paginated list of companies with optional filtering, sorting, and clustering support.", "requestBody": { "description": "Search criteria including pagination, filter, clustering, and target user count limit flags.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.Search.CompanySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"isClustered":false,"isTargetUserCountExceededLimit":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.Search.CompanySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"isClustered":false,"isTargetUserCountExceededLimit":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.Search.CompanySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"isClustered":false,"isTargetUserCountExceededLimit":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.Search.CompanySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"isClustered":false,"isTargetUserCountExceededLimit":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.CustomCompanyPagedResults`1[[KeepnetLabs.ApplicationService.Company.Dto.SearchCompanyDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/search/export": { "post": { "tags": [ "Company & Settings" ], "summary": "Exports the filtered list of companies to a downloadable file in the requested format (CSV, Excel, etc.).", "requestBody": { "description": "Export criteria including pagination, filter, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.Search.CompanyExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","isTargetUserCountExceededLimit":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.Search.CompanyExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","isTargetUserCountExceededLimit":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.Search.CompanyExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","isTargetUserCountExceededLimit":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.Search.CompanyExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","isTargetUserCountExceededLimit":false} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/companies/roi-settings": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the ROI (Return on Investment) settings for the current user's company, including cost-per-incident and breach-probability values.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Company.Dto.RoiSettingsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "put": { "tags": [ "Company & Settings" ], "summary": "Updates the ROI settings for the current user's company, allowing customization of cost-per-incident and breach-probability values used in risk calculations.", "requestBody": { "description": "The updated ROI settings payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.UpdateRoiSettingsRequest" }, "example": {"baseManHourCost":20,"baseManHour":100} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.UpdateRoiSettingsRequest" }, "example": {"baseManHourCost":20,"baseManHour":100} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.UpdateRoiSettingsRequest" }, "example": {"baseManHourCost":20,"baseManHour":100} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.UpdateRoiSettingsRequest" }, "example": {"baseManHourCost":20,"baseManHour":100} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/my": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the list of companies accessible to the current authenticated user, typically used for company-switching in multi-tenant scenarios.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.Company.Dto.GetMyCompaniesDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/companies/get-with-groups": { "post": { "tags": [ "Company & Settings" ], "summary": "Retrieves a list of company resource identifiers that belong to the specified company groups.", "requestBody": { "description": "A request containing a list of company group resource identifiers to look up.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.GetCompaniesByGroupResourceIdsRequest" }, "example": {"companyGroupResourceIds":["Cg5Wn3mR8vTp"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.GetCompaniesByGroupResourceIdsRequest" }, "example": {"companyGroupResourceIds":["Cg5Wn3mR8vTp"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.GetCompaniesByGroupResourceIdsRequest" }, "example": {"companyGroupResourceIds":["Cg5Wn3mR8vTp"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.GetCompaniesByGroupResourceIdsRequest" }, "example": {"companyGroupResourceIds":["Cg5Wn3mR8vTp"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/companies/community-companies": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves a list of companies from communities that the current user's company is a member of, enabling cross-community collaboration.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.Company.Dto.GetCommunityCompaniesDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/companies/{resourceId}/license-check": { "get": { "tags": [ "Company & Settings" ], "summary": "Checks the license status and validity for a specific company, including active module entitlements and expiration dates.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the company whose license to check.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Company.Dto.CheckCompanyLicenseDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/clients": { "post": { "tags": [ "Company & Settings" ], "summary": "Creates a new REST API client (OAuth2 credentials) for the company, enabling programmatic access to the platform API.", "requestBody": { "description": "The client creation payload including name, description, and allowed scopes.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.CreateClientRequest" }, "example": {"name":"API Integration Client","clientId":"api-client-01","clientSecret":"***","statusId":1,"hasIpAddressRestriction":false,"allowedIpAddresses":[],"roleResourceIdList":["Hs7Kp2mR4xLn"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.CreateClientRequest" }, "example": {"name":"API Integration Client","clientId":"api-client-01","clientSecret":"***","statusId":1,"hasIpAddressRestriction":false,"allowedIpAddresses":[],"roleResourceIdList":["Hs7Kp2mR4xLn"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.CreateClientRequest" }, "example": {"name":"API Integration Client","clientId":"api-client-01","clientSecret":"***","statusId":1,"hasIpAddressRestriction":false,"allowedIpAddresses":[],"roleResourceIdList":["Hs7Kp2mR4xLn"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.CreateClientRequest" }, "example": {"name":"API Integration Client","clientId":"api-client-01","clientSecret":"***","statusId":1,"hasIpAddressRestriction":false,"allowedIpAddresses":[],"roleResourceIdList":["Hs7Kp2mR4xLn"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/clients/{resourceId}": { "put": { "tags": [ "Company & Settings" ], "summary": "Updates an existing REST API client's configuration such as name, description, and allowed scopes.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the client to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated client details payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.UpdateClientRequest" }, "example": {"name":"API Integration Client","clientId":"api-client-01","clientSecret":"***","statusId":1,"hasIpAddressRestriction":false,"allowedIpAddresses":[],"roleResourceIdList":["Hs7Kp2mR4xLn"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.UpdateClientRequest" }, "example": {"name":"API Integration Client","clientId":"api-client-01","clientSecret":"***","statusId":1,"hasIpAddressRestriction":false,"allowedIpAddresses":[],"roleResourceIdList":["Hs7Kp2mR4xLn"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.UpdateClientRequest" }, "example": {"name":"API Integration Client","clientId":"api-client-01","clientSecret":"***","statusId":1,"hasIpAddressRestriction":false,"allowedIpAddresses":[],"roleResourceIdList":["Hs7Kp2mR4xLn"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.UpdateClientRequest" }, "example": {"name":"API Integration Client","clientId":"api-client-01","clientSecret":"***","statusId":1,"hasIpAddressRestriction":false,"allowedIpAddresses":[],"roleResourceIdList":["Hs7Kp2mR4xLn"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Company & Settings" ], "summary": "Deletes an existing REST API client, revoking its credentials and access to the platform API.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the client to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the details of an existing REST API client by its resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the client.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Company.Dto.ClientDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/get-current-time/{timeZoneId}": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the current date and time in the specified time zone, used for scheduling and display purposes.", "parameters": [ { "name": "timeZoneId", "in": "path", "description": "The IANA or Windows time zone identifier (e.g., \"Europe/Istanbul\", \"Eastern Standard Time\").", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/companies/clients/search": { "post": { "tags": [ "Company & Settings" ], "summary": "Searches and retrieves a paginated list of REST API clients for the current company with optional filtering and sorting.", "requestBody": { "description": "Search criteria including pagination and optional filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.Search.SearchClientRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"ClientName","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.Search.SearchClientRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"ClientName","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.Search.SearchClientRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"ClientName","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.Search.SearchClientRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"ClientName","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.Company.Dto.SearchClientDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/clients/search/export": { "post": { "tags": [ "Company & Settings" ], "summary": "Exports the filtered list of REST API clients to a downloadable file in the requested format (CSV, Excel, etc.).", "requestBody": { "description": "Export criteria including pagination, filter, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/companies/clients/generate-client-credentials": { "get": { "tags": [ "Company & Settings" ], "summary": "Generates a new pair of client credentials (client ID and secret) for use in REST API client registrations.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Company.Dto.ClientCredentialDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/my/search": { "post": { "tags": [ "Company & Settings" ], "summary": "Searches the list of companies accessible to the current user with pagination and filtering support.", "requestBody": { "description": "Search criteria including pagination and optional filters for company lookup.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SearchMyCompaniesRequest" }, "example": {"text":"keepnet"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SearchMyCompaniesRequest" }, "example": {"text":"keepnet"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SearchMyCompaniesRequest" }, "example": {"text":"keepnet"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SearchMyCompaniesRequest" }, "example": {"text":"keepnet"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Company.Dto.SearchMyCompaniesServiceRequest, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/bulk-delete": { "delete": { "tags": [ "Company & Settings" ], "summary": "Permanently deletes multiple companies in a single bulk operation.", "requestBody": { "description": "A list of company resource identifiers to delete.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.CompaniesBulkDeleteRequest" }, "example": {"items":["Co3Rm8vT2nKp"],"selectAll":false,"excludedItems":[],"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[]}} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.CompaniesBulkDeleteRequest" }, "example": {"items":["Co3Rm8vT2nKp"],"selectAll":false,"excludedItems":[],"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[]}} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.CompaniesBulkDeleteRequest" }, "example": {"items":["Co3Rm8vT2nKp"],"selectAll":false,"excludedItems":[],"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[]}} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.CompaniesBulkDeleteRequest" }, "example": {"items":["Co3Rm8vT2nKp"],"selectAll":false,"excludedItems":[],"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[]}} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/privacy": { "put": { "tags": [ "Company & Settings" ], "summary": "Configures the privacy settings for the current company, controlling data visibility and anonymization rules for target users.", "requestBody": { "description": "The privacy settings payload including anonymization and masking preferences.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SetCompanyPrivacyRequest" }, "example": {"privacyDurationId":1} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SetCompanyPrivacyRequest" }, "example": {"privacyDurationId":1} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SetCompanyPrivacyRequest" }, "example": {"privacyDurationId":1} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SetCompanyPrivacyRequest" }, "example": {"privacyDurationId":1} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the current privacy settings for the company, including data anonymization and masking configurations.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Company.Dto.GetCompanyPrivacyDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/privacymask": { "put": { "tags": [ "Company & Settings" ], "summary": "Configures the pentester mask privacy settings for the company, controlling how penetration tester data is displayed in reports.", "requestBody": { "description": "The pentester mask privacy settings payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Company.Dto.SetCompanyPrivacyPentesterMaskRequest" }, "example": {"pentesterMasked":true} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Company.Dto.SetCompanyPrivacyPentesterMaskRequest" }, "example": {"pentesterMasked":true} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Company.Dto.SetCompanyPrivacyPentesterMaskRequest" }, "example": {"pentesterMasked":true} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Company.Dto.SetCompanyPrivacyPentesterMaskRequest" }, "example": {"pentesterMasked":true} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the pentester mask privacy settings for the company, indicating how tester identities are masked in simulation reports.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Company.Dto.GetCompanyPrivacyPentesterMaskDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/licenseexpirydate": { "post": { "tags": [ "Company & Settings" ], "summary": "Retrieves the license expiry date for a company, used for license renewal tracking and notifications.", "requestBody": { "description": "The request containing the company identifier or filter for the license check.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Company.Dto.GetCompanyLicenseExpiryDateRequest" }, "example": {"licenseStartDate":"2026-01-01 00:00:00"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Company.Dto.GetCompanyLicenseExpiryDateRequest" }, "example": {"licenseStartDate":"2026-01-01 00:00:00"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Company.Dto.GetCompanyLicenseExpiryDateRequest" }, "example": {"licenseStartDate":"2026-01-01 00:00:00"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Company.Dto.GetCompanyLicenseExpiryDateRequest" }, "example": {"licenseStartDate":"2026-01-01 00:00:00"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Company.Dto.GetCompanyLicenseExpiryDateDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/ai": { "post": { "tags": [ "Company & Settings" ], "summary": "Configures the AI-assisted feature settings for the company, enabling or disabling AI capabilities across modules.", "requestBody": { "description": "The AI settings payload specifying which AI features are enabled.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SetCompanyAISettingsRequest" }, "example": {"psEmailTemplateGenerationAssistant":true,"landingPageTemplateGenerationAssistant":true} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SetCompanyAISettingsRequest" }, "example": {"psEmailTemplateGenerationAssistant":true,"landingPageTemplateGenerationAssistant":true} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SetCompanyAISettingsRequest" }, "example": {"psEmailTemplateGenerationAssistant":true,"landingPageTemplateGenerationAssistant":true} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SetCompanyAISettingsRequest" }, "example": {"psEmailTemplateGenerationAssistant":true,"landingPageTemplateGenerationAssistant":true} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the current AI-assisted feature settings for the company, showing which AI capabilities are enabled.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Company.Dto.GetCompanyAISettingsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/agentic-ai": { "post": { "tags": [ "Company & Settings" ], "summary": "Configures the Agentic AI settings for the company, controlling autonomous AI agent behavior and execution preferences.", "requestBody": { "description": "The Agentic AI settings payload including execution mode and behavioral policies.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SetCompanyAgenticAISettingsRequest" }, "example": {"agenticAIEnabled":true} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SetCompanyAgenticAISettingsRequest" }, "example": {"agenticAIEnabled":true} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SetCompanyAgenticAISettingsRequest" }, "example": {"agenticAIEnabled":true} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SetCompanyAgenticAISettingsRequest" }, "example": {"agenticAIEnabled":true} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the current Agentic AI settings for the company, including autonomous agent execution mode and behavioral constraints.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Company.Dto.GetCompanyAgenticAISettingsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/agentic-ai-settings/metadata": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the static metadata for Agentic AI settings, including available execution modes and behavioral policy definitions with their descriptions and ordering.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.DistributedService.Rest.Models.Company.AgenticAI.AgenticAIMetadataResponse, KeepnetLabs.DistributedService.Rest, Version=3.5.0.7, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/agentic-ai-settings": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the company-specific Agentic AI settings, including the selected execution mode and configured behavioral policies.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.DistributedService.Rest.Models.Company.AgenticAI.AgenticAISettingsResponse, KeepnetLabs.DistributedService.Rest, Version=3.5.0.7, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "patch": { "tags": [ "Company & Settings" ], "summary": "Partially updates the company's Agentic AI settings. Supports selective updates to execution mode and/or behavioral policies without requiring all fields.", "requestBody": { "description": "The partial update payload containing optional execution mode and/or behavioral policy changes.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.AgenticAI.UpdateAgenticAISettingsRequest" }, "example": {"executionMode":"autonomous","behavioralPolicies":{"auto_generate_content":true,"auto_enroll_users":false,"send_notifications":true}} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.AgenticAI.UpdateAgenticAISettingsRequest" }, "example": {"executionMode":"autonomous","behavioralPolicies":{"auto_generate_content":true,"auto_enroll_users":false,"send_notifications":true}} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.AgenticAI.UpdateAgenticAISettingsRequest" }, "example": {"executionMode":"autonomous","behavioralPolicies":{"auto_generate_content":true,"auto_enroll_users":false,"send_notifications":true}} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.AgenticAI.UpdateAgenticAISettingsRequest" }, "example": {"executionMode":"autonomous","behavioralPolicies":{"auto_generate_content":true,"auto_enroll_users":false,"send_notifications":true}} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.DistributedService.Rest.Models.Company.AgenticAI.AgenticAISettingsResponse, KeepnetLabs.DistributedService.Rest, Version=3.5.0.7, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/agentic-ai-settings/reset": { "post": { "tags": [ "Company & Settings" ], "summary": "Resets the company's Agentic AI settings back to platform defaults by deleting all custom configurations.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/teams-obo/authorize-link": { "post": { "tags": [ "Company & Settings" ], "summary": "Generates a Microsoft Teams OBO (On-Behalf-Of) authorization URL and creates or updates the Teams integration setting for the company.", "requestBody": { "description": "The request containing the company resource identifier for Teams integration.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsOboAuthorizeLinkRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsOboAuthorizeLinkRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsOboAuthorizeLinkRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsOboAuthorizeLinkRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Teams.Dto.TeamsOboAuthorizeLinkResponse, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/v2/companies/teams-obo/callback": { "get": { "tags": [ "Company & Settings" ], "summary": "Processes the Microsoft Teams OBO callback after admin consent, exchanging the authorization code for an access token to complete the integration.\r\nReturns the standard API envelope (DataResponse).", "parameters": [ { "name": "code", "in": "query", "description": "The authorization code returned by Microsoft identity platform.", "schema": { "type": "string" } }, { "name": "state", "in": "query", "description": "Optional state parameter containing the company identifier for context.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/companies/teams-app/upload": { "post": { "tags": [ "Company & Settings" ], "summary": "Uploads the Keepnet Teams app package to the company's Microsoft Teams tenant via the OBO flow, making it available for installation.", "requestBody": { "description": "The request containing the company resource identifier.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppUploadRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppUploadRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppUploadRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppUploadRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/companies/teams-app/authorize-link": { "post": { "tags": [ "Company & Settings" ], "summary": "Generates a Microsoft Teams app authorization URL for admin consent, required before the Teams app can be installed in the tenant.", "requestBody": { "description": "The request containing the company resource identifier.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppAuthorizeLinkRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppAuthorizeLinkRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppAuthorizeLinkRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppAuthorizeLinkRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppAuthorizeLinkResponse, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/teams-app/check": { "post": { "tags": [ "Company & Settings" ], "summary": "Checks whether the Keepnet Teams app is installed in the company's Microsoft Teams tenant and returns its current status, version, and distribution details.", "requestBody": { "description": "The request containing the company resource identifier.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppCheckRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppCheckRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppCheckRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppCheckRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppCheckResponse, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/teams-app/callback": { "get": { "tags": [ "Company & Settings" ], "summary": "Handles the Microsoft Teams app admin consent callback, processing the consent result and updating the integration status accordingly.", "parameters": [ { "name": "admin_consent", "in": "query", "description": "Whether admin consent was granted (\"True\" or \"False\").", "schema": { "type": "string", "default": "" } }, { "name": "tenant", "in": "query", "description": "The Azure AD tenant identifier.", "schema": { "type": "string", "default": "" } }, { "name": "scope", "in": "query", "description": "The granted permission scopes.", "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "query", "description": "The state parameter containing the company context.", "schema": { "type": "string", "default": "" } }, { "name": "error", "in": "query", "description": "Error code if the consent was denied or failed.", "schema": { "type": "string", "default": "" } }, { "name": "error_description", "in": "query", "description": "Detailed description of the consent error, if any.", "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppCallbackResponse, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/teams-app/remove": { "delete": { "tags": [ "Company & Settings" ], "summary": "Removes the Keepnet Teams app from the company's Microsoft Teams tenant and soft-deletes the integration record from the database.", "requestBody": { "description": "The request containing the company resource identifier.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppRemoveRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppRemoveRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppRemoveRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppRemoveRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/companies/teams-app/install-to-users": { "post": { "tags": [ "Company & Settings" ], "summary": "Installs the Keepnet Teams app to all active target users of the specified company, enabling per-user Teams notifications and interactions.", "requestBody": { "description": "The request containing the company resource identifier.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppInstallToUsersRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppInstallToUsersRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppInstallToUsersRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppInstallToUsersRequest" }, "example": {"companyResourceId":"Cm5Kp2mR7xLv"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Teams.Dto.TeamsAppInstallToUsersResponse, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/teams-app/send-test-activity": { "post": { "tags": [ "Company & Settings" ], "summary": "Sends a test Teams activity notification to a specific user to verify that the Teams integration is functioning correctly.", "requestBody": { "description": "The request containing the company resource identifier and the target user's email address.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SendTestTeamsActivityRequest" }, "example": {"companyResourceId":"65BVv1136Vnp","userEmail":"admin@acmecorp.com"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SendTestTeamsActivityRequest" }, "example": {"companyResourceId":"65BVv1136Vnp","userEmail":"admin@acmecorp.com"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SendTestTeamsActivityRequest" }, "example": {"companyResourceId":"65BVv1136Vnp","userEmail":"admin@acmecorp.com"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.SendTestTeamsActivityRequest" }, "example": {"companyResourceId":"65BVv1136Vnp","userEmail":"admin@acmecorp.com"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Teams.SendTestActivityResponseDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/company-groups": { "post": { "tags": [ "Company & Settings" ], "summary": "Creates a new company group for organizing and managing multiple companies together under a shared logical grouping.", "requestBody": { "description": "The company group creation payload including group name and optional description.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.CreateCompanyGroupRequest" }, "example": {"name":"EMEA Region","companyResourceIdArray":["Hs7Kp2mR4xLn","Tg8Rp4nK2wLm"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.CreateCompanyGroupRequest" }, "example": {"name":"EMEA Region","companyResourceIdArray":["Hs7Kp2mR4xLn","Tg8Rp4nK2wLm"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.CreateCompanyGroupRequest" }, "example": {"name":"EMEA Region","companyResourceIdArray":["Hs7Kp2mR4xLn","Tg8Rp4nK2wLm"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.CreateCompanyGroupRequest" }, "example": {"name":"EMEA Region","companyResourceIdArray":["Hs7Kp2mR4xLn","Tg8Rp4nK2wLm"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the full list of all company groups available to the current user's organization.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.CompanyGroup.Dto.CompanyGroupDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/company-groups/{resourceId}": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the details of a specific company group by its resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the company group.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.CompanyGroup.Dto.CompanyGroupDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "put": { "tags": [ "Company & Settings" ], "summary": "Updates an existing company group's details such as name and description.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the company group to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated company group details payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.UpdateCompanyGroupRequest" }, "example": {"name":"EMEA Region","companyResourceIdArray":["Hs7Kp2mR4xLn","Tg8Rp4nK2wLm"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.UpdateCompanyGroupRequest" }, "example": {"name":"EMEA Region","companyResourceIdArray":["Hs7Kp2mR4xLn","Tg8Rp4nK2wLm"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.UpdateCompanyGroupRequest" }, "example": {"name":"EMEA Region","companyResourceIdArray":["Hs7Kp2mR4xLn","Tg8Rp4nK2wLm"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.UpdateCompanyGroupRequest" }, "example": {"name":"EMEA Region","companyResourceIdArray":["Hs7Kp2mR4xLn","Tg8Rp4nK2wLm"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Company & Settings" ], "summary": "Permanently deletes a company group. Member companies are not deleted but lose their group association.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the company group to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/company-groups/{resourceId}/participants": { "put": { "tags": [ "Company & Settings" ], "summary": "Adds one or more companies to a company group, establishing their membership in the group for shared operations.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the company group to add companies to.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request containing the list of company resource identifiers to add.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.AddCompanyToCompanyGroupRequest" }, "example": {"companyResourceIdArray":["Hs7Kp2mR4xLn","Tg8Rp4nK2wLm"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.AddCompanyToCompanyGroupRequest" }, "example": {"companyResourceIdArray":["Hs7Kp2mR4xLn","Tg8Rp4nK2wLm"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.AddCompanyToCompanyGroupRequest" }, "example": {"companyResourceIdArray":["Hs7Kp2mR4xLn","Tg8Rp4nK2wLm"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.AddCompanyToCompanyGroupRequest" }, "example": {"companyResourceIdArray":["Hs7Kp2mR4xLn","Tg8Rp4nK2wLm"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Company & Settings" ], "summary": "Removes one or more companies from a company group, revoking their group membership.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the company group to remove companies from.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The request containing the list of company resource identifiers to remove.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.RemoveCompanyFromCompanyGroupRequest" }, "example": {"companyResourceIdArray":["Hs7Kp2mR4xLn","Tg8Rp4nK2wLm"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.RemoveCompanyFromCompanyGroupRequest" }, "example": {"companyResourceIdArray":["Hs7Kp2mR4xLn","Tg8Rp4nK2wLm"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.RemoveCompanyFromCompanyGroupRequest" }, "example": {"companyResourceIdArray":["Hs7Kp2mR4xLn","Tg8Rp4nK2wLm"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.RemoveCompanyFromCompanyGroupRequest" }, "example": {"companyResourceIdArray":["Hs7Kp2mR4xLn","Tg8Rp4nK2wLm"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/company-groups/{resourceId}/companies/search": { "post": { "tags": [ "Company & Settings" ], "summary": "Searches and retrieves a paginated list of companies that belong to a specific company group.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the company group.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including pagination and optional filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.Search.GroupCompanySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.Search.GroupCompanySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.Search.GroupCompanySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.Search.GroupCompanySearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.CompanyGroup.Dto.SearchGroupCompanyDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/company-groups/search": { "post": { "tags": [ "Company & Settings" ], "summary": "Searches and retrieves a paginated list of company groups for the current company with optional filtering and sorting.", "requestBody": { "description": "Search criteria including pagination, filter, and report-all-pages flag.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.Search.SearchCompanyGroupRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":false,"reportAllPages":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.Search.SearchCompanyGroupRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":false,"reportAllPages":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.Search.SearchCompanyGroupRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":false,"reportAllPages":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.Search.SearchCompanyGroupRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":false,"reportAllPages":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.CompanyGroup.Dto.SearchCompanyGroupDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/company-groups/search/export": { "post": { "tags": [ "Company & Settings" ], "summary": "Exports the filtered list of company groups to a downloadable file in the requested format (CSV, Excel, etc.).", "requestBody": { "description": "Export criteria including pagination, filter, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/company-groups/{resourceId}/companies/search/export": { "post": { "tags": [ "Company & Settings" ], "summary": "Exports the list of companies belonging to a specific company group to a downloadable file.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the company group.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Export criteria including pagination, filter, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/company-groups/bulk-delete": { "delete": { "tags": [ "Company & Settings" ], "summary": "Permanently deletes multiple company groups in a single bulk operation. Member companies are not deleted.", "requestBody": { "description": "A list of company group resource identifiers to delete.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.CompanyGroupsBulkDeleteRequest" }, "example": {"items":["Cg5Wn3mR8vTp"],"selectAll":false,"excludedItems":[],"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[]}} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.CompanyGroupsBulkDeleteRequest" }, "example": {"items":["Cg5Wn3mR8vTp"],"selectAll":false,"excludedItems":[],"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[]}} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.CompanyGroupsBulkDeleteRequest" }, "example": {"items":["Cg5Wn3mR8vTp"],"selectAll":false,"excludedItems":[],"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[]}} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.CompanyGroupsBulkDeleteRequest" }, "example": {"items":["Cg5Wn3mR8vTp"],"selectAll":false,"excludedItems":[],"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[]}} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/company-groups/search-with-parent": { "post": { "tags": [ "Company & Settings" ], "summary": "Searches company groups including those inherited from parent companies, enabling hierarchical group management across the tenant tree.", "requestBody": { "description": "Search criteria including pagination and filter.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.Search.SearchCompanyGroupRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":false,"reportAllPages":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.Search.SearchCompanyGroupRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":false,"reportAllPages":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.Search.SearchCompanyGroupRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":false,"reportAllPages":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyGroup.Search.SearchCompanyGroupRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":false,"reportAllPages":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.CompanyGroup.Dto.SearchCompanyGroupDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/ip-restrictions": { "get": { "tags": [ "Company & Settings" ], "summary": "Returns the list of IP restriction rules for the current company.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.DistributedService.Rest.Models.CompanyIpRestriction.CompanyIpRestrictionResponse, KeepnetLabs.DistributedService.Rest, Version=3.5.0.7, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } }, "post": { "tags": [ "Company & Settings" ], "summary": "Adds one or more IP restriction rules (single IP or CIDR range) to the current company.", "requestBody": { "description": "The IP restriction rules to add.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyIpRestriction.AddCompanyIpRestrictionRequest" }, "example": {"ipRanges":["192.168.1.0/24","10.0.0.1"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyIpRestriction.AddCompanyIpRestrictionRequest" }, "example": {"ipRanges":["192.168.1.0/24","10.0.0.1"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyIpRestriction.AddCompanyIpRestrictionRequest" }, "example": {"ipRanges":["192.168.1.0/24","10.0.0.1"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.CompanyIpRestriction.AddCompanyIpRestrictionRequest" }, "example": {"ipRanges":["192.168.1.0/24","10.0.0.1"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.DistributedService.Rest.Models.CompanyIpRestriction.CompanyIpRestrictionResponse, KeepnetLabs.DistributedService.Rest, Version=3.5.0.7, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/companies/ip-restrictions/{resourceId}": { "delete": { "tags": [ "Company & Settings" ], "summary": "Deletes an IP restriction rule from the current company.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The resource identifier of the IP restriction rule to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult" } } } } } } }, "/api/companies/direct-email-settings": { "post": { "tags": [ "Company & Settings" ], "summary": "Creates a new Direct Email Connector (DEC) setting for the company, enabling direct email delivery via Microsoft 365 or Google Workspace APIs instead of SMTP.", "requestBody": { "description": "The DEC creation payload including provider type (O365/Google), tenant ID, and API credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.CreateDirectEmailSettingRequest" }, "example": {"name":"Office 365 Direct Email","tenantId":"b2c7e9a1-4f3d-4e8b-9c1a-5d6f7e8a9b0c","allowedDomains":["example.com","mail.example.com"],"type":1} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.CreateDirectEmailSettingRequest" }, "example": {"name":"Office 365 Direct Email","tenantId":"b2c7e9a1-4f3d-4e8b-9c1a-5d6f7e8a9b0c","allowedDomains":["example.com","mail.example.com"],"type":1} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.CreateDirectEmailSettingRequest" }, "example": {"name":"Office 365 Direct Email","tenantId":"b2c7e9a1-4f3d-4e8b-9c1a-5d6f7e8a9b0c","allowedDomains":["example.com","mail.example.com"],"type":1} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.CreateDirectEmailSettingRequest" }, "example": {"name":"Office 365 Direct Email","tenantId":"b2c7e9a1-4f3d-4e8b-9c1a-5d6f7e8a9b0c","allowedDomains":["example.com","mail.example.com"],"type":1} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/direct-email-settings/{resourceId}": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the details of an existing Direct Email Connector setting by its resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the DEC setting.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.DirectEmailSetting.Dto.DirectEmailSettingDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "put": { "tags": [ "Company & Settings" ], "summary": "Updates an existing Direct Email Connector setting's configuration such as API credentials, sender address, and tenant details.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the DEC setting to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated DEC setting details payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.UpdateDirectEmailSettingRequest" }, "example": {"name":"Office 365 Direct Email","tenantId":"b2c7e9a1-4f3d-4e8b-9c1a-5d6f7e8a9b0c","allowedDomains":["example.com","mail.example.com"],"type":1} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.UpdateDirectEmailSettingRequest" }, "example": {"name":"Office 365 Direct Email","tenantId":"b2c7e9a1-4f3d-4e8b-9c1a-5d6f7e8a9b0c","allowedDomains":["example.com","mail.example.com"],"type":1} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.UpdateDirectEmailSettingRequest" }, "example": {"name":"Office 365 Direct Email","tenantId":"b2c7e9a1-4f3d-4e8b-9c1a-5d6f7e8a9b0c","allowedDomains":["example.com","mail.example.com"],"type":1} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.UpdateDirectEmailSettingRequest" }, "example": {"name":"Office 365 Direct Email","tenantId":"b2c7e9a1-4f3d-4e8b-9c1a-5d6f7e8a9b0c","allowedDomains":["example.com","mail.example.com"],"type":1} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Company & Settings" ], "summary": "Deletes an existing Direct Email Connector setting from the company's configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the DEC setting to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/direct-email-settings/settings": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the default application settings for Direct Email Connectors, including supported provider types and configuration templates.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.DirectEmailSetting.Dto.Setting, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/direct-email-settings/search": { "post": { "tags": [ "Company & Settings" ], "summary": "Searches and retrieves a paginated list of Direct Email Connector settings for the company with optional filtering and sorting.", "requestBody": { "description": "Search criteria including pagination and optional filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.SearchDirectEmailSettingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.SearchDirectEmailSettingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.SearchDirectEmailSettingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.SearchDirectEmailSettingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/direct-email-settings/search/export": { "post": { "tags": [ "Company & Settings" ], "summary": "Exports the filtered list of Direct Email Connector settings to a downloadable file in the requested format (CSV, Excel, etc.).", "requestBody": { "description": "Export criteria including pagination, filter, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/companies/direct-email-settings/test": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests connectivity and authentication of a Direct Email Connector by attempting to connect to the configured mail provider API.", "requestBody": { "description": "The DEC configuration to test including provider credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.TestDirectEmailSettingRequest" }, "example": {"from":"noreply@example.com","fromName":"Keepnet Security","to":"admin@example.com","message":"This is a test email from Keepnet.","tenantId":"b2c7e9a1-4f3d-4e8b-9c1a-5d6f7e8a9b0c","type":1} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.TestDirectEmailSettingRequest" }, "example": {"from":"noreply@example.com","fromName":"Keepnet Security","to":"admin@example.com","message":"This is a test email from Keepnet.","tenantId":"b2c7e9a1-4f3d-4e8b-9c1a-5d6f7e8a9b0c","type":1} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.TestDirectEmailSettingRequest" }, "example": {"from":"noreply@example.com","fromName":"Keepnet Security","to":"admin@example.com","message":"This is a test email from Keepnet.","tenantId":"b2c7e9a1-4f3d-4e8b-9c1a-5d6f7e8a9b0c","type":1} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.TestDirectEmailSettingRequest" }, "example": {"from":"noreply@example.com","fromName":"Keepnet Security","to":"admin@example.com","message":"This is a test email from Keepnet.","tenantId":"b2c7e9a1-4f3d-4e8b-9c1a-5d6f7e8a9b0c","type":1} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/direct-email-settings/domain-list": { "post": { "tags": [ "Company & Settings" ], "summary": "Retrieves the list of verified domains for a Microsoft 365 tenant, used to populate sender address options for the Direct Email Connector.", "requestBody": { "description": "The request containing tenant ID and API credentials for domain lookup.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.GetDomainListRequest" }, "example": {"resourceId":"65BVv1136Vnp","tenantId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","type":1} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.GetDomainListRequest" }, "example": {"resourceId":"65BVv1136Vnp","tenantId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","type":1} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.GetDomainListRequest" }, "example": {"resourceId":"65BVv1136Vnp","tenantId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","type":1} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DirectEmailSetting.GetDomainListRequest" }, "example": {"resourceId":"65BVv1136Vnp","tenantId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","type":1} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/companies/direct-email-settings/google-client": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the Google Workspace OAuth2 client ID used for configuring Google Workspace Direct Email Connectors.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.DirectEmailSetting.Dto.Setting, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/direct-email-settings/make-default/{resourceId}": { "put": { "tags": [ "Company & Settings" ], "summary": "Sets a Direct Email Connector as the default sender for the company, used when no specific DEC is selected for a campaign.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the DEC to set as default.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/direct-email-settings/remove-default/{resourceId}": { "put": { "tags": [ "Company & Settings" ], "summary": "Removes the default status from a Direct Email Connector, so no DEC is pre-selected as the default sender.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the DEC to remove from default.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/{providerName}/{resourceId}": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves an existing mail provider configuration by provider type and resource identifier. Supports O365, EWS, and Google Workspace providers.", "parameters": [ { "name": "providerName", "in": "path", "description": "The mail provider type (e.g., O365, EWS, GoogleWorkspace).", "required": true, "schema": { "$ref": "#/components/schemas/KeepnetLabs.Domain.Entities.Investigation.ScanType" } }, { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the mail configuration.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.MailProvider.Dto.MailProviderDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/o365": { "post": { "tags": [ "Company & Settings" ], "summary": "Creates a new Microsoft 365 (O365) mail provider configuration for incident response scanning, enabling mailbox access via Graph API.", "requestBody": { "description": "The O365 configuration payload including tenant ID, client ID, client secret, and scanning parameters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.CreateO365MailProviderRequest" }, "example": {"name":"ACME O365 Mail Provider","applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","allowedDomains":["acme.com","acme.org"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.CreateO365MailProviderRequest" }, "example": {"name":"ACME O365 Mail Provider","applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","allowedDomains":["acme.com","acme.org"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.CreateO365MailProviderRequest" }, "example": {"name":"ACME O365 Mail Provider","applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","allowedDomains":["acme.com","acme.org"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.CreateO365MailProviderRequest" }, "example": {"name":"ACME O365 Mail Provider","applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","allowedDomains":["acme.com","acme.org"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/mail-configurations/ews": { "post": { "tags": [ "Company & Settings" ], "summary": "Creates a new Exchange Web Services (EWS) mail provider configuration for incident response scanning, using on-premises or hybrid Exchange.", "requestBody": { "description": "The EWS configuration payload including server URL, authentication method, and credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.EwsMailProviderRequest" }, "example": {"name":"ACME Exchange EWS Provider","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"exchangeVersionLookupResourceId":"Lk8Rn3mQ7wXp","userName":"svc-ews@acme.com","password":"ews_password_placeholder","email":"svc-ews@acme.com","xAnchorMailBoxHeader":true,"targetGroupResourceIdList":["Rn5Kp8mQ3wLx"],"isAllTargetGroupsSelected":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.EwsMailProviderRequest" }, "example": {"name":"ACME Exchange EWS Provider","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"exchangeVersionLookupResourceId":"Lk8Rn3mQ7wXp","userName":"svc-ews@acme.com","password":"ews_password_placeholder","email":"svc-ews@acme.com","xAnchorMailBoxHeader":true,"targetGroupResourceIdList":["Rn5Kp8mQ3wLx"],"isAllTargetGroupsSelected":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.EwsMailProviderRequest" }, "example": {"name":"ACME Exchange EWS Provider","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"exchangeVersionLookupResourceId":"Lk8Rn3mQ7wXp","userName":"svc-ews@acme.com","password":"ews_password_placeholder","email":"svc-ews@acme.com","xAnchorMailBoxHeader":true,"targetGroupResourceIdList":["Rn5Kp8mQ3wLx"],"isAllTargetGroupsSelected":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.EwsMailProviderRequest" }, "example": {"name":"ACME Exchange EWS Provider","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"exchangeVersionLookupResourceId":"Lk8Rn3mQ7wXp","userName":"svc-ews@acme.com","password":"ews_password_placeholder","email":"svc-ews@acme.com","xAnchorMailBoxHeader":true,"targetGroupResourceIdList":["Rn5Kp8mQ3wLx"],"isAllTargetGroupsSelected":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/mail-configurations/googleworkspace": { "post": { "tags": [ "Company & Settings" ], "summary": "Creates a new Google Workspace mail provider configuration for incident response scanning, enabling Gmail API access via service account.", "requestBody": { "description": "The Google Workspace configuration payload including service account credentials and domain details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.CreateGoogleWorkspaceMailProviderRequest" }, "example": {"name":"ACME Google Workspace Provider","authJson":"{\"type\":\"service_account\",\"project_id\":\"acme-security\",\"private_key_id\":\"key_placeholder\"}","email":"admin@acme.com"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.CreateGoogleWorkspaceMailProviderRequest" }, "example": {"name":"ACME Google Workspace Provider","authJson":"{\"type\":\"service_account\",\"project_id\":\"acme-security\",\"private_key_id\":\"key_placeholder\"}","email":"admin@acme.com"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.CreateGoogleWorkspaceMailProviderRequest" }, "example": {"name":"ACME Google Workspace Provider","authJson":"{\"type\":\"service_account\",\"project_id\":\"acme-security\",\"private_key_id\":\"key_placeholder\"}","email":"admin@acme.com"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.CreateGoogleWorkspaceMailProviderRequest" }, "example": {"name":"ACME Google Workspace Provider","authJson":"{\"type\":\"service_account\",\"project_id\":\"acme-security\",\"private_key_id\":\"key_placeholder\"}","email":"admin@acme.com"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/mail-configurations": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves all mail provider configurations for the current company, listing all configured O365, EWS, and Google Workspace integrations.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.MailProvider.Dto.MailProviderDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/mail-configurations/o365/{resourceId}": { "put": { "tags": [ "Company & Settings" ], "summary": "Updates an existing Microsoft 365 (O365) mail provider configuration's settings such as tenant ID, credentials, and scanning parameters.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the O365 mail configuration to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated O365 configuration payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.UpdateO365MailProviderRequest" }, "example": {"name":"ACME O365 Mail Provider (Updated)","applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_updated","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","allowedDomains":["acme.com","acme.org","acme.net"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.UpdateO365MailProviderRequest" }, "example": {"name":"ACME O365 Mail Provider (Updated)","applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_updated","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","allowedDomains":["acme.com","acme.org","acme.net"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.UpdateO365MailProviderRequest" }, "example": {"name":"ACME O365 Mail Provider (Updated)","applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_updated","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","allowedDomains":["acme.com","acme.org","acme.net"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.UpdateO365MailProviderRequest" }, "example": {"name":"ACME O365 Mail Provider (Updated)","applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_updated","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","allowedDomains":["acme.com","acme.org","acme.net"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Company & Settings" ], "summary": "Deletes a Microsoft 365 (O365) mail provider configuration from the company.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the O365 mail configuration to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/ews/{resourceId}": { "put": { "tags": [ "Company & Settings" ], "summary": "Updates an existing Exchange Web Services (EWS) mail provider configuration's settings such as server URL, authentication, and credentials.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the EWS mail configuration to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated EWS configuration payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.EwsMailProviderRequest" }, "example": {"name":"ACME Exchange EWS Provider","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"exchangeVersionLookupResourceId":"Lk8Rn3mQ7wXp","userName":"svc-ews@acme.com","password":"ews_password_placeholder","email":"svc-ews@acme.com","xAnchorMailBoxHeader":true,"targetGroupResourceIdList":["Rn5Kp8mQ3wLx"],"isAllTargetGroupsSelected":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.EwsMailProviderRequest" }, "example": {"name":"ACME Exchange EWS Provider","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"exchangeVersionLookupResourceId":"Lk8Rn3mQ7wXp","userName":"svc-ews@acme.com","password":"ews_password_placeholder","email":"svc-ews@acme.com","xAnchorMailBoxHeader":true,"targetGroupResourceIdList":["Rn5Kp8mQ3wLx"],"isAllTargetGroupsSelected":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.EwsMailProviderRequest" }, "example": {"name":"ACME Exchange EWS Provider","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"exchangeVersionLookupResourceId":"Lk8Rn3mQ7wXp","userName":"svc-ews@acme.com","password":"ews_password_placeholder","email":"svc-ews@acme.com","xAnchorMailBoxHeader":true,"targetGroupResourceIdList":["Rn5Kp8mQ3wLx"],"isAllTargetGroupsSelected":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.EwsMailProviderRequest" }, "example": {"name":"ACME Exchange EWS Provider","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"exchangeVersionLookupResourceId":"Lk8Rn3mQ7wXp","userName":"svc-ews@acme.com","password":"ews_password_placeholder","email":"svc-ews@acme.com","xAnchorMailBoxHeader":true,"targetGroupResourceIdList":["Rn5Kp8mQ3wLx"],"isAllTargetGroupsSelected":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Company & Settings" ], "summary": "Deletes an Exchange Web Services (EWS) mail provider configuration from the company.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the EWS mail configuration to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/googleworkspace/{resourceId}": { "put": { "tags": [ "Company & Settings" ], "summary": "Updates an existing Google Workspace mail provider configuration's settings such as service account credentials and domain details.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the Google Workspace mail configuration to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated Google Workspace configuration payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.UpdateGoogleWorkspaceMailProviderRequest" }, "example": {"name":"ACME Google Workspace Provider (Updated)","authJson":"{\"type\":\"service_account\",\"project_id\":\"acme-security\",\"private_key_id\":\"key_updated\"}","email":"admin@acme.com"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.UpdateGoogleWorkspaceMailProviderRequest" }, "example": {"name":"ACME Google Workspace Provider (Updated)","authJson":"{\"type\":\"service_account\",\"project_id\":\"acme-security\",\"private_key_id\":\"key_updated\"}","email":"admin@acme.com"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.UpdateGoogleWorkspaceMailProviderRequest" }, "example": {"name":"ACME Google Workspace Provider (Updated)","authJson":"{\"type\":\"service_account\",\"project_id\":\"acme-security\",\"private_key_id\":\"key_updated\"}","email":"admin@acme.com"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.UpdateGoogleWorkspaceMailProviderRequest" }, "example": {"name":"ACME Google Workspace Provider (Updated)","authJson":"{\"type\":\"service_account\",\"project_id\":\"acme-security\",\"private_key_id\":\"key_updated\"}","email":"admin@acme.com"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Company & Settings" ], "summary": "Deletes a Google Workspace mail provider configuration from the company.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the Google Workspace mail configuration to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/search": { "post": { "tags": [ "Company & Settings" ], "summary": "Searches and retrieves a paginated list of mail provider configurations for the company with optional filtering and sorting.", "requestBody": { "description": "Search criteria including pagination and optional filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.MailProviderSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.MailProviderSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.MailProviderSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.MailProviderSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.MailProvider.Search.MailProviderSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/search/export": { "post": { "tags": [ "Company & Settings" ], "summary": "Exports the filtered list of mail provider configurations to a downloadable file in the requested format (CSV, Excel, etc.).", "requestBody": { "description": "Export criteria including pagination, filter, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/mail-configurations/o365/check-api-connectivity": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests API connectivity for a Microsoft 365 mail configuration by verifying the Graph API token exchange and basic endpoint access.", "requestBody": { "description": "The O365 configuration to test including tenant ID, client ID, and client secret.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/o365/check-privileges-access": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests whether the O365 service account has sufficient application permissions (e.g., Mail.Read, Mail.ReadWrite) for incident response operations.", "requestBody": { "description": "The O365 configuration to test including tenant ID, client ID, and client secret.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/o365/check-inbox-access": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests inbox read access for an O365 mail configuration by attempting to list messages in the configured mailbox.", "requestBody": { "description": "The O365 configuration to test including tenant ID, client ID, and client secret.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/o365/check-all-users-access": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests whether the O365 mail configuration can enumerate all users in the tenant directory, required for organization-wide scanning.", "requestBody": { "description": "The O365 configuration to test including tenant ID, client ID, and client secret.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/o365/check-email-access": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests email read access for an O365 mail configuration by verifying the ability to read full email content from user mailboxes.", "requestBody": { "description": "The O365 configuration to test including tenant ID, client ID, and client secret.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/o365/check-create-new-category": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests the ability to create a new mailbox category in O365, used for tagging emails during incident response processing.", "requestBody": { "description": "The O365 configuration to test including tenant ID, client ID, and client secret.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/o365/check-update-category": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests the ability to update an existing mailbox category in O365, used for modifying email tags during incident response.", "requestBody": { "description": "The O365 configuration to test including tenant ID, client ID, and client secret.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/o365/check-delete-email": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests email deletion access for an O365 mail configuration, verifying the ability to quarantine/remove malicious emails from user mailboxes.", "requestBody": { "description": "The O365 configuration to test including tenant ID, client ID, and client secret.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/o365/list-related-domains": { "post": { "tags": [ "Company & Settings" ], "summary": "Lists all verified domains associated with the O365 tenant, useful for identifying organization-owned domains during mail analysis.", "requestBody": { "description": "The O365 configuration including tenant credentials for domain enumeration.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.ListRelatedDomainsForO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.ListRelatedDomainsForO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.ListRelatedDomainsForO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.ListRelatedDomainsForO365MailProviderRequest" }, "example": {"applicationId":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","applicationSecret":"app_secret_placeholder","directoryId":"d1e2f3a4-b5c6-7890-abcd-ef0987654321","email":"admin@acme.com","resourceId":"Ht4Wn8kL2mXq"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/ews/check-api-connectivity": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests API connectivity for an Exchange Web Services (EWS) mail configuration by verifying the EWS endpoint access and authentication.", "requestBody": { "description": "The EWS configuration to test including server URL and credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/ews/check-privileges-access": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests whether the EWS service account has sufficient impersonation and mailbox access privileges for incident response operations.", "requestBody": { "description": "The EWS configuration to test including server URL and credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/ews/check-inbox-access": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests inbox read access for an EWS mail configuration by attempting to access the configured mailbox inbox folder.", "requestBody": { "description": "The EWS configuration to test including server URL and credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/ews/check-email-body-access": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests email body access for an EWS mail configuration by verifying the ability to read full email content including HTML body.", "requestBody": { "description": "The EWS configuration to test including server URL and credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/ews/check-email-header-access": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests email header access for an EWS mail configuration by verifying the ability to read email transport headers for analysis.", "requestBody": { "description": "The EWS configuration to test including server URL and credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/ews/check-mail-filter": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests mail filtering capabilities for an EWS mail configuration by verifying the ability to search and filter emails by criteria such as date, sender, and subject.", "requestBody": { "description": "The EWS configuration to test including server URL and credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.MailProvider.TestApiEwsMailProviderRequest" }, "example": {"username":"svc-ews@acme.com","password":"ews_password_placeholder","serviceUrl":"https://mail.acme.com/EWS/Exchange.asmx","accountType":1,"email":"svc-ews@acme.com","xAnchorMailbox":true,"exchangeVersion":"Exchange2016","resourceId":"Ht4Wn8kL2mXq"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/gsuite/check-api-connectivity": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests API connectivity for a Google Workspace mail configuration by verifying the service account authentication and Gmail API access.", "requestBody": { "description": "The Google Workspace configuration to test including service account credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/gsuite/check-privileges-access": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests whether the Google Workspace service account has sufficient domain-wide delegation privileges for incident response scanning.", "requestBody": { "description": "The Google Workspace configuration to test including service account credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/gsuite/check-inbox-access": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests inbox read access for a Google Workspace mail configuration by attempting to list messages in the configured user's Gmail inbox.", "requestBody": { "description": "The Google Workspace configuration to test including service account credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/gsuite/check-all-users-access": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests whether the Google Workspace configuration can enumerate all users in the domain directory, required for organization-wide scanning.", "requestBody": { "description": "The Google Workspace configuration to test including service account credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/gsuite/check-email-access": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests email read access for a Google Workspace mail configuration by verifying the ability to read full email content from Gmail.", "requestBody": { "description": "The Google Workspace configuration to test including service account credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/gsuite/check-create-new-category": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests the ability to create a new Gmail label in Google Workspace, used for tagging emails during incident response processing.", "requestBody": { "description": "The Google Workspace configuration to test including service account credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/gsuite/check-update-category": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests the ability to update an existing Gmail label in Google Workspace, used for modifying email tags during incident response.", "requestBody": { "description": "The Google Workspace configuration to test including service account credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/mail-configurations/gsuite/check-delete-email": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests email deletion access for a Google Workspace mail configuration, verifying the ability to trash/remove malicious emails from user mailboxes.", "requestBody": { "description": "The Google Workspace configuration to test including service account credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.MailProvider.Dto.TestApiGoogleWorkspaceMailProviderServiceRequest" }, "example": {"credentialJson":"{\"type\":\"service_account\",\"project_id\":\"example-project\"}","email":"admin@example.com","resourceId":"Mp5Kp2mR7xLv"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/proxy-settings": { "post": { "tags": [ "Company & Settings" ], "summary": "Creates a new proxy setting for the company, configuring an HTTP/HTTPS proxy to route outbound simulation traffic through.", "requestBody": { "description": "The proxy setting creation payload including host, port, and optional authentication credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ProxySetting.CreateProxySettingRequest" }, "example": {"name":"Corporate Proxy","address":"proxy.example.com","port":"8080","authenticationTypeId":1,"username":"proxy-user","password":"***","isDefault":true} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ProxySetting.CreateProxySettingRequest" }, "example": {"name":"Corporate Proxy","address":"proxy.example.com","port":"8080","authenticationTypeId":1,"username":"proxy-user","password":"***","isDefault":true} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ProxySetting.CreateProxySettingRequest" }, "example": {"name":"Corporate Proxy","address":"proxy.example.com","port":"8080","authenticationTypeId":1,"username":"proxy-user","password":"***","isDefault":true} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ProxySetting.CreateProxySettingRequest" }, "example": {"name":"Corporate Proxy","address":"proxy.example.com","port":"8080","authenticationTypeId":1,"username":"proxy-user","password":"***","isDefault":true} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/proxy-settings/{resourceId}": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the details of an existing proxy setting by its resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the proxy setting.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.ProxySetting.Dto.ProxySettingDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "put": { "tags": [ "Company & Settings" ], "summary": "Updates an existing proxy setting's configuration such as host, port, and authentication credentials.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the proxy setting to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated proxy setting details payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ProxySetting.UpdateProxySettingRequest" }, "example": {"name":"Corporate Proxy","address":"proxy.example.com","port":"8080","authenticationTypeId":1,"username":"proxy-user","password":"***","isDefault":true} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ProxySetting.UpdateProxySettingRequest" }, "example": {"name":"Corporate Proxy","address":"proxy.example.com","port":"8080","authenticationTypeId":1,"username":"proxy-user","password":"***","isDefault":true} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ProxySetting.UpdateProxySettingRequest" }, "example": {"name":"Corporate Proxy","address":"proxy.example.com","port":"8080","authenticationTypeId":1,"username":"proxy-user","password":"***","isDefault":true} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ProxySetting.UpdateProxySettingRequest" }, "example": {"name":"Corporate Proxy","address":"proxy.example.com","port":"8080","authenticationTypeId":1,"username":"proxy-user","password":"***","isDefault":true} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Company & Settings" ], "summary": "Deletes an existing proxy setting from the company's configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the proxy setting to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/proxy-settings/search": { "post": { "tags": [ "Company & Settings" ], "summary": "Searches and retrieves a paginated list of proxy settings for the company with optional filtering and sorting.", "requestBody": { "description": "Search criteria including pagination and optional filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ProxySetting.SearchProxySettingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ProxySetting.SearchProxySettingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ProxySetting.SearchProxySettingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ProxySetting.SearchProxySettingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.ProxySetting.Dto.SearchProxySettingDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/proxy-settings/search/export": { "post": { "tags": [ "Company & Settings" ], "summary": "Exports the filtered list of proxy settings to a downloadable file in the requested format (CSV, Excel, etc.).", "requestBody": { "description": "Export criteria including pagination, filter, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/companies/proxy-settings/test": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests the connectivity of a proxy setting by attempting to connect through the configured proxy server, verifying host, port, and authentication.", "requestBody": { "description": "The proxy setting configuration to test.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ProxySetting.TestProxySettingRequest" }, "example": {"address":"proxy.example.com","port":"8080","authenticationTypeId":1,"username":"proxy-user","password":"***","testUrl":"https://www.google.com"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ProxySetting.TestProxySettingRequest" }, "example": {"address":"proxy.example.com","port":"8080","authenticationTypeId":1,"username":"proxy-user","password":"***","testUrl":"https://www.google.com"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ProxySetting.TestProxySettingRequest" }, "example": {"address":"proxy.example.com","port":"8080","authenticationTypeId":1,"username":"proxy-user","password":"***","testUrl":"https://www.google.com"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ProxySetting.TestProxySettingRequest" }, "example": {"address":"proxy.example.com","port":"8080","authenticationTypeId":1,"username":"proxy-user","password":"***","testUrl":"https://www.google.com"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/siem-settings": { "post": { "tags": [ "Company & Settings" ], "summary": "Creates a new SIEM integration setting for the company, configuring event forwarding to a Security Information and Event Management system (e.g., Splunk, QRadar, Sentinel).", "requestBody": { "description": "The SIEM setting creation payload including provider type, endpoint URL, and authentication details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SIEMSetting.CreateSIEMSettingRequest" }, "example": {"name":"Splunk SIEM Integration","apiUrl":"https://splunk.example.com:8088/services/collector","token":"***","typeId":1,"statusId":1,"isForwardHistoricalAuditLog":false,"serverAddress":"","port":"","connectionType":""} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SIEMSetting.CreateSIEMSettingRequest" }, "example": {"name":"Splunk SIEM Integration","apiUrl":"https://splunk.example.com:8088/services/collector","token":"***","typeId":1,"statusId":1,"isForwardHistoricalAuditLog":false,"serverAddress":"","port":"","connectionType":""} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SIEMSetting.CreateSIEMSettingRequest" }, "example": {"name":"Splunk SIEM Integration","apiUrl":"https://splunk.example.com:8088/services/collector","token":"***","typeId":1,"statusId":1,"isForwardHistoricalAuditLog":false,"serverAddress":"","port":"","connectionType":""} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SIEMSetting.CreateSIEMSettingRequest" }, "example": {"name":"Splunk SIEM Integration","apiUrl":"https://splunk.example.com:8088/services/collector","token":"***","typeId":1,"statusId":1,"isForwardHistoricalAuditLog":false,"serverAddress":"","port":"","connectionType":""} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/siem-settings/{resourceId}": { "put": { "tags": [ "Company & Settings" ], "summary": "Updates an existing SIEM integration setting's configuration such as endpoint URL, authentication, and event filtering rules.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the SIEM setting to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated SIEM setting details payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SIEMSetting.UpdateSIEMSettingRequest" }, "example": {"name":"Splunk SIEM Integration","apiUrl":"https://splunk.example.com:8088/services/collector","token":"***","typeId":1,"statusId":1,"isForwardHistoricalAuditLog":false,"serverAddress":"","port":"","connectionType":""} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SIEMSetting.UpdateSIEMSettingRequest" }, "example": {"name":"Splunk SIEM Integration","apiUrl":"https://splunk.example.com:8088/services/collector","token":"***","typeId":1,"statusId":1,"isForwardHistoricalAuditLog":false,"serverAddress":"","port":"","connectionType":""} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SIEMSetting.UpdateSIEMSettingRequest" }, "example": {"name":"Splunk SIEM Integration","apiUrl":"https://splunk.example.com:8088/services/collector","token":"***","typeId":1,"statusId":1,"isForwardHistoricalAuditLog":false,"serverAddress":"","port":"","connectionType":""} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SIEMSetting.UpdateSIEMSettingRequest" }, "example": {"name":"Splunk SIEM Integration","apiUrl":"https://splunk.example.com:8088/services/collector","token":"***","typeId":1,"statusId":1,"isForwardHistoricalAuditLog":false,"serverAddress":"","port":"","connectionType":""} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Company & Settings" ], "summary": "Deletes an existing SIEM integration setting, stopping event forwarding to the configured SIEM system.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the SIEM setting to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the details of an existing SIEM integration setting by its resource identifier, including provider type and endpoint configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the SIEM setting.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.SIEMSetting.Dto.SIEMSettingDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/siem-settings/search": { "post": { "tags": [ "Company & Settings" ], "summary": "Searches and retrieves a paginated list of SIEM integration settings for the company with optional filtering and sorting.", "requestBody": { "description": "Search criteria including pagination and optional filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SIEMSetting.Search.SIEMSettingSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SIEMSetting.Search.SIEMSettingSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SIEMSetting.Search.SIEMSettingSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SIEMSetting.Search.SIEMSettingSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.SIEMSetting.Dto.SearchSIEMSettingsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/siem-settings/search/export": { "post": { "tags": [ "Company & Settings" ], "summary": "Exports the filtered list of SIEM integration settings to a downloadable file in the requested format (CSV, Excel, etc.).", "requestBody": { "description": "Export criteria including pagination, filter, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/companies/siem-settings/test": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests a SIEM integration setting by sending a sample event to the configured SIEM endpoint, verifying connectivity and authentication.", "requestBody": { "description": "The SIEM configuration to test including endpoint URL and credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SIEMSetting.TestSIEMSettingRequest" }, "example": {"resourceId":"65BVv1136Vnp","apiUrl":"https://splunk.example.com:8088/services/collector","token":"***","typeId":1} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SIEMSetting.TestSIEMSettingRequest" }, "example": {"resourceId":"65BVv1136Vnp","apiUrl":"https://splunk.example.com:8088/services/collector","token":"***","typeId":1} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SIEMSetting.TestSIEMSettingRequest" }, "example": {"resourceId":"65BVv1136Vnp","apiUrl":"https://splunk.example.com:8088/services/collector","token":"***","typeId":1} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SIEMSetting.TestSIEMSettingRequest" }, "example": {"resourceId":"65BVv1136Vnp","apiUrl":"https://splunk.example.com:8088/services/collector","token":"***","typeId":1} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/smtp-settings": { "post": { "tags": [ "Company & Settings" ], "summary": "Creates a new SMTP setting for the company, configuring an outbound mail server for sending phishing simulation emails.", "requestBody": { "description": "The SMTP setting creation payload including host, port, encryption, and authentication credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.CreateSmtpSettingRequest" }, "example": {"name":"Production SMTP Server","serverAddress":"smtp.example.com","serverPort":"587","userName":"smtp-user@example.com","password":"***","useAuthentication":true,"useSSL":true,"hasSMTPRelay":false,"replyTo":"noreply@example.com","errorTo":"postmaster@example.com","cc":"","bcc":"","customHeader":"","statusId":1,"availableForRequests":[{"type":"Company","resourceId":"65BVv1136Vnp"}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.CreateSmtpSettingRequest" }, "example": {"name":"Production SMTP Server","serverAddress":"smtp.example.com","serverPort":"587","userName":"smtp-user@example.com","password":"***","useAuthentication":true,"useSSL":true,"hasSMTPRelay":false,"replyTo":"noreply@example.com","errorTo":"postmaster@example.com","cc":"","bcc":"","customHeader":"","statusId":1,"availableForRequests":[{"type":"Company","resourceId":"65BVv1136Vnp"}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.CreateSmtpSettingRequest" }, "example": {"name":"Production SMTP Server","serverAddress":"smtp.example.com","serverPort":"587","userName":"smtp-user@example.com","password":"***","useAuthentication":true,"useSSL":true,"hasSMTPRelay":false,"replyTo":"noreply@example.com","errorTo":"postmaster@example.com","cc":"","bcc":"","customHeader":"","statusId":1,"availableForRequests":[{"type":"Company","resourceId":"65BVv1136Vnp"}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.CreateSmtpSettingRequest" }, "example": {"name":"Production SMTP Server","serverAddress":"smtp.example.com","serverPort":"587","userName":"smtp-user@example.com","password":"***","useAuthentication":true,"useSSL":true,"hasSMTPRelay":false,"replyTo":"noreply@example.com","errorTo":"postmaster@example.com","cc":"","bcc":"","customHeader":"","statusId":1,"availableForRequests":[{"type":"Company","resourceId":"65BVv1136Vnp"}]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/companies/smtp-settings/search": { "post": { "tags": [ "Company & Settings" ], "summary": "Searches and retrieves a paginated list of SMTP settings for the company with optional filtering and sorting.", "requestBody": { "description": "Search criteria including pagination and optional filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.Search.SmtpSettingSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.Search.SmtpSettingSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.Search.SmtpSettingSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.Search.SmtpSettingSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.SMTPSetting.Dto.SearchSmtpSettingsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/smtp-settings/{resourceId}": { "put": { "tags": [ "Company & Settings" ], "summary": "Updates an existing SMTP setting's configuration such as host, port, encryption method, and authentication credentials.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the SMTP setting to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated SMTP setting details payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.UpdateSmtpSettingRequest" }, "example": {"name":"Production SMTP Server","serverAddress":"smtp.example.com","serverPort":"587","userName":"smtp-user@example.com","password":"***","useAuthentication":true,"useSSL":true,"hasSMTPRelay":false,"replyTo":"noreply@example.com","errorTo":"postmaster@example.com","cc":"","bcc":"","customHeader":"","statusId":1,"availableForRequests":[{"type":"Company","resourceId":"65BVv1136Vnp"}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.UpdateSmtpSettingRequest" }, "example": {"name":"Production SMTP Server","serverAddress":"smtp.example.com","serverPort":"587","userName":"smtp-user@example.com","password":"***","useAuthentication":true,"useSSL":true,"hasSMTPRelay":false,"replyTo":"noreply@example.com","errorTo":"postmaster@example.com","cc":"","bcc":"","customHeader":"","statusId":1,"availableForRequests":[{"type":"Company","resourceId":"65BVv1136Vnp"}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.UpdateSmtpSettingRequest" }, "example": {"name":"Production SMTP Server","serverAddress":"smtp.example.com","serverPort":"587","userName":"smtp-user@example.com","password":"***","useAuthentication":true,"useSSL":true,"hasSMTPRelay":false,"replyTo":"noreply@example.com","errorTo":"postmaster@example.com","cc":"","bcc":"","customHeader":"","statusId":1,"availableForRequests":[{"type":"Company","resourceId":"65BVv1136Vnp"}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.UpdateSmtpSettingRequest" }, "example": {"name":"Production SMTP Server","serverAddress":"smtp.example.com","serverPort":"587","userName":"smtp-user@example.com","password":"***","useAuthentication":true,"useSSL":true,"hasSMTPRelay":false,"replyTo":"noreply@example.com","errorTo":"postmaster@example.com","cc":"","bcc":"","customHeader":"","statusId":1,"availableForRequests":[{"type":"Company","resourceId":"65BVv1136Vnp"}]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Company & Settings" ], "summary": "Deletes an existing SMTP setting from the company's configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the SMTP setting to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the details of an existing SMTP setting by its resource identifier, including server configuration and encryption method.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the SMTP setting.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.SMTPSetting.Dto.SmtpSettingDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/smtp-settings/search/export": { "post": { "tags": [ "Company & Settings" ], "summary": "Exports the filtered list of SMTP settings to a downloadable file in the requested format (CSV, Excel, etc.).", "requestBody": { "description": "Export criteria including pagination, filter, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/companies/smtp-settings/test": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests the SMTP setting by sending a test email through the configured server, verifying host, port, encryption, and authentication.", "requestBody": { "description": "The SMTP configuration to test, including recipient email for the test message.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.TestSmtpSettingRequest" }, "example": {"serverAddress":"smtp.example.com","port":587,"username":"smtp-user@example.com","password":"***","useAuthentication":true,"useSsl":true,"from":"noreply@example.com","fromName":"Keepnet Security","to":"admin@example.com","message":"This is a test email from Keepnet.","customHeader":"","phishingTypeId":1} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.TestSmtpSettingRequest" }, "example": {"serverAddress":"smtp.example.com","port":587,"username":"smtp-user@example.com","password":"***","useAuthentication":true,"useSsl":true,"from":"noreply@example.com","fromName":"Keepnet Security","to":"admin@example.com","message":"This is a test email from Keepnet.","customHeader":"","phishingTypeId":1} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.TestSmtpSettingRequest" }, "example": {"serverAddress":"smtp.example.com","port":587,"username":"smtp-user@example.com","password":"***","useAuthentication":true,"useSsl":true,"from":"noreply@example.com","fromName":"Keepnet Security","to":"admin@example.com","message":"This is a test email from Keepnet.","customHeader":"","phishingTypeId":1} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.TestSmtpSettingRequest" }, "example": {"serverAddress":"smtp.example.com","port":587,"username":"smtp-user@example.com","password":"***","useAuthentication":true,"useSsl":true,"from":"noreply@example.com","fromName":"Keepnet Security","to":"admin@example.com","message":"This is a test email from Keepnet.","customHeader":"","phishingTypeId":1} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/smtp-settings/{resourceId}/test": { "post": { "tags": [ "Company & Settings" ], "summary": "Tests an existing SMTP setting identified by resource ID by sending a test email, allowing verification of previously saved configurations.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the saved SMTP setting to test.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The test request payload including recipient email for the test message.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.TestSmtpSettingWithResourceIdRequest" }, "example": {"from":"noreply@example.com","fromName":"Keepnet Security","to":"admin@example.com","message":"This is a test email from Keepnet.","phishingTypeId":1} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.TestSmtpSettingWithResourceIdRequest" }, "example": {"from":"noreply@example.com","fromName":"Keepnet Security","to":"admin@example.com","message":"This is a test email from Keepnet.","phishingTypeId":1} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.TestSmtpSettingWithResourceIdRequest" }, "example": {"from":"noreply@example.com","fromName":"Keepnet Security","to":"admin@example.com","message":"This is a test email from Keepnet.","phishingTypeId":1} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SMTPSetting.TestSmtpSettingWithResourceIdRequest" }, "example": {"from":"noreply@example.com","fromName":"Keepnet Security","to":"admin@example.com","message":"This is a test email from Keepnet.","phishingTypeId":1} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/whitelabeling": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves the white labeling configuration for the current user's company, including custom branding, logos, and color schemes.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.WhiteLabeling.Dto.WhiteLabelingDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/whitelabeling/{companyId}": { "get": { "tags": [ "Company & Settings" ], "summary": "Retrieves white labeling configuration by company ID. This endpoint is used internally by the Awareness Educator microservice.", "parameters": [ { "name": "companyId", "in": "path", "description": "The internal numeric identifier of the company.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.WhiteLabeling.Dto.WhiteLabelingDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/whitelabeling/by-url": { "post": { "tags": [ "Company & Settings" ], "summary": "Resolves a company's white labeling configuration by matching the provided URL domain against registered white-label domains. This is an anonymous endpoint for login page branding.", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "DomainUrl": { "type": "string", "description": "Custom domain URL used to look up the corresponding white-labeling configuration." } } }, "example": { "DomainUrl": "https://security.example.com" }, "encoding": { "DomainUrl": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.WhiteLabeling.Dto.WhiteLabelingByDomainDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/whitelabeling/{resourceId}": { "put": { "tags": [ "Company & Settings" ], "summary": "Updates the white labeling configuration for the company, allowing customization of logos, colors, favicon, and custom domain settings.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the white labeling record to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "FooterCookiePolicyUrl", "FooterEulaUrl", "FooterPrivacyPolicyUrl", "FooterTermsAndConditionsUrl" ], "type": "object", "properties": { "BrandName": { "type": "string", "description": "Custom brand name displayed throughout the platform." }, "MainDomainProtocol": { "type": "string", "description": "Protocol scheme for the main custom domain (e.g., \"https\")." }, "MainDomainUrl": { "type": "string", "description": "Custom domain URL for the white-labeled platform." }, "MainLogoUrl": { "type": "string", "description": "URL of the currently stored main logo image." }, "MainLogoFile": { "type": "string", "description": "Uploaded file to replace the main logo image.", "format": "binary" }, "MinimizedMenuLogoUrl": { "type": "string", "description": "URL of the currently stored minimized (collapsed) menu logo." }, "MinimizedMenuLogoFile": { "type": "string", "description": "Uploaded file to replace the minimized menu logo.", "format": "binary" }, "FaviconUrl": { "type": "string", "description": "URL of the currently stored favicon." }, "FaviconFile": { "type": "string", "description": "Uploaded file to replace the favicon.", "format": "binary" }, "EmailTemplateLogoUrl": { "type": "string", "description": "URL of the logo used in outgoing email templates." }, "EmailTemplateLogoFile": { "type": "string", "description": "Uploaded file to replace the email template logo.", "format": "binary" }, "SupportEmailAddress": { "type": "string", "description": "Support email address displayed to end users." }, "FooterPrivacyPolicyUrl": { "type": "string", "description": "URL to the privacy policy page shown in the platform footer." }, "FooterTermsAndConditionsUrl": { "type": "string", "description": "URL to the terms and conditions page shown in the platform footer." }, "FooterEulaUrl": { "type": "string", "description": "URL to the End User License Agreement page shown in the platform footer." }, "FooterCookiePolicyUrl": { "type": "string", "description": "URL to the cookie policy page shown in the platform footer." }, "IsShowReleaseVersionNumber": { "type": "boolean", "description": "Whether to display the application release version number in the UI." }, "IsShowReleaseNotes": { "type": "boolean", "description": "Whether to display release notes link in the UI." }, "ReleaseNotesUrl": { "type": "string", "description": "URL pointing to the release notes page." }, "IsDocumentationLinkEnabled": { "type": "boolean", "description": "Whether the documentation link is visible to users." }, "AcceptDnsRecordSettings": { "type": "boolean", "description": "Whether the user has accepted the DNS record settings required for white-labeling." } } }, "example": { "BrandName": "Acme Security Platform", "MainDomainProtocol": "https", "MainDomainUrl": "security.acmecorp.com", "MainLogoUrl": "https://cdn.acmecorp.com/logos/main-logo.png", "MinimizedMenuLogoUrl": "https://cdn.acmecorp.com/logos/icon-logo.png", "FaviconUrl": "https://cdn.acmecorp.com/logos/favicon.ico", "EmailTemplateLogoUrl": "https://cdn.acmecorp.com/logos/email-logo.png", "SupportEmailAddress": "support@acmecorp.com", "FooterPrivacyPolicyUrl": "https://www.acmecorp.com/privacy-policy", "FooterTermsAndConditionsUrl": "https://www.acmecorp.com/terms-and-conditions", "FooterEulaUrl": "https://www.acmecorp.com/eula", "FooterCookiePolicyUrl": "https://www.acmecorp.com/cookie-policy", "IsShowReleaseVersionNumber": false, "IsShowReleaseNotes": false, "ReleaseNotesUrl": "https://www.acmecorp.com/release-notes", "IsDocumentationLinkEnabled": true, "AcceptDnsRecordSettings": true }, "encoding": { "BrandName": { "style": "form" }, "MainDomainProtocol": { "style": "form" }, "MainDomainUrl": { "style": "form" }, "MainLogoUrl": { "style": "form" }, "MainLogoFile": { "style": "form" }, "MinimizedMenuLogoUrl": { "style": "form" }, "MinimizedMenuLogoFile": { "style": "form" }, "FaviconUrl": { "style": "form" }, "FaviconFile": { "style": "form" }, "EmailTemplateLogoUrl": { "style": "form" }, "EmailTemplateLogoFile": { "style": "form" }, "SupportEmailAddress": { "style": "form" }, "FooterPrivacyPolicyUrl": { "style": "form" }, "FooterTermsAndConditionsUrl": { "style": "form" }, "FooterEulaUrl": { "style": "form" }, "FooterCookiePolicyUrl": { "style": "form" }, "IsShowReleaseVersionNumber": { "style": "form" }, "IsShowReleaseNotes": { "style": "form" }, "ReleaseNotesUrl": { "style": "form" }, "IsDocumentationLinkEnabled": { "style": "form" }, "AcceptDnsRecordSettings": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Company & Settings" ], "summary": "Deletes the white labeling configuration, reverting the company's branding back to platform defaults.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the white labeling record to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/whitelabeling/resolve-whitelabeling": { "get": { "tags": [ "Company & Settings" ], "summary": "Resolves the effective white labeling for the current company by traversing the company hierarchy to find the nearest configured branding.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.WhiteLabeling.Dto.WhiteLabelingDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/whitelabeling/check-dns": { "post": { "tags": [ "Company & Settings" ], "summary": "Validates whether a DNS CNAME record is correctly configured for the company's custom white-label domain.", "requestBody": { "description": "The request containing the domain name to verify.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.WhiteLabeling.CheckDNSRequest" }, "example": {"mainDomainUrl":"security.acmecorp.com"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.WhiteLabeling.CheckDNSRequest" }, "example": {"mainDomainUrl":"security.acmecorp.com"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.WhiteLabeling.CheckDNSRequest" }, "example": {"mainDomainUrl":"security.acmecorp.com"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.WhiteLabeling.CheckDNSRequest" }, "example": {"mainDomainUrl":"security.acmecorp.com"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/regions": { "get": { "tags": [ "Company & Settings" ], "summary": "Returns the list of regions that are active AND have a provisioned\r\nregional database (filtered by IsActive=true AND HasActiveDatabase=true).\r\nSorted by SortOrder. Root-only.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.Region.Dto.RegionDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/companies/{companyResourceId}/sovereignty/migrate": { "post": { "tags": [ "Company & Settings" ], "summary": "Queues a central -> regional TargetUser migration job for the specified company.\r\nReturns the job's ResourceId, which can be used to poll job status (M8).\r\nRoot-only.", "parameters": [ { "name": "companyResourceId", "in": "path", "description": "The company's unique resource identifier (route).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The migration request payload (TargetRegionCode, BatchSize).", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.MigrateCompanyRegionRequest" }, "example": {"targetRegionCode":"canadacentral","batchSize":1000} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.MigrateCompanyRegionRequest" }, "example": {"targetRegionCode":"canadacentral","batchSize":1000} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.MigrateCompanyRegionRequest" }, "example": {"targetRegionCode":"canadacentral","batchSize":1000} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.MigrateCompanyRegionRequest" }, "example": {"targetRegionCode":"canadacentral","batchSize":1000} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/{companyResourceId}/sovereignty/reverse-migrate": { "post": { "tags": [ "Company & Settings" ], "summary": "Queues a REVERSE (regional -> central) TargetUser migration job for the specified company,\r\nbringing its PII back to the central database and clearing its RegionCode. Returns the\r\njob's ResourceId. Root-only. The company must currently have a RegionCode.", "parameters": [ { "name": "companyResourceId", "in": "path", "description": "The company's unique resource identifier (route).", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The reverse migration request payload (BatchSize).", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.ReverseMigrateCompanyRegionRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.ReverseMigrateCompanyRegionRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.ReverseMigrateCompanyRegionRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Company.ReverseMigrateCompanyRegionRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/{companyResourceId}/sovereignty/pii-residency-report": { "get": { "tags": [ "Company & Settings" ], "summary": "Generates a PII residency report for the specified company.\r\nWalks central + every active regional DB and reports whether the\r\ncompany's TargetUser PII is confined to its declared region.\r\nRoot-only.", "parameters": [ { "name": "companyResourceId", "in": "path", "description": "The company's unique resource identifier (route).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.DataSovereignty.PiiResidency.Dto.PiiResidencyReportServiceResult, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/agent/notified-emails/{resourceId}": { "get": { "tags": [ "Incident Response" ], "summary": "Retrieves the full details of a reported email for the Agentic AI agent.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the notified email.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.NotifiedEmail.Dto.NotifiedEmailDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/analysis-engines": { "post": { "tags": [ "Incident Response" ], "summary": "Creates a new analysis engine integration for scanning reported emails against threat intelligence providers.", "requestBody": { "description": "The analysis engine configuration including provider type, API credentials, and scanning preferences.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.CreateAnalysisEngineRequest" }, "example": {"analysisEngineTypeResourceId":"65BVv1136Vnp","name":"VirusTotal Integration","description":"Primary VirusTotal analysis engine for URL and hash scanning","apiUrl":"https://www.virustotal.com/api/v3","tags":["url-scan","hash-scan","primary"],"isActive":true,"isSendUrl":true,"isSendIp":true,"isHideUrlParameter":false,"isSendFileHash":true,"isUploadExecutableFile":true,"isUploadOtherFileType":false,"proxyResourceId":"","uploadFileTypes":[".exe",".dll",".pdf",".docx"],"apiCredentials":[{"apiKey":"vt_api_key_placeholder","userName":"","password":"","resourceId":"Kx9Rm3nQ7wLp"}],"isCachingEnabled":true,"cacheDuration":60,"cacheQueryCount":1000,"detectionThreshold":3} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.CreateAnalysisEngineRequest" }, "example": {"analysisEngineTypeResourceId":"65BVv1136Vnp","name":"VirusTotal Integration","description":"Primary VirusTotal analysis engine for URL and hash scanning","apiUrl":"https://www.virustotal.com/api/v3","tags":["url-scan","hash-scan","primary"],"isActive":true,"isSendUrl":true,"isSendIp":true,"isHideUrlParameter":false,"isSendFileHash":true,"isUploadExecutableFile":true,"isUploadOtherFileType":false,"proxyResourceId":"","uploadFileTypes":[".exe",".dll",".pdf",".docx"],"apiCredentials":[{"apiKey":"vt_api_key_placeholder","userName":"","password":"","resourceId":"Kx9Rm3nQ7wLp"}],"isCachingEnabled":true,"cacheDuration":60,"cacheQueryCount":1000,"detectionThreshold":3} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.CreateAnalysisEngineRequest" }, "example": {"analysisEngineTypeResourceId":"65BVv1136Vnp","name":"VirusTotal Integration","description":"Primary VirusTotal analysis engine for URL and hash scanning","apiUrl":"https://www.virustotal.com/api/v3","tags":["url-scan","hash-scan","primary"],"isActive":true,"isSendUrl":true,"isSendIp":true,"isHideUrlParameter":false,"isSendFileHash":true,"isUploadExecutableFile":true,"isUploadOtherFileType":false,"proxyResourceId":"","uploadFileTypes":[".exe",".dll",".pdf",".docx"],"apiCredentials":[{"apiKey":"vt_api_key_placeholder","userName":"","password":"","resourceId":"Kx9Rm3nQ7wLp"}],"isCachingEnabled":true,"cacheDuration":60,"cacheQueryCount":1000,"detectionThreshold":3} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.CreateAnalysisEngineRequest" }, "example": {"analysisEngineTypeResourceId":"65BVv1136Vnp","name":"VirusTotal Integration","description":"Primary VirusTotal analysis engine for URL and hash scanning","apiUrl":"https://www.virustotal.com/api/v3","tags":["url-scan","hash-scan","primary"],"isActive":true,"isSendUrl":true,"isSendIp":true,"isHideUrlParameter":false,"isSendFileHash":true,"isUploadExecutableFile":true,"isUploadOtherFileType":false,"proxyResourceId":"","uploadFileTypes":[".exe",".dll",".pdf",".docx"],"apiCredentials":[{"apiKey":"vt_api_key_placeholder","userName":"","password":"","resourceId":"Kx9Rm3nQ7wLp"}],"isCachingEnabled":true,"cacheDuration":60,"cacheQueryCount":1000,"detectionThreshold":3} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Incident Response" ], "summary": "Returns all analysis engine integrations configured for the current company, including their status and provider details.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.AnalysisEngine.Dto.AnalysisEngineDetailDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/analysis-engines/{resourceId}": { "put": { "tags": [ "Incident Response" ], "summary": "Updates the configuration of an existing analysis engine, such as API keys, scanning options, or priority settings.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the analysis engine to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated analysis engine configuration fields.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.UpdateAnalysisEngineRequest" }, "example": {"resourceId":"Ht4Wn8kL2mXq","analysisEngineTypeResourceId":"65BVv1136Vnp","name":"VirusTotal Integration (Updated)","description":"Updated VirusTotal integration with extended file type support","apiUrl":"https://www.virustotal.com/api/v3","tags":["url-scan","hash-scan","file-upload"],"isActive":true,"isSendUrl":true,"isSendIp":true,"isHideUrlParameter":true,"isSendFileHash":true,"isUploadExecutableFile":true,"isUploadOtherFileType":true,"proxyResourceId":"Pq7Jm2xR5nKw","uploadFileTypes":[".exe",".dll",".pdf",".docx",".xlsx"],"apiCredentials":[{"apiKey":"vt_api_key_updated","userName":"","password":"","resourceId":"Kx9Rm3nQ7wLp"}],"isCachingEnabled":true,"cacheDuration":120,"cacheQueryCount":5000,"detectionThreshold":5} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.UpdateAnalysisEngineRequest" }, "example": {"resourceId":"Ht4Wn8kL2mXq","analysisEngineTypeResourceId":"65BVv1136Vnp","name":"VirusTotal Integration (Updated)","description":"Updated VirusTotal integration with extended file type support","apiUrl":"https://www.virustotal.com/api/v3","tags":["url-scan","hash-scan","file-upload"],"isActive":true,"isSendUrl":true,"isSendIp":true,"isHideUrlParameter":true,"isSendFileHash":true,"isUploadExecutableFile":true,"isUploadOtherFileType":true,"proxyResourceId":"Pq7Jm2xR5nKw","uploadFileTypes":[".exe",".dll",".pdf",".docx",".xlsx"],"apiCredentials":[{"apiKey":"vt_api_key_updated","userName":"","password":"","resourceId":"Kx9Rm3nQ7wLp"}],"isCachingEnabled":true,"cacheDuration":120,"cacheQueryCount":5000,"detectionThreshold":5} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.UpdateAnalysisEngineRequest" }, "example": {"resourceId":"Ht4Wn8kL2mXq","analysisEngineTypeResourceId":"65BVv1136Vnp","name":"VirusTotal Integration (Updated)","description":"Updated VirusTotal integration with extended file type support","apiUrl":"https://www.virustotal.com/api/v3","tags":["url-scan","hash-scan","file-upload"],"isActive":true,"isSendUrl":true,"isSendIp":true,"isHideUrlParameter":true,"isSendFileHash":true,"isUploadExecutableFile":true,"isUploadOtherFileType":true,"proxyResourceId":"Pq7Jm2xR5nKw","uploadFileTypes":[".exe",".dll",".pdf",".docx",".xlsx"],"apiCredentials":[{"apiKey":"vt_api_key_updated","userName":"","password":"","resourceId":"Kx9Rm3nQ7wLp"}],"isCachingEnabled":true,"cacheDuration":120,"cacheQueryCount":5000,"detectionThreshold":5} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.UpdateAnalysisEngineRequest" }, "example": {"resourceId":"Ht4Wn8kL2mXq","analysisEngineTypeResourceId":"65BVv1136Vnp","name":"VirusTotal Integration (Updated)","description":"Updated VirusTotal integration with extended file type support","apiUrl":"https://www.virustotal.com/api/v3","tags":["url-scan","hash-scan","file-upload"],"isActive":true,"isSendUrl":true,"isSendIp":true,"isHideUrlParameter":true,"isSendFileHash":true,"isUploadExecutableFile":true,"isUploadOtherFileType":true,"proxyResourceId":"Pq7Jm2xR5nKw","uploadFileTypes":[".exe",".dll",".pdf",".docx",".xlsx"],"apiCredentials":[{"apiKey":"vt_api_key_updated","userName":"","password":"","resourceId":"Kx9Rm3nQ7wLp"}],"isCachingEnabled":true,"cacheDuration":120,"cacheQueryCount":5000,"detectionThreshold":5} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Incident Response" ], "summary": "Retrieves the full configuration details of a specific analysis engine by its resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the analysis engine.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.AnalysisEngine.Dto.AnalysisEngineDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Incident Response" ], "summary": "Permanently deletes an analysis engine integration and removes it from incident response workflows.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the analysis engine to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/analysis-engines/form-details": { "get": { "tags": [ "Incident Response" ], "summary": "Retrieves the form metadata needed to render the analysis engine create/edit form, including available provider types and configuration fields.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.AnalysisEngine.Dto.AnalysisEngineFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/analysis-engines/search": { "post": { "tags": [ "Incident Response" ], "summary": "Searches and returns a paginated list of analysis engines configured for the current company, with optional filtering and sorting.", "requestBody": { "description": "Pagination, sorting, and filter criteria for the analysis engine search.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.AnalysisEngineSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.AnalysisEngineSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.AnalysisEngineSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.AnalysisEngineSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.AnalysisEngine.Search.AnalysisEngineSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/analysis-engines/search/export": { "post": { "tags": [ "Incident Response" ], "summary": "Exports the analysis engine list as a downloadable file in the specified format (e.g., CSV, Excel).", "requestBody": { "description": "Export parameters including format, pagination, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult" } } } } } } }, "/api/analysis-engines/{resourceId}/disable": { "put": { "tags": [ "Incident Response" ], "summary": "Disables an analysis engine, preventing it from being used in email threat scanning without deleting its configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the analysis engine to disable.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/analysis-engines/{resourceId}/enable": { "put": { "tags": [ "Incident Response" ], "summary": "Re-enables a previously disabled analysis engine so it can participate in email threat scanning again.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the analysis engine to enable.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/analysis-engines-types/{resourceId}/test-connection": { "put": { "tags": [ "Incident Response" ], "summary": "Tests the connectivity and authentication of an analysis engine by making a probe request to the configured provider endpoint.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the analysis engine type to test.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The analysis engine test parameters including provider type and credentials.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.TestAnalysisEngineRequest" }, "example": {"apiUrl":"https://www.virustotal.com/api/v3","apiCredential":{"apiKey":"vt_api_key_placeholder","userName":"","password":"","resourceId":"Kx9Rm3nQ7wLp"},"proxyResourceId":""} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.TestAnalysisEngineRequest" }, "example": {"apiUrl":"https://www.virustotal.com/api/v3","apiCredential":{"apiKey":"vt_api_key_placeholder","userName":"","password":"","resourceId":"Kx9Rm3nQ7wLp"},"proxyResourceId":""} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.TestAnalysisEngineRequest" }, "example": {"apiUrl":"https://www.virustotal.com/api/v3","apiCredential":{"apiKey":"vt_api_key_placeholder","userName":"","password":"","resourceId":"Kx9Rm3nQ7wLp"},"proxyResourceId":""} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.TestAnalysisEngineRequest" }, "example": {"apiUrl":"https://www.virustotal.com/api/v3","apiCredential":{"apiKey":"vt_api_key_placeholder","userName":"","password":"","resourceId":"Kx9Rm3nQ7wLp"},"proxyResourceId":""} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/analysis-engines/analysis-exclusions": { "get": { "tags": [ "Incident Response" ], "summary": "Retrieves the analysis exclusion rules that define which domains, senders, or patterns should be skipped during email analysis.", "parameters": [ { "name": "type", "in": "query", "description": "Optional exclusion type filter to retrieve only a specific category of exclusions.", "schema": { "$ref": "#/components/schemas/KeepnetLabs.Domain.Entities.AnalysisEngine.AnalysisExclusionType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.AnalysisEngine.Dto.AnalysisExclusionDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "put": { "tags": [ "Incident Response" ], "summary": "Updates the analysis exclusion rules that control which domains, senders, or patterns are skipped during email threat analysis.", "requestBody": { "description": "The updated exclusion rules including domains, senders, or patterns to exclude.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.UpdateAnalysisExclusionsRequest" }, "example": {"exclusionItems":[{"value":"192.168.1.0/24","exclusionType":"IP","isEditable":true},{"value":"https://trusted-domain.com","exclusionType":"URL","isEditable":true},{"value":".png","exclusionType":"AttacmentExtension","attachmentExtensionType":"Image","isEditable":false}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.UpdateAnalysisExclusionsRequest" }, "example": {"exclusionItems":[{"value":"192.168.1.0/24","exclusionType":"IP","isEditable":true},{"value":"https://trusted-domain.com","exclusionType":"URL","isEditable":true},{"value":".png","exclusionType":"AttacmentExtension","attachmentExtensionType":"Image","isEditable":false}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.UpdateAnalysisExclusionsRequest" }, "example": {"exclusionItems":[{"value":"192.168.1.0/24","exclusionType":"IP","isEditable":true},{"value":"https://trusted-domain.com","exclusionType":"URL","isEditable":true},{"value":".png","exclusionType":"AttacmentExtension","attachmentExtensionType":"Image","isEditable":false}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.AnalysisEngine.UpdateAnalysisExclusionsRequest" }, "example": {"exclusionItems":[{"value":"192.168.1.0/24","exclusionType":"IP","isEditable":true},{"value":"https://trusted-domain.com","exclusionType":"URL","isEditable":true},{"value":".png","exclusionType":"AttacmentExtension","attachmentExtensionType":"Image","isEditable":false}]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/investigations/{resourceId}/actions-delete": { "post": { "tags": [ "Incident Response" ], "summary": "Creates a delete action for an investigation, which removes the identified malicious emails from user mailboxes via the mail provider.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the investigation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The delete action parameters including target email identifiers and scope.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationDeleteActionRequest" }, "example": {"isPermanentDelete":false,"items":["Rn5Kp8mQ3wLx"],"selectAll":false,"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationDeleteActionRequest" }, "example": {"isPermanentDelete":false,"items":["Rn5Kp8mQ3wLx"],"selectAll":false,"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationDeleteActionRequest" }, "example": {"isPermanentDelete":false,"items":["Rn5Kp8mQ3wLx"],"selectAll":false,"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationDeleteActionRequest" }, "example": {"isPermanentDelete":false,"items":["Rn5Kp8mQ3wLx"],"selectAll":false,"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/investigations/{resourceId}/actions-warning": { "post": { "tags": [ "Incident Response" ], "summary": "Creates a warning action for an investigation, which sends notification emails to affected users alerting them about the identified threat.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the investigation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The warning action parameters including notification template and target users.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationWarningActionRequest" }, "example": {"warningMessage":"The security team has identified a suspicious email in your mailbox. Please do not click any links or open attachments.","items":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc","Km7Wx4pL8nRt"],"selectAll":false,"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationWarningActionRequest" }, "example": {"warningMessage":"The security team has identified a suspicious email in your mailbox. Please do not click any links or open attachments.","items":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc","Km7Wx4pL8nRt"],"selectAll":false,"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationWarningActionRequest" }, "example": {"warningMessage":"The security team has identified a suspicious email in your mailbox. Please do not click any links or open attachments.","items":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc","Km7Wx4pL8nRt"],"selectAll":false,"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationWarningActionRequest" }, "example": {"warningMessage":"The security team has identified a suspicious email in your mailbox. Please do not click any links or open attachments.","items":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc","Km7Wx4pL8nRt"],"selectAll":false,"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/investigations/{resourceId}/actions-delete-and-notify": { "post": { "tags": [ "Incident Response" ], "summary": "Creates a combined delete-and-notify action for an investigation, which removes malicious emails and sends warning notifications to affected users simultaneously.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the investigation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The combined action parameters including delete scope and notification template.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationDeleteAndNotifyActionRequest" }, "example": {"warningMessage":"A malicious email has been removed from your mailbox. Please do not interact with similar messages.","isPermanentDelete":true,"items":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc"],"selectAll":false,"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationDeleteAndNotifyActionRequest" }, "example": {"warningMessage":"A malicious email has been removed from your mailbox. Please do not interact with similar messages.","isPermanentDelete":true,"items":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc"],"selectAll":false,"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationDeleteAndNotifyActionRequest" }, "example": {"warningMessage":"A malicious email has been removed from your mailbox. Please do not interact with similar messages.","isPermanentDelete":true,"items":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc"],"selectAll":false,"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationDeleteAndNotifyActionRequest" }, "example": {"warningMessage":"A malicious email has been removed from your mailbox. Please do not interact with similar messages.","isPermanentDelete":true,"items":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc"],"selectAll":false,"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/investigations/actions-warning": { "put": { "tags": [ "Incident Response" ], "summary": "Updates the execution status of an investigation warning action, tracking whether notifications were successfully delivered.", "requestBody": { "description": "The updated action status including completion state and any error details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.UpdateInvestigationActionStatusRequest" }, "example": {"email":"john.doe@acme.com","items":[{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG93AAA=","status":"Completed","errorMsg":"","newEmailId":""},{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG94BBB=","status":"CompletedWithError","errorMsg":"Mailbox not accessible","newEmailId":""}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.UpdateInvestigationActionStatusRequest" }, "example": {"email":"john.doe@acme.com","items":[{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG93AAA=","status":"Completed","errorMsg":"","newEmailId":""},{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG94BBB=","status":"CompletedWithError","errorMsg":"Mailbox not accessible","newEmailId":""}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.UpdateInvestigationActionStatusRequest" }, "example": {"email":"john.doe@acme.com","items":[{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG93AAA=","status":"Completed","errorMsg":"","newEmailId":""},{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG94BBB=","status":"CompletedWithError","errorMsg":"Mailbox not accessible","newEmailId":""}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.UpdateInvestigationActionStatusRequest" }, "example": {"email":"john.doe@acme.com","items":[{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG93AAA=","status":"Completed","errorMsg":"","newEmailId":""},{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG94BBB=","status":"CompletedWithError","errorMsg":"Mailbox not accessible","newEmailId":""}]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/investigations/actions-delete": { "put": { "tags": [ "Incident Response" ], "summary": "Updates the execution status of an investigation delete action, tracking whether the malicious emails were successfully removed from mailboxes.", "requestBody": { "description": "The updated action status including completion state and any error details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.UpdateInvestigationActionStatusRequest" }, "example": {"email":"john.doe@acme.com","items":[{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG93AAA=","status":"Completed","errorMsg":"","newEmailId":""},{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG94BBB=","status":"CompletedWithError","errorMsg":"Mailbox not accessible","newEmailId":""}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.UpdateInvestigationActionStatusRequest" }, "example": {"email":"john.doe@acme.com","items":[{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG93AAA=","status":"Completed","errorMsg":"","newEmailId":""},{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG94BBB=","status":"CompletedWithError","errorMsg":"Mailbox not accessible","newEmailId":""}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.UpdateInvestigationActionStatusRequest" }, "example": {"email":"john.doe@acme.com","items":[{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG93AAA=","status":"Completed","errorMsg":"","newEmailId":""},{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG94BBB=","status":"CompletedWithError","errorMsg":"Mailbox not accessible","newEmailId":""}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.UpdateInvestigationActionStatusRequest" }, "example": {"email":"john.doe@acme.com","items":[{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG93AAA=","status":"Completed","errorMsg":"","newEmailId":""},{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG94BBB=","status":"CompletedWithError","errorMsg":"Mailbox not accessible","newEmailId":""}]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/investigations/actions-delete-and-notify": { "put": { "tags": [ "Incident Response" ], "summary": "Updates the execution status of an investigation delete-and-notify action, tracking email removal and notification delivery progress.", "requestBody": { "description": "The updated action status including completion state and any error details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.UpdateInvestigationActionStatusRequest" }, "example": {"email":"john.doe@acme.com","items":[{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG93AAA=","status":"Completed","errorMsg":"","newEmailId":""},{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG94BBB=","status":"CompletedWithError","errorMsg":"Mailbox not accessible","newEmailId":""}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.UpdateInvestigationActionStatusRequest" }, "example": {"email":"john.doe@acme.com","items":[{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG93AAA=","status":"Completed","errorMsg":"","newEmailId":""},{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG94BBB=","status":"CompletedWithError","errorMsg":"Mailbox not accessible","newEmailId":""}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.UpdateInvestigationActionStatusRequest" }, "example": {"email":"john.doe@acme.com","items":[{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG93AAA=","status":"Completed","errorMsg":"","newEmailId":""},{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG94BBB=","status":"CompletedWithError","errorMsg":"Mailbox not accessible","newEmailId":""}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.UpdateInvestigationActionStatusRequest" }, "example": {"email":"john.doe@acme.com","items":[{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG93AAA=","status":"Completed","errorMsg":"","newEmailId":""},{"investigationId":"Ht4Wn8kL2mXq","mailId":"AAMkAGI2TG94BBB=","status":"CompletedWithError","errorMsg":"Mailbox not accessible","newEmailId":""}]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/investigations": { "post": { "tags": [ "Incident Response" ], "summary": "Creates a new email threat investigation to scan and analyze reported emails across configured analysis engines.", "requestBody": { "description": "The investigation parameters including target emails, scan types, and analysis engine selections.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationRequest" }, "example": {"headers":[{"ip":"","from":"attacker@malicious-domain.com","to":"","cc":"","bcc":"","subject":"Urgent: Verify your account","senderName":""}],"bodies":[{"url":"https://malicious-domain.com/login","keyword":"","regex":""}],"attachments":[{"name":"","md5":"","sha512":"","extension":".exe"}],"logicalOperator":0,"name":"Phishing Campaign Investigation Q1","duration":24,"startDate":"2026-03-01 00:00:00","endDate":"2026-03-10 23:59:59","targetUserType":"SpecificUsers","targetUsers":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc"],"isScanEnterpriseVault":false,"scanTypes":[{"type":"O365","mailConfigurationResourceId":"Mp4Lw7nR2xKq"}],"investigationType":"Manual","autoAction":{"type":"NoAction","isPermanentDelete":false,"warningMessage":""},"scannedUsersCount":0,"completedUsersCount":0,"progress":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationRequest" }, "example": {"headers":[{"ip":"","from":"attacker@malicious-domain.com","to":"","cc":"","bcc":"","subject":"Urgent: Verify your account","senderName":""}],"bodies":[{"url":"https://malicious-domain.com/login","keyword":"","regex":""}],"attachments":[{"name":"","md5":"","sha512":"","extension":".exe"}],"logicalOperator":0,"name":"Phishing Campaign Investigation Q1","duration":24,"startDate":"2026-03-01 00:00:00","endDate":"2026-03-10 23:59:59","targetUserType":"SpecificUsers","targetUsers":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc"],"isScanEnterpriseVault":false,"scanTypes":[{"type":"O365","mailConfigurationResourceId":"Mp4Lw7nR2xKq"}],"investigationType":"Manual","autoAction":{"type":"NoAction","isPermanentDelete":false,"warningMessage":""},"scannedUsersCount":0,"completedUsersCount":0,"progress":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationRequest" }, "example": {"headers":[{"ip":"","from":"attacker@malicious-domain.com","to":"","cc":"","bcc":"","subject":"Urgent: Verify your account","senderName":""}],"bodies":[{"url":"https://malicious-domain.com/login","keyword":"","regex":""}],"attachments":[{"name":"","md5":"","sha512":"","extension":".exe"}],"logicalOperator":0,"name":"Phishing Campaign Investigation Q1","duration":24,"startDate":"2026-03-01 00:00:00","endDate":"2026-03-10 23:59:59","targetUserType":"SpecificUsers","targetUsers":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc"],"isScanEnterpriseVault":false,"scanTypes":[{"type":"O365","mailConfigurationResourceId":"Mp4Lw7nR2xKq"}],"investigationType":"Manual","autoAction":{"type":"NoAction","isPermanentDelete":false,"warningMessage":""},"scannedUsersCount":0,"completedUsersCount":0,"progress":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationRequest" }, "example": {"headers":[{"ip":"","from":"attacker@malicious-domain.com","to":"","cc":"","bcc":"","subject":"Urgent: Verify your account","senderName":""}],"bodies":[{"url":"https://malicious-domain.com/login","keyword":"","regex":""}],"attachments":[{"name":"","md5":"","sha512":"","extension":".exe"}],"logicalOperator":0,"name":"Phishing Campaign Investigation Q1","duration":24,"startDate":"2026-03-01 00:00:00","endDate":"2026-03-10 23:59:59","targetUserType":"SpecificUsers","targetUsers":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc"],"isScanEnterpriseVault":false,"scanTypes":[{"type":"O365","mailConfigurationResourceId":"Mp4Lw7nR2xKq"}],"investigationType":"Manual","autoAction":{"type":"NoAction","isPermanentDelete":false,"warningMessage":""},"scannedUsersCount":0,"completedUsersCount":0,"progress":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/investigations/{resourceId}": { "get": { "tags": [ "Incident Response" ], "summary": "Retrieves the full details of an existing investigation, including its status, scan results, and associated emails.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the investigation.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Investigation.Dto.InvestigationDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/investigations/{resourceId}/user": { "post": { "tags": [ "Incident Response" ], "summary": "Adds a user (analyst) to an existing investigation, granting them access to participate in the threat analysis workflow.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the investigation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The user details to add to the investigation.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationUserRequest" }, "example": {"investigationId":"Ht4Wn8kL2mXq","investigationScanTypeId":"Jx6Rp3nQ9wLm","email":"john.doe@acme.com","totalMailCount":1250,"filteredMailCount":3} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationUserRequest" }, "example": {"investigationId":"Ht4Wn8kL2mXq","investigationScanTypeId":"Jx6Rp3nQ9wLm","email":"john.doe@acme.com","totalMailCount":1250,"filteredMailCount":3} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationUserRequest" }, "example": {"investigationId":"Ht4Wn8kL2mXq","investigationScanTypeId":"Jx6Rp3nQ9wLm","email":"john.doe@acme.com","totalMailCount":1250,"filteredMailCount":3} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationUserRequest" }, "example": {"investigationId":"Ht4Wn8kL2mXq","investigationScanTypeId":"Jx6Rp3nQ9wLm","email":"john.doe@acme.com","totalMailCount":1250,"filteredMailCount":3} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "put": { "tags": [ "Incident Response" ], "summary": "Marks a user's participation in an investigation as finished, recording their individual analysis completion status.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the investigation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The finish details including the user's analysis outcome.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.FinishUserInvestigationRequest" }, "example": {"investigationId":"Ht4Wn8kL2mXq","investigationScanTypeId":"Jx6Rp3nQ9wLm","email":"john.doe@acme.com","scanResultMessage":"Scan completed successfully. 3 matching emails found out of 1250 total."} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.FinishUserInvestigationRequest" }, "example": {"investigationId":"Ht4Wn8kL2mXq","investigationScanTypeId":"Jx6Rp3nQ9wLm","email":"john.doe@acme.com","scanResultMessage":"Scan completed successfully. 3 matching emails found out of 1250 total."} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.FinishUserInvestigationRequest" }, "example": {"investigationId":"Ht4Wn8kL2mXq","investigationScanTypeId":"Jx6Rp3nQ9wLm","email":"john.doe@acme.com","scanResultMessage":"Scan completed successfully. 3 matching emails found out of 1250 total."} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.FinishUserInvestigationRequest" }, "example": {"investigationId":"Ht4Wn8kL2mXq","investigationScanTypeId":"Jx6Rp3nQ9wLm","email":"john.doe@acme.com","scanResultMessage":"Scan completed successfully. 3 matching emails found out of 1250 total."} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/investigations/{resourceId}/result": { "post": { "tags": [ "Incident Response" ], "summary": "Records the final result of an investigation, capturing the analyst's verdict and any remediation actions taken.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the investigation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The investigation result details including verdict and notes.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationResultRequest" }, "example": {"investigationId":"Ht4Wn8kL2mXq","investigationScanTypeId":"Jx6Rp3nQ9wLm","email":"john.doe@acme.com","mailId":"AAMkAGI2TG93AAA=","folderName":"Inbox","folderType":"Inbox","senderIp":"198.51.100.42","from":"attacker@malicious-domain.com","senderName":"IT Support","recipients":[{"email":"john.doe@acme.com","recipientType":"To"},{"email":"security-team@acme.com","recipientType":"Cc"}],"subject":"Urgent: Verify your account credentials","attachmentCount":1,"receivedTime":"2026-03-05 14:30:00","investigationFilterTagList":["HeaderFrom","HeaderSubject","BodyUrl"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationResultRequest" }, "example": {"investigationId":"Ht4Wn8kL2mXq","investigationScanTypeId":"Jx6Rp3nQ9wLm","email":"john.doe@acme.com","mailId":"AAMkAGI2TG93AAA=","folderName":"Inbox","folderType":"Inbox","senderIp":"198.51.100.42","from":"attacker@malicious-domain.com","senderName":"IT Support","recipients":[{"email":"john.doe@acme.com","recipientType":"To"},{"email":"security-team@acme.com","recipientType":"Cc"}],"subject":"Urgent: Verify your account credentials","attachmentCount":1,"receivedTime":"2026-03-05 14:30:00","investigationFilterTagList":["HeaderFrom","HeaderSubject","BodyUrl"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationResultRequest" }, "example": {"investigationId":"Ht4Wn8kL2mXq","investigationScanTypeId":"Jx6Rp3nQ9wLm","email":"john.doe@acme.com","mailId":"AAMkAGI2TG93AAA=","folderName":"Inbox","folderType":"Inbox","senderIp":"198.51.100.42","from":"attacker@malicious-domain.com","senderName":"IT Support","recipients":[{"email":"john.doe@acme.com","recipientType":"To"},{"email":"security-team@acme.com","recipientType":"Cc"}],"subject":"Urgent: Verify your account credentials","attachmentCount":1,"receivedTime":"2026-03-05 14:30:00","investigationFilterTagList":["HeaderFrom","HeaderSubject","BodyUrl"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.CreateInvestigationResultRequest" }, "example": {"investigationId":"Ht4Wn8kL2mXq","investigationScanTypeId":"Jx6Rp3nQ9wLm","email":"john.doe@acme.com","mailId":"AAMkAGI2TG93AAA=","folderName":"Inbox","folderType":"Inbox","senderIp":"198.51.100.42","from":"attacker@malicious-domain.com","senderName":"IT Support","recipients":[{"email":"john.doe@acme.com","recipientType":"To"},{"email":"security-team@acme.com","recipientType":"Cc"}],"subject":"Urgent: Verify your account credentials","attachmentCount":1,"receivedTime":"2026-03-05 14:30:00","investigationFilterTagList":["HeaderFrom","HeaderSubject","BodyUrl"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/investigations/{resourceId}/progress": { "put": { "tags": [ "Incident Response" ], "summary": "Updates the progress status of an ongoing investigation, reflecting the current stage of the analysis workflow.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the investigation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated progress details for the investigation.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.UpdateInvestigationProgressRequest" }, "example": {"investigationId":"Ht4Wn8kL2mXq","investigationScanTypeId":"Jx6Rp3nQ9wLm","email":"john.doe@acme.com","analyzedMailCount":450} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.UpdateInvestigationProgressRequest" }, "example": {"investigationId":"Ht4Wn8kL2mXq","investigationScanTypeId":"Jx6Rp3nQ9wLm","email":"john.doe@acme.com","analyzedMailCount":450} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.UpdateInvestigationProgressRequest" }, "example": {"investigationId":"Ht4Wn8kL2mXq","investigationScanTypeId":"Jx6Rp3nQ9wLm","email":"john.doe@acme.com","analyzedMailCount":450} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.UpdateInvestigationProgressRequest" }, "example": {"investigationId":"Ht4Wn8kL2mXq","investigationScanTypeId":"Jx6Rp3nQ9wLm","email":"john.doe@acme.com","analyzedMailCount":450} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/investigations/{resourceId}/cancel": { "put": { "tags": [ "Incident Response" ], "summary": "Cancels an in-progress investigation, stopping any pending analysis tasks and marking it as cancelled.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the investigation to cancel.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/investigations/scan-types": { "get": { "tags": [ "Incident Response" ], "summary": "Retrieves the available scan type configurations for investigations, including supported analysis engines and their scan capabilities.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.Domain.Entities.Investigation.ScanConfigurationDetailDto, KeepnetLabs.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/investigations/{resourceId}/search-email": { "post": { "tags": [ "Incident Response" ], "summary": "Searches and returns a paginated list of emails associated with a specific investigation, including their analysis status and threat verdicts.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the investigation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Pagination, sorting, and filter criteria for the investigation email search.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.InvestigationSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.InvestigationSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.InvestigationSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.InvestigationSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.Investigation.Search.InvestigationEmailSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/investigations/{resourceId}/search-user": { "post": { "tags": [ "Incident Response" ], "summary": "Searches and returns a paginated list of users (analysts) assigned to a specific investigation, including their participation status.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the investigation.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Pagination, sorting, and filter criteria for the investigation user search.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.InvestigationSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.InvestigationSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.InvestigationSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.InvestigationSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.Investigation.Search.InvestigationUserSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/investigations/search": { "post": { "tags": [ "Incident Response" ], "summary": "Searches and returns a paginated list of all investigations for the current company, with optional filtering by status, date, or threat type.", "requestBody": { "description": "Pagination, sorting, and filter criteria for the investigation search.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.InvestigationSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.InvestigationSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.InvestigationSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Investigation.InvestigationSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.Investigation.Search.InvestigationSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/investigations/{resourceId}/summary": { "get": { "tags": [ "Incident Response" ], "summary": "Retrieves a summary overview of a specific investigation, including scan progress, threat counts, and action outcomes.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the investigation.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Investigation.Dto.InvestigationSummaryDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/investigations/search/export": { "post": { "tags": [ "Incident Response" ], "summary": "Exports the investigation list as a downloadable file in the specified format (e.g., CSV, Excel).", "requestBody": { "description": "Export parameters including format, pagination, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/investigations/{resourceId}/search-email/export": { "post": { "tags": [ "Incident Response" ], "summary": "Exports the investigation email list as a downloadable file in the specified format for a given investigation.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the investigation whose emails to export.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Export parameters including format, pagination, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/investigations/{resourceId}/search-user/export": { "post": { "tags": [ "Incident Response" ], "summary": "Exports the investigation user (analyst) list as a downloadable file in the specified format for a given investigation.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the investigation whose users to export.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Export parameters including format, pagination, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/ir/dashboard/summary": { "get": { "tags": [ "Incident Response" ], "summary": "Retrieves the incident response dashboard summary, including total reported emails, investigations, and threat resolution metrics.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Investigation.Dto.DashboardSummaryDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/ir/dashboard/top-rules": { "get": { "tags": [ "Incident Response" ], "summary": "Retrieves the most frequently triggered playbook rules, providing insight into the most common threat patterns detected.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.Investigation.Dto.TopRuleDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/ir/dashboard/running-investigations": { "get": { "tags": [ "Incident Response" ], "summary": "Retrieves the list of currently active and recently completed investigations for the dashboard overview.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.Investigation.Dto.RunningInvestigationDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/notified-emails/search": { "post": { "tags": [ "Incident Response" ], "summary": "Searches and returns a paginated list of emails reported by users via the phishing reporter add-in, with optional clustering and filtering.", "requestBody": { "description": "Pagination, sorting, filter, and clustering criteria for the notified email search.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.NotifiedEmailRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"EmailCategory","operator":"Include","value":"Spam,Marketing"}],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"clusteredBy":""} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.NotifiedEmailRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"EmailCategory","operator":"Include","value":"Spam,Marketing"}],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"clusteredBy":""} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.NotifiedEmailRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"EmailCategory","operator":"Include","value":"Spam,Marketing"}],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"clusteredBy":""} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.NotifiedEmailRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"EmailCategory","operator":"Include","value":"Spam,Marketing"}],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"clusteredBy":""} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.NotifiedEmail.Search.NotifiedEmailSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/notified-emails/{resourceId}": { "get": { "tags": [ "Incident Response" ], "summary": "Retrieves the full details of a specific reported email, including sender info, analysis results, headers, and threat verdicts.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the notified email.", "required": true, "schema": { "type": "string" } }, { "name": "isPublic", "in": "query", "description": "Whether to retrieve the public-facing version of the email details (without sensitive internal data).", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.NotifiedEmail.Dto.NotifiedEmailDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "put": { "tags": [ "Incident Response" ], "summary": "Updates the classification, analyst notes, or status of a specific reported email.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the notified email to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated fields for the notified email.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.UpdateNotifiedEmailRequest" }, "example": {"result":"Phishing","status":"Closed","tag":"confirmed-phishing","note":"Verified phishing attempt targeting credentials. Sender domain flagged.","isNotifyUser":true,"customMessage":"Thank you for reporting this email. It has been confirmed as a phishing attempt and removed.","notificationTemplateResourceId":"Bn5Kw8mR3xLp"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.UpdateNotifiedEmailRequest" }, "example": {"result":"Phishing","status":"Closed","tag":"confirmed-phishing","note":"Verified phishing attempt targeting credentials. Sender domain flagged.","isNotifyUser":true,"customMessage":"Thank you for reporting this email. It has been confirmed as a phishing attempt and removed.","notificationTemplateResourceId":"Bn5Kw8mR3xLp"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.UpdateNotifiedEmailRequest" }, "example": {"result":"Phishing","status":"Closed","tag":"confirmed-phishing","note":"Verified phishing attempt targeting credentials. Sender domain flagged.","isNotifyUser":true,"customMessage":"Thank you for reporting this email. It has been confirmed as a phishing attempt and removed.","notificationTemplateResourceId":"Bn5Kw8mR3xLp"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.UpdateNotifiedEmailRequest" }, "example": {"result":"Phishing","status":"Closed","tag":"confirmed-phishing","note":"Verified phishing attempt targeting credentials. Sender domain flagged.","isNotifyUser":true,"customMessage":"Thank you for reporting this email. It has been confirmed as a phishing attempt and removed.","notificationTemplateResourceId":"Bn5Kw8mR3xLp"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/notified-emails/{resourceId}/ai-analysis": { "get": { "tags": [ "Incident Response" ], "summary": "Retrieves the latest Agentic AI analysis result for a reported email.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the notified email.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.NotifiedEmail.Dto.NotifiedEmailAIAnalysisDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/notified-emails/{resourceId}/ai-analysis/re-analyze": { "post": { "tags": [ "Incident Response" ], "summary": "Queues a fresh Agentic AI re-analysis for a reported email. A new analysis record is\r\ncreated; the request is ignored when an analysis is already pending or running.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the notified email.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.NotifiedEmail.Dto.NotifiedEmailAIAnalysisDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/notified-emails/for-edit/{resourceId}": { "get": { "tags": [ "Incident Response" ], "summary": "Retrieves a notified email in an editable format, including mutable fields like classification and analyst notes.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the notified email to edit.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.NotifiedEmail.Dto.NotifiedEmailForEditDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/notified-emails/attachments/{resourceId}": { "get": { "tags": [ "Incident Response" ], "summary": "Downloads a specific email attachment file from a reported email, optionally protected with a ZIP password.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the attachment.", "required": true, "schema": { "type": "string" } }, { "name": "zipPassword", "in": "query", "description": "Optional password to apply when zipping the attachment for secure download.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/notified-emails/attachments": { "post": { "tags": [ "Incident Response" ], "summary": "Downloads all attachments from a reported email as a single password-protected ZIP archive.", "requestBody": { "description": "The download request containing the email resource ID and ZIP password for encryption.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.DownloadAttachmentZipRequest" }, "example": {"resourceId":"Ht4Wn8kL2mXq","zipPassword":"infected123"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.DownloadAttachmentZipRequest" }, "example": {"resourceId":"Ht4Wn8kL2mXq","zipPassword":"infected123"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.DownloadAttachmentZipRequest" }, "example": {"resourceId":"Ht4Wn8kL2mXq","zipPassword":"infected123"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.DownloadAttachmentZipRequest" }, "example": {"resourceId":"Ht4Wn8kL2mXq","zipPassword":"infected123"} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/notified-emails/msg-files/{resourceId}": { "get": { "tags": [ "Incident Response" ], "summary": "Downloads the original message file (MSG/EML) of a reported email for offline analysis or archival.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the notified email.", "required": true, "schema": { "type": "string" } }, { "name": "zipPassword", "in": "query", "description": "Optional password parameter (currently unused; the file is downloaded without encryption).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/notified-emails/msg-files": { "post": { "tags": [ "Incident Response" ], "summary": "Downloads the original message file (MSG/EML) of a reported email as a password-protected ZIP archive.", "requestBody": { "description": "The download request containing the email resource ID and ZIP password for encryption.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.DownloadMsgZipRequest" }, "example": {"resourceId":"Ht4Wn8kL2mXq","zipPassword":"infected123"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.DownloadMsgZipRequest" }, "example": {"resourceId":"Ht4Wn8kL2mXq","zipPassword":"infected123"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.DownloadMsgZipRequest" }, "example": {"resourceId":"Ht4Wn8kL2mXq","zipPassword":"infected123"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.DownloadMsgZipRequest" }, "example": {"resourceId":"Ht4Wn8kL2mXq","zipPassword":"infected123"} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/notified-emails/bulk-update": { "put": { "tags": [ "Incident Response" ], "summary": "Bulk updates the classification or status of multiple reported emails in a single operation, with optional select-all support.", "requestBody": { "description": "The bulk update parameters including target emails, new field values, and optional select-all criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.BulkUpdateNotifiedEmailRequest" }, "example": {"resourceIdList":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc","Km7Wx4pL8nRt"],"result":"Malicious","status":"Closed","tag":"bulk-resolved","note":"Bulk closure after investigation confirmed malicious campaign.","isNotifyUser":true,"customMessage":"A malicious email has been identified and handled by the security team.","notificationTemplateResourceId":"Bn5Kw8mR3xLp"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.BulkUpdateNotifiedEmailRequest" }, "example": {"resourceIdList":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc","Km7Wx4pL8nRt"],"result":"Malicious","status":"Closed","tag":"bulk-resolved","note":"Bulk closure after investigation confirmed malicious campaign.","isNotifyUser":true,"customMessage":"A malicious email has been identified and handled by the security team.","notificationTemplateResourceId":"Bn5Kw8mR3xLp"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.BulkUpdateNotifiedEmailRequest" }, "example": {"resourceIdList":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc","Km7Wx4pL8nRt"],"result":"Malicious","status":"Closed","tag":"bulk-resolved","note":"Bulk closure after investigation confirmed malicious campaign.","isNotifyUser":true,"customMessage":"A malicious email has been identified and handled by the security team.","notificationTemplateResourceId":"Bn5Kw8mR3xLp"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.BulkUpdateNotifiedEmailRequest" }, "example": {"resourceIdList":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc","Km7Wx4pL8nRt"],"result":"Malicious","status":"Closed","tag":"bulk-resolved","note":"Bulk closure after investigation confirmed malicious campaign.","isNotifyUser":true,"customMessage":"A malicious email has been identified and handled by the security team.","notificationTemplateResourceId":"Bn5Kw8mR3xLp"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/notified-emails/bulk-update-email-stats": { "post": { "tags": [ "Incident Response" ], "summary": "Returns email count statistics for a proposed bulk update operation, allowing the user to preview the impact before confirming.", "requestBody": { "description": "The bulk update parameters to compute statistics for, including target emails and select-all criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.BulkUpdateNotifiedEmailRequest" }, "example": {"resourceIdList":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc","Km7Wx4pL8nRt"],"result":"Malicious","status":"Closed","tag":"bulk-resolved","note":"Bulk closure after investigation confirmed malicious campaign.","isNotifyUser":true,"customMessage":"A malicious email has been identified and handled by the security team.","notificationTemplateResourceId":"Bn5Kw8mR3xLp"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.BulkUpdateNotifiedEmailRequest" }, "example": {"resourceIdList":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc","Km7Wx4pL8nRt"],"result":"Malicious","status":"Closed","tag":"bulk-resolved","note":"Bulk closure after investigation confirmed malicious campaign.","isNotifyUser":true,"customMessage":"A malicious email has been identified and handled by the security team.","notificationTemplateResourceId":"Bn5Kw8mR3xLp"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.BulkUpdateNotifiedEmailRequest" }, "example": {"resourceIdList":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc","Km7Wx4pL8nRt"],"result":"Malicious","status":"Closed","tag":"bulk-resolved","note":"Bulk closure after investigation confirmed malicious campaign.","isNotifyUser":true,"customMessage":"A malicious email has been identified and handled by the security team.","notificationTemplateResourceId":"Bn5Kw8mR3xLp"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.BulkUpdateNotifiedEmailRequest" }, "example": {"resourceIdList":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc","Km7Wx4pL8nRt"],"result":"Malicious","status":"Closed","tag":"bulk-resolved","note":"Bulk closure after investigation confirmed malicious campaign.","isNotifyUser":true,"customMessage":"A malicious email has been identified and handled by the security team.","notificationTemplateResourceId":"Bn5Kw8mR3xLp"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.NotifiedEmail.Dto.NotifiedEmailStatsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/notified-emails/search/export": { "post": { "tags": [ "Incident Response" ], "summary": "Exports the notified email list as a downloadable file in the specified format (e.g., CSV, Excel).", "requestBody": { "description": "Export parameters including format, pagination, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/notified-emails/matching-playbooks/{playbookResourceId}/search": { "post": { "tags": [ "Incident Response" ], "summary": "Searches and returns a paginated list of notified emails that match a specific playbook's rule criteria.", "parameters": [ { "name": "playbookResourceId", "in": "path", "description": "The unique resource identifier of the playbook whose matching rules to evaluate.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Pagination, sorting, and filter criteria for the matching email search.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.NotifiedEmailRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"EmailCategory","operator":"Include","value":"Spam,Marketing"}],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"clusteredBy":""} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.NotifiedEmailRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"EmailCategory","operator":"Include","value":"Spam,Marketing"}],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"clusteredBy":""} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.NotifiedEmailRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"EmailCategory","operator":"Include","value":"Spam,Marketing"}],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"clusteredBy":""} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.NotifiedEmail.NotifiedEmailRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"EmailCategory","operator":"Include","value":"Spam,Marketing"}],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"clusteredBy":""} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.NotifiedEmail.Search.MatchingNotifiedEmailSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/notified-emails/matching-playbooks/{playbookResourceId}/search/export": { "post": { "tags": [ "Incident Response" ], "summary": "Exports the list of notified emails matching a specific playbook's rules as a downloadable file.", "parameters": [ { "name": "playbookResourceId", "in": "path", "description": "The unique resource identifier of the playbook whose matching emails to export.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Export parameters including format, pagination, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/notified-emails/{resourceId}/reanalyze": { "get": { "tags": [ "Incident Response" ], "summary": "Triggers a re-analysis of a previously reported email, resubmitting it to all configured analysis engines for fresh threat assessment.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the notified email to re-analyze.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/notified-emails/fortisandbox-attachments-report/{resourceId}": { "get": { "tags": [ "Incident Response" ], "summary": "Downloads the FortiSandbox analysis report for a specific email attachment, providing detailed sandbox execution results.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the FortiSandbox attachment analysis report.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/phishing-reporter": { "post": { "tags": [ "Incident Response" ], "summary": "Creates or updates the phishing reporter add-in configuration including branding, dialog box settings, and reporting behavior.", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "AddInName", "ApiKey", "ApiUrl", "BrandName", "CompanyKey", "WarningLabel" ], "type": "object", "properties": { "File": { "type": "string", "description": "Logo or icon file for the phishing reporter add-in branding.", "format": "binary" }, "AddInName": { "maxLength": 64, "type": "string", "description": "Display name of the Outlook add-in.", "deprecated": true }, "BrandName": { "maxLength": 64, "type": "string", "description": "Brand name displayed in the add-in interface.", "deprecated": true }, "WarningLabel": { "type": "string", "description": "Warning label text shown to users when reporting suspicious emails." }, "AddInBackgroundColor": { "maxLength": 7, "type": "string", "description": "Page View add-in panel background color. #RRGGBB, or empty for the default white." }, "IsAddInTextCentered": { "type": "boolean", "description": "Whether Page View add-in message text is centered." }, "MaxLogFileSize": { "type": "integer", "description": "Maximum size in bytes for log files generated by the add-in.", "format": "int32" }, "IsProcessAttachmentOnTheFly": { "type": "boolean", "description": "Whether to process email attachments in real-time during reporting." }, "To": { "type": "string", "description": "Primary recipient email address for reported phishing emails." }, "Cc": { "type": "string", "description": "CC recipient email address for reported phishing emails." }, "Bcc": { "type": "string", "description": "BCC recipient email address for reported phishing emails." }, "Subject": { "type": "string", "description": "Subject line for the forwarded phishing report email." }, "Content": { "type": "string", "description": "Body content for the forwarded phishing report email." }, "EnterpriseVaultUrl": { "type": "string", "description": "URL of the Enterprise Vault server for archived email access." }, "ApiUrl": { "type": "string", "description": "API endpoint URL for the phishing reporter backend service." }, "ApiKey": { "type": "string", "description": "API key used to authenticate the add-in with the backend service." }, "CompanyKey": { "type": "string", "description": "Company-specific key that identifies the tenant for the add-in." }, "IsEnableProxy": { "type": "boolean", "description": "Whether proxy settings are enabled for the add-in network communication." }, "IsEnableAddIn": { "type": "boolean", "description": "Whether the Outlook add-in is enabled for end users." }, "IsSendInformationEmail": { "type": "boolean", "description": "Whether to send an information email to the reporter after submission." }, "SendUsACopy": { "type": "boolean", "description": "Whether to send a copy of the reported email to the configured recipients." }, "IsMicrosoftDefenderIntegrationEnabled": { "type": "boolean", "description": "Whether Microsoft Defender integration is enabled for reported emails." }, "DefenderReportingEmailAddress": { "maxLength": 320, "type": "string", "description": "Email address used for Microsoft Defender submission reporting." }, "WriteAddinStatusToHKLM": { "type": "boolean", "description": "Whether to write add-in status to HKEY_LOCAL_MACHINE registry." }, "WriteAddinStatusToHKCU": { "type": "boolean", "description": "Whether to write add-in status to HKEY_CURRENT_USER registry." }, "ProxyMode": { "type": "integer", "description": "Proxy mode setting (e.g., 0 = no proxy, 1 = system proxy, 2 = custom proxy). Allowed values: 0 = NoProxy | 1 = Auto | 2 = Custom", "format": "int32" }, "ProxyAddress": { "type": "string", "description": "Proxy server address when using a custom proxy." }, "ProxyPort": { "type": "string", "description": "Proxy server port number." }, "ProxyUserName": { "type": "string", "description": "Username for proxy server authentication." }, "ProxyUserPassword": { "type": "string", "description": "Password for proxy server authentication." }, "DialogBoxSettings": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.PhishingReporter.PhishingReporterAddinDialogBoxSetting" }, "description": "Localized dialog box settings for the add-in UI in different languages." } } }, "example": { "AddInName": "Keepnet Phishing Reporter", "BrandName": "Keepnet Labs", "WarningLabel": "Are you sure you want to report this email as phishing?", "AddInBackgroundColor": "#0B2545", "IsAddInTextCentered": false, "MaxLogFileSize": 5242880, "IsProcessAttachmentOnTheFly": true, "To": "security@acme.com", "Cc": "soc-team@acme.com", "Bcc": "audit@acme.com", "Subject": "[Phishing Report] Suspicious email reported by {{reporter}}", "Content": "A suspicious email has been reported. Please review the attached original message.", "EnterpriseVaultUrl": "https://vault.acme.com/api", "ApiUrl": "https://api.keepnetlabs.com/phishing-reporter", "ApiKey": "pr_api_key_placeholder", "CompanyKey": "ck_company_key_placeholder", "IsEnableProxy": false, "IsEnableAddIn": true, "IsSendInformationEmail": true, "SendUsACopy": true, "IsMicrosoftDefenderIntegrationEnabled": false, "DefenderReportingEmailAddress": "defender-submit@acme.com", "WriteAddinStatusToHKLM": false, "WriteAddinStatusToHKCU": true, "ProxyMode": 0, "ProxyAddress": "", "ProxyPort": "", "ProxyUserName": "", "ProxyUserPassword": "", "DialogBoxSettings": [ { "LanguageResourceId": "Ln4Kp2mR4xEn", "MsgBoxTitle": "Report Phishing", "MsgBoxBtnYesText": "Yes", "MsgBoxBtnNoText": "No", "MsgBoxBtnCancelText": "Cancel", "MsgBoxBtnOkText": "OK", "AnalysisThankYouMessage": "Thank you for reporting this email. Our security team will review it.", "NoInternetConnectionMessage": "No internet connection. Please try again later.", "EmailSendingErrorMessage": "Failed to send the report. Please try again.", "EmailSelectionErrorMessage": "Please select an email to report.", "BadFormatEmailMessage": "The selected email has an invalid format.", "IsConfirmationBeforeAnalysis": true, "AnalysisConfirmationMessage": "This email will be sent to the security team for analysis. Continue?", "IsDeleteEmailBeforeAnalysis": false, "IsDeleteWithoutConfirmation": false, "AnalysisEmailDeleteMessage": "The reported email has been removed from your inbox.", "IsSendSimulationMails": true, "SimulationMailMessage": "This was a phishing simulation. Great job reporting it!", "IsDefault": true } ] }, "encoding": { "File": { "style": "form" }, "AddInName": { "style": "form" }, "BrandName": { "style": "form" }, "WarningLabel": { "style": "form" }, "AddInBackgroundColor": { "style": "form" }, "IsAddInTextCentered": { "style": "form" }, "MaxLogFileSize": { "style": "form" }, "IsProcessAttachmentOnTheFly": { "style": "form" }, "To": { "style": "form" }, "Cc": { "style": "form" }, "Bcc": { "style": "form" }, "Subject": { "style": "form" }, "Content": { "style": "form" }, "EnterpriseVaultUrl": { "style": "form" }, "ApiUrl": { "style": "form" }, "ApiKey": { "style": "form" }, "CompanyKey": { "style": "form" }, "IsEnableProxy": { "style": "form" }, "IsEnableAddIn": { "style": "form" }, "IsSendInformationEmail": { "style": "form" }, "SendUsACopy": { "style": "form" }, "IsMicrosoftDefenderIntegrationEnabled": { "style": "form" }, "DefenderReportingEmailAddress": { "style": "form" }, "WriteAddinStatusToHKLM": { "style": "form" }, "WriteAddinStatusToHKCU": { "style": "form" }, "ProxyMode": { "style": "form" }, "ProxyAddress": { "style": "form" }, "ProxyPort": { "style": "form" }, "ProxyUserName": { "style": "form" }, "ProxyUserPassword": { "style": "form" }, "DialogBoxSettings": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Incident Response" ], "summary": "Retrieves the current phishing reporter add-in configuration for the company, including branding and behavior settings.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingReporter.Dto.PhishingReporterDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-reporter/img": { "get": { "tags": [ "Incident Response" ], "summary": "Downloads the custom logo image configured for the phishing reporter Outlook add-in.", "responses": { "200": { "description": "OK" } } } }, "/api/phishing-reporter/summary": { "get": { "tags": [ "Incident Response" ], "summary": "Retrieves a summary of phishing reporter activity within the specified date range, including report counts and response metrics.", "parameters": [ { "name": "startDate", "in": "query", "description": "The start date of the reporting period (inclusive), in string format.", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "description": "The end date of the reporting period (inclusive), in string format.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingReporter.Dto.PhishingReporterSummaryViewDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-reporter/search": { "post": { "tags": [ "Incident Response" ], "summary": "Searches and returns a paginated list of users who have reported phishing emails via the reporter add-in.", "requestBody": { "description": "Pagination, sorting, and filter criteria for the phishing reporter user search.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.PhishingReporter.PhishingReporterUserSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme.com","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"Email","ascending":true} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.PhishingReporter.PhishingReporterUserSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme.com","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"Email","ascending":true} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.PhishingReporter.PhishingReporterUserSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme.com","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"Email","ascending":true} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.PhishingReporter.PhishingReporterUserSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme.com","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"Email","ascending":true} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.PhishingReporter.Search.PhishingReporterUserSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-reporter/search/export": { "post": { "tags": [ "Incident Response" ], "summary": "Exports the phishing reporter user list as a downloadable file in the specified format (e.g., CSV, Excel).", "requestBody": { "description": "Export parameters including format, pagination, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/phishing-reporter-users/{resourceId}": { "delete": { "tags": [ "Incident Response" ], "summary": "Permanently deletes a phishing reporter user record, removing their reporting history from the system.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing reporter user to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-reporter/generate/outlook-addin": { "get": { "tags": [ "Incident Response" ], "summary": "Triggers the generation of the Outlook desktop phishing reporter add-in installer (MSI) with the company's custom configuration.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-reporter/generate/microsoft365-addin": { "get": { "tags": [ "Incident Response" ], "summary": "Generates and downloads the Microsoft 365 OWA phishing reporter add-in manifest XML file with the company's custom configuration.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-reporter/generate/microsoft365-spam-reporting-addin": { "get": { "tags": [ "Incident Response" ], "summary": "Generates and downloads the Microsoft 365 spam reporting add-in manifest XML file for integrated junk mail reporting.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-reporter/generate/gsuite-addin": { "get": { "tags": [ "Incident Response" ], "summary": "Generates and downloads the Google Workspace (G Suite) phishing reporter add-in as a ZIP archive containing the Apps Script project.", "responses": { "200": { "description": "OK", "content": { "application/zip": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-reporter/download/outlook-addin/{resourceId}": { "get": { "tags": [ "Incident Response" ], "summary": "Downloads a previously generated Outlook desktop phishing reporter add-in MSI installer by its resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the generated add-in build.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/phishing-reporter/generate/diagnostic-tool": { "get": { "tags": [ "Incident Response" ], "summary": "Triggers the generation of the diagnostic tool installer used for troubleshooting phishing reporter add-in connectivity issues.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-reporter/download/diagnostic-tool/{resourceId}": { "get": { "tags": [ "Incident Response" ], "summary": "Downloads a previously generated diagnostic tool MSI installer by its resource identifier.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the generated diagnostic tool build.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/phishing-reporter/history/search": { "post": { "tags": [ "Incident Response" ], "summary": "Searches and returns a paginated history of generated phishing reporter add-in builds, including their status and download availability.", "requestBody": { "description": "Pagination, sorting, and filter criteria for the application generation history search.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.PhishingReporter.GeneratedApplicationHistorySearchRequest" }, "example": {"filter":{"condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.PhishingReporter.GeneratedApplicationHistorySearchRequest" }, "example": {"filter":{"condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.PhishingReporter.GeneratedApplicationHistorySearchRequest" }, "example": {"filter":{"condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.PhishingReporter.GeneratedApplicationHistorySearchRequest" }, "example": {"filter":{"condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.PhishingReporter.Search.GeneratedApplicationHistorySearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-reporter/history/search/export": { "post": { "tags": [ "Incident Response" ], "summary": "Exports the phishing reporter download history as a downloadable file in the specified format (e.g., CSV, Excel).", "requestBody": { "description": "Export parameters including format, pagination, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/phishing-reporter-users/bulk-delete": { "delete": { "tags": [ "Incident Response" ], "summary": "Bulk deletes multiple phishing reporter user records in a single operation.", "requestBody": { "description": "The list of phishing reporter user resource identifiers to delete.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.PhishingReporter.PhishingReporterUserBulkDeleteRequest" }, "example": {"items":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc"],"selectAll":false,"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.PhishingReporter.PhishingReporterUserBulkDeleteRequest" }, "example": {"items":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc"],"selectAll":false,"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.PhishingReporter.PhishingReporterUserBulkDeleteRequest" }, "example": {"items":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc"],"selectAll":false,"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.PhishingReporter.PhishingReporterUserBulkDeleteRequest" }, "example": {"items":["Rn5Kp8mQ3wLx","Yt2Hv6jD9nBc"],"selectAll":false,"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-reporter/translate-addin-settings": { "post": { "tags": [ "Incident Response" ], "summary": "Translates the phishing reporter add-in dialog box settings JSON into the specified target language using Azure OpenAI.", "requestBody": { "description": "The translation request containing the JSON to translate and the target language name.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.OpenAI.Dto.GetDialogBoxSettingsTranslationServiceRequest" }, "example": {"languageJson":"{\"reportButton\":\"Report\",\"cancelButton\":\"Cancel\"}","languageName":"Turkish"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.OpenAI.Dto.GetDialogBoxSettingsTranslationServiceRequest" }, "example": {"languageJson":"{\"reportButton\":\"Report\",\"cancelButton\":\"Cancel\"}","languageName":"Turkish"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.OpenAI.Dto.GetDialogBoxSettingsTranslationServiceRequest" }, "example": {"languageJson":"{\"reportButton\":\"Report\",\"cancelButton\":\"Cancel\"}","languageName":"Turkish"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.OpenAI.Dto.GetDialogBoxSettingsTranslationServiceRequest" }, "example": {"languageJson":"{\"reportButton\":\"Report\",\"cancelButton\":\"Cancel\"}","languageName":"Turkish"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/phishing-reporter/o365-spam-reporting/settings": { "get": { "tags": [ "Incident Response" ], "summary": "Retrieves the default O365 spam reporting application settings for the phishing reporter add-in.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingReporter.Dto.Setting, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-reporter/link-graph-account": { "post": { "tags": [ "Incident Response" ], "summary": "Links a Microsoft Graph account to the phishing reporter application, enabling mailbox access for automated email reporting.", "requestBody": { "description": "The Microsoft tenant ID to link for Graph API access.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingReporter.Dto.ConnectGraphAccountRequest" }, "example": {"tenantId":"00000000-0000-0000-0000-000000000000"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingReporter.Dto.ConnectGraphAccountRequest" }, "example": {"tenantId":"00000000-0000-0000-0000-000000000000"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingReporter.Dto.ConnectGraphAccountRequest" }, "example": {"tenantId":"00000000-0000-0000-0000-000000000000"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingReporter.Dto.ConnectGraphAccountRequest" }, "example": {"tenantId":"00000000-0000-0000-0000-000000000000"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ApiResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ApiResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ApiResponse" } } } } } } }, "/api/phishing-reporter/unlink-graph-account": { "delete": { "tags": [ "Incident Response" ], "summary": "Unlinks the currently connected Microsoft Graph account from the phishing reporter application, revoking mailbox access.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-reporter/app-permission-access/{isGranted}": { "put": { "tags": [ "Incident Response" ], "summary": "Updates the application permission access granted status for the phishing reporter, controlling whether the add-in has delegated admin consent.", "parameters": [ { "name": "isGranted", "in": "path", "description": "Whether application permission access has been granted (true) or revoked (false).", "required": true, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/playbooks": { "post": { "tags": [ "Incident Response" ], "summary": "Creates a new automated playbook that defines rules and actions for handling reported emails based on analysis engine results.", "requestBody": { "description": "The playbook configuration including name, rule conditions, and automated response actions.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Playbook.CreatePlaybookRequest" }, "example": {"name":"Auto-Quarantine Phishing Emails","description":"Automatically quarantine confirmed phishing emails and notify affected users","priority":"High","tags":["phishing","auto-response"],"isActive":true,"condition":{"operator":"AND","conditionGroups":[{"operator":"AND","conditionItems":[{"fieldName":"AnalysisResult","operator":"eq","format":"string","value":"Phishing"}],"conditionGroups":[]}]},"playbookAction":{"resourceId":"Kx9Rm3nQ7wLp","playbookId":0,"markType":"Phishing","tags":["confirmed-phishing"]},"playbookActionStatus":{"actionStatusType":"InProgress"},"playbookActionAnalyzers":[{"resourceId":"Dn3Wp7kR2mLx","integrationId":"65BVv1136Vnp","isCheckHash":true,"isCheckFile":false,"isCheckUrl":true,"isCheckSenderIP":true}],"playbookActionInvestigations":[{"resourceId":"Qm8Kv4nL6wRp","isCreatedByAnalyzer":false,"scanTypes":[{"type":"O365","mailConfigurationResourceId":"Mp4Lw7nR2xKq"}],"autoDetectFilters":true,"filters":[],"emailDateRangeType":"SevenDays","durationType":null,"targetUserType":"AllUsers","targetUsers":[],"actionType":"Quarantine","actionNotifyTargetUserType":"MailboxOwner","actionNotifyTargetUsers":[],"emailTemplateId":0,"autoAction":{"type":"Delete","isPermanentDelete":false,"warningMessage":"A phishing email has been quarantined from your mailbox."}}],"playbookActionNotifications":[{"resourceId":"Yt2Hv6jD9nBc","targetUserType":"Reporter","targetUsers":[],"emailTemplateId":"Bn5Kw8mR3xLp","analysisResultFilters":["Phishing","Malicious"]}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Playbook.CreatePlaybookRequest" }, "example": {"name":"Auto-Quarantine Phishing Emails","description":"Automatically quarantine confirmed phishing emails and notify affected users","priority":"High","tags":["phishing","auto-response"],"isActive":true,"condition":{"operator":"AND","conditionGroups":[{"operator":"AND","conditionItems":[{"fieldName":"AnalysisResult","operator":"eq","format":"string","value":"Phishing"}],"conditionGroups":[]}]},"playbookAction":{"resourceId":"Kx9Rm3nQ7wLp","playbookId":0,"markType":"Phishing","tags":["confirmed-phishing"]},"playbookActionStatus":{"actionStatusType":"InProgress"},"playbookActionAnalyzers":[{"resourceId":"Dn3Wp7kR2mLx","integrationId":"65BVv1136Vnp","isCheckHash":true,"isCheckFile":false,"isCheckUrl":true,"isCheckSenderIP":true}],"playbookActionInvestigations":[{"resourceId":"Qm8Kv4nL6wRp","isCreatedByAnalyzer":false,"scanTypes":[{"type":"O365","mailConfigurationResourceId":"Mp4Lw7nR2xKq"}],"autoDetectFilters":true,"filters":[],"emailDateRangeType":"SevenDays","durationType":null,"targetUserType":"AllUsers","targetUsers":[],"actionType":"Quarantine","actionNotifyTargetUserType":"MailboxOwner","actionNotifyTargetUsers":[],"emailTemplateId":0,"autoAction":{"type":"Delete","isPermanentDelete":false,"warningMessage":"A phishing email has been quarantined from your mailbox."}}],"playbookActionNotifications":[{"resourceId":"Yt2Hv6jD9nBc","targetUserType":"Reporter","targetUsers":[],"emailTemplateId":"Bn5Kw8mR3xLp","analysisResultFilters":["Phishing","Malicious"]}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Playbook.CreatePlaybookRequest" }, "example": {"name":"Auto-Quarantine Phishing Emails","description":"Automatically quarantine confirmed phishing emails and notify affected users","priority":"High","tags":["phishing","auto-response"],"isActive":true,"condition":{"operator":"AND","conditionGroups":[{"operator":"AND","conditionItems":[{"fieldName":"AnalysisResult","operator":"eq","format":"string","value":"Phishing"}],"conditionGroups":[]}]},"playbookAction":{"resourceId":"Kx9Rm3nQ7wLp","playbookId":0,"markType":"Phishing","tags":["confirmed-phishing"]},"playbookActionStatus":{"actionStatusType":"InProgress"},"playbookActionAnalyzers":[{"resourceId":"Dn3Wp7kR2mLx","integrationId":"65BVv1136Vnp","isCheckHash":true,"isCheckFile":false,"isCheckUrl":true,"isCheckSenderIP":true}],"playbookActionInvestigations":[{"resourceId":"Qm8Kv4nL6wRp","isCreatedByAnalyzer":false,"scanTypes":[{"type":"O365","mailConfigurationResourceId":"Mp4Lw7nR2xKq"}],"autoDetectFilters":true,"filters":[],"emailDateRangeType":"SevenDays","durationType":null,"targetUserType":"AllUsers","targetUsers":[],"actionType":"Quarantine","actionNotifyTargetUserType":"MailboxOwner","actionNotifyTargetUsers":[],"emailTemplateId":0,"autoAction":{"type":"Delete","isPermanentDelete":false,"warningMessage":"A phishing email has been quarantined from your mailbox."}}],"playbookActionNotifications":[{"resourceId":"Yt2Hv6jD9nBc","targetUserType":"Reporter","targetUsers":[],"emailTemplateId":"Bn5Kw8mR3xLp","analysisResultFilters":["Phishing","Malicious"]}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Playbook.CreatePlaybookRequest" }, "example": {"name":"Auto-Quarantine Phishing Emails","description":"Automatically quarantine confirmed phishing emails and notify affected users","priority":"High","tags":["phishing","auto-response"],"isActive":true,"condition":{"operator":"AND","conditionGroups":[{"operator":"AND","conditionItems":[{"fieldName":"AnalysisResult","operator":"eq","format":"string","value":"Phishing"}],"conditionGroups":[]}]},"playbookAction":{"resourceId":"Kx9Rm3nQ7wLp","playbookId":0,"markType":"Phishing","tags":["confirmed-phishing"]},"playbookActionStatus":{"actionStatusType":"InProgress"},"playbookActionAnalyzers":[{"resourceId":"Dn3Wp7kR2mLx","integrationId":"65BVv1136Vnp","isCheckHash":true,"isCheckFile":false,"isCheckUrl":true,"isCheckSenderIP":true}],"playbookActionInvestigations":[{"resourceId":"Qm8Kv4nL6wRp","isCreatedByAnalyzer":false,"scanTypes":[{"type":"O365","mailConfigurationResourceId":"Mp4Lw7nR2xKq"}],"autoDetectFilters":true,"filters":[],"emailDateRangeType":"SevenDays","durationType":null,"targetUserType":"AllUsers","targetUsers":[],"actionType":"Quarantine","actionNotifyTargetUserType":"MailboxOwner","actionNotifyTargetUsers":[],"emailTemplateId":0,"autoAction":{"type":"Delete","isPermanentDelete":false,"warningMessage":"A phishing email has been quarantined from your mailbox."}}],"playbookActionNotifications":[{"resourceId":"Yt2Hv6jD9nBc","targetUserType":"Reporter","targetUsers":[],"emailTemplateId":"Bn5Kw8mR3xLp","analysisResultFilters":["Phishing","Malicious"]}]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/playbooks/{resourceId}": { "get": { "tags": [ "Incident Response" ], "summary": "Retrieves the full configuration of a specific playbook, including its rule definitions, conditions, and automated actions.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the playbook.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Playbook.Dto.PlaybookDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Incident Response" ], "summary": "Permanently deletes a playbook and its associated rule definitions, stopping any future automated actions.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the playbook to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "put": { "tags": [ "Incident Response" ], "summary": "Updates an existing playbook's configuration, including rule conditions, action definitions, and notification settings.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the playbook to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated playbook configuration fields.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Playbook.UpdatePlaybookRequest" }, "example": {"name":"Auto-Quarantine Phishing Emails (Updated)","description":"Updated playbook with additional analysis engines","priority":"VeryHigh","tags":["phishing","auto-response","critical"],"isActive":true,"condition":{"operator":"AND","conditionGroups":[{"operator":"AND","conditionItems":[{"fieldName":"AnalysisResult","operator":"eq","format":"string","value":"Phishing"}],"conditionGroups":[]}]},"playbookAction":{"resourceId":"Kx9Rm3nQ7wLp","playbookId":0,"markType":"Phishing","tags":["confirmed-phishing"]},"playbookActionStatus":{"actionStatusType":"Closed"},"playbookActionAnalyzers":[],"playbookActionInvestigations":[],"playbookActionNotifications":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Playbook.UpdatePlaybookRequest" }, "example": {"name":"Auto-Quarantine Phishing Emails (Updated)","description":"Updated playbook with additional analysis engines","priority":"VeryHigh","tags":["phishing","auto-response","critical"],"isActive":true,"condition":{"operator":"AND","conditionGroups":[{"operator":"AND","conditionItems":[{"fieldName":"AnalysisResult","operator":"eq","format":"string","value":"Phishing"}],"conditionGroups":[]}]},"playbookAction":{"resourceId":"Kx9Rm3nQ7wLp","playbookId":0,"markType":"Phishing","tags":["confirmed-phishing"]},"playbookActionStatus":{"actionStatusType":"Closed"},"playbookActionAnalyzers":[],"playbookActionInvestigations":[],"playbookActionNotifications":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Playbook.UpdatePlaybookRequest" }, "example": {"name":"Auto-Quarantine Phishing Emails (Updated)","description":"Updated playbook with additional analysis engines","priority":"VeryHigh","tags":["phishing","auto-response","critical"],"isActive":true,"condition":{"operator":"AND","conditionGroups":[{"operator":"AND","conditionItems":[{"fieldName":"AnalysisResult","operator":"eq","format":"string","value":"Phishing"}],"conditionGroups":[]}]},"playbookAction":{"resourceId":"Kx9Rm3nQ7wLp","playbookId":0,"markType":"Phishing","tags":["confirmed-phishing"]},"playbookActionStatus":{"actionStatusType":"Closed"},"playbookActionAnalyzers":[],"playbookActionInvestigations":[],"playbookActionNotifications":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Playbook.UpdatePlaybookRequest" }, "example": {"name":"Auto-Quarantine Phishing Emails (Updated)","description":"Updated playbook with additional analysis engines","priority":"VeryHigh","tags":["phishing","auto-response","critical"],"isActive":true,"condition":{"operator":"AND","conditionGroups":[{"operator":"AND","conditionItems":[{"fieldName":"AnalysisResult","operator":"eq","format":"string","value":"Phishing"}],"conditionGroups":[]}]},"playbookAction":{"resourceId":"Kx9Rm3nQ7wLp","playbookId":0,"markType":"Phishing","tags":["confirmed-phishing"]},"playbookActionStatus":{"actionStatusType":"Closed"},"playbookActionAnalyzers":[],"playbookActionInvestigations":[],"playbookActionNotifications":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/playbooks/search": { "post": { "tags": [ "Incident Response" ], "summary": "Searches and returns a paginated list of playbooks configured for the current company, with optional filtering and sorting.", "requestBody": { "description": "Pagination, sorting, and filter criteria for the playbook search.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Playbook.PlaybookSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Playbook.PlaybookSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Playbook.PlaybookSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentResponder.Playbook.PlaybookSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.Playbook.Search.PlaybookSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/playbooks/search/export": { "post": { "tags": [ "Incident Response" ], "summary": "Exports the playbook list as a downloadable file in the specified format (e.g., CSV, Excel).", "requestBody": { "description": "Export parameters including format, pagination, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/google-user-provisioning": { "get": { "tags": [ "Integration" ], "summary": "Retrieves the current Google Workspace user provisioning configuration for the company.\r\nReturns sync schedule, field mappings, target group assignment, and last synchronization status.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Google.Dto.GoogleUserProvisioningDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/google-user-provisioning/sync": { "post": { "tags": [ "Integration" ], "summary": "Configures and enables scheduled user synchronization from Google Workspace.\r\nSets up periodic imports of users from selected Google groups or organizational units into Keepnet target groups.", "requestBody": { "description": "Sync configuration including Google group/OU selection, target group mapping, and schedule settings.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Google.Model.GoogleUserProvisioningSyncRequest" }, "example": {"googleOAuthResourceId":"Xk9Lm2nP4qR7","provisioningConfig":{"source":"Organization","selected":["org-unit-id-1"],"sync":{"method":"TargetGroup","details":["target-group-resource-id-1"]}}} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Google.Model.GoogleUserProvisioningSyncRequest" }, "example": {"googleOAuthResourceId":"Xk9Lm2nP4qR7","provisioningConfig":{"source":"Organization","selected":["org-unit-id-1"],"sync":{"method":"TargetGroup","details":["target-group-resource-id-1"]}}} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Google.Model.GoogleUserProvisioningSyncRequest" }, "example": {"googleOAuthResourceId":"Xk9Lm2nP4qR7","provisioningConfig":{"source":"Organization","selected":["org-unit-id-1"],"sync":{"method":"TargetGroup","details":["target-group-resource-id-1"]}}} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Google.Model.GoogleUserProvisioningSyncRequest" }, "example": {"googleOAuthResourceId":"Xk9Lm2nP4qR7","provisioningConfig":{"source":"Organization","selected":["org-unit-id-1"],"sync":{"method":"TargetGroup","details":["target-group-resource-id-1"]}}} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/google-user-provisioning/sync-now": { "post": { "tags": [ "Integration" ], "summary": "Triggers an immediate one-time user synchronization from Google Workspace, bypassing the regular schedule.\r\nImports users from the configured Google groups or organizational units into the assigned Keepnet target group.", "requestBody": { "description": "Immediate sync parameters including the Google source and target group to synchronize.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Google.Model.GoogleUserProvisioningSyncNowRequest" }, "example": {"provisioningResourceId":"Xk9Lm2nP4qR7"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Google.Model.GoogleUserProvisioningSyncNowRequest" }, "example": {"provisioningResourceId":"Xk9Lm2nP4qR7"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Google.Model.GoogleUserProvisioningSyncNowRequest" }, "example": {"provisioningResourceId":"Xk9Lm2nP4qR7"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Google.Model.GoogleUserProvisioningSyncNowRequest" }, "example": {"provisioningResourceId":"Xk9Lm2nP4qR7"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/google-user-provisioning/sync-stop": { "post": { "tags": [ "Integration" ], "summary": "Stops the active scheduled user synchronization from Google Workspace.\r\nThe existing sync configuration is preserved but no further automatic imports will occur until re-enabled.", "requestBody": { "description": "Stop request containing the sync configuration identifier to deactivate.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Google.Model.GoogleUserProvisioningSyncStopRequest" }, "example": {"provisioningResourceId":"Xk9Lm2nP4qR7"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Google.Model.GoogleUserProvisioningSyncStopRequest" }, "example": {"provisioningResourceId":"Xk9Lm2nP4qR7"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Google.Model.GoogleUserProvisioningSyncStopRequest" }, "example": {"provisioningResourceId":"Xk9Lm2nP4qR7"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.Google.Model.GoogleUserProvisioningSyncStopRequest" }, "example": {"provisioningResourceId":"Xk9Lm2nP4qR7"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/google-user-provisioning/group": { "get": { "tags": [ "Integration" ], "summary": "Lists all available groups from the connected Google Workspace directory.\r\nUsed to populate group selection when configuring which Google groups to synchronize users from.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Google.Dto.GoogleUserGroupDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/google-user-provisioning/orgunit": { "get": { "tags": [ "Integration" ], "summary": "Lists all available organizational units from the connected Google Workspace directory.\r\nUsed to populate OU selection when configuring which organizational units to synchronize users from.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Google.Dto.GoogleUserGroupDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/ldap-setting": { "post": { "tags": [ "Integration" ], "summary": "Creates a new LDAP integration setting for the current company, including server URL, bind credentials, and base DN.\r\nThis setting is used to connect to an Active Directory or LDAP server for user provisioning.", "requestBody": { "description": "LDAP connection configuration including server URL, username, password, base DN, and relative DN.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.CreateLDAPSettingRequest" }, "example": {"username":"CN=svc-keepnet,OU=ServiceAccounts,DC=acme,DC=com","password":"Ldap$ecureP@ss!","baseDN":"DC=acme,DC=com","relativeDN":["OU=Users","OU=Employees"],"url":"ldaps://ldap.acme.com:636","isActive":true} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.CreateLDAPSettingRequest" }, "example": {"username":"CN=svc-keepnet,OU=ServiceAccounts,DC=acme,DC=com","password":"Ldap$ecureP@ss!","baseDN":"DC=acme,DC=com","relativeDN":["OU=Users","OU=Employees"],"url":"ldaps://ldap.acme.com:636","isActive":true} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.CreateLDAPSettingRequest" }, "example": {"username":"CN=svc-keepnet,OU=ServiceAccounts,DC=acme,DC=com","password":"Ldap$ecureP@ss!","baseDN":"DC=acme,DC=com","relativeDN":["OU=Users","OU=Employees"],"url":"ldaps://ldap.acme.com:636","isActive":true} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.CreateLDAPSettingRequest" }, "example": {"username":"CN=svc-keepnet,OU=ServiceAccounts,DC=acme,DC=com","password":"Ldap$ecureP@ss!","baseDN":"DC=acme,DC=com","relativeDN":["OU=Users","OU=Employees"],"url":"ldaps://ldap.acme.com:636","isActive":true} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/ldap-setting/{resourceId}": { "put": { "tags": [ "Integration" ], "summary": "Updates the connection parameters (server URL, bind credentials, base DN) of an existing LDAP setting.\r\nUse this to rotate credentials or change the directory server endpoint without recreating the integration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the LDAP setting to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Updated LDAP connection parameters including server URL, username, password, and DN paths.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.UpdateLDAPSettingRequest" }, "example": {"username":"CN=svc-keepnet,OU=ServiceAccounts,DC=acme,DC=com","password":"Ldap$ecureP@ss!","url":"ldaps://ldap.acme.com:636","baseDN":"DC=acme,DC=com","relativeDN":["OU=Users","OU=Employees"],"fieldMappings":[{"customFieldResourceId":"Cf7Kn4pR9wLx","ldapFieldResourceId":"Ld9Wp6nR3pKx"}],"isActive":true} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.UpdateLDAPSettingRequest" }, "example": {"username":"CN=svc-keepnet,OU=ServiceAccounts,DC=acme,DC=com","password":"Ldap$ecureP@ss!","url":"ldaps://ldap.acme.com:636","baseDN":"DC=acme,DC=com","relativeDN":["OU=Users","OU=Employees"],"fieldMappings":[{"customFieldResourceId":"Cf7Kn4pR9wLx","ldapFieldResourceId":"Ld9Wp6nR3pKx"}],"isActive":true} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.UpdateLDAPSettingRequest" }, "example": {"username":"CN=svc-keepnet,OU=ServiceAccounts,DC=acme,DC=com","password":"Ldap$ecureP@ss!","url":"ldaps://ldap.acme.com:636","baseDN":"DC=acme,DC=com","relativeDN":["OU=Users","OU=Employees"],"fieldMappings":[{"customFieldResourceId":"Cf7Kn4pR9wLx","ldapFieldResourceId":"Ld9Wp6nR3pKx"}],"isActive":true} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.UpdateLDAPSettingRequest" }, "example": {"username":"CN=svc-keepnet,OU=ServiceAccounts,DC=acme,DC=com","password":"Ldap$ecureP@ss!","url":"ldaps://ldap.acme.com:636","baseDN":"DC=acme,DC=com","relativeDN":["OU=Users","OU=Employees"],"fieldMappings":[{"customFieldResourceId":"Cf7Kn4pR9wLx","ldapFieldResourceId":"Ld9Wp6nR3pKx"}],"isActive":true} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/ldap-setting/detail": { "get": { "tags": [ "Integration" ], "summary": "Retrieves the detailed LDAP integration settings for the current company, including connection parameters and sync status.\r\nReturns the full configuration needed to display or edit the LDAP integration on the settings page.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.LDAP.ApplicationService.Models.LDAPSettingDetailResult, KeepnetLabs.LDAP.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/ldap-setting/test-connection": { "post": { "tags": [ "Integration" ], "summary": "Tests connectivity to the LDAP/Active Directory server using the provided credentials and DN paths.\r\nReturns whether the connection was successful, allowing administrators to validate settings before saving.", "requestBody": { "description": "LDAP test connection parameters including server URL, username, password, base DN, and relative DN.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPSettingTestConnectionRequest" }, "example": {"username":"CN=svc-keepnet,OU=ServiceAccounts,DC=acme,DC=com","password":"Ldap$ecureP@ss!","url":"ldaps://ldap.acme.com:636","baseDN":"DC=acme,DC=com","relativeDN":["OU=Users"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPSettingTestConnectionRequest" }, "example": {"username":"CN=svc-keepnet,OU=ServiceAccounts,DC=acme,DC=com","password":"Ldap$ecureP@ss!","url":"ldaps://ldap.acme.com:636","baseDN":"DC=acme,DC=com","relativeDN":["OU=Users"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPSettingTestConnectionRequest" }, "example": {"username":"CN=svc-keepnet,OU=ServiceAccounts,DC=acme,DC=com","password":"Ldap$ecureP@ss!","url":"ldaps://ldap.acme.com:636","baseDN":"DC=acme,DC=com","relativeDN":["OU=Users"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPSettingTestConnectionRequest" }, "example": {"username":"CN=svc-keepnet,OU=ServiceAccounts,DC=acme,DC=com","password":"Ldap$ecureP@ss!","url":"ldaps://ldap.acme.com:636","baseDN":"DC=acme,DC=com","relativeDN":["OU=Users"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.LDAP.ApplicationService.Models.LDAPSettingConnectionResult, KeepnetLabs.LDAP.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/ldap-fields": { "get": { "tags": [ "Integration" ], "summary": "Returns the list of available LDAP attribute fields that can be mapped to Keepnet target user properties.\r\nUsed to populate field mapping UIs when configuring LDAP-to-Keepnet user attribute synchronization.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.LDAP.ApplicationService.Models.LDAPFieldListResult, KeepnetLabs.LDAP.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/active-directory/groups": { "post": { "tags": [ "Integration" ], "summary": "Searches and returns a paginated list of groups from the connected Active Directory server.\r\nUsed to select which AD groups should be included in user synchronization.", "requestBody": { "description": "Search criteria including filters, pagination settings, and the LDAP setting ID to query against.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.ActiveDirectoryGroupSearchRequest" }, "example": {"filter":{"searchInputTextValue":"Engineering","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Name","operator":"contains","value":"Engineering"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"ldapSettingId":"a1b2c3d4e5f6"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.ActiveDirectoryGroupSearchRequest" }, "example": {"filter":{"searchInputTextValue":"Engineering","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Name","operator":"contains","value":"Engineering"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"ldapSettingId":"a1b2c3d4e5f6"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.ActiveDirectoryGroupSearchRequest" }, "example": {"filter":{"searchInputTextValue":"Engineering","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Name","operator":"contains","value":"Engineering"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"ldapSettingId":"a1b2c3d4e5f6"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.ActiveDirectoryGroupSearchRequest" }, "example": {"filter":{"searchInputTextValue":"Engineering","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Name","operator":"contains","value":"Engineering"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"ldapSettingId":"a1b2c3d4e5f6"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.LDAP.ApplicationService.Models.ActiveDirectoryGroup, KeepnetLabs.LDAP.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/ldap-setting/mapping": { "post": { "tags": [ "Integration" ], "summary": "Creates a field mapping between LDAP attributes and Keepnet target user properties for the selected AD groups.\r\nInitiates an asynchronous mapping transaction that analyzes users in the selected groups and categorizes them as existing, new, or invalid.", "requestBody": { "description": "Mapping configuration including the LDAP setting ID, selected AD group filter values, and exclusion rules.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPSettingCreateMapping" }, "example": {"ldapSettingId":"a1b2c3d4e5f6","groupFilterValues":["CN=Engineering,OU=Groups,DC=acme,DC=com","CN=Security,OU=Groups,DC=acme,DC=com"],"selectAll":false,"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPSettingCreateMapping" }, "example": {"ldapSettingId":"a1b2c3d4e5f6","groupFilterValues":["CN=Engineering,OU=Groups,DC=acme,DC=com","CN=Security,OU=Groups,DC=acme,DC=com"],"selectAll":false,"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPSettingCreateMapping" }, "example": {"ldapSettingId":"a1b2c3d4e5f6","groupFilterValues":["CN=Engineering,OU=Groups,DC=acme,DC=com","CN=Security,OU=Groups,DC=acme,DC=com"],"selectAll":false,"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPSettingCreateMapping" }, "example": {"ldapSettingId":"a1b2c3d4e5f6","groupFilterValues":["CN=Engineering,OU=Groups,DC=acme,DC=com","CN=Security,OU=Groups,DC=acme,DC=com"],"selectAll":false,"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.LDAP.ApplicationService.Models.LDAPSettingCreateMappingResult, KeepnetLabs.LDAP.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/ldap-setting/status/{transactionId}": { "get": { "tags": [ "Integration" ], "summary": "Retrieves the current status of an LDAP user mapping transaction, showing counts of existing, invalid, and new users.\r\nPoll this endpoint after initiating a mapping to track progress before finalizing the import configuration.", "parameters": [ { "name": "transactionId", "in": "path", "description": "The unique transaction identifier returned by the create-mapping endpoint.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.LDAP.ApplicationService.Models.LDAPMappingStatusResult, KeepnetLabs.LDAP.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/ldap-config": { "post": { "tags": [ "Integration" ], "summary": "Creates a new LDAP sync configuration that defines how AD users are imported into a Keepnet target group.\r\nSpecifies the import type (one-time or scheduled), target group assignment, selected users, and filter criteria.", "requestBody": { "description": "LDAP config details including the LDAP setting ID, target group, import type, schedule flag, and user selection.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPConfigCreate" }, "example": {"ldapSettingResourceId":"a1b2c3d4e5f6","transactionId":"txn-20260310-001","importType":"All","targetGroupResourceId":"Tg4Rn9pK6vWx","groupFilterValues":["CN=Engineering,OU=Groups,DC=acme,DC=com"],"selectedUserResourceIds":[],"isSchedule":false,"selectAll":true,"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPConfigCreate" }, "example": {"ldapSettingResourceId":"a1b2c3d4e5f6","transactionId":"txn-20260310-001","importType":"All","targetGroupResourceId":"Tg4Rn9pK6vWx","groupFilterValues":["CN=Engineering,OU=Groups,DC=acme,DC=com"],"selectedUserResourceIds":[],"isSchedule":false,"selectAll":true,"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPConfigCreate" }, "example": {"ldapSettingResourceId":"a1b2c3d4e5f6","transactionId":"txn-20260310-001","importType":"All","targetGroupResourceId":"Tg4Rn9pK6vWx","groupFilterValues":["CN=Engineering,OU=Groups,DC=acme,DC=com"],"selectedUserResourceIds":[],"isSchedule":false,"selectAll":true,"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPConfigCreate" }, "example": {"ldapSettingResourceId":"a1b2c3d4e5f6","transactionId":"txn-20260310-001","importType":"All","targetGroupResourceId":"Tg4Rn9pK6vWx","groupFilterValues":["CN=Engineering,OU=Groups,DC=acme,DC=com"],"selectedUserResourceIds":[],"isSchedule":false,"selectAll":true,"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/ldap-setting/target-groups": { "get": { "tags": [ "Integration" ], "summary": "Returns the list of Keepnet target groups available for LDAP user synchronization.\r\nUsed to populate the target group dropdown when configuring which Keepnet group imported AD users should be assigned to.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.LDAP.ApplicationService.Models.TargetGroupForLDAPSelectBoxResult, KeepnetLabs.LDAP.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/active-directory/users": { "post": { "tags": [ "Integration" ], "summary": "Retrieves a list of users from the connected Active Directory server based on the specified group and filter criteria.\r\nUsed to preview which users will be imported before finalizing an LDAP sync configuration.", "requestBody": { "description": "AD user query parameters including the LDAP setting ID, selected groups, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.ActiveDirectoryUserRequest" }, "example": {"fieldMappings":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.ActiveDirectoryUserRequest" }, "example": {"fieldMappings":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.ActiveDirectoryUserRequest" }, "example": {"fieldMappings":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.ActiveDirectoryUserRequest" }, "example": {"fieldMappings":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/ldap-schedule/search": { "post": { "tags": [ "Integration" ], "summary": "Searches and returns a paginated list of scheduled LDAP synchronization jobs for the current company.\r\nSupports filtering and sorting to locate specific schedules by status, name, or creation date.", "requestBody": { "description": "Search criteria including pagination settings (page number, page size, sort order) and optional filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPSettingSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreatedDate","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPSettingSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreatedDate","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPSettingSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreatedDate","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPSettingSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreatedDate","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.LDAP.ApplicationService.Models.LDAPScheduleSearchResult, KeepnetLabs.LDAP.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/ldap-schedule/{resourceId}": { "get": { "tags": [ "Integration" ], "summary": "Retrieves the full configuration details of a specific LDAP scheduled sync job, including group filters, target group, and schedule status.\r\nUsed to display or edit the schedule on the LDAP integration detail page.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the LDAP schedule to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.LDAP.ApplicationService.Models.LDAPScheduleDetailResult, KeepnetLabs.LDAP.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "put": { "tags": [ "Integration" ], "summary": "Updates an existing LDAP scheduled sync job, allowing changes to group filters, schedule status, and user selection.\r\nCan be used to enable/disable the schedule, change synced groups, or update filter criteria.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the LDAP schedule to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Updated schedule configuration including group filters, schedule flag, status, and optional user selection.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPConfigUpdateRequest" }, "example": {"transactionId":"Tx5Kp2mR7xLv","groupFilterValues":["Domain Users"],"selectedUserResourceIds":[],"isSchedule":false,"status":"Passive"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPConfigUpdateRequest" }, "example": {"transactionId":"Tx5Kp2mR7xLv","groupFilterValues":["Domain Users"],"selectedUserResourceIds":[],"isSchedule":false,"status":"Passive"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPConfigUpdateRequest" }, "example": {"transactionId":"Tx5Kp2mR7xLv","groupFilterValues":["Domain Users"],"selectedUserResourceIds":[],"isSchedule":false,"status":"Passive"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LDAP.LDAPConfigUpdateRequest" }, "example": {"transactionId":"Tx5Kp2mR7xLv","groupFilterValues":["Domain Users"],"selectedUserResourceIds":[],"isSchedule":false,"status":"Passive"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Integration" ], "summary": "Permanently deletes an LDAP scheduled sync job and stops any future automatic user synchronizations for this configuration.\r\nThe underlying LDAP setting and previously imported users are not affected.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the LDAP schedule to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/sbm/cube/token": { "post": { "tags": [ "Integration" ], "summary": "Returns a short-lived analytics access token for the current company, together with the analytics\r\nAPI base URL. Call it when the dashboard opens, when the token expires, and after a company switch.", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/sbm/cube/sql/status": { "get": { "tags": [ "Integration" ], "summary": "Returns the BYO Power BI (DirectQuery) connection status for the current company: whether SQL\r\naccess is enabled, the SQL username, the server/database to enter in Power BI, and the last test.", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/sbm/cube/sql/connect": { "post": { "tags": [ "Integration" ], "summary": "Enables BYO Power BI SQL access for the current company: issues a tenant-scoped SQL username and\r\npassword. The password is returned ONCE and is never stored in plaintext.", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/sbm/cube/sql/rotate": { "post": { "tags": [ "Integration" ], "summary": "Resets the BYO Power BI SQL password for the current company. The new password is returned ONCE.\r\nAny Power BI report using the old password stops refreshing until re-entered.", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/sbm/cube/sql/test": { "post": { "tags": [ "Integration" ], "summary": "Tests the BYO Power BI connection for the current company. Checks that the Cube SQL endpoint is\r\nreachable; it does NOT re-verify the password (full authentication is confirmed on first connect).", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/sbm/cube/sql/disconnect": { "post": { "tags": [ "Integration" ], "summary": "Disconnects BYO Power BI SQL access for the current company (soft: the credential is disabled,\r\nnot deleted). Power BI reports stop authenticating until access is enabled again.", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/sbm/cube/sql/credentials": { "get": { "tags": [ "Integration" ], "summary": "Lists the BYO Power BI credentials the current company holds, oldest first. Never returns a\r\npassword.", "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } }, "post": { "tags": [ "Integration" ], "summary": "Issues an additional named Cube SQL credential for the current company. The password is\r\nreturned ONCE and is never stored in plaintext.", "description": "The name is required. The reason to hold more than one is knowing which consumer each belongs\r\nto, so a list of unnamed rows would be worse than the single credential this replaces.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SbmCube.SbmCubeSqlCredentialRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SbmCube.SbmCubeSqlCredentialRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SbmCube.SbmCubeSqlCredentialRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SbmCube.SbmCubeSqlCredentialRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/sbm/cube/sql/credentials/{resourceId}/rotate": { "post": { "tags": [ "Integration" ], "summary": "Resets ONE credential's password, leaving the company's others untouched. The new password is\r\nreturned ONCE. Only the Power BI reports signed in with this credential need re-entering.", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "500": { "description": "Internal Server Error" } } } }, "/api/sbm/cube/sql/credentials/{resourceId}/test": { "post": { "tags": [ "Integration" ], "summary": "Tests the Cube SQL endpoint and records the result against ONE credential. Reachability only:\r\nit does NOT re-verify the password (full authentication is confirmed on first Power BI connect).", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/sbm/cube/sql/credentials/{resourceId}": { "patch": { "tags": [ "Integration" ], "summary": "Renames ONE credential. Nothing else about it changes - not the username, not the password,\r\nso the Power BI signed in with it keeps working.", "description": "The label is the only part of a credential an administrator authors, and it is the part they\r\nget wrong: a credential issued before names existed has none, and a name chosen for one report\r\noutlives that report. Without this it could never be corrected.", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SbmCube.SbmCubeSqlCredentialRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SbmCube.SbmCubeSqlCredentialRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SbmCube.SbmCubeSqlCredentialRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SbmCube.SbmCubeSqlCredentialRequest" } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } }, "delete": { "tags": [ "Integration" ], "summary": "Revokes ONE credential. Any Power BI report signing in with it stops working immediately; the\r\ncompany's other credentials are unaffected, which is the whole point of holding several.", "description": "Disabled and soft-deleted: the row leaves the list but stays for the audit, and Cube stops\r\nresolving the login because its lookup filters on both flags.", "parameters": [ { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/scim/{resourceId}": { "get": { "tags": [ "Integration" ], "summary": "Retrieves the full configuration details of an existing SCIM integration identified by its resource ID.\r\nReturns field mappings, provisioning settings, and connection status.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the SCIM integration to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } }, "put": { "tags": [ "Integration" ], "summary": "Updates the display name of an existing SCIM integration identified by its resource ID.\r\nOnly the integration name can be changed; field mappings and tokens remain unaffected.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the SCIM integration to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The update payload containing the new integration name.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SCIM.UpdateSCIMIntegrationRequest" }, "example": {"name":"Azure AD SCIM Provisioning (Updated)"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SCIM.UpdateSCIMIntegrationRequest" }, "example": {"name":"Azure AD SCIM Provisioning (Updated)"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SCIM.UpdateSCIMIntegrationRequest" }, "example": {"name":"Azure AD SCIM Provisioning (Updated)"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SCIM.UpdateSCIMIntegrationRequest" }, "example": {"name":"Azure AD SCIM Provisioning (Updated)"} } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } }, "delete": { "tags": [ "Integration" ], "summary": "Permanently deletes a SCIM integration and revokes its associated bearer token.\r\nAfter deletion, the identity provider will no longer be able to provision users via this integration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the SCIM integration to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/scim": { "post": { "tags": [ "Integration" ], "summary": "Creates a new SCIM integration for the current company, generating a bearer token for identity provider authentication.\r\nThe returned token is used by the IdP to provision and de-provision users via the SCIM 2.0 protocol.", "requestBody": { "description": "The SCIM integration configuration including name, field mappings, and provisioning options.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SCIM.CreateScimIntegrationRequest" }, "example": {"name":"Azure AD SCIM Provisioning","groupResourceId":"Tg4Rn9pK6vWx","groupBySCIMFieldResourceId":"Sd5Wp2nR7mKx","fieldMappings":[{"customFieldResourceId":"Cf6Kn3mR8wLx","scimFieldResourceId":"Sf7Rp4vK9nWx"},{"customFieldResourceId":"Cf8Wn5pR2mKx","scimFieldResourceId":"Sf9Kp6nR3wLx"}],"syncPlatformGroup":true} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SCIM.CreateScimIntegrationRequest" }, "example": {"name":"Azure AD SCIM Provisioning","groupResourceId":"Tg4Rn9pK6vWx","groupBySCIMFieldResourceId":"Sd5Wp2nR7mKx","fieldMappings":[{"customFieldResourceId":"Cf6Kn3mR8wLx","scimFieldResourceId":"Sf7Rp4vK9nWx"},{"customFieldResourceId":"Cf8Wn5pR2mKx","scimFieldResourceId":"Sf9Kp6nR3wLx"}],"syncPlatformGroup":true} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SCIM.CreateScimIntegrationRequest" }, "example": {"name":"Azure AD SCIM Provisioning","groupResourceId":"Tg4Rn9pK6vWx","groupBySCIMFieldResourceId":"Sd5Wp2nR7mKx","fieldMappings":[{"customFieldResourceId":"Cf6Kn3mR8wLx","scimFieldResourceId":"Sf7Rp4vK9nWx"},{"customFieldResourceId":"Cf8Wn5pR2mKx","scimFieldResourceId":"Sf9Kp6nR3wLx"}],"syncPlatformGroup":true} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SCIM.CreateScimIntegrationRequest" }, "example": {"name":"Azure AD SCIM Provisioning","groupResourceId":"Tg4Rn9pK6vWx","groupBySCIMFieldResourceId":"Sd5Wp2nR7mKx","fieldMappings":[{"customFieldResourceId":"Cf6Kn3mR8wLx","scimFieldResourceId":"Sf7Rp4vK9nWx"},{"customFieldResourceId":"Cf8Wn5pR2mKx","scimFieldResourceId":"Sf9Kp6nR3wLx"}],"syncPlatformGroup":true} } } }, "responses": { "200": { "description": "OK" }, "201": { "description": "Created" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/scim/search": { "post": { "tags": [ "Integration" ], "summary": "Searches and returns a paginated list of SCIM integrations for the current company.\r\nSupports filtering, sorting, and pagination to locate specific integrations.", "requestBody": { "description": "Search criteria including pagination settings (page number, page size, sort order) and optional filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SCIM.SCIMIntegrationSearchRequest" }, "example": {"filter":{"searchInputTextValue":"Azure","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Name","operator":"contains","value":"Azure"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":true} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SCIM.SCIMIntegrationSearchRequest" }, "example": {"filter":{"searchInputTextValue":"Azure","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Name","operator":"contains","value":"Azure"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":true} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SCIM.SCIMIntegrationSearchRequest" }, "example": {"filter":{"searchInputTextValue":"Azure","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Name","operator":"contains","value":"Azure"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":true} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SCIM.SCIMIntegrationSearchRequest" }, "example": {"filter":{"searchInputTextValue":"Azure","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Name","operator":"contains","value":"Azure"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":true} } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/scim/{resourceId}/revoke": { "post": { "tags": [ "Integration" ], "summary": "Revokes the current bearer token of a SCIM integration and generates a new one.\r\nThe identity provider must be reconfigured with the new token to continue provisioning users.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the SCIM integration whose token should be revoked.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/scim/fields": { "get": { "tags": [ "Integration" ], "summary": "Returns all configurable SCIM attribute fields that can be mapped between the identity provider and Keepnet target user properties.\r\nUse this endpoint to populate field mapping UIs when creating or editing a SCIM integration.", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/phishing-simulator/dns-services/form-details": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the form details required to create or edit a DNS service provider, including supported provider types and configuration fields.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.DnsService.Dto.DnsServiceFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/dns-services": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Creates a new DNS service provider configuration for the current company, used for managing phishing simulation domain records.", "requestBody": { "description": "The DNS service provider creation payload containing provider type, API credentials, and configuration.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.CreateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.CreateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.CreateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.CreateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/phishing-simulator/dns-services/{resourceId}": { "put": { "tags": [ "Phishing Simulation" ], "summary": "Updates an existing DNS service provider configuration identified by its resource ID.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the DNS service provider to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated DNS service provider payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.UpdateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production Updated","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.UpdateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production Updated","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.UpdateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production Updated","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.UpdateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production Updated","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Phishing Simulation" ], "summary": "Deletes a DNS service provider configuration identified by its resource ID.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the DNS service provider to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the full details of an existing DNS service provider by its resource ID, including API credentials and configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the DNS service provider.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.DnsService.Dto.DnsServiceProviderDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/dns-services/search": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns a paginated list of DNS service providers for the current company, with filtering and sorting support.", "requestBody": { "description": "The search request containing pagination, sorting, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.DnServiceProviderSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.DnServiceProviderSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.DnServiceProviderSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.DnServiceProviderSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.DnsService.Search.DnsServiceProviderSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/dns-services/search/export": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Exports the DNS service provider list to a downloadable file (CSV, Excel, or PDF) based on the current search filters.", "requestBody": { "description": "The export request containing pagination, filter criteria, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/phishing-simulator/dns-services/{resourceId}/test": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Tests the connectivity and configuration of an existing DNS service provider by attempting to verify its API credentials.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the DNS service provider to test.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The test request containing the DNS service configuration parameters to validate.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.TestDnsServiceProviderRequest" }, "example": {"resourceId":"65BVv1136Vnp","dnsServiceProviderTypeId":1,"username":"api-key@example.com","password":"api-secret-token"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.TestDnsServiceProviderRequest" }, "example": {"resourceId":"65BVv1136Vnp","dnsServiceProviderTypeId":1,"username":"api-key@example.com","password":"api-secret-token"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.TestDnsServiceProviderRequest" }, "example": {"resourceId":"65BVv1136Vnp","dnsServiceProviderTypeId":1,"username":"api-key@example.com","password":"api-secret-token"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.TestDnsServiceProviderRequest" }, "example": {"resourceId":"65BVv1136Vnp","dnsServiceProviderTypeId":1,"username":"api-key@example.com","password":"api-secret-token"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/domain-records/form-details": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the form details required to create or edit a domain record, including available DNS providers and record type options.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.DomainRecord.Dto.DomainRecordFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/domain-records/test": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Tests DNS zone ID connectivity and validity by verifying the configuration against the specified DNS provider.", "requestBody": { "description": "The test request containing DNS provider credentials and zone ID to validate.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.TestDomainRecordRequest" }, "example": {"dnsServiceProviderId":1,"zoneId":"abc123def456"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.TestDomainRecordRequest" }, "example": {"dnsServiceProviderId":1,"zoneId":"abc123def456"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.TestDomainRecordRequest" }, "example": {"dnsServiceProviderId":1,"zoneId":"abc123def456"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.TestDomainRecordRequest" }, "example": {"dnsServiceProviderId":1,"zoneId":"abc123def456"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/domain-records": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Creates a new domain record for the current company, used to configure phishing simulation landing page domains.", "requestBody": { "description": "The domain record creation payload containing domain name, DNS provider, zone ID, and record configuration.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+CreateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.50","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+CreateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.50","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+CreateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.50","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+CreateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.50","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/phishing-simulator/domain-records/{resourceId}": { "put": { "tags": [ "Phishing Simulation" ], "summary": "Updates an existing domain record identified by its resource ID with new DNS configuration settings.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the domain record to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated domain record payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+UpdateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.51","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+UpdateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.51","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+UpdateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.51","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+UpdateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.51","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Phishing Simulation" ], "summary": "Deletes a domain record identified by its resource ID and removes associated DNS entries.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the domain record to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the full details of an existing domain record by its resource ID, including DNS provider and zone configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the domain record.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.DomainRecord.Dto.DomainRecordDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/domain-records/search": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns a paginated list of domain records for the current company, with filtering and sorting support.", "requestBody": { "description": "The search request containing pagination, sorting, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+DomainRecordSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":true} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+DomainRecordSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":true} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+DomainRecordSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":true} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+DomainRecordSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":true} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.DomainRecord.Dto.DomainRecordSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/domain-records/search/export": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Exports the domain record list to a downloadable file (CSV, Excel, or PDF) based on the current search filters.", "requestBody": { "description": "The export request containing pagination, filter criteria, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/companies/email-templates": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Creates a new notification email template for the current company, used for system notifications and campaign communications.", "requestBody": { "description": "The email template creation payload containing name, subject, HTML body, category, and merge tag configuration.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.CreateEmailTemplateRequest" }, "example": {"name":"Training Enrollment Notification","emailDeliverySettingType":1,"smtpSettingResourceId":"Sm8pW3nR5vQx","emailTemplateCategoryResourceId":"Ec5Kp2mR7xLn","fromName":"Security Awareness Team","fromAddress":"training@example-corp.com","subject":"You Have Been Enrolled in Security Training","template":"Dear {FIRSTNAME},
Please contact {MANAGER} to complete your training.
","tags":["training","enrollment"],"languageTypeResourceId":"Ln2Kp5mR7vWx","mergeTagFallbacks":[{"tagName":"{MANAGER}","fallbackValue":"your manager"}],"languages":[{"detailActionType":"InsertRecord","languageTypeResourceId":"Fr8nQ2pL4xYz","subject":"Vous avez ete inscrit a une formation","fromName":"Security Awareness Team","fromAddress":"training@example-corp.com","template":"Contactez {MANAGER} pour plus d'informations.
","mergeTagFallbacks":[{"tagName":"{MANAGER}","fallbackValue":"votre manager"}]}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.CreateEmailTemplateRequest" }, "example": {"name":"Training Enrollment Notification","emailDeliverySettingType":1,"smtpSettingResourceId":"Sm8pW3nR5vQx","emailTemplateCategoryResourceId":"Ec5Kp2mR7xLn","fromName":"Security Awareness Team","fromAddress":"training@example-corp.com","subject":"You Have Been Enrolled in Security Training","template":"Dear {FIRSTNAME},
Please contact {MANAGER} to complete your training.
","tags":["training","enrollment"],"languageTypeResourceId":"Ln2Kp5mR7vWx","mergeTagFallbacks":[{"tagName":"{MANAGER}","fallbackValue":"your manager"}],"languages":[{"detailActionType":"InsertRecord","languageTypeResourceId":"Fr8nQ2pL4xYz","subject":"Vous avez ete inscrit a une formation","fromName":"Security Awareness Team","fromAddress":"training@example-corp.com","template":"Contactez {MANAGER} pour plus d'informations.
","mergeTagFallbacks":[{"tagName":"{MANAGER}","fallbackValue":"votre manager"}]}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.CreateEmailTemplateRequest" }, "example": {"name":"Training Enrollment Notification","emailDeliverySettingType":1,"smtpSettingResourceId":"Sm8pW3nR5vQx","emailTemplateCategoryResourceId":"Ec5Kp2mR7xLn","fromName":"Security Awareness Team","fromAddress":"training@example-corp.com","subject":"You Have Been Enrolled in Security Training","template":"Dear {FIRSTNAME},
Please contact {MANAGER} to complete your training.
","tags":["training","enrollment"],"languageTypeResourceId":"Ln2Kp5mR7vWx","mergeTagFallbacks":[{"tagName":"{MANAGER}","fallbackValue":"your manager"}],"languages":[{"detailActionType":"InsertRecord","languageTypeResourceId":"Fr8nQ2pL4xYz","subject":"Vous avez ete inscrit a une formation","fromName":"Security Awareness Team","fromAddress":"training@example-corp.com","template":"Contactez {MANAGER} pour plus d'informations.
","mergeTagFallbacks":[{"tagName":"{MANAGER}","fallbackValue":"votre manager"}]}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.CreateEmailTemplateRequest" }, "example": {"name":"Training Enrollment Notification","emailDeliverySettingType":1,"smtpSettingResourceId":"Sm8pW3nR5vQx","emailTemplateCategoryResourceId":"Ec5Kp2mR7xLn","fromName":"Security Awareness Team","fromAddress":"training@example-corp.com","subject":"You Have Been Enrolled in Security Training","template":"Dear {FIRSTNAME},
Please contact {MANAGER} to complete your training.
","tags":["training","enrollment"],"languageTypeResourceId":"Ln2Kp5mR7vWx","mergeTagFallbacks":[{"tagName":"{MANAGER}","fallbackValue":"your manager"}],"languages":[{"detailActionType":"InsertRecord","languageTypeResourceId":"Fr8nQ2pL4xYz","subject":"Vous avez ete inscrit a une formation","fromName":"Security Awareness Team","fromAddress":"training@example-corp.com","template":"Contactez {MANAGER} pour plus d'informations.
","mergeTagFallbacks":[{"tagName":"{MANAGER}","fallbackValue":"votre manager"}]}]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/companies/email-templates/{resourceId}": { "put": { "tags": [ "Phishing Simulation" ], "summary": "Updates an existing notification email template identified by its resource ID with new content and configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the email template to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated email template payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.UpdateEmailTemplateRequest" }, "example": {"name":"Updated Training Enrollment Notification","emailDeliverySettingType":1,"smtpSettingResourceId":"Sm8pW3nR5vQx","emailTemplateCategoryResourceId":"Ec5Kp2mR7xLn","fromName":"Security Awareness Team","fromAddress":"training@example-corp.com","subject":"Reminder: Complete Your Security Training","template":"Dear {FIRSTNAME},
Please contact {MANAGER} to complete your training.
","tags":["training","enrollment","reminder"],"languageTypeResourceId":"Ln2Kp5mR7vWx","mergeTagFallbacks":[{"tagName":"{MANAGER}","fallbackValue":"your manager"}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.UpdateEmailTemplateRequest" }, "example": {"name":"Updated Training Enrollment Notification","emailDeliverySettingType":1,"smtpSettingResourceId":"Sm8pW3nR5vQx","emailTemplateCategoryResourceId":"Ec5Kp2mR7xLn","fromName":"Security Awareness Team","fromAddress":"training@example-corp.com","subject":"Reminder: Complete Your Security Training","template":"Dear {FIRSTNAME},
Please contact {MANAGER} to complete your training.
","tags":["training","enrollment","reminder"],"languageTypeResourceId":"Ln2Kp5mR7vWx","mergeTagFallbacks":[{"tagName":"{MANAGER}","fallbackValue":"your manager"}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.UpdateEmailTemplateRequest" }, "example": {"name":"Updated Training Enrollment Notification","emailDeliverySettingType":1,"smtpSettingResourceId":"Sm8pW3nR5vQx","emailTemplateCategoryResourceId":"Ec5Kp2mR7xLn","fromName":"Security Awareness Team","fromAddress":"training@example-corp.com","subject":"Reminder: Complete Your Security Training","template":"Dear {FIRSTNAME},
Please contact {MANAGER} to complete your training.
","tags":["training","enrollment","reminder"],"languageTypeResourceId":"Ln2Kp5mR7vWx","mergeTagFallbacks":[{"tagName":"{MANAGER}","fallbackValue":"your manager"}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.UpdateEmailTemplateRequest" }, "example": {"name":"Updated Training Enrollment Notification","emailDeliverySettingType":1,"smtpSettingResourceId":"Sm8pW3nR5vQx","emailTemplateCategoryResourceId":"Ec5Kp2mR7xLn","fromName":"Security Awareness Team","fromAddress":"training@example-corp.com","subject":"Reminder: Complete Your Security Training","template":"Dear {FIRSTNAME},
Please contact {MANAGER} to complete your training.
","tags":["training","enrollment","reminder"],"languageTypeResourceId":"Ln2Kp5mR7vWx","mergeTagFallbacks":[{"tagName":"{MANAGER}","fallbackValue":"your manager"}]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the full details of an existing notification email template by its resource ID.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the email template.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.EmailTemplate.Dto.EmailTemplateDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Phishing Simulation" ], "summary": "Deletes an existing notification email template identified by its resource ID.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the email template to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/{companyId}/email-templates/{emailTemplateCategoryResourceId}/default": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the default email template for a specific category and company, including SMTP settings. Optionally respects target user language preference.", "parameters": [ { "name": "emailTemplateCategoryResourceId", "in": "path", "description": "The resource ID of the email template category.", "required": true, "schema": { "type": "string" } }, { "name": "companyId", "in": "path", "description": "The company ID to retrieve the default template for.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "targetUserId", "in": "query", "description": "Optional target user ID to resolve language-specific template preference.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Mailer.Domain.Dtos.Worker.EmailInformationResult, KeepnetLabs.Mailer.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/email-templates/{emailTemplateCategoryResourceId}/default": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the default email template for a specific category for the current company, without SMTP setting resolution.", "parameters": [ { "name": "emailTemplateCategoryResourceId", "in": "path", "description": "The resource ID of the email template category.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Mailer.Domain.Dtos.Worker.EmailInformationResult, KeepnetLabs.Mailer.Domain, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/email-templates/search": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns a paginated list of notification email templates for the current company, with filtering and sorting support.", "requestBody": { "description": "The search request containing pagination, sorting, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.Search.EmailTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"EmailDeliverySettingType","operator":"eq","value":"1"}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"EmailTemplateCategoryResourceId","operator":"eq","value":""}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.Search.EmailTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"EmailDeliverySettingType","operator":"eq","value":"1"}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"EmailTemplateCategoryResourceId","operator":"eq","value":""}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.Search.EmailTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"EmailDeliverySettingType","operator":"eq","value":"1"}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"EmailTemplateCategoryResourceId","operator":"eq","value":""}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.Search.EmailTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"EmailDeliverySettingType","operator":"eq","value":"1"}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"EmailTemplateCategoryResourceId","operator":"eq","value":""}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.EmailTemplate.Dto.SearchEmailTemplateDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/email-templates/search/export": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Exports the notification email template list to a downloadable file (CSV, Excel, or PDF) based on the current search filters.", "requestBody": { "description": "The export request containing pagination, filter criteria, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/companies/email-templates/merge-tags/{resourceId}": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the list of available merge tags (dynamic placeholders) for a specific email template category.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the email template category.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/companies/email-templates/check-availability": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Checks whether the specified email template configuration is available for the current company (e.g., name uniqueness validation).", "requestBody": { "description": "The availability check request containing the template name and category to validate.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.CheckAvailabilityRequest" }, "example": {"emailTemplateName":"Monthly Security Newsletter"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.CheckAvailabilityRequest" }, "example": {"emailTemplateName":"Monthly Security Newsletter"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.CheckAvailabilityRequest" }, "example": {"emailTemplateName":"Monthly Security Newsletter"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.CheckAvailabilityRequest" }, "example": {"emailTemplateName":"Monthly Security Newsletter"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.EmailTemplate.Dto.CheckAvailabilityDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/email-templates/categorylookup": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the lookup list of all available email template categories (e.g., enrollment, reminder, notification).", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.Lookup.Dto.LookupDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/companies/email-templates/typelookup": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the lookup list of all available email template types for filtering and categorization.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.EmailTemplate.Dto.GetEmailTemplateTypeLookupDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/companies/email-templates/make-default/{resourceId}": { "put": { "tags": [ "Phishing Simulation" ], "summary": "Sets the specified notification email template as the default template for its category within the current company.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the email template to set as default.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/email-templates/email-delivery-setting-list": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the list of available email delivery settings, including both SMTP configurations and direct email creation settings.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaign.Dto.EmailDeliverySettingModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/companies/translated-email-templates": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the list of AI-translated notification email template variations for the current company.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.OpenAI.Dto.PsEmailTemplateTranslationResponseDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/companies/email-templates/translate": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Initiates AI-powered translation of a notification email template into the specified target languages.", "requestBody": { "description": "The translation request containing the source template and target language codes.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.TranslateEmailTemplateWithAIRequest" }, "example": {"languages":[],"subject":"You Have Been Enrolled in Security Training","template":"Dear {{first_name}},
You have been enrolled in a security awareness training course.
"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.TranslateEmailTemplateWithAIRequest" }, "example": {"languages":[],"subject":"You Have Been Enrolled in Security Training","template":"Dear {{first_name}},
You have been enrolled in a security awareness training course.
"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.TranslateEmailTemplateWithAIRequest" }, "example": {"languages":[],"subject":"You Have Been Enrolled in Security Training","template":"Dear {{first_name}},
You have been enrolled in a security awareness training course.
"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.EmailTemplate.TranslateEmailTemplateWithAIRequest" }, "example": {"languages":[],"subject":"You Have Been Enrolled in Security Training","template":"Dear {{first_name}},
You have been enrolled in a security awareness training course.
"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.BooleanResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/notification-template/{emailTemplateId}/merge-tag-fallbacks": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the merge tag fallback values stored for a notification email template.", "parameters": [ { "name": "emailTemplateId", "in": "path", "description": "The email template identifier.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.PhishingCampaign.Dto.MergeTagFallbackDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.BaseResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/phishing-simulator/excluded-ip": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Creates or updates the excluded IP address list for phishing campaigns, preventing tracking events from specified IP addresses (e.g., security scanners, proxies).", "requestBody": { "description": "The request containing the list of IP addresses or CIDR ranges to exclude from phishing campaign activity tracking.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ExcludedIP.CreatePhishingCampaignExcludedIPRequest" }, "example": {"excludedIPs":["10.0.0.1","192.168.1.0/24"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ExcludedIP.CreatePhishingCampaignExcludedIPRequest" }, "example": {"excludedIPs":["10.0.0.1","192.168.1.0/24"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ExcludedIP.CreatePhishingCampaignExcludedIPRequest" }, "example": {"excludedIPs":["10.0.0.1","192.168.1.0/24"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ExcludedIP.CreatePhishingCampaignExcludedIPRequest" }, "example": {"excludedIPs":["10.0.0.1","192.168.1.0/24"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignExcludedIP.Dto.PhishingCampaignExcludedIPDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/excluded-ip-list": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the current excluded IP address list for the company's phishing campaigns, including all configured IP addresses and CIDR ranges.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignExcludedIP.Dto.PhishingCampaignExcludedIPItemDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign/form-details": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the form details required to create or edit a phishing campaign, including available options and default values.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaign.Dto.PhishingCampaignFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Creates a new phishing campaign for the current company, including scenario assignment, target groups, and scheduling configuration.", "requestBody": { "description": "The phishing campaign creation payload containing name, scenarios, target groups, and schedule settings.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.CreatePhishingCampaignRequest" }, "example": {"phishingScenarios":[{"phishingScenarioResourceId":"Ps4Kx7mN2wRt","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"phishingScenarioResourceIds":["Ps4Kx7mN2wRt","Ps9Lv3nQ8jHf"],"smtpSettingResourceId":"Sm8pW3nR5vQx","distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"emailDeliverySettingType":1,"useTargetUserTimeZone":false,"sendUserPreferredLanguage":0,"name":"Q1 2026 Phishing Awareness Campaign","description":"Quarterly credential-harvesting simulation for engineering team","scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"distributionStartTypeId":1,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionStartTime":"09:00:00","distributionEndTime":"17:00:00","distributionDays":31,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"frequency":"OneTime","awardCertificate":true,"categoryDistributionType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.CreatePhishingCampaignRequest" }, "example": {"phishingScenarios":[{"phishingScenarioResourceId":"Ps4Kx7mN2wRt","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"phishingScenarioResourceIds":["Ps4Kx7mN2wRt","Ps9Lv3nQ8jHf"],"smtpSettingResourceId":"Sm8pW3nR5vQx","distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"emailDeliverySettingType":1,"useTargetUserTimeZone":false,"sendUserPreferredLanguage":0,"name":"Q1 2026 Phishing Awareness Campaign","description":"Quarterly credential-harvesting simulation for engineering team","scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"distributionStartTypeId":1,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionStartTime":"09:00:00","distributionEndTime":"17:00:00","distributionDays":31,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"frequency":"OneTime","awardCertificate":true,"categoryDistributionType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.CreatePhishingCampaignRequest" }, "example": {"phishingScenarios":[{"phishingScenarioResourceId":"Ps4Kx7mN2wRt","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"phishingScenarioResourceIds":["Ps4Kx7mN2wRt","Ps9Lv3nQ8jHf"],"smtpSettingResourceId":"Sm8pW3nR5vQx","distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"emailDeliverySettingType":1,"useTargetUserTimeZone":false,"sendUserPreferredLanguage":0,"name":"Q1 2026 Phishing Awareness Campaign","description":"Quarterly credential-harvesting simulation for engineering team","scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"distributionStartTypeId":1,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionStartTime":"09:00:00","distributionEndTime":"17:00:00","distributionDays":31,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"frequency":"OneTime","awardCertificate":true,"categoryDistributionType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.CreatePhishingCampaignRequest" }, "example": {"phishingScenarios":[{"phishingScenarioResourceId":"Ps4Kx7mN2wRt","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"phishingScenarioResourceIds":["Ps4Kx7mN2wRt","Ps9Lv3nQ8jHf"],"smtpSettingResourceId":"Sm8pW3nR5vQx","distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"emailDeliverySettingType":1,"useTargetUserTimeZone":false,"sendUserPreferredLanguage":0,"name":"Q1 2026 Phishing Awareness Campaign","description":"Quarterly credential-harvesting simulation for engineering team","scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"distributionStartTypeId":1,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionStartTime":"09:00:00","distributionEndTime":"17:00:00","distributionDays":31,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"frequency":"OneTime","awardCertificate":true,"categoryDistributionType":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign/{resourceId}": { "put": { "tags": [ "Phishing Simulation" ], "summary": "Updates an existing phishing campaign identified by its resource ID, allowing changes to scenarios, target groups, and schedule.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated phishing campaign payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.UpdatePhishingCampaignRequest" }, "example": {"phishingScenarios":[{"phishingScenarioResourceId":"Ps4Kx7mN2wRt","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"phishingScenarioResourceIds":["Ps4Kx7mN2wRt"],"smtpSettingResourceId":"Sm8pW3nR5vQx","emailDeliverySettingType":1,"useTargetUserTimeZone":false,"sendUserPreferredLanguage":0,"resourceId":"Cp4Wn8mT2xRv","name":"Q2 2026 Updated Phishing Campaign","description":"Updated quarterly phishing simulation for all departments","distributionStartTypeId":1,"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"distributionStartTime":"09:00:00","distributionEndTime":"17:00:00","distributionDays":31,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"awardCertificate":true,"categoryDistributionType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.UpdatePhishingCampaignRequest" }, "example": {"phishingScenarios":[{"phishingScenarioResourceId":"Ps4Kx7mN2wRt","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"phishingScenarioResourceIds":["Ps4Kx7mN2wRt"],"smtpSettingResourceId":"Sm8pW3nR5vQx","emailDeliverySettingType":1,"useTargetUserTimeZone":false,"sendUserPreferredLanguage":0,"resourceId":"Cp4Wn8mT2xRv","name":"Q2 2026 Updated Phishing Campaign","description":"Updated quarterly phishing simulation for all departments","distributionStartTypeId":1,"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"distributionStartTime":"09:00:00","distributionEndTime":"17:00:00","distributionDays":31,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"awardCertificate":true,"categoryDistributionType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.UpdatePhishingCampaignRequest" }, "example": {"phishingScenarios":[{"phishingScenarioResourceId":"Ps4Kx7mN2wRt","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"phishingScenarioResourceIds":["Ps4Kx7mN2wRt"],"smtpSettingResourceId":"Sm8pW3nR5vQx","emailDeliverySettingType":1,"useTargetUserTimeZone":false,"sendUserPreferredLanguage":0,"resourceId":"Cp4Wn8mT2xRv","name":"Q2 2026 Updated Phishing Campaign","description":"Updated quarterly phishing simulation for all departments","distributionStartTypeId":1,"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"distributionStartTime":"09:00:00","distributionEndTime":"17:00:00","distributionDays":31,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"awardCertificate":true,"categoryDistributionType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.UpdatePhishingCampaignRequest" }, "example": {"phishingScenarios":[{"phishingScenarioResourceId":"Ps4Kx7mN2wRt","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"phishingScenarioResourceIds":["Ps4Kx7mN2wRt"],"smtpSettingResourceId":"Sm8pW3nR5vQx","emailDeliverySettingType":1,"useTargetUserTimeZone":false,"sendUserPreferredLanguage":0,"resourceId":"Cp4Wn8mT2xRv","name":"Q2 2026 Updated Phishing Campaign","description":"Updated quarterly phishing simulation for all departments","distributionStartTypeId":1,"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"distributionStartTime":"09:00:00","distributionEndTime":"17:00:00","distributionDays":31,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"awardCertificate":true,"categoryDistributionType":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Phishing Simulation" ], "summary": "Deletes a phishing campaign identified by its resource ID, removing all associated configuration and scheduled jobs.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the full details of an existing phishing campaign by its resource ID, including scenarios, target groups, and schedule.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaign.Dto.PhishingCampaignDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign/search": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns a paginated list of phishing campaigns for the current company, with support for filtering and sorting.", "requestBody": { "description": "The search request containing pagination, sorting, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"awareness","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreatedDate","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"awareness","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreatedDate","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"awareness","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreatedDate","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"awareness","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreatedDate","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.PhishingCampaign.Dto.PhishingCampaignSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign/search/unscheduled": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns a paginated list of unscheduled phishing campaigns eligible for training enrollment.", "requestBody": { "description": "The search request containing pagination, sorting, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"awareness","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreatedDate","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"awareness","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreatedDate","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"awareness","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreatedDate","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"awareness","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreatedDate","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.PhishingCampaign.Dto.PhishingCampaignSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign/search/export": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Exports the phishing campaign list to a downloadable file (CSV, Excel, or PDF) based on the current search filters.", "requestBody": { "description": "The export request containing pagination, filter criteria, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/phishing-simulator/phishing-campaign/preview/{resourceId}": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves a preview of a phishing campaign including all associated scenario previews (email template and landing page).", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign to preview.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaign.Dto.PhishingCampaignPreviewListDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign/preview/{smtpSettingResourceId}/{phishingScenarioResourceId}": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Previews a phishing campaign by combining a specific SMTP setting with a phishing scenario to render the email and landing page.", "parameters": [ { "name": "smtpSettingResourceId", "in": "path", "description": "The resource ID of the SMTP setting to use for the preview.", "required": true, "schema": { "type": "string" } }, { "name": "phishingScenarioResourceId", "in": "path", "description": "The resource ID of the phishing scenario to preview.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaign.Dto.PhishingCampaignPreviewDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign/root-company-shared-smtp-resource-id": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Returns the resource ID of the most recently created shared SMTP settings belonging to the root company.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign/default-email-delivery-setting": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Returns the default email delivery setting (SMTP or direct) used for fast-launch phishing campaigns.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaign.Dto.EmailDeliverySettingFastLaunchModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign/bulk-delete": { "delete": { "tags": [ "Phishing Simulation" ], "summary": "Deletes multiple phishing campaigns in a single bulk operation based on the provided list of resource IDs.", "requestBody": { "description": "The bulk delete request containing the list of campaign resource IDs to remove.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignDeleteRequest" }, "example": {"items":["Cp4Wn8mT2xRv","Cp7Lk3nQ9jHf"],"selectAll":false,"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignDeleteRequest" }, "example": {"items":["Cp4Wn8mT2xRv","Cp7Lk3nQ9jHf"],"selectAll":false,"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignDeleteRequest" }, "example": {"items":["Cp4Wn8mT2xRv","Cp7Lk3nQ9jHf"],"selectAll":false,"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignDeleteRequest" }, "example": {"items":["Cp4Wn8mT2xRv","Cp7Lk3nQ9jHf"],"selectAll":false,"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign/calculate-sending-info": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Calculates the estimated sending information for a phishing campaign, including total email count and delivery timeline.", "requestBody": { "description": "The calculation request containing target groups and sending configuration parameters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCalculateSendingInfoRequest" }, "example": {"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"sendingLimit":50,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"totalTargetUserCount":250} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCalculateSendingInfoRequest" }, "example": {"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"sendingLimit":50,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"totalTargetUserCount":250} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCalculateSendingInfoRequest" }, "example": {"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"sendingLimit":50,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"totalTargetUserCount":250} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCalculateSendingInfoRequest" }, "example": {"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"sendingLimit":50,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"totalTargetUserCount":250} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaign.Dto.PhishingCampaignSendingInfoViewModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign/calculate-schedule-info": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Calculates the schedule information for a phishing campaign, including planned send dates and frequency distribution.", "requestBody": { "description": "The schedule calculation request containing frequency and date range parameters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.Base.PhishingCalculateScheduleInfoRequest" }, "example": {"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","frequency":1,"phishingScenarioResourceIds":["Ps4Kx7mN2wRt","Ps9Lv3nQ8jHf"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.Base.PhishingCalculateScheduleInfoRequest" }, "example": {"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","frequency":1,"phishingScenarioResourceIds":["Ps4Kx7mN2wRt","Ps9Lv3nQ8jHf"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.Base.PhishingCalculateScheduleInfoRequest" }, "example": {"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","frequency":1,"phishingScenarioResourceIds":["Ps4Kx7mN2wRt","Ps9Lv3nQ8jHf"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.Base.PhishingCalculateScheduleInfoRequest" }, "example": {"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","frequency":1,"phishingScenarioResourceIds":["Ps4Kx7mN2wRt","Ps9Lv3nQ8jHf"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaign.Dto.PhishingCampaignScheduleInfoViewModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign/email-delivery-setting-list": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the list of available email delivery settings, including both SMTP configurations and direct email creation settings.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaign.Dto.EmailDeliverySettingModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/{resourceId}/target-groups": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves target groups and user counts for a campaign", "parameters": [ { "name": "resourceId", "in": "path", "description": "Campaign resource id", "required": true, "schema": { "type": "string" } }, { "name": "campaignType", "in": "query", "description": "Campaign type (1=Phishing, 2=Smishing, 3=Quishing, 4=Callback, 5=Vishing)", "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingCampaign.Dto.CampaignType" } }, { "name": "instanceGroup", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaign.Dto.CampaignTargetGroupsResult, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign/validate-merge-tags": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Validates merge tags and reports users with empty values.\r\nAccepts either an existing campaign resourceId or targetGroupResourceIds + scenarioResourceIds for pre-creation validation.", "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingCampaign.Dto.ValidateMergeTagsServiceRequest" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingCampaign.Dto.ValidateMergeTagsServiceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingCampaign.Dto.ValidateMergeTagsServiceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingCampaign.Dto.ValidateMergeTagsServiceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaign.Dto.ValidateMergeTagsResultDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign/{resourceId}/merge-tag-fallbacks": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Gets merge tag fallback values for a phishing campaign", "parameters": [ { "name": "resourceId", "in": "path", "description": "Phishing campaign resource id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.PhishingCampaign.Dto.MergeTagFallbackDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job/form-details": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the form details required to configure a phishing campaign job, including available options and default values.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignJobFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job/start/{resourceId}/{instanceGroup}": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Starts a phishing campaign job for a specific instance group within an existing campaign.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number to start the job for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job/start/{resourceId}": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Creates a new campaign instance and immediately starts the phishing campaign job for the specified campaign.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Optional campaign instance configuration for the new job.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignInstance" }, "example": {"excludeFromReports":false,"scheduledDate":"2026-10-20 12:13:31","scheduledDateTimeZoneId":"UTC","scheduleTypeId":1,"targetGroupResourceIds":["Qw4Rt6yU8iOp"],"distributionStartTypeId":1,"sendingLimit":100,"distributionDelayTimeTypeId":1,"distributionDelayEvery":0,"useTargetUserTimeZone":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignInstance" }, "example": {"excludeFromReports":false,"scheduledDate":"2026-10-20 12:13:31","scheduledDateTimeZoneId":"UTC","scheduleTypeId":1,"targetGroupResourceIds":["Qw4Rt6yU8iOp"],"distributionStartTypeId":1,"sendingLimit":100,"distributionDelayTimeTypeId":1,"distributionDelayEvery":0,"useTargetUserTimeZone":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignInstance" }, "example": {"excludeFromReports":false,"scheduledDate":"2026-10-20 12:13:31","scheduledDateTimeZoneId":"UTC","scheduleTypeId":1,"targetGroupResourceIds":["Qw4Rt6yU8iOp"],"distributionStartTypeId":1,"sendingLimit":100,"distributionDelayTimeTypeId":1,"distributionDelayEvery":0,"useTargetUserTimeZone":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignInstance" }, "example": {"excludeFromReports":false,"scheduledDate":"2026-10-20 12:13:31","scheduledDateTimeZoneId":"UTC","scheduleTypeId":1,"targetGroupResourceIds":["Qw4Rt6yU8iOp"],"distributionStartTypeId":1,"sendingLimit":100,"distributionDelayTimeTypeId":1,"distributionDelayEvery":0,"useTargetUserTimeZone":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job/stop/{resourceId}/{instanceGroup}": { "patch": { "tags": [ "Phishing Simulation" ], "summary": "Stops a running phishing campaign job for a specific instance group, halting any pending email deliveries.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the job to stop.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job/{resourceId}/{instanceGroup}": { "delete": { "tags": [ "Phishing Simulation" ], "summary": "Deletes a phishing campaign job and its associated data for a specific instance group.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the job to delete.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job/resend/{resourceId}/{instanceGroup}": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Resends phishing campaign emails to users filtered by activity type (e.g., not opened, not clicked) within a specific instance group.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number to resend emails for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The resend request containing the activity types to filter target users.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersRequest" }, "example": {"types":["NoResponse"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersRequest" }, "example": {"types":["NoResponse"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersRequest" }, "example": {"types":["NoResponse"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersRequest" }, "example": {"types":["NoResponse"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job/resend/list/{resourceId}/{instanceGroup}": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Resends phishing campaign emails to a specific list of selected users within a campaign instance group.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number to resend emails for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The resend request containing the selected user list, exclusions, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersListRequest" }, "example": {"items":["Tu3Kp8mR7xLv","Tu6Wn4vT9nQs"],"selectAll":false,"excludedItems":[],"searchType":"NoResponse"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersListRequest" }, "example": {"items":["Tu3Kp8mR7xLv","Tu6Wn4vT9nQs"],"selectAll":false,"excludedItems":[],"searchType":"NoResponse"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersListRequest" }, "example": {"items":["Tu3Kp8mR7xLv","Tu6Wn4vT9nQs"],"selectAll":false,"excludedItems":[],"searchType":"NoResponse"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersListRequest" }, "example": {"items":["Tu3Kp8mR7xLv","Tu6Wn4vT9nQs"],"selectAll":false,"excludedItems":[],"searchType":"NoResponse"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job/email-activity/{resourceId}": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the detailed email activity log for a specific user within a phishing campaign job, including open, click, and submission events.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign job user record.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job-report/summary/{resourceId}/{instanceGroup}": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the summary report for a phishing campaign job instance, including delivery stats, open rates, click rates, and submission counts.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignSummaryResult, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job-report/summary/training/{resourceId}/{instanceGroup}": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the summary report for a phishing campaign job instance with training-specific metrics included.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignSummaryResult, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job-report/summary/target-groups/{resourceId}/{instanceGroup}": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the target groups and their user counts for a specific phishing campaign job instance.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignTargetGroupsResult, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job-report/{resourceId}/search": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns a paginated list of campaign job instances that belong to a specific phishing campaign.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the parent phishing campaign.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The search request containing pagination, sorting, filter criteria, and optional frequency group.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false,"phishingCampaignFrequencyGroup":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false,"phishingCampaignFrequencyGroup":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false,"phishingCampaignFrequencyGroup":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false,"phishingCampaignFrequencyGroup":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Search.PhishingCampaignJobSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job-report/search": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns a paginated list of all phishing campaign job reports across campaigns, with filtering and sorting support.", "requestBody": { "description": "The search request containing pagination, sorting, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobReportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobReportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobReportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobReportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Search.PhishingCampaignJobReportSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job-report/search/export": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Exports the phishing campaign job report list to a downloadable file (CSV, Excel, or PDF) based on the current filters.", "requestBody": { "description": "The export request containing pagination, filter criteria, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/phishing-simulator/phishing-campaign-job-report/{resourceId}/search/export": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Exports the list of campaign job instances belonging to a specific phishing campaign to a downloadable file.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the parent phishing campaign.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The export request containing pagination, filter criteria, export type, and frequency group.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ExportPhishingCampaignJobRequest" }, "example": {"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","phishingCampaignFrequencyGroup":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ExportPhishingCampaignJobRequest" }, "example": {"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","phishingCampaignFrequencyGroup":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ExportPhishingCampaignJobRequest" }, "example": {"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","phishingCampaignFrequencyGroup":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ExportPhishingCampaignJobRequest" }, "example": {"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","phishingCampaignFrequencyGroup":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/phishing-simulator/phishing-campaign-job-report/{searchType}/search/{resourceId}/{instanceGroup}": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns a paginated list of users targeted by a phishing campaign job, filtered by activity search type (e.g., opened, clicked, submitted).", "parameters": [ { "name": "searchType", "in": "path", "description": "The user activity search type filter (e.g., all users, opened, clicked, submitted).", "required": true, "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignJobUserSearchType" } }, { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The search request containing pagination, sorting, activity type, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.CustomPhishingCampaignJobUsersPagedResults`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignJobUsersSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job-report/{searchType}/search/export/{resourceId}/{instanceGroup}": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Exports the list of phishing campaign job users to a downloadable file, filtered by activity search type and instance group.", "parameters": [ { "name": "searchType", "in": "path", "description": "The user activity search type filter (e.g., all, opened, clicked, submitted).", "required": true, "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignJobUserSearchType" } }, { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The export request containing pagination, filter criteria, and export type.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignJobUsersSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job-report/search-email-clicked/{resourceId}": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns the detailed click activity records for a specific user in a phishing campaign job.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign job user record.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The search request containing pagination, sorting, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignJobUserEmailClickedSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job-report/search-email-replied/{resourceId}": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns the email reply activity records for a specific user in a phishing campaign job.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign job user record.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The search request containing pagination, sorting, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignJobUserEmailRepliedSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job-report/search-email-opened/{resourceId}": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns the email open activity records for a specific user in a phishing campaign job.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign job user record.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The search request containing pagination, sorting, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignJobUserEmailOpenedSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job-report/search-email-submitted/{resourceId}": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns the form submission (credential harvesting) records for a specific user in a phishing campaign job.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign job user record.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The search request containing pagination, sorting, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignJobUserEmailSubmittedSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job-report/search-mfa-submitted/{resourceId}": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns the MFA token submission records for a specific user in a phishing campaign job.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign job user record.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The search request containing pagination, sorting, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignJobUserMfaSubmittedSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job-report/export/{resourceId}/{instanceGroup}": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Exports a detailed Excel report for a phishing campaign job instance, including per-user activity data with optional bot activity exclusion.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "excludeBotActivity", "in": "query", "description": "Whether to exclude detected bot activity from the report. Defaults to true.", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } } } }, "/api/phishing-simulator/phishing-campaign-job-report/search-email-reported/{resourceId}": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns the phishing email report (user-reported suspicious email) records for a specific user in a campaign job.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign job user record.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The search request containing pagination, sorting, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignJobUserEmailReportedSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job-report/search-email-opened-attachment/{resourceId}": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns the attachment open activity records for a specific user in a phishing campaign job.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign job user record.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The search request containing pagination, sorting, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignJobUserEmailAttachmentOpenedSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job-report/activity/{resourceId}": { "put": { "tags": [ "Phishing Simulation" ], "summary": "Updates the activity type classification for a specific phishing campaign job user record (e.g., marking activity as bot or legitimate).", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign job user record.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The update request containing the new search type and activity type values.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.UpdatePhishingCampaignJobUserActivityRequest" }, "example": {"searchType":"NoResponse","activityType":"HumanActivity"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.UpdatePhishingCampaignJobUserActivityRequest" }, "example": {"searchType":"NoResponse","activityType":"HumanActivity"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.UpdatePhishingCampaignJobUserActivityRequest" }, "example": {"searchType":"NoResponse","activityType":"HumanActivity"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.UpdatePhishingCampaignJobUserActivityRequest" }, "example": {"searchType":"NoResponse","activityType":"HumanActivity"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-campaign-job-report/activity-users/search": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns a paginated list of users with phishing activity within a specified date range, with optional user-level grouping.", "requestBody": { "description": "The search request containing date range, grouping preference, pagination, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingActivityUsersRequest" }, "example": {"startDate":"2026-07-19 12:13:31","endDate":"2026-10-19 12:13:31","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"email","ascending":false,"groupByUser":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingActivityUsersRequest" }, "example": {"startDate":"2026-07-19 12:13:31","endDate":"2026-10-19 12:13:31","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"email","ascending":false,"groupByUser":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingActivityUsersRequest" }, "example": {"startDate":"2026-07-19 12:13:31","endDate":"2026-10-19 12:13:31","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"email","ascending":false,"groupByUser":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingActivityUsersRequest" }, "example": {"startDate":"2026-07-19 12:13:31","endDate":"2026-10-19 12:13:31","filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"email","ascending":false,"groupByUser":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingActivityUsersSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/landing-page-template/form-details": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the form details required to create or edit a phishing landing page template, including available categories and field options.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.LandingPageTemplate.Dto.LandingPageTemplateFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/landing-page-template/ai-limit": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the remaining AI generation quota for landing page template creation for the current company.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.CompanyAILimit.Dto.CompanyAILimitResponse, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/landing-page-template": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Creates a new phishing landing page template for the current company with HTML content, form fields, and redirect settings.", "requestBody": { "description": "The landing page template creation payload containing name, HTML content, and configuration.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LandingPageTemplate.CreateLandingPageTemplateRequest" }, "example": {"name":"Office 365 Login Page","description":"Simulates a Microsoft 365 sign-in page for credential harvesting","methodTypeId":1,"difficultyTypeId":1,"urlSchemaTypeId":1,"subDomain":"login","domainRecordId":1,"autoRotate":false,"pathTypeId":1,"extensionTypeId":1,"parameterTypeId":1,"landingPages":[{"resourceId":"Lp3Kx7mN2wRt","name":"Login Page","order":1,"content":"Your password will expire in 24 hours. Click here to reset it now.
", "IsPhishingFileModified": false, "PhishingTypeId": 1, "IsAssistedByAI": false, "IsPlainText": false }, "encoding": { "IsDuplicated": { "style": "form" }, "DuplicatedTemplateResourceId": { "style": "form" }, "Languages": { "style": "form" }, "BarrelPayload.Subject": { "style": "form" }, "BarrelPayload.Template": { "style": "form" }, "BarrelPayload.PhishingFile": { "style": "form" }, "BarrelPayload.PhishingFileType": { "style": "form" }, "BarrelPayload.PhishingFileName": { "style": "form" }, "BarrelPayload.IsPhishingFileModified": { "style": "form" }, "BarrelPayload.AttachmentFiles": { "style": "form" }, "BarrelPayload.AttachmentFilesToRemove": { "style": "form" }, "Name": { "style": "form" }, "Description": { "style": "form" }, "CategoryResourceId": { "style": "form" }, "DifficultyResourceId": { "style": "form" }, "LanguageTypeResourceId": { "style": "form" }, "Tags": { "style": "form" }, "Subject": { "style": "form" }, "FromName": { "style": "form" }, "FromAddress": { "style": "form" }, "CcAddresses": { "style": "form" }, "Template": { "style": "form" }, "AvailableForRequests": { "style": "form" }, "AttachmentFiles": { "style": "form" }, "PhishingFile": { "style": "form" }, "PhishingFileType": { "style": "form" }, "IsPhishingFileModified": { "style": "form" }, "PhishingFileName": { "style": "form" }, "PhishingTypeId": { "style": "form" }, "Prompt": { "style": "form" }, "IsAssistedByAI": { "style": "form" }, "IsPlainText": { "style": "form" }, "ToneResourceId": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } }, "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the most recently AI-generated phishing email template content for the current company.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/phishing-simulator/translated-email-templates": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the list of AI-translated phishing email template variations for the current company.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.OpenAI.Dto.PsEmailTemplateTranslationResponseDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/phishing-simulator/email-templates/translate": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Initiates AI-powered translation of a phishing email template into the specified target languages.", "requestBody": { "description": "The translation request containing the source template and target language codes.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.TranslatePsEmailTemplateWithAIRequest" }, "example": {"languages":[],"template":"Your password will expire in 24 hours. Click here to reset it now.
","subject":"Action Required: Your Password Will Expire Soon"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.TranslatePsEmailTemplateWithAIRequest" }, "example": {"languages":[],"template":"Your password will expire in 24 hours. Click here to reset it now.
","subject":"Action Required: Your Password Will Expire Soon"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.TranslatePsEmailTemplateWithAIRequest" }, "example": {"languages":[],"template":"Your password will expire in 24 hours. Click here to reset it now.
","subject":"Action Required: Your Password Will Expire Soon"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.TranslatePsEmailTemplateWithAIRequest" }, "example": {"languages":[],"template":"Your password will expire in 24 hours. Click here to reset it now.
","subject":"Action Required: Your Password Will Expire Soon"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.BooleanResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/email-templates/generate": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Initiates AI-powered generation of a phishing email template based on the provided prompt, category, and language preferences.", "requestBody": { "description": "The AI generation request containing the prompt, language, and template configuration.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.GeneratePsEmailTemplateWithAIRequest" }, "example": {"name":"IT Password Reset Notice","languageTypeResourceId":"Ln2Kp5mR7vWx","subject":"Action Required: Your Password Will Expire Soon","fromName":"IT Service Desk","fromAddress":"it-support@example-corp.com","prompt":"Generate a convincing IT password reset email that urges the user to click a link to update their credentials before their account is locked.","phishingTypeId":1,"methodTypeId":1,"isPlainText":false,"toneResourceId":"Tn5Rp2nK7mWx","localizationResourceId":"Lc6Wp3mR8vKx"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.GeneratePsEmailTemplateWithAIRequest" }, "example": {"name":"IT Password Reset Notice","languageTypeResourceId":"Ln2Kp5mR7vWx","subject":"Action Required: Your Password Will Expire Soon","fromName":"IT Service Desk","fromAddress":"it-support@example-corp.com","prompt":"Generate a convincing IT password reset email that urges the user to click a link to update their credentials before their account is locked.","phishingTypeId":1,"methodTypeId":1,"isPlainText":false,"toneResourceId":"Tn5Rp2nK7mWx","localizationResourceId":"Lc6Wp3mR8vKx"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.GeneratePsEmailTemplateWithAIRequest" }, "example": {"name":"IT Password Reset Notice","languageTypeResourceId":"Ln2Kp5mR7vWx","subject":"Action Required: Your Password Will Expire Soon","fromName":"IT Service Desk","fromAddress":"it-support@example-corp.com","prompt":"Generate a convincing IT password reset email that urges the user to click a link to update their credentials before their account is locked.","phishingTypeId":1,"methodTypeId":1,"isPlainText":false,"toneResourceId":"Tn5Rp2nK7mWx","localizationResourceId":"Lc6Wp3mR8vKx"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.GeneratePsEmailTemplateWithAIRequest" }, "example": {"name":"IT Password Reset Notice","languageTypeResourceId":"Ln2Kp5mR7vWx","subject":"Action Required: Your Password Will Expire Soon","fromName":"IT Service Desk","fromAddress":"it-support@example-corp.com","prompt":"Generate a convincing IT password reset email that urges the user to click a link to update their credentials before their account is locked.","phishingTypeId":1,"methodTypeId":1,"isPlainText":false,"toneResourceId":"Tn5Rp2nK7mWx","localizationResourceId":"Lc6Wp3mR8vKx"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.BooleanResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/email-templates/ai-limit": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the remaining AI generation quota for phishing email template creation for the current company.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.CompanyAILimit.Dto.CompanyAILimitResponse, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/email-templates/ai-generation-options": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves all available AI template generation options including categories, tones, and language choices for phishing email templates.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.CompanyAILimit.Dto.CompanyAILimitResponse, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/email-templates/{resourceId}": { "put": { "tags": [ "Phishing Simulation" ], "summary": "Updates an existing phishing simulation email template identified by its resource ID with new content, subject, and settings.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the email template to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "CategoryResourceId", "Description", "FromAddress", "FromName", "Name", "Subject", "Template" ], "type": "object", "properties": { "Languages": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PsEmailTemplate.Dto.UpdatePsEmailTemplateLanguageDto" }, "description": "Localized language variants of the email template to update." }, "BarrelPayload.Subject": { "type": "string", "description": "Email subject line for the payload." }, "BarrelPayload.Template": { "type": "string", "description": "HTML or plain-text body content of the payload email." }, "BarrelPayload.PhishingFile": { "type": "string", "description": "Phishing attachment file for the payload email (tracked download).", "format": "binary" }, "BarrelPayload.PhishingFileType": { "type": "string", "description": "File type hint for the phishing file (e.g. \"exe\", \"pdf\")." }, "BarrelPayload.PhishingFileName": { "type": "string", "description": "Display name for the phishing file." }, "BarrelPayload.IsPhishingFileModified": { "type": "boolean", "description": "Update only: true when the phishing file was changed or removed. Sent with no PhishingFile and an\r\nempty PhishingFileName, it removes the payload's phishing file." }, "BarrelPayload.AttachmentFiles": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "Embedded attachment files for the payload email (not tracked)." }, "BarrelPayload.AttachmentFilesToRemove": { "type": "array", "items": { "type": "string" }, "description": "Update only: resource ids of the payload's embedded attachments to remove." }, "Name": { "maxLength": 64, "type": "string", "description": "Display name of the email template." }, "Description": { "type": "string", "description": "Description providing context about the template's purpose and content." }, "CategoryResourceId": { "type": "string", "description": "Resource identifier of the category this template belongs to." }, "DifficultyResourceId": { "type": "string", "description": "Resource identifier of the difficulty level assigned to this template." }, "LanguageTypeResourceId": { "type": "string", "description": "Resource identifier of the language type for localization." }, "Tags": { "type": "array", "items": { "type": "string" }, "description": "List of tag labels for categorizing and searching templates." }, "Subject": { "maxLength": 320, "type": "string", "description": "Email subject line used in the phishing simulation." }, "FromName": { "maxLength": 320, "type": "string", "description": "Sender display name shown in the email header." }, "FromAddress": { "maxLength": 320, "type": "string", "description": "Sender email address used in the From field." }, "CcAddresses": { "type": "array", "items": { "type": "string" }, "description": "List of CC (carbon copy) email addresses." }, "Template": { "maxLength": 10485760, "type": "string", "description": "HTML or plain-text body content of the email template." }, "AvailableForRequests": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.EntityAvailableFor.Dto.EntityAvailableForRequest" }, "description": "Visibility and sharing rules that control which entities can access this template." }, "AttachmentFiles": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "Attachment files included with the phishing simulation email." }, "PhishingFile": { "type": "string", "description": "Simulated malicious file attached to the phishing email for payload testing.", "format": "binary" }, "PhishingFileType": { "type": "string", "description": "MIME type or extension identifier of the phishing attachment file." }, "IsPhishingFileModified": { "type": "boolean", "description": "Whether the phishing attachment file has been modified since the last save." }, "PhishingFileName": { "type": "string", "description": "Original file name of the phishing attachment." }, "PhishingTypeId": { "type": "integer", "description": "Phishing type identifier classifying the simulation category.", "format": "int32" }, "Prompt": { "type": "string", "description": "AI prompt text used when the template content is AI-generated." }, "IsAssistedByAI": { "type": "boolean", "description": "Whether this template was generated or refined with AI assistance." }, "IsPlainText": { "type": "boolean", "description": "Whether the template body is plain text instead of HTML." }, "ToneResourceId": { "type": "string", "description": "Resource identifier of the writing tone applied to the template (e.g., formal, urgent)." } } }, "example": { "Name": "Updated IT Password Reset Notice", "Description": "Updated phishing simulation for IT password reset notification", "CategoryResourceId": "Ct4Kp8mR7xLn", "DifficultyResourceId": "Df3Kp8mR7xLv", "LanguageTypeResourceId": "Ln2Kp5mR7vWx", "Tags": [ "password-reset", "credential-harvesting" ], "Subject": "Urgent: Your Password Will Expire Soon", "FromName": "IT Service Desk", "FromAddress": "it-support@example-corp.com", "Template": "Your password will expire in 12 hours. Click here to reset it immediately.
", "IsPhishingFileModified": false, "PhishingTypeId": 1, "IsAssistedByAI": false, "IsPlainText": false }, "encoding": { "Languages": { "style": "form" }, "BarrelPayload.Subject": { "style": "form" }, "BarrelPayload.Template": { "style": "form" }, "BarrelPayload.PhishingFile": { "style": "form" }, "BarrelPayload.PhishingFileType": { "style": "form" }, "BarrelPayload.PhishingFileName": { "style": "form" }, "BarrelPayload.IsPhishingFileModified": { "style": "form" }, "BarrelPayload.AttachmentFiles": { "style": "form" }, "BarrelPayload.AttachmentFilesToRemove": { "style": "form" }, "Name": { "style": "form" }, "Description": { "style": "form" }, "CategoryResourceId": { "style": "form" }, "DifficultyResourceId": { "style": "form" }, "LanguageTypeResourceId": { "style": "form" }, "Tags": { "style": "form" }, "Subject": { "style": "form" }, "FromName": { "style": "form" }, "FromAddress": { "style": "form" }, "CcAddresses": { "style": "form" }, "Template": { "style": "form" }, "AvailableForRequests": { "style": "form" }, "AttachmentFiles": { "style": "form" }, "PhishingFile": { "style": "form" }, "PhishingFileType": { "style": "form" }, "IsPhishingFileModified": { "style": "form" }, "PhishingFileName": { "style": "form" }, "PhishingTypeId": { "style": "form" }, "Prompt": { "style": "form" }, "IsAssistedByAI": { "style": "form" }, "IsPlainText": { "style": "form" }, "ToneResourceId": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the full details of an existing phishing simulation email template by its resource ID.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the email template.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PsEmailTemplate.Dto.PsEmailTemplateDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Phishing Simulation" ], "summary": "Deletes an existing phishing simulation email template identified by its resource ID.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the email template to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/email-templates/bulk-delete": { "delete": { "tags": [ "Phishing Simulation" ], "summary": "Deletes multiple phishing simulation email templates in a single bulk operation based on the provided list of resource IDs.", "requestBody": { "description": "The bulk delete request containing the list of email template resource IDs to remove.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/email-templates/search": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns a paginated list of phishing simulation email templates for the current company, with filtering and sorting support.", "requestBody": { "description": "The search request containing pagination, sorting, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.Search.PsEmailTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"MethodTypeId","operator":"eq","value":"1"}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"IsPlainText","operator":"eq","value":"false"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"phishingTypeId":1} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.Search.PsEmailTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"MethodTypeId","operator":"eq","value":"1"}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"IsPlainText","operator":"eq","value":"false"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"phishingTypeId":1} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.Search.PsEmailTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"MethodTypeId","operator":"eq","value":"1"}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"IsPlainText","operator":"eq","value":"false"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"phishingTypeId":1} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.Search.PsEmailTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"MethodTypeId","operator":"eq","value":"1"}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"IsPlainText","operator":"eq","value":"false"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"phishingTypeId":1} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.PsEmailTemplate.Dto.SearchPsEmailTemplateDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/email-templates/search/export": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Exports the phishing simulation email template list to a downloadable file (CSV, Excel, or PDF) based on the current filters.", "requestBody": { "description": "The export request containing pagination, filter criteria, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/phishing-simulator/email-templates/merge-tags": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the list of available merge tags (dynamic placeholders) that can be used in phishing email templates.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/phishing-simulator/email-templates/download-attachment/{resourceId}": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Downloads the attachment file associated with a phishing email template by its resource ID.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the email template whose attachment to download.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/phishing-simulator/phishing-campaign-job-report/summary/{resourceId}/{instanceGroup}/email-templates/{templateResourceId}": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the email template used in a specific phishing campaign job instance for the campaign summary view.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "templateResourceId", "in": "path", "description": "The unique resource identifier of the email template.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PsEmailTemplate.Dto.PsEmailTemplateDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-scenario/form-details": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the form details required to create or edit a phishing scenario, including available email templates, landing pages, and categories.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingScenario.Dto.PhishingScenarioFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-scenario": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Creates a new phishing scenario that pairs an email template with a landing page template, and initiates red flag analysis for the mail template.", "requestBody": { "description": "The phishing scenario creation payload containing email template, landing page template, and category assignments.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.CreatePhishingScenarioRequest" }, "example": {"emailTemplateId":1,"name":"Password Reset Phishing Scenario","description":"Credential harvesting scenario simulating password reset notification","methodTypeId":1,"landingPageTemplateId":1,"categoryId":1,"languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["credential-harvesting","password"],"roleResourceIds":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.CreatePhishingScenarioRequest" }, "example": {"emailTemplateId":1,"name":"Password Reset Phishing Scenario","description":"Credential harvesting scenario simulating password reset notification","methodTypeId":1,"landingPageTemplateId":1,"categoryId":1,"languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["credential-harvesting","password"],"roleResourceIds":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.CreatePhishingScenarioRequest" }, "example": {"emailTemplateId":1,"name":"Password Reset Phishing Scenario","description":"Credential harvesting scenario simulating password reset notification","methodTypeId":1,"landingPageTemplateId":1,"categoryId":1,"languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["credential-harvesting","password"],"roleResourceIds":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.CreatePhishingScenarioRequest" }, "example": {"emailTemplateId":1,"name":"Password Reset Phishing Scenario","description":"Credential harvesting scenario simulating password reset notification","methodTypeId":1,"landingPageTemplateId":1,"categoryId":1,"languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["credential-harvesting","password"],"roleResourceIds":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/phishing-simulator/phishing-scenario/{resourceId}": { "put": { "tags": [ "Phishing Simulation" ], "summary": "Updates an existing phishing scenario identified by its resource ID, and re-triggers red flag analysis if the mail template changed.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing scenario to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated phishing scenario payload.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.UpdatePhishingScenarioRequest" }, "example": {"emailTemplateId":2,"mfaSenderNumberResourceId":"Mf5Tp3kW8xNv","name":"Updated Password Reset Scenario","description":"Updated credential harvesting scenario","methodTypeId":1,"landingPageTemplateId":1,"categoryId":1,"languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["credential-harvesting","password"],"roleResourceIds":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.UpdatePhishingScenarioRequest" }, "example": {"emailTemplateId":2,"mfaSenderNumberResourceId":"Mf5Tp3kW8xNv","name":"Updated Password Reset Scenario","description":"Updated credential harvesting scenario","methodTypeId":1,"landingPageTemplateId":1,"categoryId":1,"languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["credential-harvesting","password"],"roleResourceIds":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.UpdatePhishingScenarioRequest" }, "example": {"emailTemplateId":2,"mfaSenderNumberResourceId":"Mf5Tp3kW8xNv","name":"Updated Password Reset Scenario","description":"Updated credential harvesting scenario","methodTypeId":1,"landingPageTemplateId":1,"categoryId":1,"languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["credential-harvesting","password"],"roleResourceIds":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.UpdatePhishingScenarioRequest" }, "example": {"emailTemplateId":2,"mfaSenderNumberResourceId":"Mf5Tp3kW8xNv","name":"Updated Password Reset Scenario","description":"Updated credential harvesting scenario","methodTypeId":1,"landingPageTemplateId":1,"categoryId":1,"languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["credential-harvesting","password"],"roleResourceIds":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Phishing Simulation" ], "summary": "Deletes a phishing scenario identified by its resource ID.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing scenario to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the full details of an existing phishing scenario by its resource ID, including linked email and landing page templates.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing scenario.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingScenario.Dto.PhishingScenarioDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-scenario/bulk-delete": { "delete": { "tags": [ "Phishing Simulation" ], "summary": "Deletes multiple phishing scenarios in a single bulk operation based on the provided list of resource IDs.", "requestBody": { "description": "The bulk delete request containing the list of scenario resource IDs to remove.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-scenario/scenario-statistics": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves aggregated statistics for all phishing scenarios grouped by category, including usage counts and success rates.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingScenario.Dto.PhishingScenarioStatisticsGroupByDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-scenario/search": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns a paginated list of phishing scenarios for the current company, with support for filtering by campaign, roles, and other criteria.", "requestBody": { "description": "The search request containing pagination, sorting, filter criteria, and optional campaign/role filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.PhishingScenarioSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"templateTypes":[],"roleResourceIds":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.PhishingScenarioSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"templateTypes":[],"roleResourceIds":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.PhishingScenarioSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"templateTypes":[],"roleResourceIds":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.PhishingScenarioSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"templateTypes":[],"roleResourceIds":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.PhishingScenario.Dto.PhishingScenarioSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-scenario/search/export": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Exports the phishing scenario list to a downloadable file (CSV, Excel, or PDF) based on the current search filters.", "requestBody": { "description": "The export request containing pagination, filter criteria, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/phishing-simulator/phishing-scenario/preview/{resourceId}": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves a preview of a phishing scenario including the rendered email template and landing page by scenario resource ID.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the phishing scenario to preview.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingScenario.Dto.PhishingScenarioPreviewDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-scenario/preview/{emailTemplateResourceId}/{landingPageTemplateResourceId}": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Previews a phishing scenario by combining a specific email template and landing page template by their resource IDs.", "parameters": [ { "name": "emailTemplateResourceId", "in": "path", "description": "The resource ID of the email template to use in the preview.", "required": true, "schema": { "type": "string" } }, { "name": "landingPageTemplateResourceId", "in": "path", "description": "The resource ID of the landing page template to use in the preview.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingScenario.Dto.PhishingScenarioPreviewDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/phishing-simulator/phishing-scenario/mfa-phone-number": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the list of available MFA phone numbers that can be used for SMS-based MFA verification in phishing scenarios.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.PhishingScenario.Dto.SmsPhoneNumberDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/phishing-simulator/phishing-scenario/search/category-info": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns a paginated list of phishing scenario category information with usage statistics and scenario counts per category.", "requestBody": { "description": "The search request containing pagination, sorting, and filter criteria for category info.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.PhishingScenarioCategoryInfoSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":true} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.PhishingScenarioCategoryInfoSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":true} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.PhishingScenarioCategoryInfoSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":true} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.PhishingScenarioCategoryInfoSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Name","ascending":true} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.PhishingScenario.Dto.PhishingScenarioCategoryInfoSearchViewDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/text-templates": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Creates a new SMS text template for the smishing (SMS phishing) simulator with message content and merge tag configuration.", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "CategoryResourceId", "Description", "FromAddress", "FromName", "Name", "Subject", "Template" ], "type": "object", "properties": { "IsDuplicated": { "type": "boolean", "description": "Indicates whether this template was duplicated from an existing one." }, "DuplicatedTemplateResourceId": { "type": "string", "description": "Resource identifier of the original template when duplicating." }, "Name": { "maxLength": 64, "type": "string", "description": "Template display name." }, "Description": { "type": "string", "description": "Description of the template's purpose and content." }, "CategoryResourceId": { "type": "string", "description": "Resource identifier of the phishing scenario category." }, "DifficultyResourceId": { "type": "string", "description": "Resource identifier of the template difficulty level." }, "LanguageTypeResourceId": { "type": "string", "description": "Resource identifier of the template language." }, "Tags": { "type": "array", "items": { "type": "string" }, "description": "Searchable tags associated with the template." }, "Subject": { "maxLength": 320, "type": "string", "description": "Email subject line used in the phishing simulation." }, "FromName": { "maxLength": 320, "type": "string", "description": "Display name of the email sender." }, "FromAddress": { "maxLength": 320, "type": "string", "description": "Email address shown as the sender." }, "Template": { "maxLength": 10485760, "type": "string", "description": "HTML body content of the email template." }, "AvailableForRequests": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.EntityAvailableFor.Dto.EntityAvailableForRequest" }, "description": "Visibility rules controlling which companies or groups can use this template." }, "AttachmentFiles": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "File attachments to include in the phishing email." }, "PhishingFile": { "type": "string", "description": "Weaponized file attachment for credential harvesting or payload delivery.", "format": "binary" }, "PhishingFileType": { "type": "string", "description": "MIME type or category of the phishing file (e.g., macro, executable)." }, "IsPhishingFileModified": { "type": "boolean", "description": "Indicates whether the phishing file has been changed since last save." }, "PhishingFileName": { "type": "string", "description": "Original file name of the phishing attachment." } } }, "example": { "IsDuplicated": false, "Name": "Bank Account Verification SMS", "Description": "Simulates a bank account verification SMS to harvest credentials", "CategoryResourceId": "Ct4Kp8mR7xLn", "DifficultyResourceId": "Df3Kp8mR7xLv", "LanguageTypeResourceId": "Ln2Kp5mR7vWx", "Tags": [ "smishing", "banking" ], "Subject": "Account Alert", "FromName": "MyBank Security", "FromAddress": "+15551234567", "Template": "ALERT: Unusual activity detected on your account. Verify your identity now: {{phishing_url}}", "IsPhishingFileModified": false }, "encoding": { "IsDuplicated": { "style": "form" }, "DuplicatedTemplateResourceId": { "style": "form" }, "Name": { "style": "form" }, "Description": { "style": "form" }, "CategoryResourceId": { "style": "form" }, "DifficultyResourceId": { "style": "form" }, "LanguageTypeResourceId": { "style": "form" }, "Tags": { "style": "form" }, "Subject": { "style": "form" }, "FromName": { "style": "form" }, "FromAddress": { "style": "form" }, "Template": { "style": "form" }, "AvailableForRequests": { "style": "form" }, "AttachmentFiles": { "style": "form" }, "PhishingFile": { "style": "form" }, "PhishingFileType": { "style": "form" }, "IsPhishingFileModified": { "style": "form" }, "PhishingFileName": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/smishing-simulator/text-templates/{resourceId}": { "put": { "tags": [ "Phishing Simulation" ], "summary": "Updates an existing smishing SMS text template identified by its resource ID with new message content and configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the text template to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "CategoryResourceId", "Description", "FromAddress", "FromName", "Name", "Subject", "Template" ], "type": "object", "properties": { "Name": { "maxLength": 64, "type": "string", "description": "Template display name." }, "Description": { "type": "string", "description": "Description of the template's purpose and content." }, "CategoryResourceId": { "type": "string", "description": "Resource identifier of the phishing scenario category." }, "DifficultyResourceId": { "type": "string", "description": "Resource identifier of the template difficulty level." }, "LanguageTypeResourceId": { "type": "string", "description": "Resource identifier of the template language." }, "Tags": { "type": "array", "items": { "type": "string" }, "description": "Searchable tags associated with the template." }, "Subject": { "maxLength": 320, "type": "string", "description": "Email subject line used in the phishing simulation." }, "FromName": { "maxLength": 320, "type": "string", "description": "Display name of the email sender." }, "FromAddress": { "maxLength": 320, "type": "string", "description": "Email address shown as the sender." }, "Template": { "maxLength": 10485760, "type": "string", "description": "HTML body content of the email template." }, "AvailableForRequests": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.EntityAvailableFor.Dto.EntityAvailableForRequest" }, "description": "Visibility rules controlling which companies or groups can use this template." }, "AttachmentFiles": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "File attachments to include in the phishing email." }, "PhishingFile": { "type": "string", "description": "Weaponized file attachment for credential harvesting or payload delivery.", "format": "binary" }, "PhishingFileType": { "type": "string", "description": "MIME type or category of the phishing file (e.g., macro, executable)." }, "IsPhishingFileModified": { "type": "boolean", "description": "Indicates whether the phishing file has been changed since last save." }, "PhishingFileName": { "type": "string", "description": "Original file name of the phishing attachment." } } }, "example": { "Name": "Updated Bank Account Verification SMS", "Description": "Updated smishing simulation for bank account verification", "CategoryResourceId": "Ct4Kp8mR7xLn", "DifficultyResourceId": "Df3Kp8mR7xLv", "LanguageTypeResourceId": "Ln2Kp5mR7vWx", "Tags": [ "smishing", "banking" ], "Subject": "Urgent Account Alert", "FromName": "MyBank Security", "FromAddress": "+15551234567", "Template": "URGENT: Your account has been temporarily locked. Verify now: {{phishing_url}}", "IsPhishingFileModified": false }, "encoding": { "Name": { "style": "form" }, "Description": { "style": "form" }, "CategoryResourceId": { "style": "form" }, "DifficultyResourceId": { "style": "form" }, "LanguageTypeResourceId": { "style": "form" }, "Tags": { "style": "form" }, "Subject": { "style": "form" }, "FromName": { "style": "form" }, "FromAddress": { "style": "form" }, "Template": { "style": "form" }, "AvailableForRequests": { "style": "form" }, "AttachmentFiles": { "style": "form" }, "PhishingFile": { "style": "form" }, "PhishingFileType": { "style": "form" }, "IsPhishingFileModified": { "style": "form" }, "PhishingFileName": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the full details of an existing smishing SMS text template by its resource ID.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the text template.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PsTextTemplate.Dto.PsTextTemplateDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Phishing Simulation" ], "summary": "Deletes an existing smishing SMS text template identified by its resource ID.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the text template to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/text-templates/bulk-delete": { "delete": { "tags": [ "Phishing Simulation" ], "summary": "Deletes multiple smishing SMS text templates in a single bulk operation based on the provided list of resource IDs.", "requestBody": { "description": "The bulk delete request containing the list of text template resource IDs to remove.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/text-templates/search": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Searches and returns a paginated list of smishing SMS text templates for the current company, with filtering and sorting support.", "requestBody": { "description": "The search request containing pagination, sorting, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsTextTemplate.Search.PsTextTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Name","operator":"contains","value":""}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"CategoryResourceId","operator":"eq","value":""}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsTextTemplate.Search.PsTextTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Name","operator":"contains","value":""}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"CategoryResourceId","operator":"eq","value":""}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsTextTemplate.Search.PsTextTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Name","operator":"contains","value":""}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"CategoryResourceId","operator":"eq","value":""}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsTextTemplate.Search.PsTextTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Name","operator":"contains","value":""}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"CategoryResourceId","operator":"eq","value":""}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.PsTextTemplate.Dto.SearchPsTextTemplateDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/text-templates/search/export": { "post": { "tags": [ "Phishing Simulation" ], "summary": "Exports the smishing SMS text template list to a downloadable file (CSV, Excel, or PDF) based on the current search filters.", "requestBody": { "description": "The export request containing pagination, filter criteria, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/smishing-simulator/text-templates/merge-tags": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the list of available merge tags (dynamic placeholders) that can be used in smishing text templates.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job-report/summary/{resourceId}/{instanceGroup}/text-templates/{templateResourceId}": { "get": { "tags": [ "Phishing Simulation" ], "summary": "Retrieves the text template used in a specific smishing campaign job instance for the campaign summary view.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "templateResourceId", "in": "path", "description": "The unique resource identifier of the text template.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PsTextTemplate.Dto.PsTextTemplateDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign/form-details": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the form details required to create or edit a QR phishing (quishing) campaign, including available options and default values.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.QuishingCampaign.Dto.QuishingCampaignFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign/search": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Searches and returns a paginated list of QR phishing (quishing) campaigns for the current company, with support for filtering, sorting, and pagination.", "requestBody": { "description": "Search criteria including pagination, sort order, and optional filter conditions.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"awareness","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreatedDate","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"awareness","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreatedDate","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"awareness","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreatedDate","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"awareness","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreatedDate","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.QuishingCampaign.Dto.QuishingCampaignSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Creates a new QR phishing (quishing) campaign for the current company with the specified configuration, target groups, and scheduling options.", "requestBody": { "description": "The quishing campaign creation payload including scenario, target groups, schedule, and delivery settings.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.CreateQuishingCampaignRequest" }, "example": {"quishingScenarios":[{"quishingScenarioResourceId":"Qs5Rm8vT3nKp","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately"}],"quishingScenarioResourceIds":["Qs5Rm8vT3nKp"],"smtpSettingResourceId":"Sm8pW3nR5vQx","distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"emailDeliverySettingType":1,"templateType":"Email","name":"Q1 2026 QR Code Phishing Simulation","description":"QR code phishing simulation targeting office staff with embedded QR codes","scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"distributionStartTypeId":1,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"frequency":"OneTime","awardCertificate":true,"categoryDistributionType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.CreateQuishingCampaignRequest" }, "example": {"quishingScenarios":[{"quishingScenarioResourceId":"Qs5Rm8vT3nKp","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately"}],"quishingScenarioResourceIds":["Qs5Rm8vT3nKp"],"smtpSettingResourceId":"Sm8pW3nR5vQx","distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"emailDeliverySettingType":1,"templateType":"Email","name":"Q1 2026 QR Code Phishing Simulation","description":"QR code phishing simulation targeting office staff with embedded QR codes","scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"distributionStartTypeId":1,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"frequency":"OneTime","awardCertificate":true,"categoryDistributionType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.CreateQuishingCampaignRequest" }, "example": {"quishingScenarios":[{"quishingScenarioResourceId":"Qs5Rm8vT3nKp","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately"}],"quishingScenarioResourceIds":["Qs5Rm8vT3nKp"],"smtpSettingResourceId":"Sm8pW3nR5vQx","distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"emailDeliverySettingType":1,"templateType":"Email","name":"Q1 2026 QR Code Phishing Simulation","description":"QR code phishing simulation targeting office staff with embedded QR codes","scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"distributionStartTypeId":1,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"frequency":"OneTime","awardCertificate":true,"categoryDistributionType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.CreateQuishingCampaignRequest" }, "example": {"quishingScenarios":[{"quishingScenarioResourceId":"Qs5Rm8vT3nKp","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately"}],"quishingScenarioResourceIds":["Qs5Rm8vT3nKp"],"smtpSettingResourceId":"Sm8pW3nR5vQx","distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"emailDeliverySettingType":1,"templateType":"Email","name":"Q1 2026 QR Code Phishing Simulation","description":"QR code phishing simulation targeting office staff with embedded QR codes","scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"distributionStartTypeId":1,"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"frequency":"OneTime","awardCertificate":true,"categoryDistributionType":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign/{resourceId}": { "put": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Updates an existing QR phishing (quishing) campaign identified by its resource ID, allowing modification of scenario, targets, schedule, and delivery settings.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated quishing campaign payload with modified configuration fields.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.UpdateQuishingCampaignRequest" }, "example": {"quishingScenarios":[{"quishingScenarioResourceId":"Qs5Rm8vT3nKp","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately"}],"smtpSettingResourceId":"Sm8pW3nR5vQx","emailDeliverySettingType":1,"quishingScenarioResourceIds":["Qs5Rm8vT3nKp"],"resourceId":"Qc3Lm7vR8nKp","name":"Q2 2026 Updated QR Code Campaign","description":"Updated QR code phishing simulation for office staff","distributionStartTypeId":1,"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"awardCertificate":true,"categoryDistributionType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.UpdateQuishingCampaignRequest" }, "example": {"quishingScenarios":[{"quishingScenarioResourceId":"Qs5Rm8vT3nKp","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately"}],"smtpSettingResourceId":"Sm8pW3nR5vQx","emailDeliverySettingType":1,"quishingScenarioResourceIds":["Qs5Rm8vT3nKp"],"resourceId":"Qc3Lm7vR8nKp","name":"Q2 2026 Updated QR Code Campaign","description":"Updated QR code phishing simulation for office staff","distributionStartTypeId":1,"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"awardCertificate":true,"categoryDistributionType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.UpdateQuishingCampaignRequest" }, "example": {"quishingScenarios":[{"quishingScenarioResourceId":"Qs5Rm8vT3nKp","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately"}],"smtpSettingResourceId":"Sm8pW3nR5vQx","emailDeliverySettingType":1,"quishingScenarioResourceIds":["Qs5Rm8vT3nKp"],"resourceId":"Qc3Lm7vR8nKp","name":"Q2 2026 Updated QR Code Campaign","description":"Updated QR code phishing simulation for office staff","distributionStartTypeId":1,"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"awardCertificate":true,"categoryDistributionType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.UpdateQuishingCampaignRequest" }, "example": {"quishingScenarios":[{"quishingScenarioResourceId":"Qs5Rm8vT3nKp","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately"}],"smtpSettingResourceId":"Sm8pW3nR5vQx","emailDeliverySettingType":1,"quishingScenarioResourceIds":["Qs5Rm8vT3nKp"],"resourceId":"Qc3Lm7vR8nKp","name":"Q2 2026 Updated QR Code Campaign","description":"Updated QR code phishing simulation for office staff","distributionStartTypeId":1,"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":14,"sendingLimit":50,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"awardCertificate":true,"categoryDistributionType":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Deletes a QR phishing (quishing) campaign identified by its resource ID, removing all associated configuration and data.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the full details of an existing QR phishing (quishing) campaign by its resource ID, including scenario, target groups, and scheduling configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.QuishingCampaign.Dto.QuishingCampaignDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign/preview/{resourceId}": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Generates a preview of a QR phishing (quishing) campaign by its resource ID, showing how the campaign emails and landing pages will appear to target users.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign to preview.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaign.Dto.QuishingCampaignPreviewListDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign/print-preview/{resourceId}": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Generates a printable preview of a QR phishing (quishing) campaign, returning the rendered content as a downloadable file.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign to generate a print preview for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/quishing-simulator/quishing-campaign/preview/{smtpSettingResourceId}/{quishingScenarioResourceId}": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Generates a preview of a QR phishing (quishing) campaign by combining a specific SMTP setting and quishing scenario, showing how the email will be rendered.", "parameters": [ { "name": "smtpSettingResourceId", "in": "path", "description": "The resource ID of the SMTP delivery setting to use for the preview.", "required": true, "schema": { "type": "string" } }, { "name": "quishingScenarioResourceId", "in": "path", "description": "The resource ID of the quishing scenario to preview.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.QuishingCampaign.Dto.QuishingCampaignPreviewDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign/root-company-shared-smtp-resource-id": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Returns the resource ID of the most recently created shared SMTP settings from the root company, used as the default email delivery configuration for quishing campaigns.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign/search/export": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Exports the filtered list of QR phishing (quishing) campaigns as a downloadable file in the specified format (e.g., Excel, CSV).", "requestBody": { "description": "Export criteria including pagination, filters, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/quishing-simulator/quishing-campaign/calculate-sending-info": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Calculates the estimated sending information for a QR phishing campaign, including total target count and estimated delivery time based on the provided configuration.", "requestBody": { "description": "The campaign configuration parameters used to compute sending estimates.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.QuishingCalculateSendingInfoRequest" }, "example": {"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"sendingLimit":50,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"totalTargetUserCount":250} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.QuishingCalculateSendingInfoRequest" }, "example": {"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"sendingLimit":50,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"totalTargetUserCount":250} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.QuishingCalculateSendingInfoRequest" }, "example": {"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"sendingLimit":50,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"totalTargetUserCount":250} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.QuishingCalculateSendingInfoRequest" }, "example": {"distributionTypeId":2,"distributionDelayEvery":5,"distributionDelayTimeTypeId":2,"distributionEmailOver":100,"distributionEmailOverTimeTypeId":2,"sendingLimit":50,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"totalTargetUserCount":250} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.QuishingCampaign.Dto.QuishingCampaignSendingInfoViewModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign/bulk-delete": { "delete": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Deletes multiple QR phishing (quishing) campaigns in a single bulk operation based on the provided list of campaign identifiers.", "requestBody": { "description": "The bulk delete payload containing the list of quishing campaign items to remove.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.QuishingCampaignDeleteRequest" }, "example": {"items":["Qc3Lm7vR8nKp","Qc9Tp2kW5xNv"],"selectAll":false,"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.QuishingCampaignDeleteRequest" }, "example": {"items":["Qc3Lm7vR8nKp","Qc9Tp2kW5xNv"],"selectAll":false,"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.QuishingCampaignDeleteRequest" }, "example": {"items":["Qc3Lm7vR8nKp","Qc9Tp2kW5xNv"],"selectAll":false,"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.QuishingCampaignDeleteRequest" }, "example": {"items":["Qc3Lm7vR8nKp","Qc9Tp2kW5xNv"],"selectAll":false,"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign/calculate-schedule-info": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Calculates the schedule information for a QR phishing campaign, providing estimated start and end times based on the scheduling configuration and target group size.", "requestBody": { "description": "The scheduling parameters used to compute the campaign timeline.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.Base.QuishingCalculateScheduleInfoRequest" }, "example": {"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","frequency":1,"quishingScenarioResourceIds":["Qs5Rm8vT3nKp"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.Base.QuishingCalculateScheduleInfoRequest" }, "example": {"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","frequency":1,"quishingScenarioResourceIds":["Qs5Rm8vT3nKp"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.Base.QuishingCalculateScheduleInfoRequest" }, "example": {"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","frequency":1,"quishingScenarioResourceIds":["Qs5Rm8vT3nKp"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.Base.QuishingCalculateScheduleInfoRequest" }, "example": {"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","frequency":1,"quishingScenarioResourceIds":["Qs5Rm8vT3nKp"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.QuishingCampaign.Dto.QuishingCampaignScheduleInfoViewModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign/email-delivery-setting-list": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the list of available email delivery settings for quishing campaigns, including both SMTP configurations and direct email creation settings.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaign.Dto.EmailDeliverySettingModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job/form-details": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the form details required to create or manage a QR phishing (quishing) campaign job, including available instance groups and configuration options.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.QuishingCampaignJob.Dto.QuishingCampaignJobFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job/start/{resourceId}/{instanceGroup}": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Starts a new QR phishing (quishing) campaign job for a specific instance group of an existing campaign, initiating email delivery to the targeted users.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number to start the job for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job/start/{resourceId}": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Creates a new instance group and immediately starts a QR phishing (quishing) campaign job, logging the action as an audit event.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign to start.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Optional instance configuration overrides for the new campaign job.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.QuishingCampaignJob.Dto.QuishingCampaignInstance" }, "example": {"excludeFromReports":false,"scheduledDate":"2026-10-20 12:13:31","scheduledDateTimeZoneId":"UTC","scheduleTypeId":1,"targetGroupResourceIds":["Qw4Rt6yU8iOp"],"distributionStartTypeId":1,"sendingLimit":100,"distributionDelayTimeTypeId":1,"distributionDelayEvery":0,"useTargetUserTimeZone":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.QuishingCampaignJob.Dto.QuishingCampaignInstance" }, "example": {"excludeFromReports":false,"scheduledDate":"2026-10-20 12:13:31","scheduledDateTimeZoneId":"UTC","scheduleTypeId":1,"targetGroupResourceIds":["Qw4Rt6yU8iOp"],"distributionStartTypeId":1,"sendingLimit":100,"distributionDelayTimeTypeId":1,"distributionDelayEvery":0,"useTargetUserTimeZone":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.QuishingCampaignJob.Dto.QuishingCampaignInstance" }, "example": {"excludeFromReports":false,"scheduledDate":"2026-10-20 12:13:31","scheduledDateTimeZoneId":"UTC","scheduleTypeId":1,"targetGroupResourceIds":["Qw4Rt6yU8iOp"],"distributionStartTypeId":1,"sendingLimit":100,"distributionDelayTimeTypeId":1,"distributionDelayEvery":0,"useTargetUserTimeZone":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.QuishingCampaignJob.Dto.QuishingCampaignInstance" }, "example": {"excludeFromReports":false,"scheduledDate":"2026-10-20 12:13:31","scheduledDateTimeZoneId":"UTC","scheduleTypeId":1,"targetGroupResourceIds":["Qw4Rt6yU8iOp"],"distributionStartTypeId":1,"sendingLimit":100,"distributionDelayTimeTypeId":1,"distributionDelayEvery":0,"useTargetUserTimeZone":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job/stop/{resourceId}/{instanceGroup}": { "patch": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Stops a running QR phishing (quishing) campaign job for the specified campaign and instance group, halting further email delivery.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the job to stop.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job/{resourceId}/{instanceGroup}": { "delete": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Deletes a QR phishing (quishing) campaign job for the specified campaign and instance group, removing all associated job data and user tracking records.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the job to delete.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job/resend/{resourceId}/{instanceGroup}": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Resends the QR phishing (quishing) campaign job emails to users filtered by activity types (e.g., not opened, not clicked), logging the resend action for audit.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the job to resend.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The resend criteria specifying which user activity types to target.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersRequest" }, "example": {"types":["NoResponse"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersRequest" }, "example": {"types":["NoResponse"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersRequest" }, "example": {"types":["NoResponse"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersRequest" }, "example": {"types":["NoResponse"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job/resend/list/{resourceId}/{instanceGroup}": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Resends the QR phishing (quishing) campaign job emails to a specific list of users, with options to select all, exclude certain users, or apply filters.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the job to resend.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The resend criteria with user selection options including include/exclude lists and filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersListRequest" }, "example": {"items":["Tu3Kp8mR7xLv","Tu6Wn4vT9nQs"],"selectAll":false,"excludedItems":[],"searchType":"NoResponse"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersListRequest" }, "example": {"items":["Tu3Kp8mR7xLv","Tu6Wn4vT9nQs"],"selectAll":false,"excludedItems":[],"searchType":"NoResponse"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersListRequest" }, "example": {"items":["Tu3Kp8mR7xLv","Tu6Wn4vT9nQs"],"selectAll":false,"excludedItems":[],"searchType":"NoResponse"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersListRequest" }, "example": {"items":["Tu3Kp8mR7xLv","Tu6Wn4vT9nQs"],"selectAll":false,"excludedItems":[],"searchType":"NoResponse"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job/email-activity/{resourceId}": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the detailed email activity timeline for a specific user within a QR phishing (quishing) campaign job, including delivery, open, click, and submission events.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the campaign job user record to retrieve activity for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job/download-individual/{resourceId}/{instanceGroup}": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Downloads a PDF document containing the QR code content for a specific quishing campaign job and instance group, suitable for physical distribution.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number to download the PDF for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/quishing-simulator/quishing-campaign-job-report/summary/{resourceId}/{instanceGroup}": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the summary report for a QR phishing (quishing) campaign job, including statistics on email delivery, opens, clicks, submissions, and overall engagement rates.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number to retrieve the summary for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignSummaryResult, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job-report/summary/training/{resourceId}/{instanceGroup}": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the training-focused summary report for a QR phishing (quishing) campaign job, providing statistics filtered to training-related metrics such as completion and awareness improvement.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number to retrieve the training summary for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignSummaryResult, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job-report/summary/target-groups/{resourceId}/{instanceGroup}": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the target groups and their summarized user lists for a specific QR phishing (quishing) campaign job instance, showing group-level engagement metrics.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number to retrieve target groups for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.QuishingCampaignJob.Dto.QuishingCampaignTargetGroupsResult, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job-report/{resourceId}/search": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Searches and returns a paginated list of campaign job instances belonging to a specific QR phishing (quishing) campaign, with support for filtering by frequency group.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the parent quishing campaign.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including pagination, sort order, frequency group filter, and optional filter conditions.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.QuishingCampaignJob.SearchQuishingCampaignJobRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false,"phishingCampaignFrequencyGroup":0,"searchType":"All"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.QuishingCampaignJob.SearchQuishingCampaignJobRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false,"phishingCampaignFrequencyGroup":0,"searchType":"All"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.QuishingCampaignJob.SearchQuishingCampaignJobRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false,"phishingCampaignFrequencyGroup":0,"searchType":"All"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.QuishingCampaignJob.SearchQuishingCampaignJobRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false,"phishingCampaignFrequencyGroup":0,"searchType":"All"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.QuishingCampaignJob.Search.QuishingCampaignJobSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job-report/search": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Searches and returns a paginated list of all QR phishing (quishing) campaign job reports across campaigns, with support for filtering, sorting, and pagination.", "requestBody": { "description": "Search criteria including pagination, sort order, and optional filter conditions.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobReportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobReportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobReportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobReportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.QuishingCampaignJob.Search.QuishingCampaignJobReportSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job-report/search/export": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Exports the filtered list of QR phishing (quishing) campaign job reports as a downloadable file in the specified format (e.g., Excel, CSV).", "requestBody": { "description": "Export criteria including pagination, filters, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/quishing-simulator/quishing-campaign-job-report/{resourceId}/search/export": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Exports the list of campaign job instances for a specific QR phishing (quishing) campaign as a downloadable file, with support for frequency group filtering.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the parent quishing campaign.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Export criteria including pagination, filters, frequency group, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ExportQuishingCampaignJobRequest" }, "example": {"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","phishingCampaignFrequencyGroup":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ExportQuishingCampaignJobRequest" }, "example": {"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","phishingCampaignFrequencyGroup":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ExportQuishingCampaignJobRequest" }, "example": {"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","phishingCampaignFrequencyGroup":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ExportQuishingCampaignJobRequest" }, "example": {"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","phishingCampaignFrequencyGroup":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/quishing-simulator/quishing-campaign-job-report/{searchType}/search/{resourceId}/{instanceGroup}": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Searches and returns a paginated list of users targeted by a QR phishing (quishing) campaign job, filtered by the specified search type (e.g., all, clicked, opened, submitted).", "parameters": [ { "name": "searchType", "in": "path", "description": "The user activity category to filter by (e.g., All, Clicked, Opened, Submitted, Reported).", "required": true, "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignJobUserSearchType" } }, { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number to search users within.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Search criteria including pagination, sort order, activity type filter, and optional filter conditions.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.CustomPhishingCampaignJobUsersPagedResults`1[[KeepnetLabs.ApplicationService.QuishingCampaignJob.Dto.QuishingCampaignJobUsersSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job-report/printout-users/search/{resourceId}/{instanceGroup}": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Searches and returns a paginated list of users for the individual printout report of a QR phishing (quishing) campaign job, used for generating per-user QR code documents.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number to search printout users within.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Search criteria including pagination, sort order, and optional filter conditions.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.QuishingCampaignJob.Dto.QuishingCampaignJobPrintoutUsersSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job-report/{searchType}/search/export/{resourceId}/{instanceGroup}": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Exports the list of users targeted by a QR phishing (quishing) campaign job as a downloadable file, filtered by the specified activity search type.", "parameters": [ { "name": "searchType", "in": "path", "description": "The user activity category to filter by (e.g., All, Clicked, Opened, Submitted, Reported).", "required": true, "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignJobUserSearchType" } }, { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number to export users from.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Export criteria including pagination, filters, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.QuishingCampaignJob.Dto.QuishingCampaignJobUsersSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job-report/search-email-clicked/{resourceId}": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Searches and returns a paginated list of email click events for a specific user within a QR phishing (quishing) campaign job, showing when and how many times the user clicked the phishing link.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the campaign job user record.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including pagination, sort order, and optional filter conditions.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.QuishingCampaignJob.Dto.QuishingCampaignJobUserEmailClickedSearchViewDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job-report/search-email-opened/{resourceId}": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Searches and returns a paginated list of email open events for a specific user within a QR phishing (quishing) campaign job, showing when and how many times the user opened the email.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the campaign job user record.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including pagination, sort order, and optional filter conditions.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.QuishingCampaignJob.Dto.QuishingCampaignJobUserEmailOpenedSearchViewDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job-report/search-email-submitted/{resourceId}": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Searches and returns a paginated list of form submission events for a specific user within a QR phishing (quishing) campaign job, showing credentials or data submitted on the landing page.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the campaign job user record.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including pagination, sort order, and optional filter conditions.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.QuishingCampaignJob.Dto.QuishingCampaignJobUserEmailSubmittedSearchViewDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job-report/search-email-reported/{resourceId}": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Searches and returns a paginated list of phishing report events for a specific user within a QR phishing (quishing) campaign job, showing when the user reported the email as suspicious.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the campaign job user record.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including pagination, sort order, and optional filter conditions.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.QuishingCampaignJob.Dto.QuishingCampaignJobUserEmailReportedSearchViewDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job-report/search-all/{resourceId}": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Searches and returns a paginated list of all email activity events for a specific user within a QR phishing (quishing) campaign job, combining open, click, submission, and report events.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the campaign job user record.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including pagination, sort order, and optional filter conditions.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.QuishingCampaignJob.Dto.QuishingCampaignJobUserEmailAllSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job-report/export/{resourceId}/{instanceGroup}": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Exports a comprehensive Excel report for a specific QR phishing (quishing) campaign job, including detailed user activity, engagement metrics, and campaign configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number to generate the detailed report for.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/quishing-simulator/quishing-campaign-job-report/search-mfa-submitted/{resourceId}": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Searches and returns a paginated list of MFA submission events for a specific user within a QR phishing (quishing) campaign job, showing when and what MFA credentials were submitted on the landing page.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the campaign job user record.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including pagination, sort order, and optional filter conditions.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.QuishingCampaignJob.Dto.QuishingCampaignJobUserEmailMfaSubmittedSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/dns-services/form-details": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the form details required to create or edit a DNS service provider configuration for the quishing simulator, including available provider types and settings.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.DnsService.Dto.DnsServiceFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/dns-services": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Creates a new DNS service provider configuration for the quishing simulator, defining the DNS provider credentials and settings used for domain management.", "requestBody": { "description": "The DNS service provider creation payload including provider type, API credentials, and configuration settings.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.CreateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.CreateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.CreateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.CreateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/quishing-simulator/dns-services/{resourceId}": { "put": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Updates an existing DNS service provider configuration for the quishing simulator, allowing modification of credentials, provider type, or settings.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the DNS service provider to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated DNS service provider payload with modified fields.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.UpdateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production Updated","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.UpdateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production Updated","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.UpdateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production Updated","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.UpdateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production Updated","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Deletes a DNS service provider configuration from the quishing simulator by its resource ID.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the DNS service provider to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the full details of an existing DNS service provider configuration by its resource ID, including provider type, credentials, and associated settings.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the DNS service provider to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.DnsService.Dto.DnsServiceProviderDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/dns-services/search": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Searches and returns a paginated list of DNS service provider configurations for the quishing simulator, with support for filtering, sorting, and pagination.", "requestBody": { "description": "Search criteria including pagination, sort order, and optional filter conditions.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.DnServiceProviderSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.DnServiceProviderSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.DnServiceProviderSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.DnServiceProviderSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.DnsService.Search.DnsServiceProviderSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/dns-services/search/export": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Exports the filtered list of DNS service provider configurations as a downloadable file in the specified format (e.g., Excel, CSV).", "requestBody": { "description": "Export criteria including pagination, filters, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/quishing-simulator/dns-services/{resourceId}/test": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Tests the connectivity and authentication of a DNS service provider configuration by performing a validation request against the provider's API.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the DNS service provider to test.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The test parameters including DNS zone or domain information to validate.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.TestDnsServiceProviderRequest" }, "example": {"resourceId":"65BVv1136Vnp","dnsServiceProviderTypeId":1,"username":"api-key@example.com","password":"api-secret-token"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.TestDnsServiceProviderRequest" }, "example": {"resourceId":"65BVv1136Vnp","dnsServiceProviderTypeId":1,"username":"api-key@example.com","password":"api-secret-token"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.TestDnsServiceProviderRequest" }, "example": {"resourceId":"65BVv1136Vnp","dnsServiceProviderTypeId":1,"username":"api-key@example.com","password":"api-secret-token"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.TestDnsServiceProviderRequest" }, "example": {"resourceId":"65BVv1136Vnp","dnsServiceProviderTypeId":1,"username":"api-key@example.com","password":"api-secret-token"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/domain-records/form-details": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the form details required to create or edit a domain record for the quishing simulator, including available DNS providers and domain configuration options.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.DomainRecord.Dto.DomainRecordFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/domain-records/test": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Tests the validity of a domain record configuration by verifying the DNS zone ID against the specified DNS provider, ensuring the domain can be managed correctly.", "requestBody": { "description": "The test parameters including DNS provider reference and zone identification details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.TestDomainRecordRequest" }, "example": {"dnsServiceProviderId":1,"zoneId":"abc123def456"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.TestDomainRecordRequest" }, "example": {"dnsServiceProviderId":1,"zoneId":"abc123def456"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.TestDomainRecordRequest" }, "example": {"dnsServiceProviderId":1,"zoneId":"abc123def456"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.TestDomainRecordRequest" }, "example": {"dnsServiceProviderId":1,"zoneId":"abc123def456"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/domain-records": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Creates a new domain record for the quishing simulator, associating a domain with a DNS provider for use in QR phishing campaign landing pages.", "requestBody": { "description": "The domain record creation payload including domain name, DNS provider reference, and zone configuration.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+CreateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.50","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+CreateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.50","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+CreateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.50","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+CreateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.50","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/quishing-simulator/domain-records/{resourceId}": { "put": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Updates an existing domain record for the quishing simulator, allowing modification of the domain name, DNS provider, or zone configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the domain record to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated domain record payload with modified fields.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+UpdateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.51","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+UpdateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.51","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+UpdateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.51","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+UpdateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.51","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Deletes a domain record from the quishing simulator by its resource ID, removing the domain association and DNS configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the domain record to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the full details of an existing domain record by its resource ID, including domain name, DNS provider association, and zone configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the domain record to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.DomainRecord.Dto.DomainRecordDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/domain-records/search": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Searches and returns a paginated list of domain records for the quishing simulator, with support for filtering, sorting, and pagination.", "requestBody": { "description": "Search criteria including pagination, sort order, and optional filter conditions.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+DomainRecordSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":true} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+DomainRecordSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":true} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+DomainRecordSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":true} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+DomainRecordSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":true} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.DomainRecord.Dto.DomainRecordSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/domain-records/search/export": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Exports the filtered list of domain records as a downloadable file in the specified format (e.g., Excel, CSV).", "requestBody": { "description": "Export criteria including pagination, filters, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/quishing-simulator/excluded-ip": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Creates or updates the excluded IP address list for QR phishing (quishing) campaigns, preventing tracking events from specified IP addresses (e.g., security scanners, corporate proxies).", "requestBody": { "description": "The excluded IP creation payload containing the list of IP addresses or CIDR ranges to exclude.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ExcludedIP.CreatePhishingCampaignExcludedIPRequest" }, "example": {"excludedIPs":["10.0.0.1","192.168.1.0/24"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ExcludedIP.CreatePhishingCampaignExcludedIPRequest" }, "example": {"excludedIPs":["10.0.0.1","192.168.1.0/24"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ExcludedIP.CreatePhishingCampaignExcludedIPRequest" }, "example": {"excludedIPs":["10.0.0.1","192.168.1.0/24"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ExcludedIP.CreatePhishingCampaignExcludedIPRequest" }, "example": {"excludedIPs":["10.0.0.1","192.168.1.0/24"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignExcludedIP.Dto.PhishingCampaignExcludedIPDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/excluded-ip-list": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the current excluded IP address list for QR phishing (quishing) campaigns, showing all IP addresses and ranges that are excluded from campaign tracking.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignExcludedIP.Dto.PhishingCampaignExcludedIPItemDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/landing-page-template/form-details": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the form details required to create or edit a landing page template for the quishing simulator, including available form fields, capture options, and layout settings.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.LandingPageTemplate.Dto.LandingPageTemplateFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/landing-page-template": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Creates a new landing page template for the quishing simulator, defining the HTML content, form fields, and data capture configuration that users see after scanning a QR code.", "requestBody": { "description": "The landing page template creation payload including HTML content, form configuration, and capture settings.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LandingPageTemplate.CreateLandingPageTemplateRequest" }, "example": {"name":"Office 365 Login Page","description":"Simulates a Microsoft 365 sign-in page for credential harvesting","methodTypeId":1,"difficultyTypeId":1,"urlSchemaTypeId":1,"subDomain":"login","domainRecordId":1,"autoRotate":false,"pathTypeId":1,"extensionTypeId":1,"parameterTypeId":1,"landingPages":[{"resourceId":"Lp3Kx7mN2wRt","name":"Login Page","order":1,"content":"Your password will expire in 24 hours. Click here to reset it now.
", "IsPhishingFileModified": false, "PhishingTypeId": 1, "IsAssistedByAI": false, "IsPlainText": false }, "encoding": { "IsDuplicated": { "style": "form" }, "DuplicatedTemplateResourceId": { "style": "form" }, "Languages": { "style": "form" }, "BarrelPayload.Subject": { "style": "form" }, "BarrelPayload.Template": { "style": "form" }, "BarrelPayload.PhishingFile": { "style": "form" }, "BarrelPayload.PhishingFileType": { "style": "form" }, "BarrelPayload.PhishingFileName": { "style": "form" }, "BarrelPayload.IsPhishingFileModified": { "style": "form" }, "BarrelPayload.AttachmentFiles": { "style": "form" }, "BarrelPayload.AttachmentFilesToRemove": { "style": "form" }, "Name": { "style": "form" }, "Description": { "style": "form" }, "CategoryResourceId": { "style": "form" }, "DifficultyResourceId": { "style": "form" }, "LanguageTypeResourceId": { "style": "form" }, "Tags": { "style": "form" }, "Subject": { "style": "form" }, "FromName": { "style": "form" }, "FromAddress": { "style": "form" }, "CcAddresses": { "style": "form" }, "Template": { "style": "form" }, "AvailableForRequests": { "style": "form" }, "AttachmentFiles": { "style": "form" }, "PhishingFile": { "style": "form" }, "PhishingFileType": { "style": "form" }, "IsPhishingFileModified": { "style": "form" }, "PhishingFileName": { "style": "form" }, "PhishingTypeId": { "style": "form" }, "Prompt": { "style": "form" }, "IsAssistedByAI": { "style": "form" }, "IsPlainText": { "style": "form" }, "ToneResourceId": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/quishing-simulator/email-templates/{resourceId}": { "put": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Updates an existing email template for the quishing simulator, allowing modification of the subject, body, sender information, or attachments.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the email template to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "CategoryResourceId", "Description", "FromAddress", "FromName", "Name", "Subject", "Template" ], "type": "object", "properties": { "Languages": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PsEmailTemplate.Dto.UpdatePsEmailTemplateLanguageDto" }, "description": "Localized language variants of the email template to update." }, "BarrelPayload.Subject": { "type": "string", "description": "Email subject line for the payload." }, "BarrelPayload.Template": { "type": "string", "description": "HTML or plain-text body content of the payload email." }, "BarrelPayload.PhishingFile": { "type": "string", "description": "Phishing attachment file for the payload email (tracked download).", "format": "binary" }, "BarrelPayload.PhishingFileType": { "type": "string", "description": "File type hint for the phishing file (e.g. \"exe\", \"pdf\")." }, "BarrelPayload.PhishingFileName": { "type": "string", "description": "Display name for the phishing file." }, "BarrelPayload.IsPhishingFileModified": { "type": "boolean", "description": "Update only: true when the phishing file was changed or removed. Sent with no PhishingFile and an\r\nempty PhishingFileName, it removes the payload's phishing file." }, "BarrelPayload.AttachmentFiles": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "Embedded attachment files for the payload email (not tracked)." }, "BarrelPayload.AttachmentFilesToRemove": { "type": "array", "items": { "type": "string" }, "description": "Update only: resource ids of the payload's embedded attachments to remove." }, "Name": { "maxLength": 64, "type": "string", "description": "Display name of the email template." }, "Description": { "type": "string", "description": "Description providing context about the template's purpose and content." }, "CategoryResourceId": { "type": "string", "description": "Resource identifier of the category this template belongs to." }, "DifficultyResourceId": { "type": "string", "description": "Resource identifier of the difficulty level assigned to this template." }, "LanguageTypeResourceId": { "type": "string", "description": "Resource identifier of the language type for localization." }, "Tags": { "type": "array", "items": { "type": "string" }, "description": "List of tag labels for categorizing and searching templates." }, "Subject": { "maxLength": 320, "type": "string", "description": "Email subject line used in the phishing simulation." }, "FromName": { "maxLength": 320, "type": "string", "description": "Sender display name shown in the email header." }, "FromAddress": { "maxLength": 320, "type": "string", "description": "Sender email address used in the From field." }, "CcAddresses": { "type": "array", "items": { "type": "string" }, "description": "List of CC (carbon copy) email addresses." }, "Template": { "maxLength": 10485760, "type": "string", "description": "HTML or plain-text body content of the email template." }, "AvailableForRequests": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.EntityAvailableFor.Dto.EntityAvailableForRequest" }, "description": "Visibility and sharing rules that control which entities can access this template." }, "AttachmentFiles": { "type": "array", "items": { "type": "string", "format": "binary" }, "description": "Attachment files included with the phishing simulation email." }, "PhishingFile": { "type": "string", "description": "Simulated malicious file attached to the phishing email for payload testing.", "format": "binary" }, "PhishingFileType": { "type": "string", "description": "MIME type or extension identifier of the phishing attachment file." }, "IsPhishingFileModified": { "type": "boolean", "description": "Whether the phishing attachment file has been modified since the last save." }, "PhishingFileName": { "type": "string", "description": "Original file name of the phishing attachment." }, "PhishingTypeId": { "type": "integer", "description": "Phishing type identifier classifying the simulation category.", "format": "int32" }, "Prompt": { "type": "string", "description": "AI prompt text used when the template content is AI-generated." }, "IsAssistedByAI": { "type": "boolean", "description": "Whether this template was generated or refined with AI assistance." }, "IsPlainText": { "type": "boolean", "description": "Whether the template body is plain text instead of HTML." }, "ToneResourceId": { "type": "string", "description": "Resource identifier of the writing tone applied to the template (e.g., formal, urgent)." } } }, "example": { "Name": "Updated IT Password Reset Notice", "Description": "Updated phishing simulation for IT password reset notification", "CategoryResourceId": "Ct4Kp8mR7xLn", "DifficultyResourceId": "Df3Kp8mR7xLv", "LanguageTypeResourceId": "Ln2Kp5mR7vWx", "Tags": [ "password-reset", "credential-harvesting" ], "Subject": "Urgent: Your Password Will Expire Soon", "FromName": "IT Service Desk", "FromAddress": "it-support@example-corp.com", "Template": "Your password will expire in 12 hours. Click here to reset it immediately.
", "IsPhishingFileModified": false, "PhishingTypeId": 1, "IsAssistedByAI": false, "IsPlainText": false }, "encoding": { "Languages": { "style": "form" }, "BarrelPayload.Subject": { "style": "form" }, "BarrelPayload.Template": { "style": "form" }, "BarrelPayload.PhishingFile": { "style": "form" }, "BarrelPayload.PhishingFileType": { "style": "form" }, "BarrelPayload.PhishingFileName": { "style": "form" }, "BarrelPayload.IsPhishingFileModified": { "style": "form" }, "BarrelPayload.AttachmentFiles": { "style": "form" }, "BarrelPayload.AttachmentFilesToRemove": { "style": "form" }, "Name": { "style": "form" }, "Description": { "style": "form" }, "CategoryResourceId": { "style": "form" }, "DifficultyResourceId": { "style": "form" }, "LanguageTypeResourceId": { "style": "form" }, "Tags": { "style": "form" }, "Subject": { "style": "form" }, "FromName": { "style": "form" }, "FromAddress": { "style": "form" }, "CcAddresses": { "style": "form" }, "Template": { "style": "form" }, "AvailableForRequests": { "style": "form" }, "AttachmentFiles": { "style": "form" }, "PhishingFile": { "style": "form" }, "PhishingFileType": { "style": "form" }, "IsPhishingFileModified": { "style": "form" }, "PhishingFileName": { "style": "form" }, "PhishingTypeId": { "style": "form" }, "Prompt": { "style": "form" }, "IsAssistedByAI": { "style": "form" }, "IsPlainText": { "style": "form" }, "ToneResourceId": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the full details of an existing email template for the quishing simulator by its resource ID, including subject, body HTML, sender information, and attachment metadata.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the email template to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PsEmailTemplate.Dto.PsEmailTemplateDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Deletes an existing email template from the quishing simulator by its resource ID, removing the template and any associated attachments.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the email template to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/email-templates/search": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Searches and returns a paginated list of email templates for the quishing simulator, filtered to QR code phishing type, with support for sorting and pagination.", "requestBody": { "description": "Search criteria including pagination, sort order, and optional filter conditions.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.Search.PsEmailTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"MethodTypeId","operator":"eq","value":"1"}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"IsPlainText","operator":"eq","value":"false"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"phishingTypeId":1} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.Search.PsEmailTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"MethodTypeId","operator":"eq","value":"1"}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"IsPlainText","operator":"eq","value":"false"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"phishingTypeId":1} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.Search.PsEmailTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"MethodTypeId","operator":"eq","value":"1"}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"IsPlainText","operator":"eq","value":"false"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"phishingTypeId":1} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PsEmailTemplate.Search.PsEmailTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"MethodTypeId","operator":"eq","value":"1"}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"IsPlainText","operator":"eq","value":"false"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"phishingTypeId":1} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.PsEmailTemplate.Dto.SearchPsEmailTemplateDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/email-templates/search/export": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Exports the filtered list of quishing simulator email templates as a downloadable file in the specified format (e.g., Excel, CSV).", "requestBody": { "description": "Export criteria including pagination, filters, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/quishing-simulator/email-templates/merge-tags": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the available merge tags for quishing email templates, providing dynamic placeholders (e.g., recipient name, company) that can be inserted into the email body.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/quishing-simulator/email-templates/download-attachment/{resourceId}": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Downloads the attachment file associated with a quishing email template, returning the file with its original MIME type and filename.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the email template whose attachment to download.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/quishing-simulator/quishing-campaign-job-report/summary/{resourceId}/{instanceGroup}/email-templates/{templateResourceId}": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the email template used in a specific quishing campaign job instance, allowing review of the template as it was configured at the time of the campaign run.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "templateResourceId", "in": "path", "description": "The unique resource identifier of the email template to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PsEmailTemplate.Dto.PsEmailTemplateDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-scenario/form-details": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the form details required to create or edit a quishing scenario, including available email templates, landing page templates, and configuration options.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingScenario.Dto.PhishingScenarioFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-scenario": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Creates a new quishing scenario for the company, combining an email template with a landing page template and QR code configuration to define a complete QR phishing attack simulation.", "requestBody": { "description": "The quishing scenario creation payload including email template, landing page, and QR code settings.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.CreateQuishingScenarioRequest" }, "example": {"templateResourceId":"Qt4Rm7vT3nKp","templateType":"Email","name":"QR Code Wi-Fi Phishing Scenario","description":"QR code phishing scenario simulating free Wi-Fi access","methodTypeId":1,"landingPageTemplateId":1,"categoryId":1,"languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["qr-code","wifi"],"roleResourceIds":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.CreateQuishingScenarioRequest" }, "example": {"templateResourceId":"Qt4Rm7vT3nKp","templateType":"Email","name":"QR Code Wi-Fi Phishing Scenario","description":"QR code phishing scenario simulating free Wi-Fi access","methodTypeId":1,"landingPageTemplateId":1,"categoryId":1,"languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["qr-code","wifi"],"roleResourceIds":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.CreateQuishingScenarioRequest" }, "example": {"templateResourceId":"Qt4Rm7vT3nKp","templateType":"Email","name":"QR Code Wi-Fi Phishing Scenario","description":"QR code phishing scenario simulating free Wi-Fi access","methodTypeId":1,"landingPageTemplateId":1,"categoryId":1,"languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["qr-code","wifi"],"roleResourceIds":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.CreateQuishingScenarioRequest" }, "example": {"templateResourceId":"Qt4Rm7vT3nKp","templateType":"Email","name":"QR Code Wi-Fi Phishing Scenario","description":"QR code phishing scenario simulating free Wi-Fi access","methodTypeId":1,"landingPageTemplateId":1,"categoryId":1,"languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["qr-code","wifi"],"roleResourceIds":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/quishing-simulator/quishing-scenario/{resourceId}": { "put": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Updates an existing quishing scenario for the company, allowing modification of the email template, landing page, or QR code configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing scenario to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated quishing scenario payload with modified fields.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.UpdateQuishingScenarioRequest" }, "example": {"templateResourceId":"Qt4Rm7vT3nKp","templateType":"Email","mfaSenderNumberResourceId":"Mf5Tp3kW8xNv","name":"Updated QR Code Phishing Scenario","description":"Updated QR code phishing scenario","methodTypeId":1,"landingPageTemplateId":1,"categoryId":1,"languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["qr-code","wifi"],"roleResourceIds":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.UpdateQuishingScenarioRequest" }, "example": {"templateResourceId":"Qt4Rm7vT3nKp","templateType":"Email","mfaSenderNumberResourceId":"Mf5Tp3kW8xNv","name":"Updated QR Code Phishing Scenario","description":"Updated QR code phishing scenario","methodTypeId":1,"landingPageTemplateId":1,"categoryId":1,"languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["qr-code","wifi"],"roleResourceIds":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.UpdateQuishingScenarioRequest" }, "example": {"templateResourceId":"Qt4Rm7vT3nKp","templateType":"Email","mfaSenderNumberResourceId":"Mf5Tp3kW8xNv","name":"Updated QR Code Phishing Scenario","description":"Updated QR code phishing scenario","methodTypeId":1,"landingPageTemplateId":1,"categoryId":1,"languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["qr-code","wifi"],"roleResourceIds":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.UpdateQuishingScenarioRequest" }, "example": {"templateResourceId":"Qt4Rm7vT3nKp","templateType":"Email","mfaSenderNumberResourceId":"Mf5Tp3kW8xNv","name":"Updated QR Code Phishing Scenario","description":"Updated QR code phishing scenario","methodTypeId":1,"landingPageTemplateId":1,"categoryId":1,"languageTypeResourceId":"Lt2Wn5vT9nQs","tags":["qr-code","wifi"],"roleResourceIds":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Deletes a quishing scenario by its resource ID, removing the scenario and its template associations.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing scenario to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the full details of an existing quishing scenario by its resource ID, including email template, landing page template, and QR code configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing scenario to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.QuishingScenario.QuishingScenarioDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-scenario/bulk-delete": { "delete": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Deletes multiple quishing scenarios in a single bulk operation based on the provided list of scenario identifiers.", "requestBody": { "description": "The bulk delete payload containing the list of quishing scenario items to remove.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-scenario/search": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Searches and returns a paginated list of quishing scenarios, with support for filtering by template types, sorting, and pagination.", "requestBody": { "description": "Search criteria including pagination, sort order, template type filters, and optional filter conditions.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.PhishingScenarioSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"templateTypes":[],"roleResourceIds":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.PhishingScenarioSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"templateTypes":[],"roleResourceIds":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.PhishingScenarioSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"templateTypes":[],"roleResourceIds":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingScenario.PhishingScenarioSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"templateTypes":[],"roleResourceIds":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.QuishingScenario.Dto.QuishingScenarioSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-scenario/search/export": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Exports the filtered list of quishing scenarios as a downloadable file in the specified format (e.g., Excel, CSV), with support for template type filtering.", "requestBody": { "description": "Export criteria including pagination, filters, template types, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/quishing-simulator/quishing-scenario/preview/{templateType}/{resourceId}": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Generates a preview of a quishing scenario by its resource ID and template type, showing how the QR code email and landing page will appear to target users.", "parameters": [ { "name": "templateType", "in": "path", "description": "The type of quishing template to preview (e.g., Email, PDF).", "required": true, "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.QuishingTemplate.Enum.QuishingTemplateSearchTypeEnum" } }, { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing scenario to preview.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingScenario.Dto.QuishingScenarioPreviewDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-scenario/print-preview/{resourceId}": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Generates a printable preview of a quishing scenario, returning the rendered QR code content as a downloadable file.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing scenario to generate a print preview for.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/quishing-simulator/quishing-scenario/preview/{templateType}/{templateResourceId}/{landingPageTemplateResourceId}": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Generates a preview of a quishing scenario by combining a specific quishing template and landing page template, showing how they will render together in a campaign.", "parameters": [ { "name": "templateType", "in": "path", "description": "The type of quishing template to preview (e.g., Email, PDF).", "required": true, "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.QuishingTemplate.Enum.QuishingTemplateSearchTypeEnum" } }, { "name": "templateResourceId", "in": "path", "description": "The resource ID of the quishing template to use in the preview.", "required": true, "schema": { "type": "string" } }, { "name": "landingPageTemplateResourceId", "in": "path", "description": "The resource ID of the landing page template to use in the preview.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingScenario.Dto.QuishingScenarioPreviewDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-scenario/mfa-phone-number": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the list of available MFA phone numbers for quishing scenarios, used to configure multi-factor authentication bypass simulations in QR phishing campaigns.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.PhishingScenario.Dto.SmsPhoneNumberDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/quishing-simulator/quishing-templates": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Creates a new quishing template (QR code template) for the quishing simulator, defining the QR code layout, design, and embedded content used in campaigns.", "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "CategoryResourceId", "Description", "Name", "Template", "Type" ], "type": "object", "properties": { "IsDuplicated": { "type": "boolean", "description": "Indicates whether this template was duplicated from an existing one." }, "DuplicatedTemplateResourceId": { "type": "string", "description": "Resource identifier of the original template when duplicating." }, "Name": { "maxLength": 64, "type": "string", "description": "Template display name." }, "Description": { "type": "string", "description": "Description of the template's purpose and content." }, "CategoryResourceId": { "type": "string", "description": "Resource identifier of the phishing scenario category." }, "DifficultyResourceId": { "type": "string", "description": "Resource identifier of the template difficulty level." }, "LanguageTypeResourceId": { "type": "string", "description": "Resource identifier of the template language." }, "Tags": { "type": "array", "items": { "type": "string" }, "description": "Searchable tags associated with the template." }, "Type": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.QuishingTemplate.Enum.QuishingTemplateTypeEnum" }, "Template": { "maxLength": 10485760, "type": "string", "description": "HTML body content of the quishing template." }, "AvailableForRequests": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.EntityAvailableFor.Dto.EntityAvailableForRequest" }, "description": "Visibility rules controlling which companies or groups can use this template." } } }, "example": { "IsDuplicated": false, "Name": "Corporate Wi-Fi QR Code", "Description": "Simulates a QR code leading to a fake corporate Wi-Fi login page", "CategoryResourceId": "Ct4Kp8mR7xLn", "DifficultyResourceId": "Df3Kp8mR7xLv", "LanguageTypeResourceId": "Ln2Kp5mR7vWx", "Tags": [ "qr-code", "wifi-phishing" ], "Type": 1, "Template": "Scan the QR code below to connect.
" }, "encoding": { "IsDuplicated": { "style": "form" }, "DuplicatedTemplateResourceId": { "style": "form" }, "Name": { "style": "form" }, "Description": { "style": "form" }, "CategoryResourceId": { "style": "form" }, "DifficultyResourceId": { "style": "form" }, "LanguageTypeResourceId": { "style": "form" }, "Tags": { "style": "form" }, "Type": { "style": "form" }, "Template": { "style": "form" }, "AvailableForRequests": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/quishing-simulator/quishing-templates/{resourceId}": { "put": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Updates an existing quishing template for the quishing simulator, allowing modification of the QR code design, layout, or embedded content.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing template to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "CategoryResourceId", "Description", "Name", "Template", "Type" ], "type": "object", "properties": { "Name": { "maxLength": 64, "type": "string", "description": "Template display name." }, "Description": { "type": "string", "description": "Description of the template's purpose and content." }, "CategoryResourceId": { "type": "string", "description": "Resource identifier of the phishing scenario category." }, "DifficultyResourceId": { "type": "string", "description": "Resource identifier of the template difficulty level." }, "LanguageTypeResourceId": { "type": "string", "description": "Resource identifier of the template language." }, "Tags": { "type": "array", "items": { "type": "string" }, "description": "Searchable tags associated with the template." }, "Type": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.QuishingTemplate.Enum.QuishingTemplateTypeEnum" }, "Template": { "maxLength": 10485760, "type": "string", "description": "HTML body content of the quishing template." }, "AvailableForRequests": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.EntityAvailableFor.Dto.EntityAvailableForRequest" }, "description": "Visibility rules controlling which companies or groups can use this template." } } }, "example": { "Name": "Updated Corporate Wi-Fi QR Code", "Description": "Updated QR code simulation for corporate Wi-Fi login", "CategoryResourceId": "Ct4Kp8mR7xLn", "DifficultyResourceId": "Df3Kp8mR7xLv", "LanguageTypeResourceId": "Ln2Kp5mR7vWx", "Tags": [ "qr-code", "wifi-phishing" ], "Type": 1, "Template": "Scan the QR code to join the secure network.
" }, "encoding": { "Name": { "style": "form" }, "Description": { "style": "form" }, "CategoryResourceId": { "style": "form" }, "DifficultyResourceId": { "style": "form" }, "LanguageTypeResourceId": { "style": "form" }, "Tags": { "style": "form" }, "Type": { "style": "form" }, "Template": { "style": "form" }, "AvailableForRequests": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the full details of an existing quishing template by its resource ID, including QR code design, layout settings, and embedded content configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing template to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.QuishingTemplate.Dto.QuishingTemplateDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Deletes an existing quishing template from the quishing simulator by its resource ID.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing template to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-templates/bulk-delete": { "delete": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Deletes multiple quishing templates in a single bulk operation based on the provided list of template identifiers.", "requestBody": { "description": "The bulk delete payload containing the list of quishing template items to remove.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DAL.Models.GlobalDeleteRequest" }, "example": {"items":["Rs5Kp2mR7xLv","Rs8Wp3nQ5vXm"],"selectAll":false,"excludedItems":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-templates/search": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Searches and returns a paginated list of quishing templates for the quishing simulator, with support for filtering by template types, sorting, and pagination.", "requestBody": { "description": "Search criteria including pagination, sort order, template type filters, and optional filter conditions.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.QuishingTemplate.Search.QuishingTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Name","operator":"contains","value":""}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"CategoryResourceId","operator":"eq","value":""}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"templateTypes":["1","2"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.QuishingTemplate.Search.QuishingTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Name","operator":"contains","value":""}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"CategoryResourceId","operator":"eq","value":""}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"templateTypes":["1","2"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.QuishingTemplate.Search.QuishingTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Name","operator":"contains","value":""}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"CategoryResourceId","operator":"eq","value":""}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"templateTypes":["1","2"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.QuishingTemplate.Search.QuishingTemplateSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"Name","operator":"contains","value":""}],"filterGroups":[]},{"condition":"AND","filterItems":[{"fieldName":"CategoryResourceId","operator":"eq","value":""}],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"templateTypes":["1","2"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.QuishingTemplate.Dto.SearchQuishingTemplateDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/quishing-simulator/quishing-templates/search/export": { "post": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Exports the filtered list of quishing templates as a downloadable file in the specified format (e.g., Excel, CSV), with support for template type filtering.", "requestBody": { "description": "Export criteria including pagination, filters, template types, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/quishing-simulator/quishing-templates/preview/{resourceId}": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Generates a PDF preview of a quishing template, rendering the QR code layout and design as a downloadable document.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing template to preview.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/quishing-simulator/quishing-templates/merge-tags/{templateType}": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the available merge tags for a specific quishing template type, providing dynamic placeholders that can be inserted into the template content.", "parameters": [ { "name": "templateType", "in": "path", "description": "The quishing template type to retrieve merge tags for.", "required": true, "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.QuishingTemplate.Enum.QuishingTemplateTypeEnum" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/quishing-simulator/quishing-campaign-job-report/summary/{resourceId}/{instanceGroup}/quishing-templates/{templateResourceId}": { "get": { "tags": [ "QR Phishing (Quishing)" ], "summary": "Retrieves the quishing template used in a specific quishing campaign job instance, allowing review of the QR code template as it was configured at the time of the campaign run.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the quishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number of the campaign job.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "templateResourceId", "in": "path", "description": "The unique resource identifier of the quishing template to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.QuishingTemplate.Dto.QuishingTemplateDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/dashboard/widgets": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Creates or saves the user's preferred dashboard widget layout, defining the order and visibility of widgets on the main dashboard.", "requestBody": { "description": "Widget ordering configuration including widget identifiers and their display positions.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DashboardWidgetsOrdering.CreateDashboardWidgetsOrderingRequest" }, "example": {"settings":[{"title":"Phishing Campaign Summary","key":"phishing_summary","x":0,"y":0,"w":6,"h":4},{"title":"Awareness Training Progress","key":"training_progress","x":6,"y":0,"w":6,"h":4}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DashboardWidgetsOrdering.CreateDashboardWidgetsOrderingRequest" }, "example": {"settings":[{"title":"Phishing Campaign Summary","key":"phishing_summary","x":0,"y":0,"w":6,"h":4},{"title":"Awareness Training Progress","key":"training_progress","x":6,"y":0,"w":6,"h":4}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DashboardWidgetsOrdering.CreateDashboardWidgetsOrderingRequest" }, "example": {"settings":[{"title":"Phishing Campaign Summary","key":"phishing_summary","x":0,"y":0,"w":6,"h":4},{"title":"Awareness Training Progress","key":"training_progress","x":6,"y":0,"w":6,"h":4}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DashboardWidgetsOrdering.CreateDashboardWidgetsOrderingRequest" }, "example": {"settings":[{"title":"Phishing Campaign Summary","key":"phishing_summary","x":0,"y":0,"w":6,"h":4},{"title":"Awareness Training Progress","key":"training_progress","x":6,"y":0,"w":6,"h":4}]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Dashboard.Dto.DashboardWidgetsOrderingDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves the current user's saved dashboard widget ordering configuration, defining which widgets are displayed and in what order.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.Dashboard.Dto.DashboardWidgetsOrderingDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/dashboard/reported-email-trends": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves reported email trend data over time, showing the volume of user-reported suspicious emails grouped by date for dashboard visualization.", "requestBody": { "description": "Trend query parameters including date range and optional filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Dashboard.GetReportedEmailTrendsRequest" }, "example": {"StartDate":"2026-01-01 00:00:00","EndDate":"2026-03-31 23:59:59"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Dashboard.GetReportedEmailTrendsRequest" }, "example": {"StartDate":"2026-01-01 00:00:00","EndDate":"2026-03-31 23:59:59"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Dashboard.GetReportedEmailTrendsRequest" }, "example": {"StartDate":"2026-01-01 00:00:00","EndDate":"2026-03-31 23:59:59"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Dashboard.GetReportedEmailTrendsRequest" }, "example": {"StartDate":"2026-01-01 00:00:00","EndDate":"2026-03-31 23:59:59"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.NotifiedEmail.Search.NotifiedEmailTrendSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/dashboard/reporters": { "get": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves the top 5 users ranked by email reporting reliability, highlighting the most accurate reporters of suspicious emails within the organization.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.NotifiedEmail.Dto.TopReportersDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/dashboard/summary": { "get": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves aggregated summary data for all enabled dashboard widgets, including counts and key metrics across phishing campaigns, awareness training, and incident response modules.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.DistributedService.Rest.Models.Dashboard.SummaryDataResponse, KeepnetLabs.DistributedService.Rest, Version=3.5.0.7, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/executive-report/metrics": { "get": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves all available executive report metric widgets, including their configuration and data. These metrics define the building blocks used to compose executive reports.", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.ExecutiveReport.Dto.GetExecutiveReportWidgetsServiceResult, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/executive-report": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Creates a new executive report with the specified widgets, filters, and optional scheduling. If scheduling is provided, a Hangfire recurring job is registered for automated delivery.", "requestBody": { "description": "Executive report creation details including title, selected widgets, date range, recipients, and optional scheduling configuration.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ExecutiveReport.Dto.CreateExecutiveReportServiceRequest" }, "example": {"executiveReport":{"name":"Q1 2026 Security Report","companyName":"Acme Corp","description":"Quarterly executive security overview","dateCreated":"0001-01-01 00:00:00","datePeriod":"Last3Months","startDate":"2026-01-01 00:00:00","endDate":"2026-03-31 23:59:59"},"scheduling":{"name":"Quarterly Report Schedule","frequency":"Quarterly","schedule":"2026-04-01 09:00:00","scheduledDateTimeZoneId":"UTC","isRegionAwareTimeZone":false,"emailAddresses":["admin@example.com"],"targetGroupResourceIds":[],"managerEmails":[]},"widgetLayouts":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ExecutiveReport.Dto.CreateExecutiveReportServiceRequest" }, "example": {"executiveReport":{"name":"Q1 2026 Security Report","companyName":"Acme Corp","description":"Quarterly executive security overview","dateCreated":"0001-01-01 00:00:00","datePeriod":"Last3Months","startDate":"2026-01-01 00:00:00","endDate":"2026-03-31 23:59:59"},"scheduling":{"name":"Quarterly Report Schedule","frequency":"Quarterly","schedule":"2026-04-01 09:00:00","scheduledDateTimeZoneId":"UTC","isRegionAwareTimeZone":false,"emailAddresses":["admin@example.com"],"targetGroupResourceIds":[],"managerEmails":[]},"widgetLayouts":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ExecutiveReport.Dto.CreateExecutiveReportServiceRequest" }, "example": {"executiveReport":{"name":"Q1 2026 Security Report","companyName":"Acme Corp","description":"Quarterly executive security overview","dateCreated":"0001-01-01 00:00:00","datePeriod":"Last3Months","startDate":"2026-01-01 00:00:00","endDate":"2026-03-31 23:59:59"},"scheduling":{"name":"Quarterly Report Schedule","frequency":"Quarterly","schedule":"2026-04-01 09:00:00","scheduledDateTimeZoneId":"UTC","isRegionAwareTimeZone":false,"emailAddresses":["admin@example.com"],"targetGroupResourceIds":[],"managerEmails":[]},"widgetLayouts":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ExecutiveReport.Dto.CreateExecutiveReportServiceRequest" }, "example": {"executiveReport":{"name":"Q1 2026 Security Report","companyName":"Acme Corp","description":"Quarterly executive security overview","dateCreated":"0001-01-01 00:00:00","datePeriod":"Last3Months","startDate":"2026-01-01 00:00:00","endDate":"2026-03-31 23:59:59"},"scheduling":{"name":"Quarterly Report Schedule","frequency":"Quarterly","schedule":"2026-04-01 09:00:00","scheduledDateTimeZoneId":"UTC","isRegionAwareTimeZone":false,"emailAddresses":["admin@example.com"],"targetGroupResourceIds":[],"managerEmails":[]},"widgetLayouts":[]} } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/executive-report/{resourceId}": { "put": { "tags": [ "Reports & Analytics" ], "summary": "Updates an existing executive report's configuration, including widgets, filters, recipients, and scheduling. Re-registers the Hangfire recurring job if scheduling is present.", "parameters": [ { "name": "resourceId", "in": "path", "description": "Unique resource identifier of the executive report to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Updated executive report details including title, widgets, date range, recipients, and optional scheduling.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ExecutiveReport.Dto.UpdateExecutiveReportServiceRequest" }, "example": {"executiveReportResourceId":"Er5Kp2mR7xLv","executiveReport":{"name":"Q1 2026 Security Report","companyName":"Acme Corp","description":"Quarterly executive security overview","dateCreated":"0001-01-01 00:00:00","datePeriod":"Last3Months","startDate":"2026-01-01 00:00:00","endDate":"2026-03-31 23:59:59"},"scheduling":{"name":"Quarterly Report Schedule","frequency":"Quarterly","schedule":"2026-04-01 09:00:00","scheduledDateTimeZoneId":"UTC","isRegionAwareTimeZone":false,"emailAddresses":["admin@example.com"],"targetGroupResourceIds":[],"managerEmails":[]},"widgetLayouts":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ExecutiveReport.Dto.UpdateExecutiveReportServiceRequest" }, "example": {"executiveReportResourceId":"Er5Kp2mR7xLv","executiveReport":{"name":"Q1 2026 Security Report","companyName":"Acme Corp","description":"Quarterly executive security overview","dateCreated":"0001-01-01 00:00:00","datePeriod":"Last3Months","startDate":"2026-01-01 00:00:00","endDate":"2026-03-31 23:59:59"},"scheduling":{"name":"Quarterly Report Schedule","frequency":"Quarterly","schedule":"2026-04-01 09:00:00","scheduledDateTimeZoneId":"UTC","isRegionAwareTimeZone":false,"emailAddresses":["admin@example.com"],"targetGroupResourceIds":[],"managerEmails":[]},"widgetLayouts":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ExecutiveReport.Dto.UpdateExecutiveReportServiceRequest" }, "example": {"executiveReportResourceId":"Er5Kp2mR7xLv","executiveReport":{"name":"Q1 2026 Security Report","companyName":"Acme Corp","description":"Quarterly executive security overview","dateCreated":"0001-01-01 00:00:00","datePeriod":"Last3Months","startDate":"2026-01-01 00:00:00","endDate":"2026-03-31 23:59:59"},"scheduling":{"name":"Quarterly Report Schedule","frequency":"Quarterly","schedule":"2026-04-01 09:00:00","scheduledDateTimeZoneId":"UTC","isRegionAwareTimeZone":false,"emailAddresses":["admin@example.com"],"targetGroupResourceIds":[],"managerEmails":[]},"widgetLayouts":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ExecutiveReport.Dto.UpdateExecutiveReportServiceRequest" }, "example": {"executiveReportResourceId":"Er5Kp2mR7xLv","executiveReport":{"name":"Q1 2026 Security Report","companyName":"Acme Corp","description":"Quarterly executive security overview","dateCreated":"0001-01-01 00:00:00","datePeriod":"Last3Months","startDate":"2026-01-01 00:00:00","endDate":"2026-03-31 23:59:59"},"scheduling":{"name":"Quarterly Report Schedule","frequency":"Quarterly","schedule":"2026-04-01 09:00:00","scheduledDateTimeZoneId":"UTC","isRegionAwareTimeZone":false,"emailAddresses":["admin@example.com"],"targetGroupResourceIds":[],"managerEmails":[]},"widgetLayouts":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "Reports & Analytics" ], "summary": "Deletes an executive report and removes its associated Hangfire recurring job if one exists.", "parameters": [ { "name": "resourceId", "in": "path", "description": "Unique resource identifier of the executive report to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves a single executive report by its resource identifier, including all widget selections, filter criteria, scheduling, and recipient details.", "parameters": [ { "name": "resourceId", "in": "path", "description": "Unique resource identifier of the executive report to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.ExecutiveReport.Dto.ExecutiveReportDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/executive-report/search": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Searches executive reports with pagination, sorting, and filtering. Returns a list of report summaries matching the provided criteria.", "requestBody": { "description": "Search parameters including pagination settings and optional filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ExecutiveReport.Dto.SearchExecutiveReportRequest" }, "example": {"name":""} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ExecutiveReport.Dto.SearchExecutiveReportRequest" }, "example": {"name":""} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ExecutiveReport.Dto.SearchExecutiveReportRequest" }, "example": {"name":""} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ExecutiveReport.Dto.SearchExecutiveReportRequest" }, "example": {"name":""} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.ExecutiveReport.Dto.ExecutiveReportSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/executive-report/get-widget-datas": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves computed data for a set of executive report widgets based on the specified parameters, including date ranges and filter criteria. Used to populate widget visualizations in the report builder.", "requestBody": { "description": "Widget data request parameters including widget identifiers, date range, and filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ExecutiveReport.Dto.GetWidgetDataServiceRequestParameters" }, "example": {"widgetIds":["widget-phishing-overview","widget-training-progress"],"datePeriod":"LastMonth","startDate":"2026-01-01 00:00:00","endDate":"2026-03-31 23:59:59"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ExecutiveReport.Dto.GetWidgetDataServiceRequestParameters" }, "example": {"widgetIds":["widget-phishing-overview","widget-training-progress"],"datePeriod":"LastMonth","startDate":"2026-01-01 00:00:00","endDate":"2026-03-31 23:59:59"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ExecutiveReport.Dto.GetWidgetDataServiceRequestParameters" }, "example": {"widgetIds":["widget-phishing-overview","widget-training-progress"],"datePeriod":"LastMonth","startDate":"2026-01-01 00:00:00","endDate":"2026-03-31 23:59:59"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ExecutiveReport.Dto.GetWidgetDataServiceRequestParameters" }, "example": {"widgetIds":["widget-phishing-overview","widget-training-progress"],"datePeriod":"LastMonth","startDate":"2026-01-01 00:00:00","endDate":"2026-03-31 23:59:59"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.ExecutiveReport.Dto.ExecutiveReportWidgetResultDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/executive-report/{resourceId}/logo": { "get": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves the logo image associated with a specific executive report. Returns the image as a PNG file for use in report headers and branding.", "parameters": [ { "name": "resourceId", "in": "path", "description": "Unique resource identifier of the executive report whose logo is requested.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/executive-report/{resourceId}/upload": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Uploads a generated executive report PDF to cloud storage (S3) for archival and distribution. The PDF is associated with the specified executive report.", "parameters": [ { "name": "resourceId", "in": "path", "description": "Unique resource identifier of the executive report to attach the PDF to.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "ExecutiveReportPdf": { "type": "string", "format": "binary" } } }, "encoding": { "ExecutiveReportPdf": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/is/dashboard/summary": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves summary statistics for the Incident Sharing dashboard, including aggregated counts of shared incidents, threat types, and response metrics filtered by the specified criteria.", "requestBody": { "description": "Dashboard filter criteria to scope the summary data.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentSharing.ISDashboardRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]}} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentSharing.ISDashboardRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]}} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentSharing.ISDashboardRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]}} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentSharing.ISDashboardRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]}} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.IncidentSharing.Dto.ISDashboardSummaryDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/is/dashboard/search-log": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Searches the Incident Sharing dashboard activity log with pagination, sorting, and filtering. Returns a paged list of individual incident sharing events.", "requestBody": { "description": "Search parameters including pagination settings (page number, page size, sort order) and optional filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentSharing.ISLogSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentSharing.ISLogSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentSharing.ISLogSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentSharing.ISLogSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.IncidentSharing.Dto.ISDashboardLogView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/is/dashboard/search-log/export": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Exports the Incident Sharing dashboard log as a downloadable file (e.g., CSV or Excel) based on the specified export type, pagination, and filter criteria.", "requestBody": { "description": "Export parameters including pagination, filter criteria, export format, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/is/dashboard/search-stats": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Searches the Incident Sharing dashboard statistics with pagination, sorting, and dual-filter support. Returns aggregated stats per organization or threat type.", "requestBody": { "description": "Search parameters including pagination, primary filter, and an additional summary filter for cross-referencing.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentSharing.ISStatSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"filterSummary":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentSharing.ISStatSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"filterSummary":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentSharing.ISStatSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"filterSummary":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.IncidentSharing.ISStatSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"filterSummary":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.IncidentSharing.Dto.ISDashboardStatView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/is/dashboard/search-stats/export": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Exports the Incident Sharing dashboard statistics as a downloadable file (e.g., CSV or Excel), supporting dual-filter criteria for both primary and summary-level filtering.", "requestBody": { "description": "Export parameters including pagination, primary and summary filters, export format, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportMultiFilterRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"filterSummary":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportMultiFilterRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"filterSummary":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportMultiFilterRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"filterSummary":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportMultiFilterRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"filterSummary":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel"} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/pbi/reports/{companyResourceId}": { "get": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves all Power BI reports available to the specified company. Returns report metadata such as name, type, and embed identifiers.", "parameters": [ { "name": "companyResourceId", "in": "path", "description": "Unique resource identifier of the company whose Power BI reports are requested.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.PBIReport.Dto.PBIReportDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/pbi/reports/{companyResourceId}/{resourceId}": { "get": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves the Power BI embed parameters (embed URL, token, and configuration) for a specific report. Includes sub-company data when the caller has the appropriate permission.", "parameters": [ { "name": "resourceId", "in": "path", "description": "Unique resource identifier of the Power BI report to embed.", "required": true, "schema": { "type": "string" } }, { "name": "companyResourceId", "in": "path", "description": "Unique resource identifier of the company that owns the report.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PBIReport.Dto.PBIEmbedParamsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/report-scheduling/{resourceId}": { "get": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves a single report scheduling configuration by its resource identifier, including schedule details, recipients, and report type settings.", "parameters": [ { "name": "resourceId", "in": "path", "description": "Unique resource identifier of the report scheduling to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.ReportScheduling.Models.ReportSchedulingModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "put": { "tags": [ "Reports & Analytics" ], "summary": "Updates an existing report scheduling configuration and re-registers the Hangfire recurring job to reflect the new schedule and parameters.", "parameters": [ { "name": "resourceId", "in": "path", "description": "Unique resource identifier of the report scheduling to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Updated scheduling details including report type, frequency, recipients, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ReportScheduling.Dto.UpdateReportSchedulingServiceRequest" }, "example": {"reportType":"ExecutiveReport","reportResourceId":"Er5Kp2mR7xLv","name":"Weekly Phishing Report","frequency":"Weekly","schedule":"2026-04-01 09:00:00","scheduledDateTimeZoneId":"UTC","isRegionAwareTimeZone":false,"emailAddresses":["admin@example.com"],"managerEmails":[],"targetGroupResourceIds":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ReportScheduling.Dto.UpdateReportSchedulingServiceRequest" }, "example": {"reportType":"ExecutiveReport","reportResourceId":"Er5Kp2mR7xLv","name":"Weekly Phishing Report","frequency":"Weekly","schedule":"2026-04-01 09:00:00","scheduledDateTimeZoneId":"UTC","isRegionAwareTimeZone":false,"emailAddresses":["admin@example.com"],"managerEmails":[],"targetGroupResourceIds":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ReportScheduling.Dto.UpdateReportSchedulingServiceRequest" }, "example": {"reportType":"ExecutiveReport","reportResourceId":"Er5Kp2mR7xLv","name":"Weekly Phishing Report","frequency":"Weekly","schedule":"2026-04-01 09:00:00","scheduledDateTimeZoneId":"UTC","isRegionAwareTimeZone":false,"emailAddresses":["admin@example.com"],"managerEmails":[],"targetGroupResourceIds":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ReportScheduling.Dto.UpdateReportSchedulingServiceRequest" }, "example": {"reportType":"ExecutiveReport","reportResourceId":"Er5Kp2mR7xLv","name":"Weekly Phishing Report","frequency":"Weekly","schedule":"2026-04-01 09:00:00","scheduledDateTimeZoneId":"UTC","isRegionAwareTimeZone":false,"emailAddresses":["admin@example.com"],"managerEmails":[],"targetGroupResourceIds":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/report-scheduling/target-groups": { "get": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves the list of target groups available for report scheduling. These groups define which user populations a scheduled report can cover.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.ReportScheduling.Dto.TargetGroup, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/report-scheduling/managers": { "get": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves the list of managers eligible to receive scheduled reports. Used to populate the recipient selector when configuring report delivery.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.ReportScheduling.Dto.ManagerDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/report-scheduling": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Creates a new report scheduling configuration and registers the corresponding recurring Hangfire job for automated report delivery.", "requestBody": { "description": "Report scheduling details including report type, frequency, recipients, and filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ReportScheduling.Dto.CreateReportSchedulingServiceRequest" }, "example": {"reportType":"ExecutiveReport","reportResourceId":"Er5Kp2mR7xLv","name":"Weekly Phishing Report","frequency":"Weekly","schedule":"2026-04-01 09:00:00","scheduledDateTimeZoneId":"UTC","isRegionAwareTimeZone":false,"emailAddresses":["admin@example.com"],"managerEmails":[],"targetGroupResourceIds":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ReportScheduling.Dto.CreateReportSchedulingServiceRequest" }, "example": {"reportType":"ExecutiveReport","reportResourceId":"Er5Kp2mR7xLv","name":"Weekly Phishing Report","frequency":"Weekly","schedule":"2026-04-01 09:00:00","scheduledDateTimeZoneId":"UTC","isRegionAwareTimeZone":false,"emailAddresses":["admin@example.com"],"managerEmails":[],"targetGroupResourceIds":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ReportScheduling.Dto.CreateReportSchedulingServiceRequest" }, "example": {"reportType":"ExecutiveReport","reportResourceId":"Er5Kp2mR7xLv","name":"Weekly Phishing Report","frequency":"Weekly","schedule":"2026-04-01 09:00:00","scheduledDateTimeZoneId":"UTC","isRegionAwareTimeZone":false,"emailAddresses":["admin@example.com"],"managerEmails":[],"targetGroupResourceIds":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ReportScheduling.Dto.CreateReportSchedulingServiceRequest" }, "example": {"reportType":"ExecutiveReport","reportResourceId":"Er5Kp2mR7xLv","name":"Weekly Phishing Report","frequency":"Weekly","schedule":"2026-04-01 09:00:00","scheduledDateTimeZoneId":"UTC","isRegionAwareTimeZone":false,"emailAddresses":["admin@example.com"],"managerEmails":[],"targetGroupResourceIds":[]} } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/report-scheduling/{resourceId}/status/{statusId}": { "put": { "tags": [ "Reports & Analytics" ], "summary": "Updates the active/inactive status of a report scheduling and adjusts the Hangfire recurring job accordingly.", "parameters": [ { "name": "resourceId", "in": "path", "description": "Unique resource identifier of the report scheduling whose status is being changed.", "required": true, "schema": { "type": "string" } }, { "name": "statusId", "in": "path", "description": "New status identifier (e.g., active or inactive).", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/report-scheduling/{resourceId}/{reportType}": { "delete": { "tags": [ "Reports & Analytics" ], "summary": "Deletes a report scheduling configuration and removes its associated Hangfire recurring job so no further reports are generated.", "parameters": [ { "name": "resourceId", "in": "path", "description": "Unique resource identifier of the report scheduling to delete.", "required": true, "schema": { "type": "string" } }, { "name": "reportType", "in": "path", "description": "The report type used to scope the deletion.", "required": true, "schema": { "$ref": "#/components/schemas/KeepnetLabs.Domain.Enums.ReportType" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/report-scheduling/search": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Searches report scheduling configurations with pagination, sorting, and filtering. Returns a paged list of scheduling summaries.", "requestBody": { "description": "Search parameters including pagination settings (page number, page size, sort order) and optional filter criteria.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ReportScheduling.Dto.SearchReportSchedulingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":5,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ReportScheduling.Dto.SearchReportSchedulingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":5,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ReportScheduling.Dto.SearchReportSchedulingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":5,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.ReportScheduling.Dto.SearchReportSchedulingRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":5,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.ReportScheduling.Models.SearchReportSchedulingView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/report-scheduling/search/export": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Exports the report scheduling list as a downloadable file (e.g., CSV or Excel) based on the specified export type, pagination, and filter criteria.", "requestBody": { "description": "Export parameters including pagination, filter criteria, export format, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/sbm-behaviour/nudges": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Queues a behaviour nudge to one target user, rendered from the company's template and citing behaviour events already recorded for that person.", "requestBody": { "description": "Who to nudge, which template to use, which behaviour events the message is about, and an idempotency key.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SbmBehaviourNudge.SendBehaviourNudgeRequest" }, "example": {"targetUserResourceId":"Cp4Wn8mT2xRv","channel":"Email","templateKey":"BehaviourCoaching","eventIds":[-25729710,4705],"agentMessage":"You clicked a link in a simulated phishing email last week. A short refresher is on the way.","requestKey":"ai-run-7f3a91c4","dryRun":false,"previewHash":"3F8A0C9E5B7D21446A0E9C3B5D7F1A2C4E6B8D0F1A3C5E7B9D1F3A5C7E9B1D3F"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SbmBehaviourNudge.SendBehaviourNudgeRequest" }, "example": {"targetUserResourceId":"Cp4Wn8mT2xRv","channel":"Email","templateKey":"BehaviourCoaching","eventIds":[-25729710,4705],"agentMessage":"You clicked a link in a simulated phishing email last week. A short refresher is on the way.","requestKey":"ai-run-7f3a91c4","dryRun":false,"previewHash":"3F8A0C9E5B7D21446A0E9C3B5D7F1A2C4E6B8D0F1A3C5E7B9D1F3A5C7E9B1D3F"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SbmBehaviourNudge.SendBehaviourNudgeRequest" }, "example": {"targetUserResourceId":"Cp4Wn8mT2xRv","channel":"Email","templateKey":"BehaviourCoaching","eventIds":[-25729710,4705],"agentMessage":"You clicked a link in a simulated phishing email last week. A short refresher is on the way.","requestKey":"ai-run-7f3a91c4","dryRun":false,"previewHash":"3F8A0C9E5B7D21446A0E9C3B5D7F1A2C4E6B8D0F1A3C5E7B9D1F3A5C7E9B1D3F"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SbmBehaviourNudge.SendBehaviourNudgeRequest" }, "example": {"targetUserResourceId":"Cp4Wn8mT2xRv","channel":"Email","templateKey":"BehaviourCoaching","eventIds":[-25729710,4705],"agentMessage":"You clicked a link in a simulated phishing email last week. A short refresher is on the way.","requestKey":"ai-run-7f3a91c4","dryRun":false,"previewHash":"3F8A0C9E5B7D21446A0E9C3B5D7F1A2C4E6B8D0F1A3C5E7B9D1F3A5C7E9B1D3F"} } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/sbm-behaviour/nudges/eligibility": { "get": { "tags": [ "Reports & Analytics" ], "summary": "Reports whether a target user can be nudged right now, and when the cooldown expires if one is running.", "parameters": [ { "name": "targetUserResourceId", "in": "query", "description": "The unique resource identifier of the target user to check.", "schema": { "type": "string" } }, { "name": "channel", "in": "query", "description": "Optional. 1 for email, 2 for Teams. Defaults to email. Asking about Teams also reports a\r\ncompany with no Teams integration and a person the directory does not know.", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/sbm-dashboard/widgets": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Saves the current user's arrangement of the Secure Behaviour Dashboard's widgets, replacing any arrangement previously stored for them.", "requestBody": { "description": "The widgets on the dashboard with the grid position each was left in.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SbmDashboardWidgetsOrdering.CreateSbmDashboardWidgetsOrderingRequest" }, "example": {"settings":[{"title":"Users at Risk","key":"sbmUsers","x":0,"y":0,"w":6,"h":8},{"title":"Behaviours","key":"sbmBehaviours","x":6,"y":0,"w":6,"h":8},{"title":"Departments","key":"sbmDepartments","x":0,"y":8,"w":6,"h":8},{"title":"Severity Distribution","key":"sbmSeverityDistribution","x":6,"y":8,"w":3,"h":8},{"title":"Integration Health","key":"sbmIntegrationHealth","x":9,"y":8,"w":3,"h":8}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SbmDashboardWidgetsOrdering.CreateSbmDashboardWidgetsOrderingRequest" }, "example": {"settings":[{"title":"Users at Risk","key":"sbmUsers","x":0,"y":0,"w":6,"h":8},{"title":"Behaviours","key":"sbmBehaviours","x":6,"y":0,"w":6,"h":8},{"title":"Departments","key":"sbmDepartments","x":0,"y":8,"w":6,"h":8},{"title":"Severity Distribution","key":"sbmSeverityDistribution","x":6,"y":8,"w":3,"h":8},{"title":"Integration Health","key":"sbmIntegrationHealth","x":9,"y":8,"w":3,"h":8}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SbmDashboardWidgetsOrdering.CreateSbmDashboardWidgetsOrderingRequest" }, "example": {"settings":[{"title":"Users at Risk","key":"sbmUsers","x":0,"y":0,"w":6,"h":8},{"title":"Behaviours","key":"sbmBehaviours","x":6,"y":0,"w":6,"h":8},{"title":"Departments","key":"sbmDepartments","x":0,"y":8,"w":6,"h":8},{"title":"Severity Distribution","key":"sbmSeverityDistribution","x":6,"y":8,"w":3,"h":8},{"title":"Integration Health","key":"sbmIntegrationHealth","x":9,"y":8,"w":3,"h":8}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SbmDashboardWidgetsOrdering.CreateSbmDashboardWidgetsOrderingRequest" }, "example": {"settings":[{"title":"Users at Risk","key":"sbmUsers","x":0,"y":0,"w":6,"h":8},{"title":"Behaviours","key":"sbmBehaviours","x":6,"y":0,"w":6,"h":8},{"title":"Departments","key":"sbmDepartments","x":0,"y":8,"w":6,"h":8},{"title":"Severity Distribution","key":"sbmSeverityDistribution","x":6,"y":8,"w":3,"h":8},{"title":"Integration Health","key":"sbmIntegrationHealth","x":9,"y":8,"w":3,"h":8}]} } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } }, "get": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves the current user's saved arrangement of the Secure Behaviour Dashboard's widgets.", "responses": { "200": { "description": "OK" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/securitygrowthdashboard/top-performance": { "get": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves the top 3 performers from last month's gamification leaderboard. If the current user is not in the top 3, their ranking is appended to the result for comparison.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/securitygrowthdashboard/top-department-performance": { "get": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves the top 3 departments ranked by average performance over the last month.\r\nIf the current user's department is not in the top 3, it is appended as a 4th entry.\r\nIf the user has no department, only the top 3 are returned.\r\nIf no departments exist in the company, an empty list is returned.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.GamificationPointScale.Dto.DepartmentLeaderboardResultDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/securitygrowthdashboard/top-department-user-performance": { "get": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves the top 3 performers within the current user's department for the last month.\r\nRankings are scoped to the department (rank 1 = best in department, not company-wide).\r\nIf the current user is not in the top 3, their ranking is appended as a 4th entry.\r\nIf the user has no department, an empty list is returned.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.GamificationPointScale.Dto.GamificationViewResultDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/securitygrowthdashboard/user-timeline": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves the current user's activity timeline from the gamification leaderboard for the last month, showing security-related events such as phishing test results and training completions.", "requestBody": { "description": "Timeline request parameters including pagination and optional filtering.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserTimelineRequestParameter" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","datePeriod":"LastMonth","pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false},"showOnlyFailedEvents":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserTimelineRequestParameter" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","datePeriod":"LastMonth","pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false},"showOnlyFailedEvents":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserTimelineRequestParameter" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","datePeriod":"LastMonth","pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false},"showOnlyFailedEvents":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.LeaderboardUserTimelineRequestParameter" }, "example": {"targetUserResourceId":"Tu5Kp2mR7xLv","datePeriod":"LastMonth","pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false},"showOnlyFailedEvents":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.GamificationPointScale.Dto.GamificationUserTimeLineViewResultDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/securitygrowthdashboard/phishing-result": { "get": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves a summary of the current user's phishing test results, including pass/fail counts and overall success rate across all campaigns.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.GamificationPointScale.Dto.PhishingTestResultSummaryDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/securitygrowthdashboard/my-learning": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves the current user's learning progress, including assigned training modules, completion status, and scores from awareness education programs.", "requestBody": { "description": "Learning request parameters including pagination and optional filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.MyLearningRequestParameter" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false}} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.MyLearningRequestParameter" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false}} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.MyLearningRequestParameter" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false}} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.MyLearningRequestParameter" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]}]},"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false}} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.GamificationPointScale.Dto.MyLearningResultDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/securitygrowthdashboard/my-certificates": { "post": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves the current user's earned certificates from completed awareness training courses, including certificate metadata and issuance dates.", "requestBody": { "description": "Certificate request parameters including pagination and optional filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.UserCertificateRequestParameter" }, "example": {"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false}} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.UserCertificateRequestParameter" }, "example": {"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false}} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.UserCertificateRequestParameter" }, "example": {"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false}} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.UserCertificateRequestParameter" }, "example": {"pagination":{"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false}} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.GamificationPointScale.Dto.UserCertificateDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/securitygrowthdashboard/user-info": { "get": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves profile information for the currently authenticated target user, including email, department, phone number, and preferred language settings.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Object, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails" } } } } } } }, "/api/securitygrowthdashboard/certificate-download/{enrollmentId}": { "get": { "tags": [ "Reports & Analytics" ], "summary": "Downloads a training completion certificate as a PDF file. The certificate HTML is fetched from the Awareness Educator service and converted to PDF using the configured page layout.", "parameters": [ { "name": "enrollmentId", "in": "path", "description": "Unique identifier of the training enrollment whose certificate is being downloaded.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request", "content": { "application/pdf": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.String, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/securitygrowthdashboard/my-badges": { "get": { "tags": [ "Reports & Analytics" ], "summary": "Retrieves the gamification badges earned by the current user, including badge type, name, and award criteria based on their security awareness activities.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.GamificationPointScale.Dto.BadgeInfoDto" } } } } } } } }, "/api/smishing-simulator/smishing-campaign/form-details": { "get": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Retrieves the form details required to create or edit an SMS phishing (smishing) campaign, including available options and default values.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.SmishingCampaign.Dto.SmishingCampaignFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign/search": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Searches and returns a paginated list of smishing campaigns for the current company, with support for filtering and sorting.", "requestBody": { "description": "Search criteria including pagination, sorting, and filter parameters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"awareness","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreatedDate","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"awareness","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreatedDate","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"awareness","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreatedDate","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.PhishingCampaignSearchRequest" }, "example": {"filter":{"searchInputTextValue":"awareness","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"StatusId","operator":"eq","value":"1"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreatedDate","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.SmishingCampaign.Dto.SmishingCampaignSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Creates a new SMS phishing (smishing) campaign for the current company with the specified target groups, scenarios, and scheduling options.", "requestBody": { "description": "The smishing campaign creation payload including name, target groups, scenario, and schedule configuration.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.CreateSmishingCampaignRequest" }, "example": {"smsProviderNumberResourceIds":["Sp3Nm7vR2kLx"],"smishingScenarios":[{"phishingScenarioResourceId":"Ss6Wp4mT8nKv","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"smishingScenarioResourceIds":["Ss6Wp4mT8nKv"],"useTargetUserTimeZone":false,"name":"Q1 2026 SMS Phishing Test","description":"SMS-based social engineering simulation for finance department","scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":7,"distributionStartTypeId":1,"distributionTypeId":3,"distributionDelayEvery":10,"distributionDelayTimeTypeId":2,"sendingLimit":30,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"frequency":"OneTime","awardCertificate":false,"categoryDistributionType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.CreateSmishingCampaignRequest" }, "example": {"smsProviderNumberResourceIds":["Sp3Nm7vR2kLx"],"smishingScenarios":[{"phishingScenarioResourceId":"Ss6Wp4mT8nKv","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"smishingScenarioResourceIds":["Ss6Wp4mT8nKv"],"useTargetUserTimeZone":false,"name":"Q1 2026 SMS Phishing Test","description":"SMS-based social engineering simulation for finance department","scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":7,"distributionStartTypeId":1,"distributionTypeId":3,"distributionDelayEvery":10,"distributionDelayTimeTypeId":2,"sendingLimit":30,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"frequency":"OneTime","awardCertificate":false,"categoryDistributionType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.CreateSmishingCampaignRequest" }, "example": {"smsProviderNumberResourceIds":["Sp3Nm7vR2kLx"],"smishingScenarios":[{"phishingScenarioResourceId":"Ss6Wp4mT8nKv","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"smishingScenarioResourceIds":["Ss6Wp4mT8nKv"],"useTargetUserTimeZone":false,"name":"Q1 2026 SMS Phishing Test","description":"SMS-based social engineering simulation for finance department","scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":7,"distributionStartTypeId":1,"distributionTypeId":3,"distributionDelayEvery":10,"distributionDelayTimeTypeId":2,"sendingLimit":30,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"frequency":"OneTime","awardCertificate":false,"categoryDistributionType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.CreateSmishingCampaignRequest" }, "example": {"smsProviderNumberResourceIds":["Sp3Nm7vR2kLx"],"smishingScenarios":[{"phishingScenarioResourceId":"Ss6Wp4mT8nKv","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"smishingScenarioResourceIds":["Ss6Wp4mT8nKv"],"useTargetUserTimeZone":false,"name":"Q1 2026 SMS Phishing Test","description":"SMS-based social engineering simulation for finance department","scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":7,"distributionStartTypeId":1,"distributionTypeId":3,"distributionDelayEvery":10,"distributionDelayTimeTypeId":2,"sendingLimit":30,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"frequency":"OneTime","awardCertificate":false,"categoryDistributionType":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign/{resourceId}": { "put": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Updates an existing SMS phishing (smishing) campaign identified by its resource ID with the provided configuration changes.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated smishing campaign payload including modified fields.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.UpdateSmishingCampaignRequest" }, "example": {"smsProviderNumberResourceIds":["Sp3Nm7vR2kLx"],"smishingScenarios":[{"phishingScenarioResourceId":"Ss6Wp4mT8nKv","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"smishingScenarioResourceIds":["Ss6Wp4mT8nKv"],"useTargetUserTimeZone":false,"resourceId":"Sc6Wn3mR8vTp","name":"Q2 2026 Updated SMS Phishing Campaign","description":"Updated SMS phishing simulation for finance department","distributionStartTypeId":1,"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":7,"sendingLimit":30,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"distributionTypeId":3,"distributionDelayEvery":10,"distributionDelayTimeTypeId":2,"distributionEmailOver":50,"distributionEmailOverTimeTypeId":2,"awardCertificate":false,"categoryDistributionType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.UpdateSmishingCampaignRequest" }, "example": {"smsProviderNumberResourceIds":["Sp3Nm7vR2kLx"],"smishingScenarios":[{"phishingScenarioResourceId":"Ss6Wp4mT8nKv","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"smishingScenarioResourceIds":["Ss6Wp4mT8nKv"],"useTargetUserTimeZone":false,"resourceId":"Sc6Wn3mR8vTp","name":"Q2 2026 Updated SMS Phishing Campaign","description":"Updated SMS phishing simulation for finance department","distributionStartTypeId":1,"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":7,"sendingLimit":30,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"distributionTypeId":3,"distributionDelayEvery":10,"distributionDelayTimeTypeId":2,"distributionEmailOver":50,"distributionEmailOverTimeTypeId":2,"awardCertificate":false,"categoryDistributionType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.UpdateSmishingCampaignRequest" }, "example": {"smsProviderNumberResourceIds":["Sp3Nm7vR2kLx"],"smishingScenarios":[{"phishingScenarioResourceId":"Ss6Wp4mT8nKv","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"smishingScenarioResourceIds":["Ss6Wp4mT8nKv"],"useTargetUserTimeZone":false,"resourceId":"Sc6Wn3mR8vTp","name":"Q2 2026 Updated SMS Phishing Campaign","description":"Updated SMS phishing simulation for finance department","distributionStartTypeId":1,"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":7,"sendingLimit":30,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"distributionTypeId":3,"distributionDelayEvery":10,"distributionDelayTimeTypeId":2,"distributionEmailOver":50,"distributionEmailOverTimeTypeId":2,"awardCertificate":false,"categoryDistributionType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.UpdateSmishingCampaignRequest" }, "example": {"smsProviderNumberResourceIds":["Sp3Nm7vR2kLx"],"smishingScenarios":[{"phishingScenarioResourceId":"Ss6Wp4mT8nKv","awardCertificate":false,"enrollmentSendTypeId":"StartTrainingImmediately","certificateConfigSendType":"SendOnFirstAttempt","sendTemplatesInPreferredLanguage":false}],"smishingScenarioResourceIds":["Ss6Wp4mT8nKv"],"useTargetUserTimeZone":false,"resourceId":"Sc6Wn3mR8vTp","name":"Q2 2026 Updated SMS Phishing Campaign","description":"Updated SMS phishing simulation for finance department","distributionStartTypeId":1,"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","duration":7,"sendingLimit":30,"excludeFromReports":false,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"targetGroupResourceIds":["Tg7Kp2mR4xLn"],"distributionTypeId":3,"distributionDelayEvery":10,"distributionDelayTimeTypeId":2,"distributionEmailOver":50,"distributionEmailOverTimeTypeId":2,"awardCertificate":false,"categoryDistributionType":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Deletes an SMS phishing (smishing) campaign identified by its resource ID, removing all associated configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Retrieves the full details of an existing SMS phishing (smishing) campaign by its resource ID, including scenarios, target groups, and schedule.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.SmishingCampaign.Dto.SmishingCampaignDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign/preview/{resourceId}": { "get": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Generates a preview of a smishing campaign, showing the SMS content and landing page as they would appear to target users.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign to preview.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.SmishingCampaign.Dto.SmishingCampaignPreviewListDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign/search/export": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Exports the smishing campaign list to a downloadable file (CSV, Excel, or PDF) based on the current search and filter criteria.", "requestBody": { "description": "Export parameters including pagination, filters, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/smishing-simulator/smishing-campaign/phone-number": { "get": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Retrieves the list of available SMS phone numbers that can be used as sender numbers in smishing scenarios.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Collections.Generic.List`1[[KeepnetLabs.ApplicationService.PhishingScenario.Dto.SmsPhoneNumberDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign/calculate-sending-info": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Calculates the estimated sending information for a smishing campaign, including total SMS count, cost, and delivery timeline.", "requestBody": { "description": "The campaign parameters used to calculate sending estimates, such as target groups and scenarios.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.SmishingCalculateSendingInfoRequest" }, "example": {"distributionTypeId":3,"distributionDelayEvery":10,"distributionDelayTimeTypeId":2,"sendingLimit":30,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"totalTargetUserCount":150} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.SmishingCalculateSendingInfoRequest" }, "example": {"distributionTypeId":3,"distributionDelayEvery":10,"distributionDelayTimeTypeId":2,"sendingLimit":30,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"totalTargetUserCount":150} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.SmishingCalculateSendingInfoRequest" }, "example": {"distributionTypeId":3,"distributionDelayEvery":10,"distributionDelayTimeTypeId":2,"sendingLimit":30,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"totalTargetUserCount":150} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.SmishingCalculateSendingInfoRequest" }, "example": {"distributionTypeId":3,"distributionDelayEvery":10,"distributionDelayTimeTypeId":2,"sendingLimit":30,"sendOnlyActiveUsers":true,"sendRandomlyUsers":false,"sendRandomlyUsersCount":0,"sendRandomlyUsersCalculateTypeId":1,"totalTargetUserCount":150} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.SmishingCampaign.Dto.SmishingCampaignSendingInfoViewModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign/calculate-schedule-info": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Calculates the schedule information for a smishing campaign, estimating delivery windows and completion times based on the provided parameters.", "requestBody": { "description": "The scheduling parameters including target groups, frequency, and time zone settings.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.Base.SmishingCalculateScheduleInfoRequest" }, "example": {"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","frequency":1,"smishingScenarioResourceIds":["Ss6Wp4mT8nKv"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.Base.SmishingCalculateScheduleInfoRequest" }, "example": {"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","frequency":1,"smishingScenarioResourceIds":["Ss6Wp4mT8nKv"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.Base.SmishingCalculateScheduleInfoRequest" }, "example": {"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","frequency":1,"smishingScenarioResourceIds":["Ss6Wp4mT8nKv"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaign.Base.SmishingCalculateScheduleInfoRequest" }, "example": {"scheduleTypeId":3,"scheduledDate":"2026-10-26 12:13:31","scheduledDateTimeZoneId":"Europe/London","frequency":1,"smishingScenarioResourceIds":["Ss6Wp4mT8nKv"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.SmishingCampaign.Dto.SmishingCampaignScheduleInfoViewModel, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job/form-details": { "get": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Retrieves the form details required to configure a smishing campaign job, including available instance groups and scheduling options.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.SmishingCampaignJob.Dto.SmishingCampaignJobFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job/start/{resourceId}/{instanceGroup}": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Starts an existing smishing campaign job instance for the specified campaign and instance group, beginning SMS delivery to target users.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number identifying which job run to start.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job/start/{resourceId}": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Creates a new smishing campaign job instance and immediately starts SMS delivery for the specified campaign.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign to create and start a job for.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Optional campaign instance configuration overrides.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.SmishingCampaignJob.Dto.SmishingCampaignInstance" }, "example": {"excludeFromReports":false,"scheduledDate":"2026-10-20 12:13:31","scheduledDateTimeZoneId":"UTC","scheduleTypeId":1,"targetGroupResourceIds":["Qw4Rt6yU8iOp"],"distributionStartTypeId":1,"sendingLimit":100,"distributionDelayTimeTypeId":1,"distributionDelayEvery":0,"useTargetUserTimeZone":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.SmishingCampaignJob.Dto.SmishingCampaignInstance" }, "example": {"excludeFromReports":false,"scheduledDate":"2026-10-20 12:13:31","scheduledDateTimeZoneId":"UTC","scheduleTypeId":1,"targetGroupResourceIds":["Qw4Rt6yU8iOp"],"distributionStartTypeId":1,"sendingLimit":100,"distributionDelayTimeTypeId":1,"distributionDelayEvery":0,"useTargetUserTimeZone":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.SmishingCampaignJob.Dto.SmishingCampaignInstance" }, "example": {"excludeFromReports":false,"scheduledDate":"2026-10-20 12:13:31","scheduledDateTimeZoneId":"UTC","scheduleTypeId":1,"targetGroupResourceIds":["Qw4Rt6yU8iOp"],"distributionStartTypeId":1,"sendingLimit":100,"distributionDelayTimeTypeId":1,"distributionDelayEvery":0,"useTargetUserTimeZone":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.SmishingCampaignJob.Dto.SmishingCampaignInstance" }, "example": {"excludeFromReports":false,"scheduledDate":"2026-10-20 12:13:31","scheduledDateTimeZoneId":"UTC","scheduleTypeId":1,"targetGroupResourceIds":["Qw4Rt6yU8iOp"],"distributionStartTypeId":1,"sendingLimit":100,"distributionDelayTimeTypeId":1,"distributionDelayEvery":0,"useTargetUserTimeZone":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job/stop/{resourceId}/{instanceGroup}": { "patch": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Stops a running smishing campaign job, halting further SMS delivery to remaining target users in the specified instance group.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number identifying which job run to stop.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job/{resourceId}/{instanceGroup}": { "delete": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Deletes a smishing campaign job instance and its associated tracking data for the specified campaign and instance group.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number identifying which job run to delete.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job/resend/{resourceId}/{instanceGroup}": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Resends SMS messages to target users filtered by activity type (e.g., not clicked, not submitted) within the specified campaign job instance.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number identifying which job run to resend from.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The resend criteria specifying which user activity types to target for re-delivery.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersRequest" }, "example": {"types":["NoResponse"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersRequest" }, "example": {"types":["NoResponse"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersRequest" }, "example": {"types":["NoResponse"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersRequest" }, "example": {"types":["NoResponse"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job/resend/list/{resourceId}/{instanceGroup}": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Resends SMS messages to a specific list of target users within the specified campaign job instance, with support for select-all and exclusion logic.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number identifying which job run to resend from.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "The resend criteria including specific user selections, exclusions, and filter parameters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersListRequest" }, "example": {"items":["Tu3Kp8mR7xLv","Tu6Wn4vT9nQs"],"selectAll":false,"excludedItems":[],"searchType":"NoResponse"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersListRequest" }, "example": {"items":["Tu3Kp8mR7xLv","Tu6Wn4vT9nQs"],"selectAll":false,"excludedItems":[],"searchType":"NoResponse"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersListRequest" }, "example": {"items":["Tu3Kp8mR7xLv","Tu6Wn4vT9nQs"],"selectAll":false,"excludedItems":[],"searchType":"NoResponse"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.ResendPhishingCampaignJobToUsersListRequest" }, "example": {"items":["Tu3Kp8mR7xLv","Tu6Wn4vT9nQs"],"selectAll":false,"excludedItems":[],"searchType":"NoResponse"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job-report/summary/{resourceId}/{instanceGroup}": { "get": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Retrieves the summary details of a smishing campaign job, including delivery statistics, click rates, and submission counts for the specified instance group.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number identifying the specific job run.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignSummaryResult, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job-report/summary/training/{resourceId}/{instanceGroup}": { "get": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Retrieves the training-focused summary details of a smishing campaign job, including awareness training completion metrics for the specified instance group.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number identifying the specific job run.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignSummaryResult, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job-report/summary/target-groups/{resourceId}/{instanceGroup}": { "get": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Retrieves the target groups and their user breakdown for a smishing campaign job, showing group-level delivery and response statistics.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number identifying the specific job run.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.SmishingCampaignJob.Dto.SmishingCampaignTargetGroupsResult, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job-report/{resourceId}/search": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Searches and returns a paginated list of campaign job instances belonging to a specific smishing campaign, with support for filtering by frequency group.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the parent smishing campaign.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including pagination, sorting, frequency group filter, and additional filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.SmishingCampaignJob.SearchSmishingCampaignJobRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false,"smishingCampaignFrequencyGroup":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.SmishingCampaignJob.SearchSmishingCampaignJobRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false,"smishingCampaignFrequencyGroup":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.SmishingCampaignJob.SearchSmishingCampaignJobRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false,"smishingCampaignFrequencyGroup":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.SmishingCampaignJob.SearchSmishingCampaignJobRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false,"smishingCampaignFrequencyGroup":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.SmishingCampaignJob.Search.SmishingCampaignJobSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job-report/search": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Searches and returns a paginated list of all smishing campaign job reports across campaigns, with support for filtering and sorting.", "requestBody": { "description": "Search criteria including pagination, sorting, and filter parameters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobReportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobReportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobReportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobReportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreatedDate","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.SmishingCampaignJob.Search.SmishingCampaignJobReportSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job-report/search/export": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Exports the smishing campaign job report list to a downloadable file (CSV, Excel, or PDF) based on the current search and filter criteria.", "requestBody": { "description": "Export parameters including pagination, filters, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/smishing-simulator/smishing-campaign-job-report/{resourceId}/search/export": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Exports the campaign job instances list for a specific smishing campaign to a downloadable file, with support for frequency group filtering.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the parent smishing campaign.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Export parameters including pagination, filters, export type, and frequency group filter.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SmishingCampaignJob.ExportSmishingCampaignJobRequest" }, "example": {"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","smishingCampaignFrequencyGroup":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SmishingCampaignJob.ExportSmishingCampaignJobRequest" }, "example": {"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","smishingCampaignFrequencyGroup":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SmishingCampaignJob.ExportSmishingCampaignJobRequest" }, "example": {"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","smishingCampaignFrequencyGroup":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.SmishingCampaignJob.ExportSmishingCampaignJobRequest" }, "example": {"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false,"reportAllPages":true,"exportType":"Excel","smishingCampaignFrequencyGroup":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/smishing-simulator/smishing-campaign-job-report/{searchType}/search/{resourceId}/{instanceGroup}": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Searches and returns a paginated list of target users for a smishing campaign job, filtered by activity type (e.g., sent, clicked, submitted).", "parameters": [ { "name": "searchType", "in": "path", "description": "The user search category such as sent, clicked, or submitted.", "required": true, "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignJobUserSearchType" } }, { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number identifying the specific job run. Must be greater than 0.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Search criteria including pagination, sorting, activity type filter, and additional filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.CustomPhishingCampaignJobUsersPagedResults`1[[KeepnetLabs.ApplicationService.SmishingCampaignJob.Dto.SmishingCampaignJobUsersSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job-report/{searchType}/search/export/{resourceId}/{instanceGroup}": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Exports the target users list for a smishing campaign job to a downloadable file, filtered by activity type (e.g., sent, clicked, submitted).", "parameters": [ { "name": "searchType", "in": "path", "description": "The user search category such as sent, clicked, or submitted.", "required": true, "schema": { "$ref": "#/components/schemas/KeepnetLabs.ApplicationService.PhishingCampaignJob.Dto.PhishingCampaignJobUserSearchType" } }, { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number identifying the specific job run. Must be greater than 0.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Export parameters including pagination, filters, export type, and activity type.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.SmishingCampaignJob.Dto.SmishingCampaignJobUsersSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job-report/search-sms-clicked/{resourceId}": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Searches and returns a paginated list of SMS link click events for a specific campaign job user, showing click timestamps and source details.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign job user.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including pagination, sorting, activity type filter, and additional filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.SmishingCampaignJob.Dto.SmishingCampaignJobUserSmsClickedSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job-report/search-sms-submitted/{resourceId}": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Searches and returns a paginated list of landing page form submission events for a specific campaign job user, showing submitted data details.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign job user.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including pagination, sorting, and additional filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.SmishingCampaignJob.Dto.SmishingCampaignJobUserSmsSubmittedSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job-report/search-sms-all/{resourceId}": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Searches and returns a paginated list of all SMS activity events for a specific campaign job user, combining click, submission, and other interaction data.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign job user.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including pagination, sorting, and additional filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.SmishingCampaignJob.Dto.SmishingCampaignJobUserSmsAllSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/smishing-campaign-job-report/export/{resourceId}/{instanceGroup}": { "get": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Exports a detailed Excel report for a smishing campaign job, including comprehensive delivery, click, and submission statistics for all target users.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign.", "required": true, "schema": { "type": "string" } }, { "name": "instanceGroup", "in": "path", "description": "The instance group number identifying the specific job run.", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/smishing-simulator/smishing-campaign-job-report/search-mfa-submitted/{resourceId}": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Searches and returns a paginated list of MFA (multi-factor authentication) code submission events for a specific campaign job user.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the smishing campaign job user.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Search criteria including pagination, sorting, and additional filters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.PhishingCampaignJob.SearchPhishingCampaignJobUsersRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"Email","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.SmishingCampaignJob.Dto.SmishingCampaignJobUserSmsMfaSubmittedSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/dns-services/form-details": { "get": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Retrieves the form details required to create or edit a DNS service provider configuration, including available provider types and default values.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.DnsService.Dto.DnsServiceFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/dns-services": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Creates a new DNS service provider configuration for the current company, used to manage domain records for smishing landing pages.", "requestBody": { "description": "The DNS service provider creation payload including provider type, API credentials, and configuration details.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.CreateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.CreateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.CreateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.CreateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/smishing-simulator/dns-services/{resourceId}": { "put": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Updates an existing DNS service provider configuration identified by its resource ID with the provided changes.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the DNS service provider to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated DNS service provider payload including modified fields.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.UpdateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production Updated","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.UpdateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production Updated","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.UpdateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production Updated","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.UpdateDnsServiceProviderRequest" }, "example": {"dnsServiceProviderTypeId":1,"dnsServiceProviderName":"Cloudflare Production Updated","username":"api-key@example.com","password":"api-secret-token","recordTypeId":1,"dnsRecord":"192.0.2.1","availableForRequests":[]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Deletes a DNS service provider configuration identified by its resource ID, removing the provider and its associated settings.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the DNS service provider to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Retrieves the full details of an existing DNS service provider configuration by its resource ID.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the DNS service provider to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.DnsService.Dto.DnsServiceProviderDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/dns-services/search": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Searches and returns a paginated list of DNS service providers for the current company, with support for filtering and sorting.", "requestBody": { "description": "Search criteria including pagination, sorting, and filter parameters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.DnServiceProviderSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.DnServiceProviderSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.DnServiceProviderSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.DnServiceProviderSearchRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":20,"orderBy":"CreateTime","ascending":false} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.DnsService.Search.DnsServiceProviderSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/dns-services/search/export": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Exports the DNS service provider list to a downloadable file (CSV, Excel, or PDF) based on the current search and filter criteria.", "requestBody": { "description": "Export parameters including pagination, filters, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/smishing-simulator/dns-services/{resourceId}/test": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Tests the connectivity and credentials of a DNS service provider by attempting to communicate with the provider's API using the stored configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the DNS service provider to test.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The test parameters including any provider-specific settings to validate.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.TestDnsServiceProviderRequest" }, "example": {"resourceId":"65BVv1136Vnp","dnsServiceProviderTypeId":1,"username":"api-key@example.com","password":"api-secret-token"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.TestDnsServiceProviderRequest" }, "example": {"resourceId":"65BVv1136Vnp","dnsServiceProviderTypeId":1,"username":"api-key@example.com","password":"api-secret-token"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.TestDnsServiceProviderRequest" }, "example": {"resourceId":"65BVv1136Vnp","dnsServiceProviderTypeId":1,"username":"api-key@example.com","password":"api-secret-token"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DnsService.TestDnsServiceProviderRequest" }, "example": {"resourceId":"65BVv1136Vnp","dnsServiceProviderTypeId":1,"username":"api-key@example.com","password":"api-secret-token"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/domain-records/form-details": { "get": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Retrieves the form details required to create or edit a domain record, including available DNS service providers and record type options.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.DomainRecord.Dto.DomainRecordFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/domain-records/test": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Tests the validity of a DNS zone ID by verifying it against the associated DNS service provider's API.", "requestBody": { "description": "The test parameters including zone ID and DNS provider reference to validate.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.TestDomainRecordRequest" }, "example": {"dnsServiceProviderId":1,"zoneId":"abc123def456"} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.TestDomainRecordRequest" }, "example": {"dnsServiceProviderId":1,"zoneId":"abc123def456"} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.TestDomainRecordRequest" }, "example": {"dnsServiceProviderId":1,"zoneId":"abc123def456"} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.TestDomainRecordRequest" }, "example": {"dnsServiceProviderId":1,"zoneId":"abc123def456"} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/domain-records": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Creates a new domain record for the current company, linking a domain to a DNS service provider for use in smishing landing pages.", "requestBody": { "description": "The domain record creation payload including domain name, zone ID, and DNS provider reference.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+CreateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.50","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+CreateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.50","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+CreateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.50","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+CreateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.50","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[System.Dynamic.ExpandoObject, System.Linq.Expressions, Version=8.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a]]" } } } } } } }, "/api/smishing-simulator/domain-records/{resourceId}": { "put": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Updates an existing domain record identified by its resource ID with the provided configuration changes.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the domain record to update.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The updated domain record payload including modified fields.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+UpdateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.51","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+UpdateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.51","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+UpdateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.51","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+UpdateDomainRecordRequest" }, "example": {"domain":"phishing-sim.acme.com","recordTypeId":1,"dnsServiceProviderId":1,"dnsRecord":"203.0.113.51","proxyStatusId":1,"urlSchemaTypeId":2,"zoneId":"zone-abc123def456","isActive":true,"availableForRequests":[{"type":"Company","resourceId":"a1b2c3d4e5f6"}]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "delete": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Deletes a domain record identified by its resource ID, removing the domain association from the smishing simulator.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the domain record to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.IdResult, KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } }, "get": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Retrieves the full details of an existing domain record by its resource ID, including domain name, zone ID, and DNS provider configuration.", "parameters": [ { "name": "resourceId", "in": "path", "description": "The unique resource identifier of the domain record to retrieve.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.DomainRecord.Dto.DomainRecordDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/domain-records/search": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Searches and returns a paginated list of domain records for the current company, with support for filtering and sorting.", "requestBody": { "description": "Search criteria including pagination, sorting, and filter parameters.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+DomainRecordSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":true} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+DomainRecordSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":true} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+DomainRecordSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":true} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.DomainRecord.DomainRecordRequest+DomainRecordSearchRequest" }, "example": {"filter":{"searchInputTextValue":"acme","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[{"fieldName":"IsActive","operator":"eq","value":"true"}],"filterGroups":[]}]},"pageNumber":1,"pageSize":10,"orderBy":"CreateTime","ascending":true} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.Core.Pagination.PagedResults`1[[KeepnetLabs.ApplicationService.DomainRecord.Dto.DomainRecordSearchView, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], KeepnetLabs.Core, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/domain-records/search/export": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Exports the domain record list to a downloadable file (CSV, Excel, or PDF) based on the current search and filter criteria.", "requestBody": { "description": "Export parameters including pagination, filters, export type, and whether to include all pages.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.Export.ExportRequest" }, "example": {"filter":{"searchInputTextValue":"","condition":"AND","filterGroups":[{"condition":"AND","filterItems":[],"filterGroups":[]},{"condition":"OR","filterItems":[],"filterGroups":[]}]},"pageNumber":1,"pageSize":25,"orderBy":"CreateTime","ascending":false,"reportAllPages":false,"exportType":"Excel","phishingTypeId":0,"tempalateType":0} } } }, "responses": { "200": { "description": "OK" } } } }, "/api/smishing-simulator/excluded-ip": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Creates or updates the excluded IP address list for smishing campaigns, preventing landing page tracking for requests originating from the specified IPs.", "requestBody": { "description": "The excluded IP list payload containing IP addresses or CIDR ranges to exclude from campaign tracking.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ExcludedIP.CreatePhishingCampaignExcludedIPRequest" }, "example": {"excludedIPs":["10.0.0.1","192.168.1.0/24"]} }, "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ExcludedIP.CreatePhishingCampaignExcludedIPRequest" }, "example": {"excludedIPs":["10.0.0.1","192.168.1.0/24"]} }, "text/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ExcludedIP.CreatePhishingCampaignExcludedIPRequest" }, "example": {"excludedIPs":["10.0.0.1","192.168.1.0/24"]} }, "application/*+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.ExcludedIP.CreatePhishingCampaignExcludedIPRequest" }, "example": {"excludedIPs":["10.0.0.1","192.168.1.0/24"]} } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignExcludedIP.Dto.PhishingCampaignExcludedIPDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/excluded-ip-list": { "get": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Retrieves the current list of excluded IP addresses configured for smishing campaigns, which are ignored during landing page interaction tracking.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.PhishingCampaignExcludedIP.Dto.PhishingCampaignExcludedIPItemDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/landing-page-template/form-details": { "get": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Retrieves the form details required to create or edit a smishing landing page template, including available field types and layout options.", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.Core.ServiceResult`1[[KeepnetLabs.ApplicationService.LandingPageTemplate.Dto.LandingPageTemplateFormDetailsDto, KeepnetLabs.ApplicationService, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]" } } } } } } }, "/api/smishing-simulator/landing-page-template": { "post": { "tags": [ "SMS Phishing (Smishing)" ], "summary": "Creates a new smishing landing page template for the current company, defining the HTML content and form fields displayed when a target user clicks an SMS link.", "requestBody": { "description": "The landing page template creation payload including name, HTML content, and form field configuration.", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/KeepnetLabs.DistributedService.Rest.Models.LandingPageTemplate.CreateLandingPageTemplateRequest" }, "example": {"name":"Office 365 Login Page","description":"Simulates a Microsoft 365 sign-in page for credential harvesting","methodTypeId":1,"difficultyTypeId":1,"urlSchemaTypeId":1,"subDomain":"login","domainRecordId":1,"autoRotate":false,"pathTypeId":1,"extensionTypeId":1,"parameterTypeId":1,"landingPages":[{"resourceId":"Lp3Kx7mN2wRt","name":"Login Page","order":1,"content":"