Create an action to remove a user

Create an action to deactivate or delete a user account in the SaaS application.

Before you begin

If you're using an existing ServiceNow® Integration Hub spoke, find out if it has an action to remove a user that you can use instead of creating one.

Role required: flow_designer

About this task

This action is used to reclaim unused subscriptions to reduce your company's software expenses.

Procedure

1. Navigate to All > Flow Designer > Designer.

2. Click New and then select Action.

3. On the form, fill in the fields.

   Field	Value
   Name	Name of your choice. For example, Remove User.
   Accessible From	All application scopes.
   Category	Leave this field empty.
   Protection	None.
   Application	Spoke app to integrate with the SaaS application. This can be an existing Integration Hub spoke or a new spoke that you created.
   In-Flow Annotation	Leave this field empty.
   Description	Description of your choice.

4. Click Submit.

5. In the Inputs section of the Action Outline, click Create Input.

6. Add a user ID input.

   This is how the action gets the user ID of the user to delete.

   Label	Name	Type	Mandatory
   User ID	userID	String	Yes

7. If the API that you're working with requires user authentication for requests, add inputs for authentication.

   Examples of common user authentication inputs are admin user id and site name. See the documentation for your chosen API to learn about the requirements for user authentication in your specific case. If the API requires an access token, a Credential Value variable is automatically created later so you don't need to add it as an input.

   When you use your completed action in a subflow, you define what values to pass as these inputs.

8. Add a SOAP step or REST step to the action outline.

   Your choice will depend on the API for the SaaS application that you're integrating with.

9. If you selected SOAP, fill in the form as shown.

1. If you selected REST, fill in the form as shown.

   Field	Value
   Connection Details
   Connection	Use Connection Alias.
   Connection Alias	Connection alias that you created when you created the integration profile. If you have not yet created an integration profile, follow the steps to create a custom integration profile with a connection alias.
   Base URL	This value is automatically populated when you select the connection alias. It's set to the Connection URL from the HTTP(s) Connection record linked to the alias.
   Request Details
   Build Request	Manually.
   Resource Path	Path to the resource. This value gets appended to the Base URL. See the documentation for the API that you're working with to learn how to construct the resource path.
   HTTP Method	DELETE.
   Query Parameters	Add a parameter for user ID. Set the value as the user ID input.

2. Add a Script step to the Action Outline for error handling.

   1. For Required Runtime, select Instance.

   2. Create input variables.

      Name	Value
      response	Response Body output from the SOAP or REST step
      status_code	Status Code output from the SOAP or REST step

   3. Create output variables.

      Label	Name	Type	Mandatory
      status	status	Choice	Yes
      error_message	error_message	String	Yes

   4. In the Script field, write a script to assign values to the status and error message outputs.

      • Use the status_code input to check if there is an error. Set the status output equal to Error if there is an error and Success if there is no error.
      • In cases where there is an error, use the response input to get information about the kind of error. Set the error message output to a description of the error so that a user can understand what went wrong.
      • In the Action Outline, click Outputs.

3. Create output variables.

   Label	Name	Type	Mandatory
   Status	status	Choice	No
   Error message	error_message	String	No

4. Assign values to the output variables.

   Label	Value
   Status	status output variable from the script step
   Error message	error_message output variable from the script step

5. To test your action, click Test.

   1. View the test results and system logs for details about any errors.

      To view system logs, navigate to System Logs > System Log > All.

   2. If your action has errors, make sure that you're using the correct endpoints and that the API request is structured as expected.

   Note: When testing, remember that this action deactivates a user. Test this action in a sub-production environment. If only a production environment is available, you can create fake users for testing.

6. After verifying that the action is working as expected, click Publish.