Vonage Network Auth

Documentation / Vonage Network Auth

Vonage Network Auth

Enumerations

Purpose

Defined in: packages/network-client/lib/enums/purpose.ts:4

Netowrk API purposes for generating the scope

Enumeration Members

Enumeration Member	Value	Description	Defined in
`FRAUD_PREVENTION_AND_DETECTION`	`"FraudPreventionAndDetection"`	Purpose for Fraud Prevention and Detection	packages/network-client/lib/enums/purpose.ts:8

Scope

Defined in: packages/network-client/lib/enums/scope.ts:4

Scopes for the API

Enumeration Members

Enumeration Member	Value	Description	Defined in
`CHECK_SIM_SWAP`	`"check-sim-swap"`	Check for SIM Swap	packages/network-client/lib/enums/scope.ts:8
`NUMBER_VERIFICATION_VERIFY_READ`	`"number-verification-verify-read"`	Number Verification	packages/network-client/lib/enums/scope.ts:13

Classes

InvalidPurposeError

Defined in: packages/network-client/lib/errors/invalidPurposeError.ts:4

Error thrown when purpose is invalid

Extends

Error

Constructors

new InvalidPurposeError()

new InvalidPurposeError(): InvalidPurposeError

Defined in: packages/network-client/lib/errors/invalidPurposeError.ts:5

Returns

InvalidPurposeError

Overrides

Error.constructor

Properties

cause?

optional cause: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

message

message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

stack?

optional stack: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Defined in: node_modules/@types/node/globals.d.ts:143

Optional override for formatting stack traces

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/@types/node/globals.d.ts:145

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:136

Create .stack property on a target object

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

InvalidScopeError

Defined in: packages/network-client/lib/errors/invalidScopeError.ts:4

Error thrown when scope is invalid

Extends

Error

Constructors

new InvalidScopeError()

new InvalidScopeError(): InvalidScopeError

Defined in: packages/network-client/lib/errors/invalidScopeError.ts:5

Returns

InvalidScopeError

Overrides

Error.constructor

Properties

cause?

optional cause: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

message

message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

stack?

optional stack: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Defined in: node_modules/@types/node/globals.d.ts:143

Optional override for formatting stack traces

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/@types/node/globals.d.ts:145

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:136

Create .stack property on a target object

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

MissingPurposeError

Defined in: packages/network-client/lib/errors/missingPurposeError.ts:4

Error thrown when purpose is invalid

Extends

Error

Constructors

new MissingPurposeError()

new MissingPurposeError(): MissingPurposeError

Defined in: packages/network-client/lib/errors/missingPurposeError.ts:5

Returns

MissingPurposeError

Overrides

Error.constructor

Properties

cause?

optional cause: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

message

message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

stack?

optional stack: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Defined in: node_modules/@types/node/globals.d.ts:143

Optional override for formatting stack traces

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/@types/node/globals.d.ts:145

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:136

Create .stack property on a target object

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

MissingScopeError

Defined in: packages/network-client/lib/errors/missingScopeError.ts:4

Error thrown when no scope is set for a request.

Extends

Error

Constructors

new MissingScopeError()

new MissingScopeError(): MissingScopeError

Defined in: packages/network-client/lib/errors/missingScopeError.ts:5

Returns

MissingScopeError

Overrides

Error.constructor

Properties

cause?

optional cause: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

message

message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

Error.message

name

name: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name

stack?

optional stack: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

Error.stack

prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any;

Defined in: node_modules/@types/node/globals.d.ts:143

Optional override for formatting stack traces

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/@types/node/globals.d.ts:145

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:136

Create .stack property on a target object

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

NetworkClient

Defined in: packages/network-client/lib/networkClient.ts:26

Extends

Client

Extended by

Constructors

new NetworkClient()

new NetworkClient(auth, config?): NetworkClient

Defined in: packages/network-client/lib/networkClient.ts:62

Parameters

Properties

_msisdn

protected _msisdn: string;

Defined in: packages/network-client/lib/networkClient.ts:45

The msisdn that will be used for API calls

_purpose?

protected optional _purpose: FRAUD_PREVENTION_AND_DETECTION;

Defined in: packages/network-client/lib/networkClient.ts:50

The purpose for the scope

_scope?

protected optional _scope: Scope;

