Module Login

Main login call which either produces a user object and credentials, or returns a challenge.

Index

Interfaces

Args

Type aliases

Variables

HTTP
Path

Functions

Interfaces

Args

Args:

password

password: string

username

username: string

Type aliases

Response

Response: UserOrChallengeResponse

Result

Result: UserOrChallengeResult

Variables

Const HTTP

HTTP: POST = "POST"

Const Path

Path: string = `${authBasePath}/${ResourcePaths.login}`

Functions

isArgs

isArgs(val: any): boolean

- Defined in spec/methods/auth/auth.ts:60
Type guard; only returns true for valid Args objects.

Parameters
- val: any
Returns boolean

newArgs

newArgs(): Args

- Defined in spec/methods/auth/auth.ts:69
Factory to produce an Args object with empty strings. Useful for getting the correct shape as a value.

Returns Args

Generated using TypeDoc