Lister les comptes distants

GET /api/partners/(string: partner_name)/accounts

Renvoie une liste des comptes du partenaire donné en fonction des paramètres fournis.

En-têtes de requête:

• Authorization – Les identifiants de l’utilisateur

Paramètres:

• limit (int) – Le nombre maximum de résultats souhaités (défaut: 20)

• offset (int) – Le numéro du premier résultat souhaité (défaut: 0)

• sort ([login+|login-]) – Le paramètre selon lequel les comptes seront triés (défaut: login+)

Status Codes:

• 200 OK – La liste a été renvoyée avec succès

• 400 Bad Request – Un ou plusieurs des paramètres de requêtes sont invalides

• 401 Unauthorized – Authentification d’utilisateur invalide

Objet JSON de réponse:

• remoteAccounts (array) – La liste des comptes demandés

Tableau d’objets JSON de réponse:

• login (string) – Le login du compte

• authMethods (array) – La liste des valeurs utilisées par la gateway pour s’authentifier auprès du partenaire quand celle-ci s’y connecte.

• authorizedRules (object) –

  Les règles que le compte est autorisé à utiliser pour les transferts.

  • sending (array of string) - Les règles d’envoi.

  • reception (array of string) - Les règles de réception.

Exemple de requête

GET https://my_waarp_gateway.net/api/partners/waarp_sftp/accounts?limit=10&sort=name- HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Exemple de réponse

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 147

{
  "remoteAccounts": [{
    "login": "tutu",
    "authMethods": ["tutu_private_key"],
    "authorizedRules": {
      "sending": ["règle_envoi_1", "règle_envoi_2"],
      "reception": ["règle_récep_1", "règle_récep_2"]
    }
  },{
    "login": "titi",
    "authMethods": ["titi_private_key", "password"],
    "authorizedRules": {
      "sending": ["règle_envoi_1", "règle_envoi_2"],
      "reception": ["règle_récep_1", "règle_récep_2"]
    }
  }]
}