Defined in: packages/network-client/lib/networkClient.ts:55

The scope for the token

accessToken?

protected optional accessToken: string;

Defined in: packages/network-client/lib/networkClient.ts:35

The current token

auth

protected auth: AuthInterface;

Defined in: packages/server-client/dist/lib/client.d.ts:24

The authentication instance responsible for generating authentication headers and query parameters.

Inherited from

Client.auth

authType?

protected optional authType: AuthenticationType;

Defined in: packages/server-client/dist/lib/client.d.ts:20

The type of authentication used for the client's requests.

Inherited from

Client.authType

config

protected config: NetworkConfigParameters;

Defined in: packages/network-client/lib/networkClient.ts:60

Configuration settings for the client, including default hosts for various services and other request settings.

Overrides

Client.config

expires

protected expires: number = 0;

Defined in: packages/network-client/lib/networkClient.ts:40

Timestamp until the token expires

gettingToken

protected gettingToken: boolean = false;

Defined in: packages/network-client/lib/networkClient.ts:30

Flags if we are currently getting a token

transformers

static transformers: object;

Defined in: packages/server-client/dist/lib/client.d.ts:11

Static property containing utility transformers.

camelCaseObjectKeys

camelCaseObjectKeys: PartialTransformFunction;

kebabCaseObjectKeys

kebabCaseObjectKeys: PartialTransformFunction;

omit()

omit: (keys, obj) => TransformedObject;

Parameters

keys

string[]

obj

ObjectToTransform

Returns

TransformedObject

snakeCaseObjectKeys

snakeCaseObjectKeys: PartialTransformFunction;

Inherited from

Client.transformers

Accessors

msisdn

Get Signature

get msisdn(): string

Defined in: packages/network-client/lib/networkClient.ts:81

Get the msisdn

Throws

If the msisdn is not set

Returns

string

The msisdn

purpose

Get Signature

get purpose(): FRAUD_PREVENTION_AND_DETECTION

Defined in: packages/network-client/lib/networkClient.ts:96

Get the purpose

Throws

If the purpose is not set

Throws

If the purpose is not valid

Returns

FRAUD_PREVENTION_AND_DETECTION

The purpose

Set Signature

set purpose(value): void

Defined in: packages/network-client/lib/networkClient.ts:112

Set the purpose

Parameters

value

FRAUD_PREVENTION_AND_DETECTION

The purpose

Returns

void

scope

Get Signature

get scope(): Scope

Defined in: packages/network-client/lib/networkClient.ts:123

Get the scope

Throws

If the scope is not set

Throws

If the scope is not valid

Returns

Scope

The scope

Set Signature

set scope(value): void

Defined in: packages/network-client/lib/networkClient.ts:142

Set the scope

Throws

If the scope is not valid

Throws

If the scope is not set

Parameters

value

Scope

The scope

Returns

void

Methods

addAuthenticationToRequest()

addAuthenticationToRequest(request): Promise<VetchOptions>

Defined in: packages/network-client/lib/networkClient.ts:154

Add authentication to the auth

This will make the calls to get a network token if required.

Parameters

request

VetchOptions

The request to add authentication to

Returns

Promise<VetchOptions>

The request with authentication added

Overrides

Client.addAuthenticationToRequest

addBasicAuthToRequest()

protected addBasicAuthToRequest(request): Promise<VetchOptions>

Defined in: packages/server-client/dist/lib/client.d.ts:71

Adds basic authentication headers to the request.

Parameters

request

VetchOptions

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

The request options with the added authentication.

Inherited from

Client.addBasicAuthToRequest

addJWTToRequest()

protected addJWTToRequest(request): Promise<VetchOptions>

Defined in: packages/server-client/dist/lib/client.d.ts:64

Adds a JWT to the request.

Parameters

request

VetchOptions

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

The request options with the added authentication.

Inherited from

Client.addJWTToRequest

addQueryKeySecretToRequest()

protected addQueryKeySecretToRequest(request): Promise<VetchOptions>

Defined in: packages/server-client/dist/lib/client.d.ts:57

Adds API key and secret to the request.

Parameters

request

VetchOptions

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

The request options with the added authentication.

Inherited from

Client.addQueryKeySecretToRequest

addQueryKeySecretToRequestBody()

