This article deals with WAPI commands related to the WEDOS Global members. Informacije o nastavitvi WAPI in odpravljanju pogostih težav so v članku WAPI – Manual.
This article provides information on the following requests:
wg-members-create
Use the wgp-members-create command to send an invitation to a new member.
Parameters
- email = e-naslov novega člana ali obstoječa prijava v račun WEDOS – obvezno
- policies = polje dovoljenj za vse domene (*) ali določene domene; vrednost 1 pomeni ReadOnly, 0 poln dostop. Podrobnosti so v predlogi.
Return Values
- 1000 OK
- 2223 = neveljavna oblika e-naslova ali naslov ne obstaja
- 2274 = notranja napaka – manjka user_id
- 2400 = notranja napaka – neznana koda odgovora
- 2419 = povabilo ni bilo najdeno
- 2420 = neveljavna tabela pravil
- 2424 = članstvo že obstaja
- 4000 = sistemska napaka
Response Data
- email = e-naslov, ki prejme povabilo
- url = URL potrditve povabila
- policies_count = število aktiviranih pravil (sistem samodejno zavrže neveljavne domene)
Templates
JSON request:
{
"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 response (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
Use the wgp-members-show return’s a member’s invitation URL.
Parameters
- email = e-naslov člana ali obstoječa prijava v račun WEDOS – obvezno
Return Values
- 1000 OK
- 2223 = neveljavna oblika e-naslova ali naslov ne obstaja
- 2274 = notranja napaka – manjka user_id
- 2400 = notranja napaka – neznana koda odgovora
- 2419 = povabilo ni bilo najdeno
- 4000 = sistemska napaka
Response Data
- email = e-naslov, ki prejme povabilo
- url = URL potrditve povabila
- policies_count = število aktiviranih pravil (sistem samodejno zavrže neveljavne domene)
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "wg-members-show",
"clTRID": "your ID",
"data": {
"email": "new member email (WEDOS account login)"
}
}
}
JSON response (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
Use the wgp-members-delete to remove an existing member and revoke their permissions.
Parameters
- email = e-naslov člana ali obstoječa prijava v račun WEDOS – obvezno
Return Values
- 1000 OK
- 2223 = neveljavna oblika e-naslova ali naslov ne obstaja
- 2274 = notranja napaka – manjka user_id
- 2400 = notranja napaka – neznana koda odgovora
- 2419 = povabilo ni bilo najdeno
- 4000 = sistemska napaka
Response Data
- email = prijavni e-naslov člana
Templates
JSON request:
{
"request": {
"user": "your@login.tld",
"auth": "authentication string",
"command": "wg-members-delete",
"clTRID": "your ID",
"data": {
"email": "member email (WEDOS account login)"
}
}
}
JSON response (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)"
}
}
}