HonkIO Auth

Sécurité

Réglages anti-abus, mode attaque, listes de blocage par application et sommaire de sécurité.

Obtenir les réglages de sécurité

GET/v1/auth-apps/:id/security

Permission: auth_apps: r

Les réglages anti-abus de l’application, son mode attaque et si les textos sont suspendus.

Requête

curl https://api.honkio.ca/v1/auth-apps/APP_ID/security \
  -H "Authorization: Bearer mk_test_YOUR_KEY"

Réponse · 200

{
  "app_id": "clxxxappxxxxxxxxxxxxxxxxx",
  "block_throwaway_emails": true,
  "aliases_are_same": false,
  "block_voip": false,
  "new_device_alerts": true,
  "sms_daily_limit_cents": 500,
  "attack_mode": {
    "setting": "auto",
    "active": false,
    "since": null,
    "trigger": null
  },
  "texts_paused": null,
  "sign_in_mail_paused": null,
  "suspended_by_honkio": null
}

Modifier les réglages de sécurité

PATCH/v1/auth-apps/:id/security

Permission: auth_apps: m

Modifie les réglages envoyés.

Corps

Nom	Type	Description
block_throwaway_emails	boolean	Refuser les fournisseurs de courriel jetable. Activé par défaut.
aliases_are_same	boolean	Traiter les alias de courriel (points, étiquettes plus) comme une seule adresse. Désactivé par défaut.
block_voip	boolean	Refuser les numéros VoIP pour la connexion par texto. Pro et Affaires.
new_device_alerts	boolean	Envoyer les alertes de nouvel appareil avec « Ce n’était pas moi ». Activé par défaut.
sms_daily_limit_cents	integer	La limite quotidienne de dépenses en textos, en cents CAD. 500 par défaut.
attack_mode	"on" \| "off" \| "auto"	`on` ou `off` force le mode attaque; `auto` (par défaut) laisse HonkIO le gérer.

Requête

curl -X PATCH https://api.honkio.ca/v1/auth-apps/APP_ID/security \
  -H "Authorization: Bearer mk_test_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "aliases_are_same": true,
    "sms_daily_limit_cents": 1000
  }'

Réponse · 200

{
  "app_id": "clxxxappxxxxxxxxxxxxxxxxx",
  "block_throwaway_emails": true,
  "aliases_are_same": true,
  "block_voip": false,
  "new_device_alerts": true,
  "sms_daily_limit_cents": 1000,
  "attack_mode": {
    "setting": "auto",
    "active": false,
    "since": null,
    "trigger": null
  },
  "texts_paused": null,
  "sign_in_mail_paused": null,
  "suspended_by_honkio": null
}

Lister la liste de blocage

GET/v1/auth-apps/:id/security/blocklist

Permission: auth_apps: r

La liste de blocage propre à l’application.

Paramètres de requête

Nom	Type	Description
kind	string	`email`, `email_domain`, `phone`, `phone_prefix`, `ip`, `ip_range`, `network_provider` ou `country`.

Requête

curl https://api.honkio.ca/v1/auth-apps/APP_ID/security/blocklist \
  -H "Authorization: Bearer mk_test_YOUR_KEY"

Réponse · 200

{
  "data": [
    {
      "id": "RU1BSUxfRE9NQUlOOm1haWxpbmF0b3IuZXhhbXBsZQ",
      "kind": "EMAIL_DOMAIN",
      "value": "mailinator.example",
      "note": "Seen in a bot run",
      "created_at": "2026-11-02T15:04:05.000Z"
    }
  ]
}

Ajouter à la liste de blocage

POST/v1/auth-apps/:id/security/blocklist

Permission: auth_apps: w

Bloque les inscriptions et les envois de codes qui correspondent.

Corps

Nom	Type	Description
kindobligatoire	"EMAIL" \| "EMAIL_DOMAIN" \| "PHONE" \| "PHONE_PREFIX" \| "IP" \| "IP_RANGE" \| "NETWORK_PROVIDER" \| "COUNTRY"	`email`, `email_domain`, `phone`, `phone_prefix`, `ip`, `ip_range`, `network_provider` ou `country`.
valueobligatoire	string	Ce qu’il faut bloquer : une adresse, un domaine, un numéro ou préfixe E.164, une IP ou une plage CIDR, l’ASN d’un fournisseur, ou un code de pays à deux lettres.
note	string	Votre propre note, affichée dans le tableau de bord.

Requête

curl -X POST https://api.honkio.ca/v1/auth-apps/APP_ID/security/blocklist \
  -H "Authorization: Bearer mk_test_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "kind": "EMAIL_DOMAIN",
    "value": "mailinator.example",
    "note": "Seen in a bot run"
  }'

Réponse · 201

{
  "id": "RU1BSUxfRE9NQUlOOm1haWxpbmF0b3IuZXhhbXBsZQ",
  "kind": "EMAIL_DOMAIN",
  "value": "mailinator.example",
  "note": "Seen in a bot run",
  "created_at": "2026-11-02T15:04:05.000Z"
}

Retirer de la liste de blocage

DELETE/v1/auth-apps/:id/security/blocklist/:entryId

Permission: auth_apps: d

Retire une entrée.

Requête

curl -X DELETE https://api.honkio.ca/v1/auth-apps/APP_ID/security/blocklist/ENTRY_ID \
  -H "Authorization: Bearer mk_test_YOUR_KEY"

204 · Aucun contenu.

Obtenir le sommaire de sécurité

GET/v1/auth-apps/:id/security/summary

Permission: auth_apps: r

Les totaux récents de l’onglet Sécurité : connexions, échecs, défis, inscriptions bloquées par motif, textos par central et périodes de mode attaque.

Paramètres de requête

Nom	Type	Description
window	"24h" \| "7d" \| "30d"	La période : `24h` (par défaut), `7d` ou `30d`.

Requête

curl https://api.honkio.ca/v1/auth-apps/APP_ID/security/summary \
  -H "Authorization: Bearer mk_test_YOUR_KEY"

Réponse · 200

{
  "window": "24h",
  "from": "2026-11-01T15:04:05.000Z",
  "to": "2026-11-02T15:04:05.000Z",
  "sign_ins": {
    "total": 1824,
    "by_outcome": {
      "succeeded": 1775,
      "failed": 37,
      "challenged": 12
    }
  },
  "challenges_shown": 12,
  "blocked": {
    "total": 5,
    "by_reason": {
      "throwaway_email": 3,
      "app_blocklist": 2
    },
    "blocked_by_honkio": 3
  },
  "texts_by_number_range": [
    {
      "range": "+1416555",
      "sent": 41
    }
  ],
  "attack_mode": {
    "active": false,
    "since": null,
    "trigger": null,
    "periods": []
  },
  "sign_in_mail": {
    "window_hours": 24,
    "delivered": 4120,
    "bounced": 12,
    "complained": 0,
    "bounce_rate": 0.0029,
    "complaint_rate": 0,
    "paused": false,
    "pause_reason": null
  },
  "available": {
    "history": true,
    "texts": true,
    "attack_mode_periods": true
  }
}