Verba Plugin profile

Creating Account

Creates an SFTPGo account for the user and returns their credentials.

sftpgo_account Version 1.0.0
When to use

Best-fit scenarios

Creates an SFTPGo account for the user and returns their credentials.

How to call it

Execution guidance

Use the example call shape below and provide only the fields the plugin expects.

Arguments

Input shape

  • username string

    <optional custom username>

Settings

Required configuration

  • DEFAULT_HOME_DIR text

    Default home directory for new SFTP accounts.

    Default: /your/default/home/dir
  • SFTPGO_API_URL text

    Base URL for the SFTPGo API (do not include /api/v2).

    Default: https://localhost
  • SFTPGO_GROUP_NAME text

    Group name to assign to new SFTP accounts.

    Default: DNServ
  • SFTPGO_PASSWORD password

    Password to authenticate with the SFTPGo API.

    Default: password
  • SFTPGO_USERNAME text

    Username to authenticate with the SFTPGo API.

    Default: username
Example call

Canonical usage JSON

{
  "function": "sftpgo_account",
  "arguments": {
    "username": "<optional custom username>"
  }
}