sf_reset_password: Reset User Password

View source: R/utils-org.R

sf_reset_passwordR Documentation

Reset User Password

Description

[Experimental]

Changes a user’s password to a temporary, system-generated value.

Usage

sf_reset_password(user_id, control = list(...), ..., verbose = FALSE)

Arguments

user_id

character; the unique Salesforce Id assigned to the User

control

list; a list of parameters for controlling the behavior of the API call being used. For more information of what parameters are available look at the documentation for sf_control.

...

arguments passed to sf_control

verbose

logical; an indicator of whether to print additional detail for each API call, which is useful for debugging. More specifically, when set to TRUE the URL, header, and body will be printed for each request, along with additional diagnostic information where available.

Value

list

Examples

## Not run: 
# reset a user's password and ensure that an email is triggered to them
sf_reset_password(user_id = "0056A000000ZZZaaBBB", 
                  EmailHeader = list(triggerAutoResponseEmail = FALSE, 
                                     triggerOtherEmail = FALSE, 
                                     triggerUserEmail = TRUE))

## End(Not run)

salesforcer documentation built on March 18, 2022, 6:26 p.m.