@itentialopensource/adapter-digicert_pki 0.1.1

package/CALLS.md

@@ -0,0 +1,356 @@
+## Using this Adapter
+
+The `adapter.js` file contains the calls the adapter makes available to the rest of the Itential Platform. The API detailed for these calls should be available through JSDOC. The following is a brief summary of the calls.
+
+### Generic Adapter Calls
+
+These are adapter methods that IAP or you might use. There are some other methods not shown here that might be used for internal adapter functionality.
+
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">connect()</td>
+    <td style="padding:15px">This call is run when the Adapter is first loaded by he Itential Platform. It validates the properties have been provided correctly.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">healthCheck(callback)</td>
+    <td style="padding:15px">This call ensures that the adapter can communicate with Digicert. The actual call that is used is defined in the adapter properties and .system entities action.json file.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">refreshProperties(properties)</td>
+    <td style="padding:15px">This call provides the adapter the ability to accept property changes without having to restart the adapter.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">encryptProperty(property, technique, callback)</td>
+    <td style="padding:15px">This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Digicert.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback)</td>
+    <td style="padding:15px">This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapFindAdapterPath(apiPath, callback)</td>
+    <td style="padding:15px">This call provides the ability to see if a particular API path is supported by the adapter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapSuspendAdapter(mode, callback)</td>
+    <td style="padding:15px">This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapUnsuspendAdapter(callback)</td>
+    <td style="padding:15px">This call provides the ability to resume a suspended adapter. Any requests in queue will be processed before new requests.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapGetAdapterQueue(callback)</td>
+    <td style="padding:15px">This call will return the requests that are waiting in the queue if throttling is enabled.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapTroubleshootAdapter(props, persistFlag, adapter, callback)</td>
+    <td style="padding:15px">This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+
+  <tr>
+    <td style="padding:15px">iapRunAdapterHealthcheck(adapter, callback)</td>
+    <td style="padding:15px">This call will return the results of a healthcheck.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapRunAdapterConnectivity(callback)</td>
+    <td style="padding:15px">This call will return the results of a connectivity check.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapRunAdapterBasicGet(callback)</td>
+    <td style="padding:15px">This call will return the results of running basic get API calls.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapMoveAdapterEntitiesToDB(callback)</td>
+    <td style="padding:15px">This call will push the adapter configuration from the entities directory into the Adapter or IAP Database.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
+    <td style="padding:15px">This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback)</td>
+    <td style="padding:15px">This call is the same as the genericAdapterRequest only it does not add a base_path or version to the call.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapHasAdapterEntity(entityType, entityId, callback)</td>
+    <td style="padding:15px">This call verifies the adapter has the specific entity.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapVerifyAdapterCapability(entityType, actionType, entityId, callback)</td>
+    <td style="padding:15px">This call verifies the adapter can perform the provided action on the specific entity.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapUpdateAdapterEntityCache()</td>
+    <td style="padding:15px">This call will update the entity cache.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+</table>
+<br>
+
+### Adapter Broker Calls
+
+These are adapter methods that are used to integrate to IAP Brokers. This adapter currently supports the following broker calls.
+
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">hasEntities(entityType, entityList, callback)</td>
+    <td style="padding:15px">This call is utilized by the IAP Device Broker to determine if the adapter has a specific entity and item of the entity.</td>
+    <td style="padding:15px">No</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDevice(deviceName, callback)</td>
+    <td style="padding:15px">This call returns the details of the requested device.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getDevicesFiltered(options, callback)</td>
+    <td style="padding:15px">This call returns the list of devices that match the criteria provided in the options filter.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">isAlive(deviceName, callback)</td>
+    <td style="padding:15px">This call returns whether the device status is active</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getConfig(deviceName, format, callback)</td>
+    <td style="padding:15px">This call returns the configuration for the selected device.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">iapGetDeviceCount(callback)</td>
+    <td style="padding:15px">This call returns the count of devices.</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+</table>
+<br>
+
+
+### Specific Adapter Calls
+
+Specific adapter calls are built based on the API of the Digicert. The Adapter Builder creates the proper method comments for generating JS-DOC for the adapter. This is the best way to get information on the calls.
+
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Method Signature</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Description</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Path</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Workflow?</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAuditsUsingGET(action, adminRA, dateFrom, dateTo, limit, offset, callback)</td>
+    <td style="padding:15px">This API is used to get audit details for given query param</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/audit-log?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAuditUsingGET(auditId, callback)</td>
+    <td style="padding:15px">This API is used to get audit details for given audit Id.</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/audit-log/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getCAInfoUsingGET(caId, callback)</td>
+    <td style="padding:15px">This API is used to get public CA details for a given ca identifier</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/ca/id/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getCAUsingGET(seatType, callback)</td>
+    <td style="padding:15px">This API is used to get public CA details for a given account api key</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/ca/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">enrollCertificateUsingPOST(enrollCertificateRequest, callback)</td>
+    <td style="padding:15px">This API is used to enroll a certificate for a given profile.</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/certificate?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createCertificateUsingPOST(enrollCertificateRequest, callback)</td>
+    <td style="padding:15px">This API is used to enroll a certificate for a given profile.</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/certificate/create?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">renewExternalCertificateUsingPOST(enrollCertificateRequest, serialNumber, callback)</td>
+    <td style="padding:15px">This API is used to enroll a certificate for a given profile.</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/certificate/renew/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getCertificateUsingGET(serialNumber, callback)</td>
+    <td style="padding:15px">This API is used to get certificate details for a given certificate serial number</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/certificate/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">recoverKeyUsingGET(serialNumber, callback)</td>
+    <td style="padding:15px">This API is used to get private key information for key-escrowed certificate with given serial number</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/certificate/{pathv1}/key?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">renewCertificateUsingPOST(enrollCertificateRequest, serialNumber, callback)</td>
+    <td style="padding:15px">This API is used to renew certificate with the given serial number.</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/certificate/{pathv1}/renew?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">revokeCertificateUsingPUT(revokeCertificateRequest, serialNumber, callback)</td>
+    <td style="padding:15px">This API can revoke certificate with the given serial number</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/certificate/{pathv1}/revoke?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">unRevokeCertificateUsingDELETE(serialNumber, callback)</td>
+    <td style="padding:15px">This API can resume certificate with the given serial number.</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/certificate/{pathv1}/revoke?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createPasscodeUsingPOST(createPasscodeRequest, callback)</td>
+    <td style="padding:15px">This API is used to enroll user for profile.</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/enrollment?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getEnrollmentUsingGET(enrollCode, seatId, callback)</td>
+    <td style="padding:15px">This API is used to get details of an existing enrollment.</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/enrollment/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">resetPasscodeUsingPUT(enrollCode, resetPasscodeRequest, callback)</td>
+    <td style="padding:15px">This API is used to reset enrollment code.</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/enrollment/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteEnrollmentUsingDELETE(deleteEnrollRequest, enrollCode, callback)</td>
+    <td style="padding:15px">This API can delete an enrollment for given enrollment id</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/enrollment/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">enrollStatusUsingGET(profileId, seatId, callback)</td>
+    <td style="padding:15px">This API is used to get certificate enrollment status.</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/enrollstatus/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">helloUsingGET(callback)</td>
+    <td style="padding:15px">Hello API</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/hello?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getAllProfilesUsingGET(callback)</td>
+    <td style="padding:15px">This API is used to get profile details of all profiles in an account and its subaccounts</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/profile?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getProfileUsingGET(profileId, callback)</td>
+    <td style="padding:15px">This API is used to get profile details for a given profile id</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/profile/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">activateProfileUsingPUT(profileCreationRequest, callback)</td>
+    <td style="padding:15px">This API is used to suspend a profile</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/profile/activate?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createProfileUsingPOST(profileCreationRequest, callback)</td>
+    <td style="padding:15px">This API is used to create a profile</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/profile/create?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteProfileUsingPUT(profileCreationRequest, callback)</td>
+    <td style="padding:15px">This API is used to delete a profile</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/profile/delete?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateProfileUsingPUT(profileCreationRequest, callback)</td>
+    <td style="padding:15px">This API is used to create a profile</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/profile/edit?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">suspendProfileUsingPUT(profileCreationRequest, callback)</td>
+    <td style="padding:15px">This API is used to suspend a profile</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/profile/suspend?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">testCreateUsingPOST(callback)</td>
+    <td style="padding:15px">This API is used to create a profile</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/profile/test?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">searchCertUsingPOST(searchReq, callback)</td>
+    <td style="padding:15px">This API is used to search for certificates.</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/searchcert?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">createSeatUsingPOST(createSeatRequest, callback)</td>
+    <td style="padding:15px">This API is used to create a seat. This seat can be used for  a user, device, server or organization seat pool.</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/seat?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">getSeatUsingGET(seatId, callback)</td>
+    <td style="padding:15px">This API is used to get information regarding a seat.</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/seat/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">updateSeatUsingPUT(seatId, updateSeatRequest, callback)</td>
+    <td style="padding:15px">This API is used to change the seat details.</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/seat/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">deleteSeatUsingDELETE(seatId, callback)</td>
+    <td style="padding:15px">This API is used to delete a seat. Deleting a seat will revoke all the certificates associated to the specified seat.</td>
+    <td style="padding:15px">{base_path}/{version}/api/v1/seat/{pathv1}?{query}</td>
+    <td style="padding:15px">Yes</td>
+  </tr>
+</table>
+<br>

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+
+## 0.1.1 [03-21-2023]
+
+* Bug fixes and performance improvements
+
+See commit 809b9ec
+
+---
+

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,43 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at support@itential.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the <a href="http://contributor-covenant.org" target="_blank">Contributor Covenant</a>, version 1.4, available at <a href="http://contributor-covenant.org/version/1/4/" target="_blank">version</a>

