@octokit/oauth-login-url NPM

oauth-login-url.js

Universal library to retrieve GitHub’s identity URL for the OAuth web flow

See GitHub’s Developer Guide for the OAuth web application flow.

Usage

Browsers

<script type="module">
  import { oauthLoginUrl } from 'https://unpkg.com/@octokit/oauth-login-url';

  // get login URL
  const { url } = oauthLoginUrl({
    clientId: '1234567890abcdef1234'
  })

  // redirect to login page
  location.href = url
</script>

Node

const { oauthLoginUrl } = require('@octokit/oauth-login-url')
// or: import { oauthLoginUrl } from '@octokit/oauth-login-url'

// get login URL
const { url } = oauthLoginUrl({
  clientId: '1234567890abcdef1234'
})

// do something with the url :)

Full usage example

const { 
  url,
  clientId,
  redirectUri,  
  login,
  scopes,
  state
} = oauthLoginUrl({
  clientId: '1234567890abcdef1234',
  redirectUri: 'https://example.com',
  login: 'octocat',
  scopes: ['repo', 'admin:org'],
  state: 'secret123',
  log: {
    warn (message) {
      myLogger.log(message, { level: 'warn' })
    }
  }
})

Override or set default options

const myLogin = login.defaults({
  baseUrl: 'https://github.my-enterprise.com',
  defaultRedirectUri: 'https://app.my-enterprise.com',
  client: '1234567890abcdef1234'
})

location.href = oauthLoginUrl().url