When a user creates an account or accepts a new version of terms or policies, an identifier for the accepted legal agreement(s) is written to the user record.
The identifier should include an appropriate name for the legal text and a version. To serve as examples, the default identifiers (pictured above) are:
These identifier values are set in the Identity Cloud Console. By default they are in Global Settings, and the settings are called:
The default identifier values can be customized to reflect your actual legal agreements and your naming and versioning conventions:
legal_acceptance_id_2settings in the Value column
Hosted Login has the ability to prompt the user to accept again when you formally update your legal text.
To enable this screen, you must add or update the following setting in the Identity Cloud Console:
By default, this setting is in Global Settings.
The value of this setting is a JSON-formatted array of legal acceptance identifiers. If any value in the array does NOT exist in the user record, this indicates the user has not yet accepted the current terms, and they will be prompted to do so the next time they log in.
The default value for this setting is:
The values in this array should always match the
legal_acceptance_id_2 setting values.
When you make a meaningful change to your legal terms such that end users should be prompted to accept the updated version, here’s what you should do:
legal_acceptance_id_2setting(s) to indicate the new version of legal terms
authorization.rules.legal_acceptedarray to match the updated
|Setting Name||Previous Value||New Value|
By default, the legal acceptance settings reside in Global Settings in the Identity Cloud Console. This means they apply to all clients in the application.
If you have multiple digital properties (websites, mobile apps), this means that when a user accepts the legal terms from one digital property, this satisfies their acceptance across all digital properties associated with the same Console application.
If you have multiple digital properties and you would prefer for users to accept legal terms for each property separately, you can do this by adding the same settings to each pertinent Property (client) in Console:
authorization.rules.legal_acceptedsettings in the Property Value column
Global values provide a default that will be used when there is no Property value. If a Property value is present, it will be used instead of the Global value.
If a user accepts property-specific terms and policies from two digital properties, all accepted agreements will be written to the
legalAcceptances plural in the user record.