protected addQueryKeySecretToRequestBody(request): Promise<VetchOptions>

Defined in: packages/server-client/dist/lib/client.d.ts:50

Adds API key and secret to the request body.

Parameters

request

VetchOptions

The request options to which authentication needs to be added.

Returns

Promise<VetchOptions>

The request options with the added authentication.

Inherited from

Client.addQueryKeySecretToRequestBody

buildOIDCURL()

buildOIDCURL(state): string

Defined in: packages/network-client/lib/networkClient.ts:191

Build the URL for the OIDC flow

Parameters

state

string = ''

The state to use

Returns

string

The URL for the OIDC flow

exchangeCodeForToken()

exchangeCodeForToken(code): Promise<NetworkTokenResponse>

Defined in: packages/network-client/lib/networkClient.ts:224

Exchange the code for a network token

Parameters

code

string

The code to exchange

Returns

Promise<NetworkTokenResponse>

The network token token

getCIBAAccessToken()

protected getCIBAAccessToken(cibaRequestId): Promise<NetworkTokenResponse>

Defined in: packages/network-client/lib/networkClient.ts:306

Get a network token

Parameters

cibaRequestId

string

The CIBA request id

Returns

Promise<NetworkTokenResponse>

The network token data

getCIBARequestId()

protected getCIBARequestId(): Promise<string>

Defined in: packages/network-client/lib/networkClient.ts:355

Get an CIBA request id

Returns

Promise<string>

The CIBA request id

getCIBAToken()

protected getCIBAToken(): Promise<void>

Defined in: packages/network-client/lib/networkClient.ts:283

Get the access token for the CIBA flow

This is a two step process. First we need to get an CIBA request id, then we can use that to get a network token.

Returns

Promise<void>

getConfig()

getConfig(): ConfigParams

Defined in: packages/server-client/dist/lib/client.d.ts:36

Returns

ConfigParams

Inherited from

Client.getConfig

parseResponse()

protected parseResponse<T>(request, response): Promise<VetchResponse<T>>

Defined in: packages/server-client/dist/lib/client.d.ts:168

Parses the response based on its content type.

Type Parameters

• T

The expected type of the parsed response data.

Parameters

request

VetchOptions

The request options.

response

Response

The raw response from the request.

Returns

Promise<VetchResponse<T>>

The parsed response.

Inherited from

Client.parseResponse

prepareBody()

protected prepareBody(request): undefined | string

Defined in: packages/server-client/dist/lib/client.d.ts:158

Prepares the body for the request based on the content type.

Parameters

request

VetchOptions

The request options.

Returns

undefined | string

The prepared request body as a string or undefined.

Inherited from

Client.prepareBody

prepareRequest()

protected prepareRequest(request): Promise<VetchOptions>

Defined in: packages/server-client/dist/lib/client.d.ts:151

Prepares the request with necessary headers, authentication, and query parameters.

Parameters

request

VetchOptions

The initial request options.

Returns

Promise<VetchOptions>

The modified request options.

Inherited from

Client.prepareRequest

sendDeleteRequest()

sendDeleteRequest<T>(url): Promise<VetchResponse<T>>

Defined in: packages/server-client/dist/lib/client.d.ts:78

Sends a DELETE request to the specified URL.

Type Parameters

• T

Parameters

url

string

The URL endpoint for the DELETE request.

Returns

Promise<VetchResponse<T>>

The response from the DELETE request.

Inherited from

Client.sendDeleteRequest

sendFormSubmitRequest()

sendFormSubmitRequest<T>(url, payload?): Promise<VetchResponse<T>>

Defined in: packages/server-client/dist/lib/client.d.ts:86

Sends a POST request with form data to the specified URL.

Type Parameters

• T

Parameters

url

string

The URL endpoint for the POST request.

payload?

Record<string, undefined | string>

Optional payload containing form data to send with the POST request.

Returns

Promise<VetchResponse<T>>

The response from the POST request.

Inherited from

Client.sendFormSubmitRequest

sendGetRequest()

sendGetRequest<T>(url, queryParams?): Promise<VetchResponse<T>>

Defined in: packages/server-client/dist/lib/client.d.ts:94

Sends a GET request to the specified URL with optional query parameters.

Type Parameters

• T

Parameters

url

string

The URL endpoint for the GET request.

queryParams?

