HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Create or update a consent record.

post
https://{tenanturl}/v1.0/privacy/consents

Use this API to create or update a consent record at runtime.

Entitlements required:

  • createPrivacyConsent (Create privacy consent records)

Body Params

Consent information

string
length ≀ 256

The unique identifier of the user. It is the Cloud Directory user ID if isExternalSubject is false.

string
required
length ≀ 64

The unique identifier of the purpose that the consent had been provided for.

boolean

Indicates if the subjectId is a Cloud Directory user.

boolean

Indicates if the consent applies across all applications.

string
length ≀ 1024

The unique identifier of an attribute that the consent had been provided for. (required when data value provided)

string
length ≀ 2048

The value corresponding to the attributeId that the consent had been provided for.

string
length ≀ 64

The unique identifier of the AccessType that the consent had been provided for. It is either for the purpose or the attribute.

string
length ≀ 256

The IP address where the consent was provided.

integer
required

The type of consent that the user provided:

  • 1 - Consent allow,
  • 2 - Consent deny,
  • 3 - Opt in,
  • 4 - Opt out,
  • 5 - Transparency
integer

Consent start time in epoch format. If not supplied a default value is set to the current timestamp

integer

Consent end time in epoch format. If not supplied a default value is set to the startTime + the purpose’s defaultConsentDuration value or null

customAttributes
array of objects
customAttributes
Responses

Updated over 2 years ago

Language
URL
Response 
 Choose an example:
application/json
Updated over 2 years ago