Inbound integration with a certificate based authentication

tesnimk
Tera Contributor

We have a requirement to integrate our service with ServiceNow via inbound REST API calls with a certificate based authentication.

Unfortunaltely we were not able to find an official documentation that illustrate this use case.

Is it already an authentification option supported for REST inbound APIs?

If yes, could you please provide us with detailed steps of a ServiceNow inbound integration via a certificate based authentication .

 

BR

1 REPLY 1

sravya chipilla
Tera Contributor

 

  • Obtain and Install Certificates:

    • Client Certificate: Acquire a client certificate issued by a trusted Certificate Authority (CA). This certificate will be used by your service to authenticate itself to ServiceNow.
    • ServiceNow Configuration: Upload the CA certificate (or the specific client certificate if self-signed) to the ServiceNow instance to establish trust.
  • Enable Mutual Authentication in ServiceNow:

    • Navigate to System Web Services > SOAP Message > Mutual Authentication.
    • Click on New to create a new mutual authentication record.
    • Provide a unique name and upload the client certificate.
    • Save the record.
  • Configure Inbound REST API to Require Mutual Authentication:

    • Navigate to System Web Services > REST API Explorer.
    • Select the API you intend to secure.
    • Edit the API and enable the Require Mutual Authentication option.
    • Save the changes.
  • Assign User Roles and Permissions:

    • Ensure that the user associated with the client certificate has the necessary roles to access and execute the REST API.
    • Navigate to User Administration > Users, select the appropriate user, and assign the required roles.
  • Test the Integration:

    • From your service, initiate a REST API call to the ServiceNow instance, presenting the client certificate for authentication.
    • Verify that the connection is successful and that the API behaves as expected.