ForcePasswordChange

The ForcePasswordChange method sets the status of the Force Password Change property for a specified user.

On this page

Usage

Privileges. This method requires Update privileges.

Parameters.

The parameters for the ForcePasswordChange method are described in the following table.
Parameter	Data Type	Value
sessionToken	String	Valid sessionToken returned by the general.CreateUserSession method
userID	Integer	Internal ID of the user as returned by the accesscontrol.LookupUserId method
forcePasswordchange	Boolean	Setting of the Force Password Change property

Output. This method returns an integer. If the method is successful, the value is 1. If there is a failure, the API issues an exception.

Sample

Sample C# Code

iReturnCode = accesscontrol.ForcePasswordChange(sSessionToken, 123, false);

Sample Request

The following is a sample SOAP 1.1 request and response. The placeholders shown would be replaced with actual values. SOAP 1.2 also is supported.

POST /archer/ws/accesscontrol.asmx HTTP/1.1

Host: staging

Content-Type: text/xml; charset=utf-8

Content-Length: length

SOAPAction: "http://archer-tech.com/webservices/ForcePasswordChange"

<?xml version="1.0" encoding="utf-8"?>

<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

<soap:Body>

<sessionToken>string</sessionToken>

<forcePasswordChange>boolean</forcePasswordChange>

</ForcePasswordChange>

</soap:Body>

</soap:Envelope>

Sample Response

HTTP/1.1 200 OK