Locale fields and APIs

Information about User's locale preferences and how they can be accessed.

Fields

Locale values are stored in database as Strings, in format produced by Java's Locale.toString() method.

Field	Stored in	Purpose
preferredLocale	User	User's preferred locale, if exists. If user has selected a locale or user's preference has otherwise been detected, it is stored here.
userMetadata.firstLoginLocale	User	Locale that was used during User's first login.
preferredLocale	Group Policy	Users without a preferred locale may use a preferred locale from an applicable Group Policy instead.

APIs

OIDC Claims

• The standard locale claim returns user's preferred locale, or a locale from a group policy.

Management API

• /api/rest/v1/user/{userId} - The locale field returns user's preferred locale, or a locale from a group policy. Updating the value will replace User's preferredLocale value.

• /api/rest/v1/user/{userId}/profile - The locale field returns user's preferred locale, or a locale from a group policy. Updating the value will replace User's preferredLocale value.