WAPI – Global-Mitglieder

Dieser Artikel enthält Informationen zu den folgenden Anfragen:

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

---

wg-members-create

Verwenden Sie wgp-members-create Befehl, um eine Einladung zu senden an ein neues Mitglied.

Parameter

• email = E-Mail-Adresse des neuen Mitglieds oder Login eines bestehenden WEDOS-Kontos – erforderlich
• Richtlinien = Array der Berechtigungen für alle Domains (*) oder bestimmte Domains; die Werte sind 1 für ReadOnly, 0 für vollen Zugriff. Details finden Sie in der Vorlage.

Rückgabewerte

• 1000 = OK
• 2223 = ungültiges E-Mail-Format oder die Adresse existiert nicht
• 2274 = interner Fehler – user_id fehlt
• 2400 = interner Fehler – unbekannter Antwortcode
• 2419 = Einladung nicht gefunden
• 2420 = ungültiges Policy-Array
• 2424 = Mitgliedschaft existiert bereits
• 4000 = Systemfehler

Antwortdaten

• email = E-Mail-Adresse, die die Einladung erhält
• url = URL-Adresse zur Bestätigung der Einladung
• policies_count = Anzahl der aktivierten Policies (das System verwirft ungültige Domains automatisch)

Vorlagen

JSON-Anfrage:

{
  "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"
      }
    }
  }
}

JSON-Antwort (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

Verwenden Sie wgp-members-show gibt zurück ein des Mitglieds Einladungs-URL.

Parameter

• email = E-Mail-Adresse des Mitglieds oder Login eines bestehenden WEDOS-Kontos – erforderlich

Rückgabewerte

• 1000 = OK
• 2223 = ungültiges E-Mail-Format oder die Adresse existiert nicht
• 2274 = interner Fehler – user_id fehlt
• 2400 = interner Fehler – unbekannter Antwortcode
• 2419 = Einladung nicht gefunden
• 4000 = Systemfehler

Antwortdaten

• email = E-Mail-Adresse, die die Einladung erhält
• url = URL-Adresse zur Bestätigung der Einladung
• policies_count = Anzahl der aktivierten Policies (das System verwirft ungültige Domains automatisch)

Vorlagen

JSON-Anfrage:

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

JSON-Antwort (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

Verwenden Sie wgp-members-delete um ein bestehendes zu entfernen Mitglied und entziehen Sie ihnen die Berechtigungen.

Parameter

• email = E-Mail-Adresse des Mitglieds oder Login eines bestehenden WEDOS-Kontos – erforderlich

Rückgabewerte

• 1000 = OK
• 2223 = ungültiges E-Mail-Format oder die Adresse existiert nicht
• 2274 = interner Fehler – user_id fehlt
• 2400 = interner Fehler – unbekannter Antwortcode
• 2419 = Einladung nicht gefunden
• 4000 = Systemfehler

Antwortdaten

• email = Login-E-Mail des Mitglieds

Vorlagen

JSON-Anfrage:

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

JSON-Antwort (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)"
    }
  }
}