SODA API: Authenticate Service

The AuthenticationService offers an alternative cookie based authentication method. Using the AuthenticationService, you can request a cookie that can be included with subsequent requests.

Requests can also be authenticated by passing in HTTP Basic Authentication headers, and in a subsequent release of the API we will also support authentication by OAuth.

Examples:

Using HTTP Basic Authentication:

> curl --user login:pass https://data.cms.gov/api/users/login/views.json

/api/authenticate

• POST

  Compliance Level: This method is a Socrata extension to the SODA standard

  Use a POST request to retrieve an authentication cookie. The service will also respond with a User object for the authenticated user.

  Parameters:

  • usernamestring (required)The user login you wish to authenticate as
  • passwordstring (required)The user's password to authenticate with

  Responds with:

  • User

  Examples:

  Authenticating in order to retreive an authentication cookie:

  > curl --cookie-jar cookies.txt --data username=login --data password=pass https://data.cms.gov/api/authenticate

  After you've requested an authentication cookie, you can reuse it to make further requests to private resources, such as rows in a private dataset:

  > curl --cookie cookies.txt https://data.cms.gov/api/views/4haf-yu5g/rows.json

* This method is not yet currently finalized and is subject to change

This API documentation is licensed as Creative Commons By-Attribution 3.0.

Current Revision: 07e2e8a (Fri Feb 15 14:53:30 PST 2013)