Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICreatePasswordClientOptions

Options for 'createPasswordClient()' and 'createPasswordClientFactory' functions.

Hierarchy

  • ICreatePasswordClientOptions

Index

Properties

Properties

auth

auth: { clientId: string; clientSecret: string; password: string; username: string }

OAuth 2.0 Auth information.

Type declaration

  • clientId: string

    The ID of the client.

  • clientSecret: string

    The secret of the client.

  • password: string

    The password.

  • username: string

    The username.

Optional baseURL

baseURL?: Nilable<string>

The base URL of the underlying API.

Optional config

config?: Nilable<NewAxiosClientConfig2>

The custom configuration for a new axios client.

Optional headers

headers?: Nilable<AxiosRequestHeaders>

Optional and custom headers.

Optional scope

scope?: Nilable<string>

The optional scope, if required.

tokenURL

tokenURL: string

The URL from where to get the access token.

Generated using TypeDoc