import Certificates from 'opengate-js/src/security/Certificates.js'

public class | source

Certificates

Extends:

BaseProvision → Security → Certificates

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

Constructor Summary

Public Constructor
public	constructor(Reference: InternalOpenGateAPI) Constructor

Method Summary

Public Methods
public	create(rawFile: File): Promise This invoke a request to OpenGate North API and the callback is managed by promises This method create an element certificate
public	update(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This method update an element certificate
public	withAdministrativeState(administrativeState: string): Certificates Set the administrativeState attribute
public	withDescription(description: string): Certificates Set the description attribute
public	withDomains(domains: Array): Certificates Set the domains attribute
public	withId(id: string): Certificates Set the id attribute
public	withName(name: string): Certificates Set the name attribute
public	withParameters(parameters: string): Certificates Set the parameters attribute
public	withTags(tags: Array): Certificates Set the tags attribute
public	withUsages(usages: Array): Certificates Set the usages 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:

Security#constructor

Params:

Name	Type	Attribute	Description
Reference	InternalOpenGateAPI		to the API object.

Public Methods

public create(rawFile: File): Promise source

This invoke a request to OpenGate North API and the callback is managed by promises This method create an element certificate

Override:

BaseProvision#create

Params:

Name	Type	Attribute	Description
rawFile	File		this File is the certificate

Return:

Promise

Return Properties:

Name	Type	Attribute	Description
then	function(result: object, statusCode: number)		When request it is OK
catch	function(error: string)		When request it is NOK

public update(): Promise source

This invoke a request to OpenGate North API and the callback is managed by promises This method update an element certificate

Override:

BaseProvision#update

Return:

Promise

Return Properties:

Name	Type	Attribute	Description
then	function(result: object, statusCode: number)		When request it is OK
catch	function(error: string)		When request it is NOK

public withAdministrativeState(administrativeState: string): Certificates source

Set the administrativeState attribute

Params:

Name	Type	Attribute	Description
administrativeState	string

Return:

Certificates

public withDescription(description: string): Certificates source

Set the description attribute

Params:

Name	Type	Attribute	Description
description	string		optional field

Return:

Certificates

public withDomains(domains: Array): Certificates source

Set the domains attribute

Params:

Name	Type	Attribute	Description
domains	Array

Return:

Certificates

public withId(id: string): Certificates source

Set the id attribute

Params:

Name	Type	Attribute	Description
id	string		required field on delete

Return:

Certificates

public withName(name: string): Certificates source

Set the name attribute

Params:

Name	Type	Attribute	Description
name	string		required field

Return:

Certificates

public withParameters(parameters: string): Certificates source

Set the parameters attribute

Params:

Name	Type	Attribute	Description
parameters	string		optional field

Return:

Certificates

public withTags(tags: Array): Certificates source

Set the tags attribute

Params:

Name	Type	Attribute	Description
tags	Array

Return:

Certificates

public withUsages(usages: Array): Certificates source

Set the usages attribute

Params:

Name	Type	Attribute	Description
usages	Array

Return:

Certificates