Buscar en la wiki...

🙍 Usuarios

Avatares

this.$gestios.avatars(id = null)

Obtiene la ruta del avatar de un usuario por su id. Si no se especifica se obtiene tu propio usuario.

this.$gestios.avatars(123); // https://gestios.dev/api/1/project1/avatar/123
PropiedadDescripcionTipoPredefinido
idID de usuario a consultarIntegernull

Listar usuarios

this.$gestios.users.list({page = 1, search = null, limit = 10, reset = false, silent = false})

Obtiene un listado de los usuarios del proyecto

this.$gestios.users.list({
    page: 1,
    search: 'jhon',
    limit: 20,
    reset: true,
    silent: false
});

// {
//     ok: true,
//     total: 1,
//     data: [{
//      API: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
//      BOSS: "0", // 1:true | 2:false
//      Email: "jhon@doe.com",
//      Group: {
//          ID: 5
//          Name: 'Operator'
//          },
//      ID: "123",
//      LastDate: '2020-08-27T17:46:14.434Z',
//      LastIp: '127.0.0.1',
//      Name: "Jhon Doe",
//      Nick: "jhondoe",
//      Phone: "+34 612 345 678",
//      RegisterDate: "2020-08-27T17:46:14.434Z",
//      Status: "0"
//  }]
// }
PropiedadDescripcionTipoPredefinido
pageNúmero de página a consultarNumber1
searchBúsqueda de usuarioString''
limitNumero de elementos a recogerNumber20
resetBorra la caché de objetosBooleanfalse
silentNo alerta ni muestra barra de progresoBooleanfalse

Permisos necesarios: view._users

Obtener usuario

this.$gestios.users.get(id = null)

Obtiene los datos de un usuario específico. Si no se especifica se obtiene tu propio usuario.

this.$gestios.users.get(123);

// {
//     ok: true,
//     data: {
//         API: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
//         BOSS: "0", // 1:true | 2:false
//         Email: "jhon@doe.com",
//         Group: {
//             ID: 5
//             Name: 'Operator'
//         },
//         ID: "123",
//         LastDate: '2020-08-27T17:46:14.434Z',
//         LastIp: '127.0.0.1',
//         Name: "Jhon Doe",
//         Nick: "jhondoe",
//         Phone: "+34 612 345 678",
//         RegisterDate: "2020-08-27T17:46:14.434Z",
//         Status: "0"
//     }
// }
PropiedadDescripcionTipoPredefinido
idID de usuario a consultarIntegernull

Permisos necesarios: view._users

No se requieren permisos si se trata de tu propio usuario

Añadir usuario

this.$gestios.users.add({ email, nick, name, phone = null, group = null, password = null })

Añade un nuevo usuario al proyecto

this.$gestios.users.add({
    email: 'matt@damon.com',
    nick: 'matt',
    name: 'Matt Damon',
    phone: '+12 666 222 111',
    group: 2,
    password: 'damonmatt123'
});

// {
//     ok: true,
//     data: {
//          API: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
//          BOSS: "0",
//          Email: "matt@damon.com",
//          Group: {
//              ID: 2
//              Name: 'Worker'
//              },
//          ID: "124",
//          LastDate: '2020-08-27T17:46:14.434Z',
//          LastIp: '127.0.0.1',
//          Name: "Matt Damon",
//          Nick: "matt",
//          Phone: "+12 666 222 111",
//          RegisterDate: "2020-08-27T17:46:14.434Z",
//          Status: "0"
//      }
// }
PropiedadDescripcionTipoPredefinido
emailEmail de acceso y notificacionesStringNecesario
nickNick de accesoStringNecesario
nameNombre completoStringNecesario
phoneTeléfono de contactoStringnull
groupID de grupo al que asignarloIntegernull
passwordClave de acceso al proyectoStringnull

Permisos necesarios: add._users

🧠 Debes saber que...

Si no se especifica contraseña se generará una automaticamente y se le enviará al usuario por correo

Editar usuario

this.$gestios.users.edit({ id, email, nick, name, phone = null, group = null, password = null })

Edita los datos del usuario especificado

this.$gestios.users.edit({
    id: 124,
    email: 'mattew@damon.com',
    nick: 'mattew',
    name: 'Mattew Damon',
    phone: '+12 666 222 111',
    group: 2,
    password: 'damonmatt123'
});

// {
//     ok: true,
//     data: {
//          API: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
//          BOSS: "0",
//          Email: "mattew@damon.com",
//          Group: {
//              ID: 2
//              Name: 'Worker'
//          },
//          ID: "124",
//          LastDate: '2020-08-27T17:46:14.434Z',
//          LastIp: '127.0.0.1',
//          Name: "Mattew Damon",
//          Nick: "mattew",
//          Phone: "+12 666 222 111",
//          RegisterDate: "2020-08-27T17:46:14.434Z",
//          Status: "0"
//      }
// }
PropiedadDescripcionTipoPredefinido
idID de usuarioIntegerNecesario
emailEmail de acceso y notificacionesStringNecesario
nickNick de accesoStringNecesario
nameNombre completoStringNecesario
phoneTeléfono de contactoStringnull
groupID de grupo al que asignarloIntegernull
passwordClave de acceso al proyectoStringnull

Permisos necesarios: edit._users

Bloquear/Desbloquear usuario

this.$gestios.users.status(id)

Bloquea o desbloquea a un usuario específico.

👓 Recuerda

No puedes bloquear tu propio usuario

this.$gestios.users.status(123);

// {
//     ok: true,
//     data: {
//          API: "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
//          BOSS: "0", // 1:true | 2:false
//          Email: "jhon@doe.com",
//          Group: {
//              ID: 5
//              Name: 'Operator'
//          },
//          ID: "123",
//          LastDate: '2020-08-27T17:46:14.434Z',
//          LastIp: '127.0.0.1',
//          Name: "Jhon Doe",
//          Nick: "jhondoe",
//          Phone: "+34 612 345 678",
//          RegisterDate: "2020-08-27T17:46:14.434Z",
//          Status: "1"
//      }
// }
PropiedadDescripcionTipoPredefinido
idID de usuarioIntegerNecesario

Permisos necesarios: mod._users

Eliminar usuario

this.$gestios.users.delete(id)

Bloquea o desbloquea a un usuario específico

this.$gestios.users.status(123);

// {
//     ok: true,
// }
PropiedadDescripcionTipoPredefinido
idID de usuarioIntegerNecesario

Permisos necesarios: del._users