Stirling PDF icon

Stirling PDF

Merged API: Stirling PDF - Processing API + Stirling PDF - Management API + Stirling PDF - System API

Actions260

User → Change Password For User

AI-generated

Summary

Changes the password of a specified user on a Stirling PDF server through its admin user API. Options let you set a given password or generate a random one, email it, and force a change at next login.

Inputs

  • username (required) — Username of the account whose password is being changed. Sent as a query parameter.
  • newPassword — The new password to set. Sent as a query parameter. Probably unused when Generate Random is on, but the properties don't say so.
  • generateRandom — Boolean, default false. Asks the server to generate a random password instead of using the one supplied.
  • sendEmail — Boolean, default false. Asks the server to email the new password to the user.
  • includePassword — Boolean, default false. Asks the server to include the password in the email.
  • forcePasswordChange — Boolean, default false. Requires the user to change their password at next login.
  • requestOptions — Node settings for the HTTP request: batching (items per batch, interval), ignore SSL issues, proxy URL, and timeout in ms (default 10000).

Output shape

The Stirling PDF server's HTTP response for the password-change request. The exact body isn't visible in the source provided.

The source pack shows only the class declaration, so the response shape is unconfirmed. Every parameter is sent as a query string, so passwords may show up in server or proxy logs. This operation needs admin permissions on the Stirling instance.

Examples

Example 1: Reset a user's password to a random value and email it to them

Username=jdoe, Generate Random=true, Send Email=true, Include Password=true, Force Password Change=true

Example 2: Set a specific password for a user

Username=jdoe, New Password=, Force Password Change=true

Links

Discussion