import Organizations from 'opengate-js/src/organizations/Organizations.js'

public class | source

Organizations

Extends:

BaseProvision → Organizations

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

Constructor Summary

Public Constructor
public	constructor(Reference: InternalOpenGateAPI) Constructor

Method Summary

Public Methods
public	withAuth(auth: object): Organizations Sets the auth security configuration
public	withCountryCode(countryCode: string): Organizations Set the country code attribute
public	withDescription(description: string): Organizations Set the description attribute
public	withDomain(domain: string): Organizations Set the parent domain
public	withLangCode(langCode: string): Organizations Set the lang code attribute
public	withLocation(latitude: number, longitude: number): Organizations Sets the map location attribute
public	withName(name: string): Organizations Set the name attribute
public	withOnlyAssignedDomainCertificates(onlyDomainCerts: boolean): Organizations Set the onlyAssignedDomainCertificates attribute
public	withPasswordPolicy(passPolicy: object): Organizations Sets the password poliicy configuration
public	withPlan(plan: string): Organizations Set the plan attribute
public	withTimeZone(timeZone: string): Organizations Set the time zone attribute
public	withZoom(zoom: number): Organizations Sets the map zoom attribute

Inherited Summary

From class BaseProvision
public	create(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision
public	delete(body: *): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function deletes a entity of provision
public	update(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

Public Constructors

public constructor(Reference: InternalOpenGateAPI) source

Constructor

Override:

BaseProvision#constructor

Params:

Name	Type	Attribute	Description
Reference	InternalOpenGateAPI		to the API object.

Public Methods

public withAuth(auth: object): Organizations source

Sets the auth security configuration

Params:

Name	Type	Attribute	Description
auth	object

Return:

Organizations

public withCountryCode(countryCode: string): Organizations source

Set the country code attribute

Params:

Name	Type	Attribute	Description
countryCode	string

Return:

Organizations

public withDescription(description: string): Organizations source

Set the description attribute

Params:

Name	Type	Attribute	Description
description	string

Return:

Organizations

public withDomain(domain: string): Organizations source

Set the parent domain

Params:

Name	Type	Attribute	Description
domain	string

Return:

Organizations

public withLangCode(langCode: string): Organizations source

Set the lang code attribute

Params:

Name	Type	Attribute	Description
langCode	string

Return:

Organizations

public withLocation(latitude: number, longitude: number): Organizations source

Sets the map location attribute

Params:

Name	Type	Attribute	Description
latitude	number
longitude	number

Return:

Organizations

public withName(name: string): Organizations source

Set the name attribute

Params:

Name	Type	Attribute	Description
name	string		required field

Return:

Organizations

public withOnlyAssignedDomainCertificates(onlyDomainCerts: boolean): Organizations source

Set the onlyAssignedDomainCertificates attribute

Params:

Name	Type	Attribute	Description
onlyDomainCerts	boolean		required field

Return:

Organizations

public withPasswordPolicy(passPolicy: object): Organizations source

Sets the password poliicy configuration

Params:

Name	Type	Attribute	Description
passPolicy	object

Return:

Organizations

public withPlan(plan: string): Organizations source

Set the plan attribute

Params:

Name	Type	Attribute	Description
plan	string

Return:

Organizations

public withTimeZone(timeZone: string): Organizations source

Set the time zone attribute

Params:

Name	Type	Attribute	Description
timeZone	string

Return:

Organizations

public withZoom(zoom: number): Organizations source

Sets the map zoom attribute

Params:

Name	Type	Attribute	Description
zoom	number

Return:

Organizations