Retrieving the Originating Client IP Address in ServiceNow

[Amit Gujarathi]

Retrieving the Originating Client IP Address in ServiceNow

Understanding how to accurately retrieve the IP address of the client making a request is pivotal in enhancing security measures, auditing, and customizing user experiences. This article guides you through the process of obtaining the client's IP address using ServiceNow's scripting capabilities.

Procedure:

To capture the IP address of the originating request within ServiceNow, a straightforward scripting method is employed. This method utilizes the ServiceNow global object gs, specifically leveraging its ability to access session information.

Step-by-Step Guide:

1. Access Session Information: Begin by utilizing the getSession() method provided by the gs object. This method fetches the current session's details, allowing you to interact with various session-related properties.

   var session = gs.getSession();​

2. Retrieve the Client IP Address: Once you have access to the session object, call the getClientIP() method on it. This method returns the IP address of the client from which the request originated.

   var addr = session.getClientIP();

3. Logging the IP Address: To verify the retrieved IP address or for auditing purposes, you can log the address using gs.info(). This will print the IP address to the system log, making it accessible for review.

   gs.info(addr);

Understanding the getClientIP() Method:

• What it does: The getClientIP() method is designed to return the IP address of the client that initiated the request.
• Return Type: This method returns a string representing the client's IP address.

Example Usage:

Consider you want to log the client IP address for every request for auditing. The following script exemplifies how to implement this:

var session = gs.getSession();
var addr = session.getClientIP();
gs.info(addr);

Expected Output:

Upon successful execution of the script, the system log will display the IP address, for instance, 50.59.164.97.

Conclusion:

Leveraging the getClientIP() method within your ServiceNow environment allows for an efficient way to obtain the client's IP address, aiding in security and customization efforts.