OBP-TypeScript/docs/classes/auth.OAuth.md

obp-typescript / Modules / auth / OAuth

Class: OAuth

auth.OAuth

Create OAuth.

Table of contents

Constructors

• constructor

Properties

• config
• instance

Methods

• authHeader
• configs
• get

Constructors

constructor

• new OAuth(config)

Parameters

Name	Type
config	OAuthConfig

Defined in

auth/index.ts:62

Properties

config

• Private config: OAuthConfig

Defined in

auth/index.ts:61

---

instance

• Private instance: OAuth

Defined in

auth/index.ts:60

Methods

authHeader

▸ authHeader(pathUri, method): string

Get the Oauth authentication header.

Parameters

Name	Type	Description
pathUri	string	The the relative path of the URL.
method	string	The http method.

Returns

string

An OAuthConfig value

Defined in

auth/index.ts:113

---

configs

▸ configs(): OAuthConfig

Get OAuthConfig object.

Returns

OAuthConfig

An OAuthConfig value

Defined in

auth/index.ts:100

---

get

▸ get(): OAuth

Get oauth.OAuth instance.

Returns

OAuth

An oauth.OAuth value

Defined in

auth/index.ts:89