HonkIOHonkIO Auth
Référence de l’API Auth
Gérez les applications de connexion, leur sécurité, leurs forfaits, leurs organisations et leurs utilisateurs depuis votre serveur, sous /v1/auth-apps.
URL de base et clés
Chaque route se trouve sous https://api.honkio.ca/v1/auth-apps et s’authentifie avec une clé d’API, comme le reste de l’API HonkIO. Une clé de test voit et gère les applications de test; une clé en direct, les applications en direct.
Permissions
Trois permissions couvrent HonkIO Auth, avec les lettres habituelles : r pour GET, w pour POST, m pour PATCH et PUT, d pour DELETE (clés d’API). Les clés existantes ne les obtiennent pas.
| Permission | Couvre |
|---|---|
| auth_apps | Applications, domaines, image de marque, méthodes de connexion, réglages de sécurité et listes de blocage, forfaits, coûts et utilisation, et politique de connexion |
| auth_users | Utilisateurs, sessions, historique de connexion et exportations |
| auth_organizations | Organisations, adhésions, rôles et invitations |
Conventions
JSON en entrée et en sortie. Les listes renvoient data et next_cursor; renvoyez-le comme cursor pour la page suivante (Pagination). Une application qui n’est pas la vôtre, qui n’est pas dans le mode de votre clé ou qui a été supprimée renvoie 404 NOT_FOUND. Les erreurs ont la forme habituelle; les codes propres à HonkIO Auth figurent sous Erreurs. Les réponses qui contiennent un secret client sont envoyées avec Cache-Control: no-store.
Ressources
Les routes, par ressource :
- Applications
Créez des applications de connexion, modifiez leurs réglages et leur image de marque, vérifiez leurs domaines, remplacez leurs secrets et supprimez-les.
10 routes
- Sécurité
Réglages anti-abus, mode attaque, listes de blocage par application et sommaire de sécurité.
6 routes
- Forfait et utilisation
Lisez et changez le forfait d’une application, annulez une rétrogradation prévue, et consultez ses coûts de connexion par méthode et son nombre d’utilisateurs.
5 routes
- Organisations
La politique de connexion, les organisations, les adhésions, les rôles et les invitations.
19 routes
- Utilisateurs
Les utilisateurs, leurs sessions et leur historique de connexion, le blocage et la suppression, et les exportations.
17 routes