DataAccessConsents

DataAccessConsent attributes

field	type	description
id	string	unique ID
created_at	date	date of creation
updated_at	date	date of last update
app_id	string	unique ID of the app, format uuid
user_id	string	unique ID of the user, format uuid
end_at	datetime	deadline of DataAccessConsent ISO 8601
databases	boolean	to allow databases
containers	boolean	to allow containers

Example object:

{
  "data_access_consent": {
    "id": "87b1ea4bfb0de6000fb8cbad",
    "created_at": "2022-06-21T15:56:43.446Z",
    "updated_at": "2022-06-21T15:56:43.446Z",
    "app_id": "ap-82a3cac5-9b25-473e-b33d-6272b87e636e",
    "user_id": "us-8ba226e5-93e0-4545-8363-9c16b2d68d67",
    "end_at": "2022-07-06T00:00:00.000+00:00",
    "databases": true,
    "containers": false
  }
}

List DataAccessConsents of an App

GET https://$SCALINGO_API_URL/v1/apps/:app_id/data_access_consents

Example request

curl -H 'Accept: application/json' -H 'Content-Type: application/json' -u ":$AUTH_TOKEN" \
  -X GET https://$SCALINGO_API_URL/v1/apps/example-app/data_access_consents

Returns 200 OK

{
  "data_access_consents": [
    {
      "id": "82b1ea4bfb0de6030fb8cbad",
      "app_id": "ap-82a3cac5-9b25-473e-b33d-6272b87e636e",
      "containers": false,
      "created_at": "2022-06-21T15:56:43.446Z",
      "databases": true,
      "end_at": "2022-07-06T00:00:00.000+00:00",
      "updated_at": "2022-06-21T15:56:43.446Z",
      "user_id": "us-8ba226e5-93e0-4545-8363-9c16b2d68d67"
    }
  ]
}

Create a New DataAccessConsent

POST https://$SCALINGO_API_URL/v1/apps/:app_id/data_access_consents

URL Parameter

app_id: the app ID

Body Parameters

end_at: deadline of DataAccessConsent format ISO 8601
databases: boolean to allow databases
containers: boolean to allow databases

Example request

curl -H 'Accept: application/json' -H 'Content-Type: application/json' -u ":$AUTH_TOKEN" \
  -X POST https://$SCALINGO_API_URL/v1/apps/example-app/data_access_consents -d \
  '{
    "data_access_consent": {
      "end_at": "2022-07-06T00:00:00.000+00:00",
      "databases": true,
      "containers": false
    }
  }'

Returns 201 Created

{
  "data_access_consent": {
    "id": "87b1ea4bfb0de6500fb8cbad",
    "app_id": "ap-82a3cac5-9b25-473e-b33d-6272b87e636e",
    "containers": false,
    "created_at": "2022-06-21T15:56:43.446Z",
    "databases": true,
    "end_at": "2022-07-06T00:00:00.000+00:00",
    "updated_at": "2022-06-21T15:56:43.446Z",
    "user_id": "us-8ba226e5-93e0-4545-8363-9c16b2d68d67"
  }
}