@webda/google-auth • Readme | API
Class: GoogleParameters
Credentials to manage Google Auth https://developers.google.com/identity/protocols/oauth2
Extends
OAuthServiceParameters
Constructors
new GoogleParameters(params)
new GoogleParameters(
params):GoogleParameters
Parameters
• params: any
Returns
Overrides
OAuthServiceParameters.constructor
Source
google-auth/src/google-auth.ts:59
Properties
access_type?
access_type?:
"offline"|"online"
Type of access for Google token
online by default
Source
google-auth/src/google-auth.ts:47
auth_options?
auth_options?:
any
Source
google-auth/src/google-auth.ts:49
authenticationService
authenticationService:
string
Name of the authentication service to use if exist
Default
Authentication
Inherited from
OAuthServiceParameters.authenticationService
Source
core/lib/services/oauth.d.ts:73
authorized_uris?
authorized_uris?:
string[]
List of URIs authorized for redirect post authorization
Default
[]
Inherited from
OAuthServiceParameters.authorized_uris
Source
core/lib/services/oauth.d.ts:56
client_id
client_id:
string
Google Auth Client id
Source
google-auth/src/google-auth.ts:32
client_secret
client_secret:
string
Google Auth Client secret
Source
google-auth/src/google-auth.ts:36
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
Inherited from
OAuthServiceParameters.exposeScope
Source
core/lib/services/oauth.d.ts:50
no_referer
no_referer:
boolean
Allow direct connection without a referer
Default
false
Inherited from
OAuthServiceParameters.no_referer
Source
core/lib/services/oauth.d.ts:68
openapi?
openapi?:
OpenAPIWebdaDefinition
OpenAPI override
Schema Ignore
Inherited from
OAuthServiceParameters.openapi
Source
core/lib/services/service.d.ts:104
project_id?
project_id?:
string
Google Project ID
Source
google-auth/src/google-auth.ts:40
redirect_uri?
redirect_uri?:
string
Default redirect_uri
Default
${url}/callback
Inherited from
OAuthServiceParameters.redirect_uri
Source
core/lib/services/oauth.d.ts:62
redirects
redirects:
Object
Type declaration
defaults
defaults:
Object
Index signature
[key: string]: string
use_referer
use_referer:
boolean
whitelist
whitelist:
string[]
Source
google-auth/src/google-auth.ts:50
scope?
scope?:
string[]
Scope to request on OAuth flow
Defaut
["email"]
Inherited from
OAuthServiceParameters.scope
Source
core/lib/services/oauth.d.ts:40
type
type:
string
Type of the service
Inherited from
OAuthServiceParameters.type
Source
core/lib/services/service.d.ts:95
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
Inherited from
OAuthServiceParameters.url
Source
core/lib/services/oauth.d.ts:34