package/CONTRIBUTING.md

@@ -0,0 +1,172 @@
+# Contributing
+
+First off, thanks for taking the time to contribute!
+
+The following is a set of rules for contributing.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to support@itential.com.
+
+## How to Contribute
+
+### Reporting Bugs
+
+This section guides you through submitting a bug report. Following these guidelines helps maintainers understand your report :pencil:, reproduce the behavior :computer: :left_right_arrow: :computer:, and find related reports :mag_right:.
+
+Before creating bug reports, please check before-submitting-a-bug-report, as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. If you have an Itential support contract, please create an Itential Service Desk ticket. If you don't have an Itential support contract, please send an email of the issue to support@itential.com.
+
+#### Before Submitting A Bug Report
+
+* **Check the README.md.** You might be able to find the cause of the problem and fix things yourself. Most importantly, check if you can reproduce the problem __in the latest version__.
+* **Work through the troubleshooting process.** Troubleshooting will include changing the log level of Itential Automation Platform (IAP) and adapters and checking the logs to see what the issues are. These logs should be included in any ticket you open for this issue.
+* **Check for resolutions to the issue.** Check the <a href="https://itential.atlassian.net/servicedesk/customer/kb/view/286883841?applicationId=605994d2-2cb2-3174-af59-ed5b23ff5fd5&spaceKey=PKB&src=1187380921" target="_blank">Itential Knowledge Base</a> to see if there is a known resolution for the issue you are having.
+* **Ask around in chat if you are an Itential employee** to see if others are experiencing the same issue.
+
+#### How to Submit a (Good) Bug Report
+
+Bugs are tracked through the Itential Service Desk. Explain the problem and include additional details to help maintainers reproduce the problem:
+
+- **Use a clear and descriptive title** for the issue to identify the problem.
+- **Describe the exact steps which reproduce the problem** in as much detail as possible. For example, start by explaining how you configured the adapter (e.g., which properties you used and how they were set) or how you are using an artifact.
+- **Provide specific examples to demonstrate the steps**. Include logs, or copy/paste snippets, in your examples.
+- **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
+- **Explain which behavior you expected to see instead and why.**
+- **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. You can use <a href="https://www.cockos.com/licecap/" target="_blank">this tool</a> to record GIFs on macOS and Windows. Use <a href="https://github.com/colinkeenan/silentcast" target="_blank">this tool</a> or <a href="https://github.com/rhcarvalho/byzanz-guiz" target="_blank">program</a> on Linux.
+- **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
+
+Provide more context by answering these questions:
+
+- **Did the problem start happening recently** (e.g. after updating to a new version/tag) or was this always a problem?
+- If the problem started happening recently, **can you reproduce the problem in an older version/tag?** What's the most recent version in which the problem does not happen?
+- **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
+
+Include details about your configuration and environment:
+
+- **Which version of the adapter/artifact are you using?** You can get the exact version by checking the project version in the package.json file.
+- **What's the name and version of the OS you're using**?
+- **Are you running or using IAP in a virtual machine?** If so, which VM software are you using and which operating systems and versions are used for the host and guest?
+- **Are there firewalls between IAP and any other system you are integrating with?** If so, have you tried running curl from the system IAP is on to the other system to verify you have connectivity between the systems?
+
+### Your First Code Contribution
+
+#### Local development
+
+This project can be developed locally on all operating systems. For instructions on how to do this, follow the steps highlighted in the README.md. The README.mdprovides many more details on cloning the repository for local development, how to lint and test your changes. 
+
+#### Development Process
+
+The following provides a local copy of the repository along with dependencies.
+
+```json
+go to the repository you are interested in working on
+click on the Clone button to get the link(s) you can use to clone the repository
+git clone <link to clone the project>
+npm install
+```
+
+Prior to making changes you should create a branch to work in. The branch should be named with the type of change (major, minor or patch) and then a Jira issue number or a description of the issue.
+
+```json
+git checkout -b <name_of_your_new_branch>
+```
+
+Make all of the desired changes.
+
+> **Note:** All code changes should be accompanied by additional Unit and Integration tests to minimize the likelihood that any changes will negatively impact the adapter/artifact as well as to ensure the desired functionality is achieved.
+
+
+<table border="1" class="bordered-table">
+  <tr>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Files</span></th>
+    <th bgcolor="lightgrey" style="padding:15px"><span style="font-size:12.0pt">Changes</span></th>
+  </tr>
+  <tr>
+    <td style="padding:15px">.codeclimate.yml, .eslintignore, .eslintrc.js, .gitignore, .gitlab-ci.yml, .jshintrc, .npmignore</td>
+    <td style="padding:15px">These are foundational files that are used in linting and building of the adapter. Changes to these files are heavily scrutinized and may be implemented in a different manner so that the changes can be implemented across all adapters.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">CODE_OF_CONDUCT.md, CONTRIBUTING.md, LICENSE, README.md</td>
+    <td style="padding:15px">These are license and process files for the repository. Changes to these files may require legal review and may also be implemented in a different manner so that the changes can be implemented across all adapters.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">utils/*, adapterBase.js</td>
+    <td style="padding:15px">Changes to these files will rarely be accepted. These are process files that need to be changed through the builder process and migration.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">adapter.js</td>
+    <td style="padding:15px">Changes to this file are code changes. They should be accompanied by the appropriate unit and integration tests. If new methods are added, they should also be added to the pronghorn.json file, otherwise integration tests are likely to fail.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">error.json, propertiesSchema.json</td>
+    <td style="padding:15px">These files are utilized by the Itential Runtime libraries. You can make changes to these files, but the changes should be appending of new errors or properties. Removal of errors and properties can result in rejection of the changes.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">pacakge.json, package-lock.json</td>
+    <td style="padding:15px">The package-lock.json is automatically generated and should only be updated when the dependencies inside of the package.json are modified. You can make changes to the package.json to add additional scripts, add new dependencies, modify names, etc. However, changing the scripts or dependencies that are Itential specific will be overriden during the acceptance process.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">pronghorn.json</td>
+    <td style="padding:15px">Changes to this file are made for integration into IAP. The most common change here is adding new methods that shoud be exposed to the IAP Workflow.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">entities/*</td>
+    <td style="padding:15px">Changes to these files include adding new capabilities, updating existing capabilities, or removing deprecated capabilities in the adapter. Translation configuration can also be modified here.</td>
+  </tr>
+  <tr>
+    <td style="padding:15px">test/*</td>
+    <td style="padding:15px">Changes to these files include adding, updating, or removing unit and integration tests in the adapter. Tests should never be removed unless the methods that are being tested are removed also. Both the unit and integration test file should have a marker that identifies where modification can take place. Modifications above that marker are likely to be rejected or implemented in a different manner.</td>
+  </tr>
+</table>
+<br>
+
+> **Note:** It is a best practice to lint and test your code prior to committing changes into the repository. You can lint your code by running **npm run lint** and test it by running **node utils/testRunner.sh**. However, there are pre-commit hooks that will run these scripts when you commit your changes.
+
+Commit the changes to the repository.
+
+```json
+git commit -a -m "<descriptive message>" 
+```
+
+> **Note:** There are pre-commit hooks in place. If the pre-commit hooks fail, you will need to address those issues before moving forward.
+
+Push the changes into the repository. This should only be done after the commit has successfully completed.
+
+```json
+git push origin <name_of_your_new_branch>
+```
+
+Create a Merge Request.
+
+### Merge Requests
+
+- Fill out the provided merge request template.
+- Reference related issues and merge requests liberally.
+- Include screenshots and animated GIFs in your merge request whenever possible.
+- Follow the project Styleguide.
+- End all files with a newline.
+
+## Styleguide
+
+### Git Commit Messages
+
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Consider starting the commit message with an applicable emoji _(not required)_:
+  - :art: `:art:` When improving the format/structure of the code.
+  - :racehorse: `:racehorse:` When improving performance
+  - :non-potable_water: `:non-potable_water:` When plugging memory leaks.
+  - :memo: `:memo:` When writing documentation.
+  - :penguin: `:penguin:` When fixing something on Linux.
+  - :apple: `:apple:` When fixing something on macOS.
+  - :checkered_flag: `:checkered_flag:` When fixing something on Windows.
+  - :bug: `:bug:` When fixing a bug.
+  - :fire: `:fire:` When removing code or files.
+  - :green_heart: `:green_heart:` When fixing the CI build.
+  - :white_check_mark: `:white_check_mark:` When adding tests,
+  - :lock: `:lock:` When dealing with security.
+  - :arrow_up: `:arrow_up:` When upgrading dependencies.
+  - :arrow_down: `:arrow_down:` When downgrading dependencies.
+  - :shirt: `:shirt:` When removing linter warnings.
+
+__Avoid installing unnecessary packages.__ Do not install packages just because they might be "nice to have". Itential Opensource projects are supposed to be minimal, specific, and compact by design.