Optional query parameters to append to the URL. These should be compatible with Node's URLSearchParams.

Returns

Promise<VetchResponse<T>>

The response from the GET request.

Inherited from

Client.sendGetRequest

sendPatchRequest()

sendPatchRequest<T>(url, payload?): Promise<VetchResponse<T>>

Defined in: packages/server-client/dist/lib/client.d.ts:104

Sends a PATCH request to the specified URL with an optional payload.

Type Parameters

• T

Parameters

url

string

The URL endpoint for the PATCH request.

payload?

Optional payload to be sent as the body of the PATCH request.

Returns

Promise<VetchResponse<T>>

The response from the PATCH request.

Inherited from

Client.sendPatchRequest

sendPostRequest()

sendPostRequest<T>(url, payload?): Promise<VetchResponse<T>>

Defined in: packages/server-client/dist/lib/client.d.ts:114

Sends a POST request to the specified URL with an optional payload.

Type Parameters

• T

Parameters

url

string

The URL endpoint for the POST request.

payload?

Optional payload to be sent as the body of the POST request.

Returns

Promise<VetchResponse<T>>

The response from the POST request.

Inherited from

Client.sendPostRequest

sendPutRequest()

sendPutRequest<T>(url, payload?): Promise<VetchResponse<T>>

Defined in: packages/server-client/dist/lib/client.d.ts:124

Sends a PUT request to the specified URL with an optional payload.

Type Parameters

• T

Parameters

url

string

The URL endpoint for the PUT request.

payload?

Optional payload to be sent as the body of the PUT request.

Returns

Promise<VetchResponse<T>>

The response from the PUT request.

Inherited from

Client.sendPutRequest

sendRequest()

sendRequest<T>(request): Promise<VetchResponse<T>>

Defined in: packages/server-client/dist/lib/client.d.ts:144

Sends a request adding necessary headers, handling authentication, and parsing the response.

Type Parameters

• T

Parameters

request

VetchOptions

The options defining the request, including URL, method, headers, and data.

Returns

Promise<VetchResponse<T>>

The parsed response from the request.

Inherited from

Client.sendRequest

sendRequestWithData()

sendRequestWithData<T>(
   method, 
   url, 
payload?): Promise<VetchResponse<T>>

Defined in: packages/server-client/dist/lib/client.d.ts:135

Sends a request with JSON-encoded data to the specified URL using the provided HTTP method.

Type Parameters

• T

Parameters

method

The HTTP method to be used for the request (only POST, PATCH, or PUT are acceptable).

POST | PUT | PATCH

url

string

The URL endpoint for the request.

payload?

Optional payload to be sent as the body of the request, JSON-encoded.

Returns

Promise<VetchResponse<T>>

The response from the request.

Inherited from

Client.sendRequestWithData

Type Aliases

CIBAResponse

type CIBAResponse = object;

Defined in: packages/network-client/lib/types/responses/odicResponse.ts:1

Type declaration

auth_req_id

auth_req_id: string;

CIBA ODIC token

expires_in

expires_in: number;

Seconds until the token expires

interval?

optional interval: string;

This is the minimum polling interval in seconds

NetworkAuthParameters

type NetworkAuthParameters = AuthParams & object;

Defined in: packages/network-client/lib/types/parameters/networkAuthParameters.ts:3

Type declaration

accessToken?

optional accessToken: string;

The access token to use for API calls

expiresIn?

optional expiresIn: number;

The expiration time of the access token (in seconds)

msisdn

msisdn: string;

The msisdn that will be used for API calls

NetworkConfigParameters

type NetworkConfigParameters = ConfigParams & object;

Defined in: packages/network-client/lib/types/parameters/networkConfigParameters.ts:3

Type declaration

networkApiHost?

optional networkApiHost: string;

URL for making calls to get a network token

odicHost?

optional odicHost: string;

URL for making calls to get a network token

redirectUri?

optional redirectUri: string;

The URL to redirect to for the OAuth flow

NetworkTokenResponse

type NetworkTokenResponse = object;

Defined in: packages/network-client/lib/types/responses/networkTokenResponse.ts:1

Type declaration

access_token

access_token: string;

The token

expires_in

expires_in: number;

The time in seconds from now that the token expires

token_type

token_type: "Bearer";

The type of token