WAPI - Globální členové

Tento článek obsahuje informace o následujících žádostech:

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

---

wg-members-create

Použijte wgp-members-create příkaz k odeslání pozvánky novému člen.

Parametry

• e-mail = e-mailová adresa nového člena nebo přihlašovací jméno k existujícímu účtu WEDOS - povinné
• policies = pole oprávnění pro všechny domény (*) nebo konkrétní domény; hodnoty jsou 1 pro ReadOnly, 0 pro plný přístup. Podrobnosti viz šablona.

Návratové hodnoty

• 1000 = OK
• 2223 = neplatný formát e-mailu nebo adresa neexistuje
• 2274 = interní chyba - chybí user_id
• 2400 = interní chyba - neznámý kód odpovědi
• 2419 = pozvánka nebyla nalezena
• 2420 = neplatné pole zásad
• 4000 = systémová chyba

Údaje o odezvě

• email = email, na který byla pozvánka zaslána
• url = adresa URL pro potvrzení pozvánky
• policies_count = počet aktivovaných zásad (systém automaticky vyřazuje neplatné domény).

Šablony

Požadavek 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"
      }
    }
  }
}

Odpověď 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

Použijte wgp-members-show návrat je člena adresa URL pozvánky.

Parametry

• e-mail = e-mailová adresa člena nebo přihlašovací jméno k existujícímu účtu WEDOS - povinné

Návratové hodnoty

• 1000 = OK
• 2223 = neplatný formát e-mailu nebo adresa neexistuje
• 2274 = interní chyba - chybí user_id
• 2400 = interní chyba - neznámý kód odpovědi
• 2419 = pozvánka nebyla nalezena
• 4000 = systémová chyba

Údaje o odezvě

• email = email, na který byla pozvánka zaslána
• url = adresa URL pro potvrzení pozvánky
• policies_count = počet aktivovaných zásad (systém automaticky vyřazuje neplatné domény).

Šablony

Požadavek JSON:

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

Odpověď 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

Použijte wgp-members-delete odstranit existující člen a zrušit jejich oprávnění.

Parametry

• e-mail = e-mailová adresa člena nebo přihlašovací jméno k existujícímu účtu WEDOS - povinné

Návratové hodnoty

• 1000 = OK
• 2223 = neplatný formát e-mailu nebo adresa neexistuje
• 2274 = interní chyba - chybí user_id
• 2400 = interní chyba - neznámý kód odpovědi
• 2419 = pozvánka nebyla nalezena
• 4000 = systémová chyba

Údaje o odezvě

• email = přihlašovací email člena

Šablony

Požadavek JSON:

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

Odpověď 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)"
    }
  }
}