Deactivate an ACME account

The DEACTIVATEACCOUNT action completely deactivates one or more ACME accounts. This action is useful when you want to prevent ACME accounts from ever being used to request certificates again. It can be used to deactivate a single ACME account, all ACME accounts that share the same EAB details, or all ACME accounts associated with the specified Sectigo Reseller account (loginName).

When all ACME accounts sharing the same EAB details, or all ACME accounts associated with the specified Sectigo Reseller account, are deactivated, the corresponding EAB credentials are disabled for reuse and cannot be used to create new ACME accounts.

ACME account deactivation is permanent. For information about temporary ACME account suspensions, see Suspend an ACME account.

Action: DEACTIVATEACCOUNT

Variable Name Type Max. Length Description

loginName

string

64 chars

Your account username.

This value is case sensitive.

loginPassword

string

128 chars

Your account password.

This value is case sensitive.

action

string

30 chars

The action to be taken.

In this case, the value is: DEACTIVATEACCOUNT.

acmeAccountID

string

32 chars

(Conditional) The Base64 URL-encoded ACME account ID of the ACME account to be deactivated.

Exclude when includeAdditionalAccounts is set to *.

includeAdditionalAccounts

string

1 char

Indicates whether to deactivate all accounts that share the same EAB details, and the EAB details themselves.

The possible values are:

  • Y — (Default) Deactivate all accounts that share the same EAB details, and the EAB details themselves.

  • N — Deactivate only the specified account.

  • * — Deactivate all accounts and all the corresponding EAB details associated with the specified Sectigo account (loginName).

Sample request

Deactivate an ACME account
curl --location --request POST 'https://secure.trust-provider.com/products/!ACMEAdmin' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'loginName=loginName' \
--data-urlencode 'loginPassword=loginPassword' \
--data-urlencode 'action=DEACTIVATEACCOUNT' \
--data-urlencode 'acmeAccountID=ABc_123xYZ456' \
--data-urlencode 'includeAdditionalAccounts=N'
Deactivate all ACME accounts sharing EAB credentials
curl --location --request POST 'https://secure.trust-provider.com/products/!ACMEAdmin' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'loginName=loginName' \
--data-urlencode 'loginPassword=loginPassword' \
--data-urlencode 'action=DEACTIVATEACCOUNT' \
--data-urlencode 'acmeAccountID=ABc_123xYZ456' \
--data-urlencode 'includeAdditionalAccounts=Y'
Deactivate all ACME accounts belonging to an external account
curl --location --request POST 'https://secure.trust-provider.com/products/!ACMEAdmin' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'loginName=loginName' \
--data-urlencode 'loginPassword=loginPassword' \
--data-urlencode 'action=DEACTIVATEACCOUNT' \
--data-urlencode 'includeAdditionalAccounts=*'

Response

Response parameters

The response may contain the following parameters:

Parameter Type Description

nRecordsUpdated

number

The number of ACME accounts that were deactivated.

success

boolean

The status of the request.

Sample success response

{
    "nRecordsUpdated": 1,
    "success": true
}