Class OnmsAuthConfig

Represents server authentication config.

Hierarchy

OnmsAuthConfig

Index

Constructors

constructor

Properties

Methods

clone
equals

Constructors

constructor

new OnmsAuthConfig(username?: string | null, password?: string | null): OnmsAuthConfig

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

constructor

Parameters
- Optional username: string | null
- Optional password: string | null
Returns OnmsAuthConfig

Properties

password

password: string | null

The password to authenticate with.

username

username: string | null

The username to connect as.

Methods

clone

clone(): OnmsAuthConfig

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

Returns OnmsAuthConfig

equals

equals(that?: OnmsAuthConfig | null): boolean

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

Parameters
- Optional that: OnmsAuthConfig | null
Returns boolean

Generated using TypeDoc