category: Case Management sectionorder: - Connect - Collect provider: Navex Global commonfields: id: Lockpath KeyLight v2 version: -1 configuration: - display: Server URL in the form of https://[server]: (e.g. https://192.168.0.1:4443) name: server required: true type: 0 section: Connect - display: Credentials name: credentials required: true type: 9 section: Connect - display: Incident type name: incidentType type: 13 required: false section: Collect - display: Incidents Fetch Interval name: incidentFetchInterval defaultvalue: '1' required: false type: 19 advanced: true section: Collect - display: Name of component to fetch from name: component_name type: 0 required: false section: Connect - defaultvalue: Created At display: Name of field to fetch by name: filter_field type: 0 required: false section: Collect - defaultvalue: '50' display: Fetch Limit name: fetch_limit type: 0 required: false section: Collect - display: Trust any certificate (not secure) name: insecure type: 8 required: false section: Connect - display: Use system proxy settings name: proxy type: 8 required: false section: Connect - display: Fetch incidents name: isFetch type: 8 required: false section: Collect description: Use the LockPath KeyLight integration to manage GRC tickets in the Keylight platform. display: Lockpath KeyLight v2 name: Lockpath KeyLight v2 script: commands: - arguments: - description: The id of the component. name: component_id - description: The alias of the component. name: alias description: Retrieves a component specified by ID or alias. If no parameters are specified, all components will be retrieved. name: kl-get-component outputs: - contextPath: Keylight.Component.ID description: The ID of the component. type: String - contextPath: Keylight.Component.Name description: The name of the component. type: String - contextPath: Keylight.Component.ShortName description: The short name of the component. type: String - contextPath: Keylight.Component.SystemName description: The system name of the component. type: String - arguments: - description: The id of the component. name: component_id required: true description: Retrieves a detail field listing for a component specified by ID. name: kl-get-field-list outputs: - contextPath: Keylight.Field.ID description: The ID of the field. type: String - contextPath: Keylight.Field.Name description: The field's name. type: String - contextPath: Keylight.Field.SystemName description: The system name of the field. type: String - contextPath: Keylight.Field.ShortName description: The short name of the field. type: String - contextPath: Keylight.Field.ReadOnly description: Is the field read only. type: Boolean - contextPath: Keylight.Field.Required description: Is the field required. type: Boolean - arguments: - description: The ID of the component. Get the ID from the kl-get-component command. name: component_id required: true - description: The name of the field. name: field_name required: true description: Retrieves details for a field specified by ID. name: kl-get-field outputs: - contextPath: Keylight.Field.ID description: The ID of the field. type: String - contextPath: Keylight.Field.Name description: The field's name. type: String - contextPath: Keylight.Field.SystemName description: The system name of the field. type: String - contextPath: Keylight.Field.ShortName description: The short name of the field. type: String - contextPath: Keylight.Field.ReadOnly description: Is the field read only. type: Boolean - contextPath: Keylight.Field.Required description: Is the field required. type: String - arguments: - description: The component ID. Get the D from the kl-get-component. name: component_id required: true - description: |- The filter specific for field names. * Case sensitive. * If one of the names contains a space, add all names in parenthesis (such as "Id,Published Revision"). isArray: true name: field_names - description: The record ID. Get the ID from Keylight or from the kl-get-records command. name: record_id required: true - auto: PREDEFINED defaultValue: 'False' description: Whether to get detailed records. Default is false. name: detailed predefined: - 'False' - 'True' description: Returns the complete set of fields for a given record within a component. name: kl-get-record outputs: - contextPath: Keylight.Record.ID description: The record ID. type: String - contextPath: Keylight.Record.Fields description: The fields in the record. type: String - contextPath: Keylight.Record.ComponentID description: The component ID of the record. type: String - contextPath: Keylight.Record.DisplayName description: The display name of the record. type: String - arguments: - description: The ID of the desired component. Get the ID from the kl-get-component command. name: component_id required: true - defaultValue: '0' description: The index of the page of result to return. Must be >= 0. name: page_index - defaultValue: '10' description: The index of the page of result to return. Must be between 0 and 100. name: page_size - auto: PREDEFINED description: 'The type of filter to apply. Can be: "Contains", "Excludes", "Starts With", "Ends With", "Equals", "Not Equals", "Greater Than", "Less Than", "Greater Than", "Less Than", "Greater Equals Than", "Between", "Not Between", "Is Null", "Is Not Null".' name: filter_type predefined: - Contains - Excludes - Starts With - Ends With - Equals - Not Equals - Greater Than - Less Than - Greater Equals Than - Less Equals Than - Between - Not Between - Is Null - Is Not Null - description: The name of the field for which to apply the filter. name: filter_field_name - description: The value for which to filter. name: filter_value - auto: PREDEFINED defaultValue: 'False' description: Whether to get detailed records. name: detailed predefined: - 'False' - 'True' - description: A list of specific fields to return. If empty, return all fields. name: returned_fields description: |- Retrieves the title/default field for a set of records within a chosen component. Filters may be applied to retrieve only the records meeting the selected criteria. name: kl-get-records outputs: - contextPath: Keylight.Record.ComponentID description: The ID of the component containing the record. type: String - contextPath: Keylight.Record.DisplayName description: The display name of the record. type: String - contextPath: Keylight.Record.Fields description: The fields in the record. type: Unknown - contextPath: Keylight.Record.ID description: The ID of the record. type: Unknown - arguments: - description: The ID of the desired component. Get the ID from the kl-get-component command. name: component_id required: true - auto: PREDEFINED description: 'The type of filter to apply. Can be: "Contains", "Excludes", "Starts With", "Ends With", "Equals", "Not Equals", "Greater Than", "Less Than", "Greater Than", "Less Than", "Greater Equals Than", "Between", "Not Between", "Is Null", "Is Not Null".' name: filter_type predefined: - Contains - Excludes - Starts With - Ends With - Equals - Not Equals - Greater Than - Less Than - Greater Equals Than - Less Equals Than - Between - Not Between - Is Null - Is Not Null - description: The name of the field for which to apply the filter. name: filter_field_name - description: The value for which to filter. name: filter_value description: Get the number of records for a specific component and filter. name: kl-get-record-count - arguments: - description: The ID of the desired component. Get the ID from the kl-get-component command. name: component_id required: true - description: The record ID. Can get from Keylight or from the kl-get-records command. name: record_id required: true - description: The name of the field that holds the attachments. Must be type "Documents". name: field_name required: true description: Return the attachments of a specific field and record. name: kl-get-record-attachments outputs: - contextPath: Keylight.Attachment.FileName description: The name of the attachment. type: String - contextPath: Keylight.Attachment.FieldID description: The field ID of the attachment. type: String - contextPath: Keylight.Attachment.DocumentID description: The ID of the document containing the attachment. type: String - contextPath: Keylight.Attachment.ComponentID description: The component ID of the attachment. type: String - contextPath: Keylight.Attachment.RecordID description: The record ID of the attachment. type: String - arguments: - description: The ID of the desired component. Get the ID from the kl-get-component command. name: component_id required: true - description: The record ID. Can get from Keylight or from the kl-get-records command. name: record_id required: true - description: The name of the field that holds the attachments. Must be type "Documents". name: field_name required: true - description: The ID of the document. name: document_id required: true description: Returns a single attachment associated with the component ID, record ID, documents field ID, and the document ID. name: kl-get-record-attachment - arguments: - description: The component ID. Get the ID from the kl-get-component command. name: component_id required: true - description: The record ID. name: record_id required: true description: Deletes a selected record from within a chosen component. name: kl-delete-record - arguments: - description: The ID of the component. Get the ID from the kl-get-component command. name: component_id required: true - description: The ID of the record to delete. name: record_id required: true - description: The ID of the field. name: field_id required: true - description: The ID of the document to delete. name: document_id required: true description: Deletes a specific attachment. name: kl-delete-record-attachment - arguments: - description: The lookup field ID, which relates to a lookup field that uses the report definition. name: lookup_field_id required: true - description: The field path ID, which relates to the field path that retrieves fields. Get from the kl-get-record command. Detailed=True. name: field_path_id required: true description: Retrieves information of each field in a field path, which relates to a lookup report column. name: kl-get-lookup-report-column-fields outputs: - contextPath: Keylight.LookupField.ID description: The lookup field's ID. type: String - contextPath: Keylight.LookupField.Name description: The lookup field's name. type: String - contextPath: Keylight.LookupField.ComponentID description: The lookup field's component ID. type: String - contextPath: Keylight.LookupField.SystemName description: The system name of the lookup field. type: String - arguments: - description: The ID of the component the record should be created in. Get the ID from the kl-get-component command. name: component_id required: true - description: A JSON file in the format that the API requests. The exact format is found in the API documentation. name: record_json description: |- Creates a new record within the specified component of the Keylight application. * The Required option for a field is only enforced through the user interface, not through Demisto. name: kl-create-record outputs: - contextPath: Keylight.Record.ComponentID description: The component ID of the record. type: String - contextPath: Keylight.Record.DisplayName description: The display name of the record. type: String - contextPath: Keylight.Record.Fields description: The fields in the record. type: Unknown - contextPath: Keylight.Record.ID description: The record ID. type: String - arguments: - description: The ID of the component. Get the ID from the kl-get-component command. name: component_id required: true - description: The ID of the record to be updated. Get the ID from Keylight or from the kl-get-records command. name: record_id required: true - description: A JSON file in the format that the API requests. The exact format is found in the API documentation. name: record_json description: |- Update fields in a specified record. * The Required option for a field is only enforced through the user interface, not through Demisto. name: kl-update-record outputs: - contextPath: Keylight.Record.ComponentID description: The ID of the component the record is in. type: String - contextPath: Keylight.Record.DisplayName description: The display name of the record. type: String - contextPath: Keylight.Record.Fields description: The fields in the record. type: String - contextPath: Keylight.Record.ID description: The record ID. type: String - arguments: - description: The user ID. name: user_id required: true description: Get user details by his ID. name: kl-get-user-by-id outputs: - contextPath: Keylight.User.Id description: The user ID. type: String - contextPath: Keylight.User.FullName description: The user's full name. type: String - contextPath: Keylight.User.Username description: The user's username. type: String - contextPath: Keylight.User.Active description: Is the user active. type: Boolean - contextPath: Keylight.User.FirstName description: The user's first name. type: String - contextPath: Keylight.User.MiddleName description: The users middle name. type: String - contextPath: Keylight.User.LastName description: The user's last name. type: String - contextPath: Keylight.User.EmailAddress description: The user's email address. type: String - contextPath: Keylight.User.HomePhone description: The user's home phone. type: String - contextPath: Keylight.User.WorkPhone description: The user's work phone. type: String - contextPath: Keylight.User.MobilePhone description: The user's mobile phone. type: String dockerimage: demisto/python3:3.12.13.10116658 isfetch: true script: '-' type: python subtype: python3 tests: - No tests fromversion: 5.0.0