WAPI - Członkowie globalni

Ten artykuł zawiera informacje na temat następujących żądań:

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

---

wg-members-create

Użyj wgp-members-create aby wysłać zaproszenie do nowego członek.

Parametry

• email = adres e-mail nowego członka lub login istniejącego konta WEDOS - wymagane
• policies = tablica uprawnień dla wszystkich domen (*) lub określonych domen; wartości to 1 dla ReadOnly, 0 dla pełnego dostępu. Szczegółowe informacje można znaleźć w szablonie.

Zwracane wartości

• 1000 = OK
• 2223 = nieprawidłowy format wiadomości e-mail lub adres nie istnieje
• 2274 = błąd wewnętrzny - brak identyfikatora użytkownika
• 2400 = błąd wewnętrzny - nieznany kod odpowiedzi
• 2419 = nie znaleziono zaproszenia
• 2420 = nieprawidłowa tablica zasad
• 4000 = błąd systemu

Dane odpowiedzi

• email = email otrzymujący zaproszenie
• url = adres URL potwierdzenia zaproszenia
• policies_count = liczba aktywowanych polityk (system automatycznie usuwa nieprawidłowe domeny)

Szablony

Żądanie 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"
      }
    }
  }
}

Odpowiedź 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

Użyj wgp-members-show powrót członka URL zaproszenia.

Parametry

• email = adres e-mail członka lub login do istniejącego konta WEDOS - wymagane

Zwracane wartości

• 1000 = OK
• 2223 = nieprawidłowy format wiadomości e-mail lub adres nie istnieje
• 2274 = błąd wewnętrzny - brak identyfikatora użytkownika
• 2400 = błąd wewnętrzny - nieznany kod odpowiedzi
• 2419 = nie znaleziono zaproszenia
• 4000 = błąd systemu

Dane odpowiedzi

• email = email otrzymujący zaproszenie
• url = adres URL potwierdzenia zaproszenia
• policies_count = liczba aktywowanych polityk (system automatycznie usuwa nieprawidłowe domeny)

Szablony

Żądanie JSON:

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

Odpowiedź 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

Użyj wgp-members-delete aby usunąć istniejący członek i odebrać im uprawnienia.

Parametry

• email = adres e-mail członka lub login do istniejącego konta WEDOS - wymagane

Zwracane wartości

• 1000 = OK
• 2223 = nieprawidłowy format wiadomości e-mail lub adres nie istnieje
• 2274 = błąd wewnętrzny - brak identyfikatora użytkownika
• 2400 = błąd wewnętrzny - nieznany kod odpowiedzi
• 2419 = nie znaleziono zaproszenia
• 4000 = błąd systemu

Dane odpowiedzi

• email = adres e-mail logowania członka

Szablony

Żądanie JSON:

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

Odpowiedź 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)"
    }
  }
}