traqoauth2

README

go-traq-oauth2

Package traqoauth2 provides constants for using OAuth2 to access traQ.

Usage

[!WARNING] OAuth2 Authorization Code Flowに則ったClientを実装する前に、他のより簡単な方法で実装できないか検討してください。

• ログインユーザーの traQ ID (e.g. @traP) を取得したい場合
  • traPtitech/NeoShowcase
  • traPtitech/caddy-trap-auth
  • traPtitech/traefik-forward-auth
• ログインユーザーの識別情報を利用したい (e.g. GET /users/me, POST /channels/:channelID/messages) 場合
  • BotのAccess Tokenを用いる
  • (実装予定) OAuth2 Client Credential Flow を用いる

Full example: _example/

package main

import (
  // ...
  traqoauth2 "github.com/traPtitech/go-traq-oauth2"
)

// Configure at https://bot-console.trap.jp/clients
var  oauth2Config = oauth2.Config{
  ClientID:     os.Getenv("TRAQ_CLIENT_ID"),
  ClientSecret: os.Getenv("TRAQ_CLIENT_SECRET"),
  Endpoint:     traqoauth2.Prod, // or traqoauth2.Staging
  RedirectURL:  os.Getenv("TRAQ_REDIRECT_URL"),
  Scopes:       []string{traqoauth2.ScopeRead, traqoauth2.ScopeWrite}
}

Documentation

Index

• Constants
• Variables
• func New(apiBaseURL string) (oauth2.Endpoint, error)

Constants

const (
	ScopeOpenID    = "openid"
	ScopeProfile   = "profile"
	ScopeRead      = "read"
	ScopeWrite     = "write"
	ScopeManageBot = "manage_bot"
)

Variables

var (
	Prod, _    = New("https://q.trap.jp/api/v3")
	Staging, _ = New("https://q-dev.trapti.tech/api/v3")
)

Functions

func New

func New(apiBaseURL string) (oauth2.Endpoint, error)

New returns an Endpoint for the given API base URL.