Skip to content

Commit

Permalink
Auth summary update to general info
Browse files Browse the repository at this point in the history
  • Loading branch information
schnuerle committed Feb 8, 2023
1 parent ba9655a commit ea5bf20
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions general-information.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,15 @@ This document contains specifications that are shared between the various MDS [A

## Authorization

TBD
Outlines shared authorization details and methods across all MDS APIs.

### Endpoint Requirements

All MDS Provider, Agency, and Metrics APIs require authentication, as outlined.

If implementing MDS Policy, Geography, and/or Jurisdiction APIs and endpoints, an agency must make them unauthenticated and public. This allows transparency for the public to see how the city is regulating, holds the city accountable for their policy decisions, and reduces the technical burden on providers to use these endpoints. A side benefit is that this allows third parties to ingest this information into their applications and services for public benefit.

All Provider endpoints must be authenticated, to protect potentially sensitive information.

As of MDS 0.3.0, `gbfs.json` is required. The required GBFS endpoints should be made available publicly. See [#realtime-data](https://github.com/openmobilityfoundation/mobility-data-specification/tree/main/provider#realtime-data) for more information about how to implement GBFS for dockless systems.
As of MDS 0.3.0, `gbfs.json` is required. The required GBFS endpoints should be made available publicly. See Provider [#realtime-data](https://github.com/openmobilityfoundation/mobility-data-specification/tree/main/provider#realtime-data) for more information about how to implement GBFS for dockless systems.

### Header

Expand Down Expand Up @@ -69,7 +67,7 @@ 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.
If an MDS endpoint producer 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 parsable way.

[Top][toc]

Expand Down

0 comments on commit ea5bf20

Please sign in to comment.