PingOne Platform APIs

Agreement Languages Resources

Agreement languages define the configuration for the locale and for the configuration that applies to all revision resources associated with the language.

Agreement languages are defined by either the language code (for example, en) or the combination of language code and country code (for example, en-gb). For identifying languages, the API follows the tags for identifying languages described in RFC_4646. For selecting a language code to use in an agreement, the API follows the matching of language tags described in RFC_4647.

The end user’s language selection for the consent agreement is determined by these attributes in the following priority: (1) the user’s preferred locale, (2) the browser locale, or (3) the default language for the environment.

The agreement languages service implements functions to create, read, update, and delete agreement language resources.

You need the Environment Admin role to perform operations on agreement languages resources.

Agreement languages data model

Property Type Required? Mutable? Description

agreement

String

Required

Read-Only

A UUID that specifies the agreement resource associated with this language resource.

currentRevision

String

Optional

Read-Only

A UUID that specifies the current revision associated with this language resource. The current revision is the one shown to users for new consents in the language.

displayName

String

Required

Mutable

Used as the title of the agreement for the language presented to the user.

enabled

Date

Required/Optional

Mutable

Maps directly with a language being enabled or displayed for the environment within the platform. When running Create Language, enabled value will be false whether or not this property is included. If the language is disabled at the environment level, this property if always false.

id

String

Required

Read-Only

UUID that specifies the language ID.

locale

String

Required

Mutable

The tag for identifying the language resource associated with this agreement consent (for example, en-US). For more information about language tags, refer to Tags for Identifying Languages.

userExperience.acceptCheckboxText

String

Optional

Mutable

The text next to the "accept" checkbox in the end user interface. Accepted character are unicode letters, combining marks, numeric characters, whitespace, and punctuation characters (regex: ^[\p{L}\p{M}\p{N}\p{Zs}\p{P}]+$).

userExperience.continueButtonText

String

Optional

Mutable

The text of the "continue" button in the end user interface. Accepted character are unicode letters, combining marks, numeric characters, whitespace, and punctuation characters (regex: ^[\p{L}\p{M}\p{N}\p{Zs}\p{P}]+$).

userExperience.declineButtonText

String

Optional

Mutable

The text of the "decline" button in the end user interface. Accepted character are unicode letters, combining marks, numeric characters, whitespace, and punctuation characters (regex: ^[\p{L}\p{M}\p{N}\p{Zs}\p{P}]+$).

Response codes

Code Message

200

Successful operation.

201

Successfully created.

204

Successfully removed. No content.

400

The request could not be completed.

401

You do not have access to this resource.

403

You do not have permissions or are not licensed to make this request.

404

The requested resource was not found.

Use case