Lister les clients de gestion

GET /v1/management-clients · autorisation management-clients:read

Renvoie les enregistrements de clients de gestion de l'environnement, par pages à curseur, triés par application_id (décroissant par défaut). Un enregistrement appartient à une application de type management et contient son plafond d'autorisations et sa liste d'adresses IP autorisées pour l'API de gestion. Les clés de signature du client ne font pas partie de cette ressource : gérez-les avec /v1/applications/{application_id}/credentials. Seule une clé d'API peut appeler ce point de terminaison ; l'environnement est déterminé par la clé.

Requête

Paramètre	Type	Obligatoire	Description
`limit`	entier	non	1 à 100, valeur par défaut 20.
`after`	chaîne	non	Curseur issu de `list_metadata.after`. Exclusif avec `before`.
`before`	chaîne	non	Curseur issu de `list_metadata.before`.
`order`	chaîne	non	`asc` ou `desc` (par défaut). Un curseur n'est valide qu'avec le même `order`.

Réponse

200 OK

{
  "data": [
    {
      "application_id": "app_01h455vb4pex5vsknk084sn02q",
      "permissions": ["users:read", "users:write"],
      "allowed_cidrs": ["203.0.113.0/24"]
    }
  ],
  "list_metadata": { "before": null, "after": null }
}

Un curseur null signifie qu'il n'y a plus d'enregistrements dans cette direction. Aucun nombre total n'est renvoyé. La suppression d'une application supprime son enregistrement ; un enregistrement dont l'application n'existe plus n'est jamais listé et est supprimé lorsqu'une page l'atteint. Une page peut donc contenir moins d'enregistrements que limit tout en ayant un after défini. Continuez à suivre le curseur.

Erreurs

HTTP	code	Quand
400	`invalid_cursor`	Le curseur est mal formé, altéré, ou a été émis pour un autre environnement ou un autre `order`.
403	`insufficient_permissions`	L'identifiant ne possède pas `management-clients:read`, ou ce n'est pas une clé d'API.
422	`validation_failed`	Un paramètre de requête est invalide.

Exemple

curl "https://api.eu.keenauth.com/v1/management-clients?limit=20" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY"

CLI : keenauth management-clients list --limit 20