Class OnmsAuthConfig

Represents server authentication config.

Hierarchy

OnmsAuthConfig

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OnmsAuthConfig(username?: string, password?: string): API.OnmsAuthConfig

- Defined in src/api/OnmsAuthConfig.ts:16
Construct an auth configuration object.

Parameters
- Optional username: string
- Optional password: string
Returns API.OnmsAuthConfig

Properties

Readonly password

password: string

The password to authenticate with.

Readonly username

username: string

The username to connect as.

Methods

clone

clone(): API.OnmsAuthConfig

- Defined in src/api/OnmsAuthConfig.ts:34
Create a new config object from this existing one.

Returns API.OnmsAuthConfig

equals

equals(that?: API.OnmsAuthConfig): boolean

- Defined in src/api/OnmsAuthConfig.ts:25
Whether this auth object is the same as another.

Parameters
- Optional that: API.OnmsAuthConfig
Returns boolean

Generated using TypeDoc