Subsections of security

Certificate Finder

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

constructor

Constructor

Parámetros

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

findById(id)

Download a specific certificate by id. This execute a GET http method

Parámetros

Nombre Tipo Opcional Descripción
id string ❌ Id of the certificate.

Retorna

Tip

Tipo: Promise

findByIdAndFormat(id, mimetype)

Download a certificate using id and in a specific format. This execute a GET http method

Parámetros

Nombre Tipo Opcional Descripción
id string ❌ Id of the certificate.
mimetype string ❌ Certificate format mimetype.

Retorna

Tip

Tipo: Promise

Certificates

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

constructor

Constructor

Parámetros

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

create(rawFile)

This invokes a request to the OpenGate North API, and the callback is managed via promises. This method creates a certificate element.

Parámetros

Nombre Tipo Opcional Descripción
rawFile File ❌ this File is the certificate

Retorna

Tip

Tipo: Promise

update()

This invokes a request to the OpenGate North API, and the callback is managed via promises. This method updates a certificate element.

Retorna

Tip

Tipo: Promise

withAdministrativeState(administrativeState)

Set the administrativeState attribute

Parámetros

Nombre Tipo Opcional Descripción
administrativeState string ❌

Retorna

Tip

Tipo: Certificates

withDescription(description)

Set the description attribute

Parámetros

Nombre Tipo Opcional Descripción
description string ❌ optional field

Retorna

Tip

Tipo: Certificates

withDomains(domains)

Set the domains attribute

Parámetros

Nombre Tipo Opcional Descripción
domains Array ❌

Retorna

Tip

Tipo: Certificates

withId(id)

Set the id attribute

Parámetros

Nombre Tipo Opcional Descripción
id string ❌ required field on delete

Retorna

Tip

Tipo: Certificates

withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: Certificates

withParameters(parameters)

Set the parameters attribute

Parámetros

Nombre Tipo Opcional Descripción
parameters string ❌ optional field

Retorna

Tip

Tipo: Certificates

withTags(tags)

Set the tags attribute

Parámetros

Nombre Tipo Opcional Descripción
tags Array ❌

Retorna

Tip

Tipo: Certificates

withUsages(usages)

Set the usages attribute

Parámetros

Nombre Tipo Opcional Descripción
usages Array ❌

Retorna

Tip

Tipo: Certificates

Security

This extends BaseProvision and contains everything you can do with Security.

constructor

Constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ this is configuration about Opengate North API.
url string ❌ this define a specific resource to make the provision