Stirling PDF icon

Stirling PDF

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

Actions260

User → Save User

AI-generated

Summary

Creates or saves a user account in a Stirling PDF instance by sending the user's details as query parameters to the server's user-admin endpoint.

Inputs

  • username (required) — Login name for the user.
  • password — Password for the user. Leave empty if not setting one, for example with an external auth type.
  • role (required) — Role to assign to the user, as a free-text string.
  • teamId — Numeric ID of the team the user belongs to. Defaults to 0.
  • authType (required) — Authentication type for the user, as a free-text string.
  • forceChange — If true, sends forceChange=true. The name suggests the user must change their password at next login, but the source doesn't confirm this.
  • forceMFA — If true, sends forceMFA=true. The name suggests multi-factor authentication is required for the user, but the source doesn't confirm this.
  • requestOptions — Node-level HTTP settings: batching (items per batch and interval), ignore SSL issues, proxy URL, and timeout in ms (default 10000).

Output shape

The JSON response from the Stirling PDF server for the save-user request, one result per input item.

The source pack contains only a class stub, so the exact response body and endpoint path are not visible. All parameters are sent as query-string values, not a request body. Valid values for role and authType are not enumerated and depend on the Stirling PDF server.

Examples

Example 1: Provision a new standard user with a password.

username=jdoe, password=, role=ROLE_USER, authType=web, teamId=1, forceChange=true

Example 2: Create an admin that must use MFA.

username=admin2, password=, role=ROLE_ADMIN, authType=web, forceMFA=true

Links

Discussion