Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • SnapchatStrategyOptions

Index

Properties

Optional authorizationURL

authorizationURL: undefined | string
optional

URL used to obtain an authorization grant from Snapchat

default

'https://accounts.snapchat.com/accounts/oauth2/auth'

callbackURL

callbackURL: string
required

URL to which Snapchat will redirect the user after granting authorization

clientID

clientID: string
required

Your application's client ID. Your client ID can be found within the Snap Kit Developer Portal (https://kit.snapchat.com/portal)

clientSecret

clientSecret: string
required

Your application's client secret. You can generate a confidential client and secret within the Snap Kit Developer Portal (https://kit.snapchat.com/portal)

Optional passReqToCallback

passReqToCallback: undefined | false | true
optional

Determines whether req is passed as the first argument to the verify callback triggered when Snapchat redirects to the callbackURL.

default

false

Optional profileFields

profileFields: string[]
optional

An array of profile fields indicating which fields to query within a Snapchat user profile when requesting information from the user profile endpoint (profileURL). Valid fields are:

  • 'id'
  • 'displayName'
  • 'bitmoji'
default

[]

Optional profileURL

profileURL: undefined | string
optional

Endpoint URL for retrieving Snapchat user profile information.

default

'https://kit.snapchat.com/v1/me'

Optional scope

scope: string | string[]
optional

An array of Snapchat OAuth2 scopes. May also be a string of scopes separated by scopeSeparator. Valid scopes include:

  • 'user.display_name'
  • 'user.bitmoji.avatar'
default

[]

Optional scopeSeparator

scopeSeparator: undefined | string
optional

String delimiter for scopes in scopes.

default

' '

Optional tokenURL

tokenURL: undefined | string
optional

URL used to obtain an access token from Snapchat

default

'https://accounts.snapchat.com/accounts/oauth2/token'

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc