Contents

# OmniAuth TeamSnap

This is the official OmniAuth strategy for authenticating to TeamSnap. To
use it, you'll need to sign up for an OAuth2 Application Id and Secret
on [Cogsworth](https://auth.teamsnap.com).

## Basic Usage

    use OmniAuth::Builder do
      provider :teamsnap, ENV['TEAMSNAP_KEY'], ENV['TEAMSNAP_SECRET']
    end

## Scopes

TeamSnap API v3 lets you set scopes to provide granular access to different types of data:

    use OmniAuth::Builder do
      provider :teamsnap, ENV['TEAMSNAP_KEY'], ENV['TEAMSNAP_SECRET'], scope: "read write"
    end

## Authentication Hash
An example auth hash available in `request.env['omniauth.auth']`:

```
{
  :provider => "teamsnap",
  :uid => "123456",
  :info => {
    :email => "[e-mail]",
    :first_name => "John",
    :last_name => "Player",
  },
  :credentials => {
    :token => "a1b2c3d4...", # The OAuth 2.0 access token
  },
  :extra = {}
}
```

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
omniauth-teamsnap-1.3.0	README.md
omniauth-teamsnap-1.2.0	README.md
omniauth-teamsnap-1.1.0	README.md