Salesforce User Disable Version 1

This handler uses Salesforce's REST API to disable a user in Salesforce. The first thing that the handler does is obtain an access token using the inputted info values, which is used to authenticate the rest of the calls that are made. Next, the handler makes a call to retrieve the user id that corresponds to the inputted username. One last REST call is then made to Salesforce using that user id to disable the desired user by setting the IsActive flag to false.

Where to find the Client ID, Client Secret, Security Token and Salesforce Instance.

  1. After logging into Salesforce, the Salesforce Instance can be found in the URL to the left of the salesforce.com (ie. na15, cs13, etc.)
  2. Go to Setup, which is in the dropdown menu under your name in the upper righthand corner.
  3. On the left sidebar, your Security Token can be found under Personal Setup > My Personal Information > Reset My Security Token.
  4. To get the Client ID and Client Secret, Navigate back to Setup and go to Manage Apps.
  5. Create a new Connected App, and fill in the basic information for the app.
  6. Check the Enable OAuth Settings checkbox and put https://auth for your callback url.
  7. Under selected OAuth scopes, add Access and manage your data (api) to your selected scopes and save.
  8. Your Client ID and Client Secret will be found on the app information page that you were redirected to upon saving.

Parameters

Name Description
Username Username of the account that will be disabled.

Sample Configuration

Name Description
Username joe.user@acme.com

Results

This handler does not return any results.

Changelog

Salesforce User Disable V1.1 (2017-09-12)

  • Due to Salesforce requiring TLS 1.2, this handler is only compatible with Task

4.2.0 and above due to needing a ruby version greater than 2.0.0

  • Update Salesforce API version from v20.0 to v37.0

  • Removed salesforce_instance as an info value

  • General cleanup of execute() and adding more debug logging

Salesforce User Disable V1 (2013-09-09)

  • Initial version. See README for details.


Related Handlers

Salesforce Account Create
Creates a Salesforce Account record with the given parameters and returns the Account Id of the created Account record.
Salesforce Case Create
Creates a Salesforce Account Case record with the given parameters and returns the Case Id of the created record. The parameters are mapped directly to their respective fields.
Salesforce Contact Retrieve
Retrieves a Salesforce Contact record with the given Contact Id.
Salesforce Object Create
Generically creates a Salesforce object given a type and a JSON body.
Salesforce Object Update
Generically updates a Salesforce object with a given type, id, and JSON body.
Salesforce Opportunity Retrieve
Retrieves a Salesforce Opportunity record with the given parameters.
Salesforce Task Create
Create a new task in Salesforce.
Salesforce User Retrieve
Retrieves a Salesforce User record with the given Username.