WAPI – Membres Global

Cet article fournit des informations sur les requêtes suivantes :

• wg-members-create
• wg-members-show
• wg-members-delete

---

wg-members-create

Utilisez wgp-members-create commande pour envoyer une invitation à un nouveau membre.

Paramètres

• e-mail = adresse e-mail du nouveau membre ou identifiant d'un compte WEDOS existant – obligatoire
• policies = tableau des autorisations pour tous les domaines (*) ou pour des domaines précis ; les valeurs sont 1 pour ReadOnly et 0 pour l'accès complet. Voir le modèle pour plus de détails.

Valeurs de retour

• 1000 = OK
• 2223 = format d'e-mail invalide ou adresse inexistante
• 2274 = erreur interne – user_id manquant
• 2400 = erreur interne – code de réponse inconnu
• 2419 = invitation introuvable
• 2420 = tableau de règles invalide
• 2424 = l'adhésion existe déjà
• 4000 = erreur système

Données de la réponse

• e-mail = e-mail recevant l'invitation
• url = URL de confirmation de l'invitation
• policies_count = nombre de règles activées (le système écarte automatiquement les domaines invalides)

Modèles

Requête JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wg-members-create",
    "clTRID": "your ID",
    "data": {
      "email": "new member email (WEDOS account login)",
      "policies": {
        "domain01.tld": "0|1",
        "domain02.tld": "0|1",
        "*": "0|1"
      }
    }
  }
}

Réponse JSON (OK) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wg-members-create",
    "data": {
      "email": "new member email (WEDOS account login)",
      "url": "invitation url",
      "policies_count": "number of successfully activated policies"
    }
  }
}

---

wg-members-show

Utilisez wgp-members-show renvoie un du membre URL d’invitation.

Paramètres

• e-mail = adresse e-mail du membre ou identifiant d'un compte WEDOS existant – obligatoire

Valeurs de retour

• 1000 = OK
• 2223 = format d'e-mail invalide ou adresse inexistante
• 2274 = erreur interne – user_id manquant
• 2400 = erreur interne – code de réponse inconnu
• 2419 = invitation introuvable
• 4000 = erreur système

Données de la réponse

• e-mail = e-mail recevant l'invitation
• url = URL de confirmation de l'invitation
• policies_count = nombre de règles activées (le système écarte automatiquement les domaines invalides)

Modèles

Requête JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wg-members-show",
    "clTRID": "your ID",
    "data": {
      "email": "new member email (WEDOS account login)"
    }
  }
}

Réponse JSON (OK) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wg-members-show",
    "data": {
      "email": "new member email (WEDOS account login)",
      "url": "invitation url",
      "policies_count": "number of successfully activated policies"
    }
  }
}

---

wg-members-delete

Utilisez wgp-members-delete pour supprimer un membre et révoquez leurs autorisations.

Paramètres

• e-mail = adresse e-mail du membre ou identifiant d'un compte WEDOS existant – obligatoire

Valeurs de retour

• 1000 = OK
• 2223 = format d'e-mail invalide ou adresse inexistante
• 2274 = erreur interne – user_id manquant
• 2400 = erreur interne – code de réponse inconnu
• 2419 = invitation introuvable
• 4000 = erreur système

Données de la réponse

• e-mail = e-mail de connexion du membre

Modèles

Requête JSON :

{
  "request": {
    "user": "your@login.tld",
    "auth": "authentication string",
    "command": "wg-members-delete",
    "clTRID": "your ID",
    "data": {
      "email": "member email (WEDOS account login)"
    }
  }
}

Réponse JSON (OK) :

{
  "response": {
    "code": 1000,
    "result": "OK",
    "timestamp": "UTF timestamp",
    "clTRID": "your ID",
    "svTRID": "server ID",
    "command": "wg-members-delete",
    "data": {
      "email": "member email (WEDOS account login)"
    }
  }
}