A user agreement consent resource is a record of a user consenting to a terms of service agreement for a specific language and revision. Only the latest consent record is available through a GETrequest. This service provides operations to read and update user consent resources.

You need the Environment Admin role to perform operations on user consent resources.

Agreement consent state data model

Parameter Description
agreement A relationship that specifies the agreement resource for this agreement consent. This is a required property.
agreement.id A string that specifies the ID of the agreement resource for this agreement consent. This is a required property.
language A relationship that specifies the language resource associated with this agreement consent. This is a required property.
language.id A string that specifies the language resource ID associated with this agreement consent. If the status is ACCEPTED, then this is the language associated with the consent. For any other status value, this represents the language to which the user must consent. This is a required property.
lastConsent.at A date that specifies the date and time at which the user consented to the agreement.
lastConsent.expiresAt A date that specifies the date and time at which the user consent to the agreement expires.
lastConsent.language A relationship that specifies the language resource associated with the user’s last agreement consent.
lastConsent.language.id A string that specifies the language resource ID associated with the user’s last agreement consent.
lastConsent.revision A relationship that specifies the revision resource associated with the user’s last agreement consent.
lastConsent.revision.id A string that specifies the revision resource ID associated with the user’s last agreement consent.
revision A relationship that specifies the revision resource associated with this agreement consent. This is a required property.
revision.id A string that specifies the revision resource ID associated with this agreement consent. This is a required property.
status A string that specifies whether the consent is valid or not, depending on the agreement, language, and revision configuration. Options are PENDING, ACCEPTED, REVOKED, EXPIRED, and AGREEMENT_DISABLED. This property value is computed dynamically when the resource is returned.
user A relationship that specifies the user associated with this agreement consent. This is a required property.
user.id A string that specifies the ID of the user associated with this agreement consent. This is a required property.

User consent event model

Parameter Description
consentedAt A date that specifies the date and time at which the user consented to the agreement.
agreement A relationship that specifies the agreement resource for this agreement consent. This is a required property.
agreement.id A string that specifies the ID of the agreement resource for this agreement consent. This is a required property.
language A relationship that specifies the language resource associated with this agreement consent. This is a required property.
language.id A string that specifies the language resource ID associated with this agreement consent. This is a required property.
revision A relationship that specifies the revision resource associated with this agreement consent. This is a required property.
revision.id A string that specifies the revision resource ID associated with this agreement consent. This is a required property.
status A string that specifies whether the consent is valid or not, depending on the agreement, language, and revision configuration. Options are ACTIVE, INVALID, and EXPIRED. This property value is computed dynamically when the resource is returned.
user A relationship that specifies the user associated with this agreement consent. This is a required property.
user.id A string that specifies the ID of the user associated with this agreement consent. This is a required property.

Response codes

Code Message
200 Successful operation.
400 The request could not be completed.
401 You do not have access to this resource.
404 The requested resource was not found.