This API has been deprecated and will be removed in a future release. Use PATCH operation to update user preferences
put
/apiplatform/administration/v1/preferences/user
Updates the preferences of the user accessing this resource. All fields are optional; send only the field(s) you want to update in the request.
All authenticated users can access this resource.
Request
Supported Media Types
- application/json
Nested Schema : AccessibilityUserPreferences
Type:
Show Source
object
-
highContrast(optional):
boolean
Default Value:
false
Indicates if high contrast mode is enabled in the in the Management Portal. Value isfalse
if high contrast mode is disabled andtrue
if enabled. -
largeFonts(optional):
boolean
Default Value:
false
Indicates if large fonts are displayed in the Management Portal. Value isfalse
if default font sizes are displayed andtrue
if large fonts are displayed. -
screenReader(optional):
boolean
Default Value:
false
Indicates if screen reader mode is enabled in the Management Portal. Value isfalse
if screen reader mode is disabled andtrue
if enabled.
Nested Schema : TimeZoneUserPreferences
Type:
Show Source
object
-
timeZoneId(optional):
string
The ID of the current platform time zone. This must be a valid Java time zone.
-
usePlatformTimeZone(optional):
boolean
Default Value:
true
Indicates if all times and dates are displayed using the platform time zone, regardless of the user's time zone settings. If disabled, users' browser time zone settings are used to display times and dates. Value is true if times and dates are displayed using the platform time zone and false if times and dates are displayed using each user's time zone.
Response
Supported Media Types
- application/json
204 Response
Preferences successfully updated.
403 Response
Forbidden.
Root Schema : Error
Type:
Show Source
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
500 Response
Unexpected error.
Root Schema : Error
Type:
Show Source
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type