List ACME accounts

The LISTACCOUNTS action lists the details of the ACME account belonging to the specified Sectigo Reseller account (loginName).

Action: LISTACCOUNTS

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: LISTACCOUNTS.

includeAdditionalAccounts

string

1 char

(Optional) Indicates which ACME accounts should be included.

The possible values are:

  • N — (Default) Include only the ACME account where the eabMACKeyID64url matches the specified acmeAccountID.

  • Y — Include all ACME accounts.

lastActivityOf

domainName

7 chars

(Optional) Indicates which accounts to be included with a timestamp of their last activity.

The possible values are:

  • eab — (Default) Include all accounts with EAB details matching the acmeAccountID.

  • account — Include only the account with the matching acmeAccountID.

acmeAccountID

string

32 chars

(Optional/Conditional) Base64 URL-encoded ACME account ID.

Required when includeAdditionalAccounts is included.

  • When included with includeAdditionalAccounts set to N, only the account with the matching acmeAccountID is included.

  • When included with includeAdditionalAccounts set to Y, all accounts with EAB details matching those in the specified acmeAccountID are included.

eabKeyID

domainName

32 chars

(Optional/Conditional) Base64 URL-encoded Key ID for external account binding.

When included, all accounts with matching EAB details are included.

Ignored if acmeAccountID is used.

page

integer

(Optional) 0-based page index.

size

integer

(Optional) Number of elements per page.

includeContacts

string

1 char

(Optional) Specifies whether to include the contact email addresses associated with an ACME account.

The possible values are:

  • N — (Default) Do not include the contact email addresses associated with an ACME account.

  • Y — Include the contact email addresses associated with an ACME account.

sort

string

32767 chars

(Optional) Specifies the sorting order of the returned data.

  • The default sort order is ascending.

  • Allowed fields for sorting: accountStatus, lastActivity.

  • Unsupported fields are ignored.

  • Only one sort parameter is allowed.

filter

string

32767 chars

(Optional) Specifies the filtering criteria for the returned data.

  • Allowed fields for filtering: userAgent, ipAddress, contacts, accountStatus, lastActivity.

  • Unsupported fields are ignored.

  • Operations supported for string values: =, !=, ?, !?.

  • Operations supported for date values: =, !=, >, <, >=, <=.

  • Multiple filter parameters are allowed.

Sample request

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=LISTACCOUNTS'

Response

Response parameters

The response may contain the following parameters:

Parameter Type Description

Accounts

array

The details of the ACME accounts.

The beginning of the Accounts array

acmeAccountID

string

The Base64 URL-encoded ACME account ID.

accountStatus

string

The status of the ACME account.

userAgent

string

The user agent of the ACME client that created the account.

ipAddress

string

The IP address of the ACME client that created the account.

lastActivity

string

The timestamp of the last activity on the ACME account.

eabMACKeyb64url

string

The Base64 URL-encoded MAC key for external account binding.

eabMACIDb64url

sting

The Base64 URL-encoded MAC ID.

contacts

object

The contact email addresses associated with the ACME account (if includeContacts is set to Y).

emailAddress

string

The contact email address associated with the ACME account.

Sample success responses

Success response with data
{
  "Accounts": [
    {
      "acmeAccountID": "ABc_123xYZ456",
      "accountStatus": "pending",
      "eabMACKeyb64url": "ZyX321_abc654DeF1",
      "eabMACIDb64url": "ghM4321abc_D8765xyZ"
    },
    {
      "acmeAccountID": "654ZYx321_cBA",
      "accountStatus": "valid",
      "userAgent": "CertbotACMEClient/0.31.0 (certbot; Red Hat Enterprise Linux) Authenticator/netscaler:ns_authenticator Installer/netscaler:ns_installer (run; flags: frn n) Py/2.7.5",
      "ipAddress": "10.0.1.64",
      "lastActivity": "2019-03-14T14:37:42Z",
      "eabMACKeyb64url": "1FeD456cba_123XyZ",
      "eabMACIDb64url": "Zyx5678D_cba1234Mhg"
    },
    {
      "acmeAccountID": "1WD-12345oiUTy9876YSA",
      "accountStatus": "deactivated",
      "ipAddress": "10.0.1.66",
      "lastActivity": "2019-03-11T10:43:43Z",
      "eabMACKeyb64url": "0n1234_hgfD45678gNQ",
      "eabMACIDb64url": "YS8765-trEw4321WD"
    }
  ]
}
Success response with includeContacts set to Y
{
  "Accounts": [
    {
      "acmeAccountID": "ABc_123xYZ456",
      "accountStatus": "pending",
      "eabMACKeyb64url": "ZyX321_abc654DeF1",
      "eabMACIDb64url": "ghM4321abc_D8765xyZ"
    },
    {
      "acmeAccountID": "654ZYx321_cBA",
      "accountStatus": "valid",
      "userAgent": "CertbotACMEClient/0.31.0 (certbot; Red Hat Enterprise Linux) Authenticator/netscaler:ns_authenticator Installer/netscaler:ns_installer (run; flags: frn n) Py/2.7.5",
      "ipAddress": "10.0.1.64",
      "lastActivity": "2019-03-14T14:37:42Z",
      "eabMACKeyb64url": "1FeD456cba_123XyZ",
      "eabMACIDb64url": "Zyx5678D_cba1234Mhg",
      "contacts": [
        {
          "emailAddress": "[email protected]"
        }
      ]
    },
    {
      "acmeAccountID": "1WD-12345oiUTy9876YSA",
      "accountStatus": "deactivated",
      "ipAddress": "10.0.1.66",
      "lastActivity": "2019-03-11T10:43:43Z",
      "eabMACKeyb64url": "0n1234_hgfD45678gNQ",
      "eabMACIDb64url": "YS8765-trEw4321WD",
      "contacts": [
        {
          "emailAddress": "[email protected]"
        }
      ]
    }
  ]
}
Success response without data
{
  "Accounts": []
}