Register consent event - client mode

Only the client needs to be logged in to use this endpoint. The user does not need to be logged in, click here to read more.

API for granting consent.

It is required to provide either a consentId, or both target and scope. If all three fields are included, they are required to refer to the same consent.

curl --location --request POST 'https://api.mediaconnect.no/capi/v1/client/customer/privacy/consentEvent' \ --header 'Content-Type: application/json' \ --data-raw '{ "consentId": 1, "consentTarget": "editoral", "consentScope": "telephone", "subject": "563457", "subjectType": "CONNECT", "source": "Selfservice", "action": true, "eventTime": 1560277312000, "data": "dHJ1ZQ==" }'

{ "consentId": 1, "subject": "563457", "subjectType": "CONNECT", "consentEventId": 1, "created": 1560963388000, "source": "Selfservice", "action": true, "childEvents": { "consentEventId": 1, "consentId": 1, "created": 1560363712000, "action": true } }

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://connectid.no/user/oauth/token

Refresh URL: https://connectid.no/user/oauth/token

Scopes:

read-For all access

Body Params application/json

consentId

integer

optional

Consent ID for this event - required unless target / scope is provided

consentTarget

string

optional

Identification of the target of the consent (e.g. URL of a policy) - required if none consentId is provided

<= 255 characters

consentScope

string

optional

Scope of the consent. Typically, this will refer to a section or clause in the target - required if none consentId is provided

<= 255 characters

subject

string

required

Identification of the subject:

Enter customer number for subjectType CONNECT

Enter credential for subjectType CONNECTID

Enter external id for subjectType EXTERNAL

Enter ConnectID orderid for subjectType ORDER.

<= 255 characters

subjectType

enum<string>

required

Type of subject, allowed is:

CONNECT

CONNECTID

EXTERNAL

ORDER

Allowed values:

CONNECTCONNECTIDEXTERNALORDER

source

string

optional

Identification of the source of the consent principal

<= 255 characters

action

boolean

required

It informs if the consent is granted.

true: The consent is granted.

false: The consent is revoked or not granted.

eventTime

integer

optional

Time when the consent was given, if different from the current time.

Unix Epoch timestamps in milliseconds since 1st January 1970 UTC.

data

string <byte>

optional

Data documenting the collecting of the consent, base64-encoded.

Examples

Responses

🟢200OK

application/json

Body

consentId

integer

optional

Consent ID for this event

subject

string

optional

Identification of the subject e.g. customer number or credential

<= 255 characters

subjectType

enum<string>

optional

Type of subject, allowed is:

CONNECT

CONNECTID

EXTERNAL

Allowed values:

CONNECTCONNECTIDEXTERNAL

consentEventId

integer

optional

The ID of this event

created

integer

optional

The time this event was saved.

Unix Epoch timestamps in milliseconds since 1st January 1970 UTC.

source

string

optional

Identification of the source of the consent principal

<= 255 characters

action

boolean

optional

It informs if the consent is granted.

true: The consent is granted.

false: The consent is revoked or not granted.

childEvents

array [object {4}]

optional

If consent has flag followParent set, so all child consent will be also pushed. Here will be list of changed consent/events to main consent/event

consentEventId

integer

optional

The ID of this event for child consent

consentId

integer

optional

Consent ID for child consent

created

integer

optional

The time this event was saved for child consent.

Unix Epoch timestamps in milliseconds since 1st January 1970 UTC.

action

boolean

optional

It informs if the consent is granted.

true: The child consent is granted.

false: The child consent is revoked or not granted.

🟠400Bad Request

🟠429Too Many Requests

🔴500Server Error