Consent Management

PreviousLocation Management NextOTP Services

Last updated 2 years ago

Was this helpful?

post

This API is used to update user consent for sharing the PII to an organisation, course or collection

The endpoint for Update Consent is /user/v1/consent/update
The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.

Authorizations

Header parameters

tsstringoptional

Timestamp at which given API request is sent.

X-msgidstringoptional

This ID uniquely identifies a request if the same API is executed multiple times.

Authorizationstringrequired

To make use of this API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.

x-authenticated-user-tokenstringrequired

It is a unique token/key to authenticate the user each time an API is called. For corresponding sessions this token is used, not your actual username/password

x-authenticated-forstringoptional

Managed User token of registered MUA user performing given API request.

Body

requestobjectrequired

Example:

{"consent":{"status":"ACTIVE","userId":"e94ad69a-9096-491c-b107-782a67760a2b","consumerId":126632859575746560,"objectId":"do_31313966505806233613406","objectType":"Collection"}}

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://staging.open-sunbird.org/api/user/v1/consent/update' \
  --header 'Authorization: text' \
  --header 'x-authenticated-user-token: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "request": {
      "consent": {
        "status": "ACTIVE",
        "userId": "e94ad69a-9096-491c-b107-782a67760a2b",
        "consumerId": 126632859575746560,
        "objectId": "do_31313966505806233613406",
        "objectType": "Collection"
      }
    }
  }'

200

400

401

404

500

{
  "id": "api.user.consent.update",
  "ver": "v1",
  "ts": "2020-09-17 14:07:15:545+0000",
  "params": {
    "resmsgid": null,
    "msgid": "3d1afc39-9350-4565-afb3-735dbccd19c7",
    "err": null,
    "status": "success",
    "errmsg": null
  },
  "responseCode": "OK",
  "result": {
    "consent": {
      "userId": "e94ad69a-9096-491c-b107-782a67760a2b"
    },
    "message": "User Consent updated successfully."
  }
}

Consent update success response