AccountPassword

Password-based authentication credential.

This object can be configured from the WebUI under Account › Credentials › Password

Fields

`secret`

Type: String? · secret

Secret value of the account

`currentSecret`

Type: String? · secret

The current secret value of the account, used for password verification.

`otpAuth`

Type: OtpAuth · required

OTP authentication settings for the account

JMAP API

The AccountPassword singleton is available via the urn:stalwart:jmap capability.

`x:AccountPassword/get`

This is a standard Foo/get method as defined in RFC 8620, Section 5.1.

For singletons, the ids argument should be the literal singleton (or null to return the single instance).

This method requires the sysAccountPasswordGet permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:AccountPassword/get",
          {
            "ids": [
              "singleton"
            ]
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

`x:AccountPassword/set`

This is a standard Foo/set method as defined in RFC 8620, Section 5.3.

For singletons, only the update argument with id singleton is accepted; create and destroy arguments are rejected.

This method requires the sysAccountPasswordUpdate permission.

curl -X POST https://mail.example.com/api \
  -H 'Authorization: Bearer $TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
      "methodCalls": [
        [
          "x:AccountPassword/set",
          {
            "update": {
              "singleton": {
                "secret": "updated value"
              }
            }
          },
          "c1"
        ]
      ],
      "using": [
        "urn:ietf:params:jmap:core",
        "urn:stalwart:jmap"
      ]
    }'

CLI

stalwart-cli wraps the same JMAP calls. See the CLI reference for installation, authentication, and general usage.

Fetch

stalwart-cli get AccountPassword

Update

stalwart-cli update AccountPassword --field secret='updated value'

Nested types

OtpAuth

OTP-based authentication credential.

`otpCode`

Type: String? · secret

OTP code for the account, required for credential changes.

`otpUrl`

Type: Uri? · secret

OTP authentication URI for the account