Skip to content

Instantly share code, notes, and snippets.

@chrisjacob

chrisjacob/github_oauth_busy_developer_guide.md

Forked from technoweenie/github_oauth_busy_developer_guide.md
Created November 18, 2010 04:53
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save chrisjacob/704639 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save chrisjacob/704639 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. @technoweenie technoweenie revised this gist Jun 16, 2010. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion github_oauth_busy_developer_guide.md
    View file
    Original file line number Diff line number Diff line change
    @@ -49,7 +49,7 @@ Your application can request the scopes in the initial redirection:

    <pre><code>https://github.com/login/oauth/authorize?
    client_id=...&
    scope=user,public_repos&
    scope=user,public_repo&
    redirect_uri=http://www.example.com/oauth_redirect</code></pre>

    ## References
  2. @technoweenie technoweenie revised this gist Jun 15, 2010. 1 changed file with 2 additions and 2 deletions.
    4 changes: 2 additions & 2 deletions github_oauth_busy_developer_guide.md
    View file
    Original file line number Diff line number Diff line change
    @@ -41,8 +41,8 @@ Disabled, for now...

    * (no scope) - public read-only access.
    * `user` - DB read/write access to profile info only.
    * `public_repo` - DB read/write access, and Git read access to public repos (not implemented yet).
    * `repo` - DB read/write access, and Git read access to public and private repos (not implemented yet).
    * `public_repo` - DB read/write access, and Git read access to public repos.
    * `repo` - DB read/write access, and Git read access to public and private repos.
    * `gist` - read/write access to public and private gists (not implemented yet).

    Your application can request the scopes in the initial redirection:
  3. @technoweenie technoweenie revised this gist Jun 15, 2010. 1 changed file with 3 additions and 3 deletions.
    6 changes: 3 additions & 3 deletions github_oauth_busy_developer_guide.md
    View file
    Original file line number Diff line number Diff line change
    @@ -41,9 +41,9 @@ Disabled, for now...

    * (no scope) - public read-only access.
    * `user` - DB read/write access to profile info only.
    * `public_repos` - DB read/write access, and Git read access to public repos (not implemented yet).
    * `repos` - DB read/write access, and Git read access to public and private repos (not implemented yet).
    * `gists` - read/write access to public and private gists (not implemented yet).
    * `public_repo` - DB read/write access, and Git read access to public repos (not implemented yet).
    * `repo` - DB read/write access, and Git read access to public and private repos (not implemented yet).
    * `gist` - read/write access to public and private gists (not implemented yet).

    Your application can request the scopes in the initial redirection:

  4. @technoweenie technoweenie revised this gist Jun 12, 2010. 1 changed file with 3 additions and 29 deletions.
    32 changes: 3 additions & 29 deletions github_oauth_busy_developer_guide.md
    View file
    Original file line number Diff line number Diff line change
    @@ -31,37 +31,11 @@ access_token=...</code></pre>

    ## Javascript Flow

    This is similar to the Web Application flow, but designed for javascript/ajax
    applications. The main difference is there is no temporary code used. The access token is included in the redirection from GitHub in a URI fragment.

    * Redirect to this link to request GitHub access (note the use of the `type`
    parameter):

    <pre><code>https://github.com/login/oauth/authorize?
    client_id=...&
    type=user_agent&
    redirect_uri=http://www.example.com/oauth_redirect</code></pre>

    * If the user accepts your request, GitHub redirects back to your site with
    the access_code in a URI fragment. Given the example above, GitHub will
    redirect to: `http://www.example.com/oauth_redirect#access_token=...`
    Disabled, for now...

    ## Desktop flow

    The desktop flow relies on having an embedded browser in your application. The redirection is handled the same way, but a special GitHub callback URL is sent. Then your desktop application can watch for GitHub to redirect back to it.

    * Redirect to this link to request GitHub access (note the use of the `type` and `redirect_uri` parameteres):

    <pre><code>https://github.com/login/oauth/authorize?
    client_id=...&
    type=user_agent&
    redirect_uri=https://github.com/login/oauth/success</code></pre>

    * If the user accepts your request, GitHub redirects back to your site with
    the access_code in a URI fragment. Given the example above, GitHub will
    redirect to: `https://github.com/login/oauth/success#access_token=...`

    It is up to your desktop application to intercept this custom URL and parse the access_token for use in the rest of the application.
    Disabled, for now...

    ## Scopes

    @@ -80,7 +54,7 @@ Your application can request the scopes in the initial redirection:

    ## References

    * [OAuth 2 spec](http://tools.ietf.org/html/draft-ietf-oauth-v2-05)
    * [OAuth 2 spec](http://tools.ietf.org/html/draft-ietf-oauth-v2-07)
    * [Facebook API](http://developers.facebook.com/docs/authentication/)
    * [Ruby OAuth2 lib](https://github.com/intridea/oauth2)
    * [simple ruby/sinatra example](https://gist.github.com/9fd1a6199da0465ec87c)
  5. @technoweenie technoweenie revised this gist Jun 3, 2010. 1 changed file with 2 additions and 0 deletions.
    2 changes: 2 additions & 0 deletions github_oauth_busy_developer_guide.md
    View file
    Original file line number Diff line number Diff line change
    @@ -61,6 +61,8 @@ The desktop flow relies on having an embedded browser in your application. The
    the access_code in a URI fragment. Given the example above, GitHub will
    redirect to: `https://github.com/login/oauth/success#access_token=...`

    It is up to your desktop application to intercept this custom URL and parse the access_token for use in the rest of the application.

    ## Scopes

    * (no scope) - public read-only access.
  6. @technoweenie technoweenie revised this gist Jun 3, 2010. 1 changed file with 14 additions and 3 deletions.
    17 changes: 14 additions & 3 deletions github_oauth_busy_developer_guide.md
    View file
    Original file line number Diff line number Diff line change
    @@ -34,7 +34,7 @@ access_token=...</code></pre>
    This is similar to the Web Application flow, but designed for javascript/ajax
    applications. The main difference is there is no temporary code used. The access token is included in the redirection from GitHub in a URI fragment.

    * Redirect to this link to request GitHub access (node the use of the `type`
    * Redirect to this link to request GitHub access (note the use of the `type`
    parameter):

    <pre><code>https://github.com/login/oauth/authorize?
    @@ -44,11 +44,22 @@ applications. The main difference is there is no temporary code used. The acce

    * If the user accepts your request, GitHub redirects back to your site with
    the access_code in a URI fragment. Given the example above, GitHub will
    redirect to: `http://www.example.com/oauth_redirect#access_token...`
    redirect to: `http://www.example.com/oauth_redirect#access_token=...`

    ## Desktop flow

    coming soon... (I'd love to work closely with a desktop app developer on this).
    The desktop flow relies on having an embedded browser in your application. The redirection is handled the same way, but a special GitHub callback URL is sent. Then your desktop application can watch for GitHub to redirect back to it.

    * Redirect to this link to request GitHub access (note the use of the `type` and `redirect_uri` parameteres):

    <pre><code>https://github.com/login/oauth/authorize?
    client_id=...&
    type=user_agent&
    redirect_uri=https://github.com/login/oauth/success</code></pre>

    * If the user accepts your request, GitHub redirects back to your site with
    the access_code in a URI fragment. Given the example above, GitHub will
    redirect to: `https://github.com/login/oauth/success#access_token=...`

    ## Scopes

  7. @technoweenie technoweenie revised this gist Jun 2, 2010. 1 changed file with 4 additions and 1 deletion.
    5 changes: 4 additions & 1 deletion github_oauth_busy_developer_guide.md
    View file
    Original file line number Diff line number Diff line change
    @@ -72,4 +72,7 @@ Your application can request the scopes in the initial redirection:
    * [Ruby OAuth2 lib](https://github.com/intridea/oauth2)
    * [simple ruby/sinatra example](https://gist.github.com/9fd1a6199da0465ec87c)
    * [simple python example](https://gist.github.com/e3fbd47fbb7ee3c626bb) using [python-oauth2](http://github.com/dgouldin/python-oauth2)
    * [Ruby OmniAuth example](http://github.com/intridea/omniauth)
    * [Ruby OmniAuth example](http://github.com/intridea/omniauth)
    * [Ruby Sinatra extension](http://github.com/atmos/sinatra_auth_github)
    * [Ruby Warden strategy](http://github.com/atmos/warden-github)
    * [Node.js demo using Nozzle](http://github.com/fictorial/nozzle/blob/master/demo/08-github-oauth2.js)
  8. @technoweenie technoweenie revised this gist May 30, 2010. 1 changed file with 1 addition and 0 deletions.
    1 change: 1 addition & 0 deletions github_oauth_busy_developer_guide.md
    View file
    Original file line number Diff line number Diff line change
    @@ -56,6 +56,7 @@ coming soon... (I'd love to work closely with a desktop app developer on this).
    * `user` - DB read/write access to profile info only.
    * `public_repos` - DB read/write access, and Git read access to public repos (not implemented yet).
    * `repos` - DB read/write access, and Git read access to public and private repos (not implemented yet).
    * `gists` - read/write access to public and private gists (not implemented yet).

    Your application can request the scopes in the initial redirection:

  9. @technoweenie technoweenie revised this gist May 30, 2010. 1 changed file with 1 addition and 0 deletions.
    1 change: 1 addition & 0 deletions github_oauth_busy_developer_guide.md
    View file
    Original file line number Diff line number Diff line change
    @@ -70,4 +70,5 @@ Your application can request the scopes in the initial redirection:
    * [Facebook API](http://developers.facebook.com/docs/authentication/)
    * [Ruby OAuth2 lib](https://github.com/intridea/oauth2)
    * [simple ruby/sinatra example](https://gist.github.com/9fd1a6199da0465ec87c)
    * [simple python example](https://gist.github.com/e3fbd47fbb7ee3c626bb) using [python-oauth2](http://github.com/dgouldin/python-oauth2)
    * [Ruby OmniAuth example](http://github.com/intridea/omniauth)
  10. @technoweenie technoweenie revised this gist May 30, 2010. 1 changed file with 7 additions and 0 deletions.
    7 changes: 7 additions & 0 deletions github_oauth_busy_developer_guide.md
    View file
    Original file line number Diff line number Diff line change
    @@ -57,6 +57,13 @@ coming soon... (I'd love to work closely with a desktop app developer on this).
    * `public_repos` - DB read/write access, and Git read access to public repos (not implemented yet).
    * `repos` - DB read/write access, and Git read access to public and private repos (not implemented yet).

    Your application can request the scopes in the initial redirection:

    <pre><code>https://github.com/login/oauth/authorize?
    client_id=...&
    scope=user,public_repos&
    redirect_uri=http://www.example.com/oauth_redirect</code></pre>

    ## References

    * [OAuth 2 spec](http://tools.ietf.org/html/draft-ietf-oauth-v2-05)
  11. @technoweenie technoweenie revised this gist May 30, 2010. 1 changed file with 2 additions and 2 deletions.
    4 changes: 2 additions & 2 deletions github_oauth_busy_developer_guide.md
    View file
    Original file line number Diff line number Diff line change
    @@ -54,8 +54,8 @@ coming soon... (I'd love to work closely with a desktop app developer on this).

    * (no scope) - public read-only access.
    * `user` - DB read/write access to profile info only.
    * `public_repos` - DB read/write access, and Git read access to public repos
    * `repos` - DB read/write access, and Git read access to public and private repos.
    * `public_repos` - DB read/write access, and Git read access to public repos (not implemented yet).
    * `repos` - DB read/write access, and Git read access to public and private repos (not implemented yet).

    ## References

  12. @technoweenie technoweenie created this gist May 30, 2010.
    66 changes: 66 additions & 0 deletions github_oauth_busy_developer_guide.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,66 @@
    # GitHub OAuth Busy Developer's Guide

    This is a quick guide to OAuth2 support in GitHub for developers. This is still experimental and could change at any moment. This Gist will serve as a living document until it becomes finalized at [Develop.GitHub.com](http://develop.github.com/).

    OAuth2 is a protocol that lets external apps request authorization to private details in your GitHub account without getting your password. All developers need to [register their application](http://github.com/account/applications/new) before getting started.

    ## Web Application Flow

    * Redirect to this link to request GitHub access:

    <pre><code>https://github.com/login/oauth/authorize?
    client_id=...&
    redirect_uri=http://www.example.com/oauth_redirect</code></pre>

    * If the user accepts your request, GitHub redirects back to your site with
    a temporary code in a `code` parameter. Exchange this for an access token:

    <pre><code>POST https://github.com/login/oauth/access_token?
    client_id=...&
    redirect_uri=http://www.example.com/oauth_redirect&
    client_secret=...&
    code=...

    RESPONSE:
    access_token=...</code></pre>

    * You have the access token, so now you can make requests on the user's behalf:

    <pre><code>GET https://github.com/api/v2/json/user/show?
    access_token=...</code></pre>

    ## Javascript Flow

    This is similar to the Web Application flow, but designed for javascript/ajax
    applications. The main difference is there is no temporary code used. The access token is included in the redirection from GitHub in a URI fragment.

    * Redirect to this link to request GitHub access (node the use of the `type`
    parameter):

    <pre><code>https://github.com/login/oauth/authorize?
    client_id=...&
    type=user_agent&
    redirect_uri=http://www.example.com/oauth_redirect</code></pre>

    * If the user accepts your request, GitHub redirects back to your site with
    the access_code in a URI fragment. Given the example above, GitHub will
    redirect to: `http://www.example.com/oauth_redirect#access_token...`

    ## Desktop flow

    coming soon... (I'd love to work closely with a desktop app developer on this).

    ## Scopes

    * (no scope) - public read-only access.
    * `user` - DB read/write access to profile info only.
    * `public_repos` - DB read/write access, and Git read access to public repos
    * `repos` - DB read/write access, and Git read access to public and private repos.

    ## References

    * [OAuth 2 spec](http://tools.ietf.org/html/draft-ietf-oauth-v2-05)
    * [Facebook API](http://developers.facebook.com/docs/authentication/)
    * [Ruby OAuth2 lib](https://github.com/intridea/oauth2)
    * [simple ruby/sinatra example](https://gist.github.com/9fd1a6199da0465ec87c)
    * [Ruby OmniAuth example](http://github.com/intridea/omniauth)