PingOne Platform APIs

Languages

There are 239 language codes in the ISO standard language code table. This service defaults to supporting a maximum of 17 languages resources. However, you can add custom languages (requires Environment Admin permissions). Refer to Create Language.

The languages service supports the following input and output data model properties for languages resources.

Languages input data model

Property Type Required? Mutable? Description

default

Boolean

Required

Mutable

Specifies whether this language is the default for the environment. This property value must be set to false when creating a language resource. It can be set to true only after the language is enabled and after the localization of an agreement resource is complete when agreements are used for the environment.

enabled

Boolean

Required

Mutable

Specifies whether this language is enabled for the environment. This property value must be set to false when creating a language.

environment.id

String

Required

Immutable

The environment resource’s unique identifier associated with the resource.

id

String

Required

Immutable

The resource’s unique identifier.

locale

String

Required

Mutable

An ISO standard language code. For more information about standard language codes, refer to ISO Language Code Table.

name

String

Optional

Mutable

The language name. If omitted, the ISO standard name is used.

Languages output data model

Property Type Required? Mutable? Description

createdAt

Date

N/A

Read-only

The time the language resource was created.

customerAdded

Boolean

Optional

Mutable

Specifies whether this language was added by a customer administrator.

default

Boolean

Required

Mutable

Specifies whether this language is the default for the environment. This property value must be set to false when creating a language resource. It can be set to true only after the language is enabled and after the localization of an agreement resource is complete when agreements are used for the environment.

enabled

Boolean

Required

Mutable

Specifies whether this language is enabled for the environment. This property value must be set to false when creating a language.

environment.id

String

Required

Immutable

The environment resource’s unique identifier associated with the resource.

id

String

Required

Immutable

The resource’s unique identifier.

locale

String

Required

Mutable

An ISO standard language code. For more information about standard language codes, refer to ISO Language Code Table.

name

String

Optional

Mutable

The language name. If omitted, the ISO standard name is used.

updatedAt

Date

N/A

Read-only

The time the language resource was last updated.

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.