Skip to main content

OAuthProviderParameters

@webda/auth

Class: OAuthProviderParameters

Defined in: packages/auth/src/oauth/oauth.service.ts:92

OAuthProvider parameters

Extends​

  • ServiceParameters

Constructors​

Constructor​

new OAuthProviderParameters(): OAuthProviderParameters

Returns​

OAuthProviderParameters

Inherited from​

ServiceParameters.constructor

Properties​

allowedEmailDomains?​

optional allowedEmailDomains?: string[]

Defined in: packages/auth/src/oauth/oauth.service.ts:129

Only these email domains may use this provider (see ProviderEmailPolicy)

authorized_uris​

authorized_uris: string[]

Defined in: packages/auth/src/oauth/oauth.service.ts:122

Allowed post-login targets for the redirect query parameter of the login route: absolute http(s) urls, a target matches when it has the same origin and its path is the listed path or below it

Default​

[]

client_id​

client_id: string

Defined in: packages/auth/src/oauth/oauth.service.ts:101

OAuth client id

client_secret?​

optional client_secret?: string | SecretString

Defined in: packages/auth/src/oauth/oauth.service.ts:107

OAuth client secret

Can be encrypted with webda config encrypt

redirect_uri?​

optional redirect_uri?: string

Defined in: packages/auth/src/oauth/oauth.service.ts:116

Callback url registered at the provider

Default​

"<absolute url of the request>/callback"; set it explicitly behind a proxy

redirects​

redirects: OAuthRedirects

Defined in: packages/auth/src/oauth/oauth.service.ts:127

Browser redirects of the callback

Default​

{ "success": "/" }

scope?​

optional scope?: string[]

Defined in: packages/auth/src/oauth/oauth.service.ts:111

Scopes requested from the provider (the default depends on the provider)

trustEmailVerification?​

optional trustEmailVerification?: boolean | string[]

Defined in: packages/auth/src/oauth/oauth.service.ts:131

Whether the verification of the email is believed (see ProviderEmailPolicy)

type​

type: string

Defined in: packages/core/lib/services/serviceparameters.d.ts:9

Type of the service

Inherited from​

ServiceParameters.type

url?​

optional url?: string

Defined in: packages/auth/src/oauth/oauth.service.ts:97

Route prefix of the login (<url>) and callback (<url>/callback) routes

Default​

"/auth/<providerName>"

Methods​

load()​

load(params?): this

Defined in: packages/auth/src/oauth/oauth.service.ts:137

Parameters​

params?​

any = {}

raw parameters

Returns​

this

this

Overrides​

ServiceParameters.load

update()​

update(params, delta): this

Defined in: packages/core/lib/application/parameters.d.ts:21

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: packages/core/lib/application/parameters.d.ts:27

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with