Class Iconectiv

Index

Constructors

Properties

password userId apiUrl baseUrl

Methods

logout ServiceProviderToken accessible crl

Constructors

constructor

new Iconectiv(userId: string, password: string): Iconectiv
Parameters
- userId: string
- password: string
Returns Iconectiv

Properties

`Readonly`password

password: string

`Readonly`userId

userId: string

`Static` `Readonly`apiUrl

apiUrl: string = ...

`Static` `Readonly`baseUrl

baseUrl: "https://authenticate-api.iconectiv.com" = 'https://authenticate-api.iconectiv.com'

Methods

`Protected`logout

logout(accessToken: string): Promise<boolean>
Attempts to log out of the API
Parameters
- accessToken: string
Returns Promise<boolean>

ServiceProviderToken

ServiceProviderToken(
    serviceProviderCode: string,
    accountKey: string | KeyObject,
    ca?: boolean,
): Promise<string>
Attempts to provision an SPCToken via iconectiv
Parameters
- serviceProviderCode: string
  typically the OCN or RespORG ID
- accountKey: string | KeyObject
- ca: boolean = false
Returns Promise<string>

`Static`accessible

accessible(): Promise<boolean>
Determines if the iconectiv API is accessible or not as their service is firewalled to only allowlisted IP address and ranges

Returns Promise<boolean>

`Static`crl

crl(): Promise<string>
Retrieves the current Certificate Revocation List

Returns Promise<string>