Syncano

Class: Group

Group

new Group()

OO wrapper around instance groups endpoint.

Properties:
Name Type Argument Default Description
id Number
instanceName String
label String
description String <optional>
 null
links String <optional>
 {}
created_at Date <optional>
 null
updated_at Date <optional>
 null
Source:

Methods

addUser()

Add user to group.

Source:
Returns:
Type
Promise
Example
Group.addUser({ user: 1}).then(function(response) {});

deleteUser()

Delete user from group.

Source:
Returns:
Type
Promise
Example
Group.deleteUser({ user: 1}).then(function(response) {});

getUserDetails()

Fetches details of a user belonging to a group.

Source:
Returns:
Type
Promise
Example
Group.getUserDetails({ user: 1}).then(function(response) {});

getUserDetails(properties, user)

Fetches details of a user belonging to a group.

Parameters:
Name Type Description
properties Object

lookup properties used for path resolving
user Object

object with user to be fetched
Source:
Example
Group.please().getUserDetails({ user: 1}).then(function(response) {});

users()

Fetches Users belonging to a group.

Source:
Returns:
Type
Promise
Example
Group.users().then(function(users) {});