Skip to main content

OAuthServiceParameters

@webda/core • Readme | API


Class: OAuthServiceParameters

Interface to specify the Service parameters

Extends​

Constructors​

new OAuthServiceParameters(params)​

new OAuthServiceParameters(params): OAuthServiceParameters

Parameters​

• params: any

Returns​

OAuthServiceParameters

Overrides​

ServiceParameters.constructor

Source​

packages/core/src/services/oauth.ts:83

Properties​

authenticationService​

authenticationService: string

Name of the authentication service to use if exist

Default​

Authentication

Source​

packages/core/src/services/oauth.ts:77


authorized_uris?​

authorized_uris?: string[]

List of URIs authorized for redirect post authorization

Default​

[]

Source​

packages/core/src/services/oauth.ts:59


defaultHeaders​

defaultHeaders: Record<string, string>

Default headers to include in the OAuth requests

Source​

packages/core/src/services/oauth.ts:81


exposeScope?​

exposeScope?: boolean

If set to true it will add a ${url}/scope So client can anticipate the requested scope

This is useful when using the client api to generate token. This way the service can request the wanted scope

Default​

false

Source​

packages/core/src/services/oauth.ts:53


no_referer​

no_referer: boolean

Allow direct connection without a referer

Default​

false

Source​

packages/core/src/services/oauth.ts:71


openapi?​

openapi?: OpenAPIWebdaDefinition

OpenAPI override

Schema Ignore​

Inherited from​

ServiceParameters.openapi

Source​

packages/core/src/services/service.ts:260


redirect_uri?​

redirect_uri?: string

Default redirect_uri

Default​

${url}/callback

Source​

packages/core/src/services/oauth.ts:65


scope?​

scope?: string[]

Scope to request on OAuth flow

Defaut​

["email"]

Source​

packages/core/src/services/oauth.ts:43


type​

type: string

Type of the service

Inherited from​

ServiceParameters.type

Source​

packages/core/src/services/service.ts:251


url?​

url?: string

URL to use for expose

The default value varying based on implementation It should by default be the provider name in lowercase

Overrides​

ServiceParameters.url

Source​

packages/core/src/services/oauth.ts:37