Subsections of workgroups

Workgroup Finder

This class allows making get requests to the workgroup resource in the OpenGate North API.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

findByDomainAndName(domain, name)

Constructor

Parámetros

Nombre Tipo Opcional Descripción
domain string ❌ domain name
name string ❌ workgroup name

Retorna

Tip

Tipo: Promise

Workgroup Relations

This is a base object that contains all you can do about workgroups.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

update()

Update not allowed

withChannel(channel)

Set the channel attribute

Parámetros

Nombre Tipo Opcional Descripción
channel string ❌ required field for creation or update

Retorna

Tip

Tipo: WorkgroupRelations

withWorkgroup(workgroup)

Set the workgroup attribute

Parámetros

Nombre Tipo Opcional Descripción
workgroup string ❌ required field

Retorna

Tip

Tipo: WorkgroupRelations

Workgroup Relations Finder

This class allows making get requests to the workgroup relation resource in the OpenGate North API.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

findByDomainAndName(domain, name)

Constructor

Parámetros

Nombre Tipo Opcional Descripción
domain string ❌ domain name
name string ❌ workgroup name

Retorna

Tip

Tipo: Promise

Workgroups

This is a base object that contains all you can do about workgroups.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.

withAdministrative(administrative)

Set the administrative attribute

Parámetros

Nombre Tipo Opcional Descripción
administrative boolean ❌

Retorna

Tip

Tipo: Workgroups

withDescription(description)

Set the description attribute

Parámetros

Nombre Tipo Opcional Descripción
description string ❌ required field

Retorna

Tip

Tipo: Workgroups

withDomainName(domainName)

Set the domain attribute

Parámetros

Nombre Tipo Opcional Descripción
domainName string ❌ required field

Retorna

Tip

Tipo: Workgroups

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: Workgroups