Skip to content
Tidepool API/Authorization API/Authorization

Authorization API (1.0)

The Tidepool API is an HTTP REST API used by Tidepool clients use to communicate with the Tidepool Platform.

For more information, see the Getting Started section.

Download OpenAPI description
access.v1.json
access.v1.yaml
Overview
URL
https://support.tidepool.org/
API Support
support@tidepool.org
License
BSD-2-Clause
Terms of Service
Languages
Servers
Mock server
https://tidepool.redocly.app/_mock/reference/access.v1
integration
https://external.integration.tidepool.org
production
https://api.tidepool.org
dev1
https://dev1.dev.tidepool.org
qa1
https://qa1.development.tidepool.org
qa2
https://qa2.development.tidepool.org

Internal

APIs intended for internal use by Tidepool.

Authorization

List, create and manage authorizations that grant access to another user's diabetes data.

Operations

Get Groups for User

Request

Retrieve all groups accessible to the user userId.

Security
sessionToken
Path
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID

curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/access.v1/access/groups/{userId}' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

Access permissions of one or more users within a group

Bodyapplication/json
non-empty
property name*Owner (object) or Custodian (object) or View (object) or Notes (object) or Upload (object)(User Permissions)non-emptyadditional property

Access permissions granted to a single user.

Example: {"note":{},"upload":{},"view":{}}
Any of:

Full account owner access permission.

non-empty
Response
application/json
{
  "d4206d26a6": {
    "root": {}
  },
  "305cabe660": {
    "note": {},
    "view": {}
  },
  "7575613eca": {
    "view": {},
    "note": {},
    "upload": {}
  },
  "975ac5cc92": {
    "note": {},
    "view": {}
  }
}

Get Users in Group

Request

Retrieve all users that have access to group sharerId.

Security
sessionToken
Path
sharerIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID of user who granted access

curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/access.v1/access/{sharerId}' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

Access permissions of one or more users within a group

Bodyapplication/json
non-empty
property name*Owner (object) or Custodian (object) or View (object) or Notes (object) or Upload (object)(User Permissions)non-emptyadditional property

Access permissions granted to a single user.

Example: {"note":{},"upload":{},"view":{}}
Any of:

Full account owner access permission.

non-empty
Response
application/json
{
  "d4206d26a6": {
    "root": {}
  },
  "305cabe660": {
    "note": {},
    "view": {}
  },
  "7575613eca": {
    "view": {},
    "note": {},
    "upload": {}
  },
  "975ac5cc92": {
    "note": {},
    "view": {}
  }
}

Get User Permissions in Group

Request

Retrieve permissions of individual user userId in group sharerId.

Security
sessionToken
Path
sharerIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID of user who granted access

userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID

curl -i -X GET \
  'https://tidepool.redocly.app/_mock/reference/access.v1/access/{sharerId}/{userId}' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE'

Responses

Access permissions of a user

Bodyapplication/json
non-empty
Any of:

Full account owner access permission.

non-empty
rootobject(Permission)

The presence of this object indicates that the user has been granted the named permission.

Example: {}
Response
application/json
{
  "root": {}
}

Update Permissions for User in Group

Request

Update permissions of individual user userId in group sharerId. The permissions provided in the request body replace all existing permissions for that user. Therefore to delete a permission, submit the request body without that permission.

Security
sessionToken
Path
sharerIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID of user who granted access

userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

Tidepool User ID

Bodyapplication/json
[ 1 .. 3 ] properties
Any of:

Permission to view diabetes data in the account.

[ 1 .. 3 ] properties
viewobject(Permission)

The presence of this object indicates that the user has been granted the named permission.

Example: {}
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/access.v1/access/{sharerId}/{userId}' \
  -H 'Content-Type: application/json' \
  -H 'X-Tidepool-Session-Token: YOUR_API_KEY_HERE' \
  -d '{
    "view": {}
  }'

Responses

Access permissions of a user

Bodyapplication/json
non-empty
Any of:

Full account owner access permission.

non-empty
rootobject(Permission)

The presence of this object indicates that the user has been granted the named permission.

Example: {}
Response
application/json
{
  "root": {}
}