Subsections of organizations

Domain Finder

This class allows making GET requests to the domains resource in the OpenGate North API.

constructor

Constructor

Parámetros

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

findByNameWithHierarchy(name)

Constructor

Parámetros

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

Retorna

Tip

Tipo: Promise

Organization Finder

This class allows making GET requests to the organization resource in the OpenGate North API.

constructor

Constructor

Parámetros

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

findByDomainAndWorkgroup(domain, workgroup)

Performs a get that returns organizations related

Parámetros

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

Retorna

Tip

Tipo: Promise

findByName(name)

Find a specify organization by a name. This execute a GET http method

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ Organization name

Retorna

Tip

Tipo: Promise

Organizations

This is a base object that contains everything you can do with Organizations.

constructor

Constructor

Parámetros

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

withAuth(auth)

Sets the auth security configuration

Parámetros

Nombre Tipo Opcional Descripción
auth object ❌

Retorna

Tip

Tipo: Organizations

withCountryCode(countryCode)

Set the country code attribute

Parámetros

Nombre Tipo Opcional Descripción
countryCode string ❌

Retorna

Tip

Tipo: Organizations

withDescription(description)

Set the description attribute

Parámetros

Nombre Tipo Opcional Descripción
description string ❌

Retorna

Tip

Tipo: Organizations

withDomain(domain)

Set the parent domain

Parámetros

Nombre Tipo Opcional Descripción
domain string ❌

Retorna

Tip

Tipo: Organizations

withLangCode(langCode)

Set the lang code attribute

Parámetros

Nombre Tipo Opcional Descripción
langCode string ❌

Retorna

Tip

Tipo: Organizations

withLocation(latitude, longitude)

Sets the map location attribute

Parámetros

Nombre Tipo Opcional Descripción
latitude number ❌
longitude number ❌

Retorna

Tip

Tipo: Organizations

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: Organizations

withOnlyAssignedDomainCertificates(onlyDomainCerts)

Set the onlyAssignedDomainCertificates attribute

Parámetros

Nombre Tipo Opcional Descripción
onlyDomainCerts boolean ❌ required field

Retorna

Tip

Tipo: Organizations

withPasswordPolicy(passPolicy)

Sets the password poliicy configuration

Parámetros

Nombre Tipo Opcional Descripción
passPolicy object ❌

Retorna

Tip

Tipo: Organizations

withPlan(plan)

Set the plan attribute

Parámetros

Nombre Tipo Opcional Descripción
plan string ❌

Retorna

Tip

Tipo: Organizations

withTimeZone(timeZone)

Set the time zone attribute

Parámetros

Nombre Tipo Opcional Descripción
timeZone string ❌

Retorna

Tip

Tipo: Organizations

withZoom(zoom)

Sets the map zoom attribute

Parámetros

Nombre Tipo Opcional Descripción
zoom number ❌

Retorna

Tip

Tipo: Organizations