WAPI - Miembros globales

Este artículo ofrece información sobre las siguientes solicitudes:

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

---

wg-members-create

Utilice la wgp-members-create para enviar una invitación a un nuevo miembro.

Parámetros

• email = dirección de correo electrónico del nuevo miembro o nombre de usuario de la cuenta WEDOS existente - obligatorio
• policies = matriz de permisos para todos los dominios (*) o dominios específicos; los valores son 1 para Sólo lectura, 0 para acceso total. Ver plantilla para más detalles.

Valores de retorno

• 1000 = OK
• 2223 = formato de correo electrónico no válido o la dirección no existe
• 2274 = error interno - falta user_id
• 2400 = error interno - código de respuesta desconocido
• 2419 = invitación no encontrada
• 2420 = matriz de políticas no válida
• 4000 = error del sistema

Datos de respuesta

• email = correo electrónico que recibe la invitación
• url = dirección URL de confirmación de la invitación
• policies_count = número de políticas activadas (el sistema elimina automáticamente los dominios no válidos)

Plantillas

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

Respuesta 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

Utilice la wgp-members-show return's a del miembro URL de la invitación.

Parámetros

• email = dirección de correo electrónico del miembro o nombre de usuario de la cuenta WEDOS existente - obligatorio

Valores de retorno

• 1000 = OK
• 2223 = formato de correo electrónico no válido o la dirección no existe
• 2274 = error interno - falta user_id
• 2400 = error interno - código de respuesta desconocido
• 2419 = invitación no encontrada
• 4000 = error del sistema

Datos de respuesta

• email = correo electrónico que recibe la invitación
• url = dirección URL de confirmación de la invitación
• policies_count = número de políticas activadas (el sistema elimina automáticamente los dominios no válidos)

Plantillas

Solicitud JSON:

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

Respuesta 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

Utilice la wgp-members-delete para eliminar un miembro y revocar sus permisos.

Parámetros

• email = dirección de correo electrónico del miembro o nombre de usuario de la cuenta WEDOS existente - obligatorio

Valores de retorno

• 1000 = OK
• 2223 = formato de correo electrónico no válido o la dirección no existe
• 2274 = error interno - falta user_id
• 2400 = error interno - código de respuesta desconocido
• 2419 = invitación no encontrada
• 4000 = error del sistema

Datos de respuesta

• email = email de acceso del miembro

Plantillas

Solicitud JSON:

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

Respuesta 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)"
    }
  }
}