Class Auth`Abstract`

Provides direct access to the OpenAM authentication tree API.

Hierarchy

Auth

Index

Methods

next constructUrl configureRequest getResponseJson

Constructors

Methods

`Static` next

next(previousStep?: Step, options?: StepOptions): Promise<Step>
Gets the next step in the authentication tree.

Returns
The next step in the authentication tree.
Parameters
- Optional previousStep: Step
  
  The previous step, including any required input.
- Optional options: StepOptions
  
  Configuration default overrides.
Returns Promise<Step>
- Defined in auth/index.ts:32

`Static` `Private` constructUrl

constructUrl(serverConfig: ServerConfig, realmPath?: string, tree?: string, query?: StringDict<string>): string
Parameters
- serverConfig: ServerConfig
- Optional realmPath: string
- Optional tree: string
- Optional query: StringDict<string>
Returns string
- Defined in auth/index.ts:55

`Static` `Private` configureRequest

configureRequest(step?: Step): RequestInit
Parameters
- Optional step: Step
Returns RequestInit
- Defined in auth/index.ts:69

`Static` `Private` getResponseJson

getResponseJson<T>(res: Response): Promise<T>
Type Parameters
- T
Parameters
- res: Response
Returns Promise<T>
- Defined in auth/index.ts:84

Constructors

constructor

new Auth(): Auth
Returns Auth

src