Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAuthorizationBase

Hierarchy

Index

Properties

Optional accessType

accessType: undefined | string

Indicates if the api apiUrl IGoogleButton can refresh tokens on the user's behalf. The default value is online but if your backend api will refresh the token then you must pass in a string value of offline (This is recommended for react apps connected to a REST api backend).

clientId

clientId: string

This is your client ID

Optional includeGrantedScopes

includeGrantedScopes: undefined | false | true

Defaulted to true. Any extra scopes the logged in user previously granted will be available within the new access token.

Optional loginHint

loginHint: undefined | string

Not required, optional. For prefilling email fields

Optional prompt

prompt: TypePrompt

Not required, optional. A space-delimited, case-sensitive list of prompts to present the user. If you don't specify this parameter, the user will be prompted only the first time your project requests access. Valid values: consent - Prompt the user for consent. select_account - Prompt the user to select an account.

redirectUri

redirectUri: string

Where you React app should redirect to if user has successfully logged in

Optional responseType

responseType: undefined | string

By default this is set to code

Optional state

state: undefined | string

This option is currently unavailable but will be in a added in a future version, TODO - See https://github.com/joegasewicz/react-google-oauth2.0/issues/3

Generated using TypeDoc