Update External Account Binding status

Dedicated endpoint to update the status of an External Account Binding

Path parameters
eabName
string required

The name of the External Account Binding
Body required
application/json

Status and optional revocation date for certificates

status
string (ExternalAccountBindingStatus) required

The new status for the External Account Binding.

  • DEACTIVATED: Will deactivate all linked ACME accounts.
  • COMPROMISED: Will compromise all linked ACME accounts and trigger certificate revocation (using the compromisedAt and compromissionReason parameters).
  • DISABLED: Has no impact on linked ACME accounts (they remain valid).
  • SUSPENDED: Temporarily suspended, no impact on linked accounts.
  • VALID: Reactivates the EAB.
Enum valid disabled suspended deactivated compromised
compromisedAt
integer

Unix epoch time in milliseconds. Certificates issued after this date will be revoked.
compromissionReason
string | null (Revocation Reason)

One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation
Responses
  • 200 Status updated successfully
    _id
    string (Internal ID) required

    Object internal ID
    name
    string required
    status
    string (ExternalAccountBindingStatus) required

    The current status of the External Account Binding. See ExternalAccountBindingStatus for impact details.

    Enum valid disabled suspended deactivated compromised
    createdAt
    integer required
    eabPolicy
    string required
    allowedProfiles
    array of string required
    validationMethods
    array of string (AcmeAuthorizationType) required
    numberOfKeyRegeneration
    integer required
    macKeyAlgorithm
    string (ExternalAccountBindingAlgorithm) required
    Enum HS256 HS384 HS512
    description
    string
    identifierConstraint
    string
    emailConstraint
    string
    expirationDate
    integer
    compromisedAt
    integer

    The date when the EAB was compromised
    compromissionReason
    string (Revocation Reason)

    One of: unspecified, keycompromise, cacompromise, affiliationchange, superseded, cessationofoperation
  • 400 Invalid request
  • 401 Authentication error
  • 403 Forbidden action
  • 404 EAB not found
    status
    integer required

    The http status code of the error. In compliance with RFC7807

    Value 404
    error
    string required

    The error code of the problem

    Value EAB-002
    message
    string required

    A short, human-readable summary of the problem type

    Value External Account Binding does not exist
    title
    string required

    A short, human-readable summary of the problem type. In compliance with RFC7807

    Value External Account Binding does not exist
    detail
    string | null

    A human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
  • 500 Internal server error
    status
    integer required

    The http status code of the error. In compliance with RFC7807

    Value 500
    error
    string required

    The error code of the problem

    Value ACME-001
    message
    string required

    A short, human-readable summary of the problem type

    Value Unexpected error
    title
    string required

    A short, human-readable summary of the problem type. In compliance with RFC7807

    Value Unexpected error
    detail
    string | null

    A human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807