Skip to content

Commit

Permalink
Document Auth requirements. fixes #171
Browse files Browse the repository at this point in the history
  • Loading branch information
hunterowens authored Feb 4, 2019
1 parent d47d625 commit f557b5e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions provider/auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,3 +31,9 @@ OAuth 2.0's `client_credentials` grant type (outlined in [RFC6749](https://tools
OAuth 2.0 is an industry standard authorization framework with a variety of existing tooling. The `client_credentials` grant type facilitates generation of tokens that can be used for access by agencies and distributed to data partners.

If an MDS `provider` implements this auth scheme, it **MAY** choose to specify token scopes that define access parameters like allowable time ranges. These guidelines **SHOULD** be encoded into the returned token in a parseable way.

## Endpoint Authenication Requirements

The `/trips` and `/status_changes` endpoints may either have authentication or not, it is up to the implementing provider to descide if they want historical information avaliable openly or only to authenticated users.

As of MDS 0.3.0, `gbfs.json` is required. The required GBFS endpoints should be made avaliable publically. See [#realtime-data](https://github.com/CityOfLosAngeles/mobility-data-specification/tree/master/provider#realtime-data) for more information about realtime info.

0 comments on commit f557b5e

Please sign in to comment.