Return
-
Title
API options to manage preferences on behalf of other users -
Description
A new API-only feature has been added to allow administrators to manage per user settings throughout the lifecycle of their account.Examples of settings that can be managed are:Show Access Request AvailabilityShow Session Launch ButtonShow Web Launch ButtonUse Previous VersionShow Version Banner -
Resolution
Safeguard-PS commandlets below can be utilized to manage per user settings:
Get-Safeguarduserpreference -UserToGet {Username} -PreferenceName {PreferenceName}
Set-Safeguarduserpreference -UserToGet {Username} -PreferenceName {PreferenceName} -PreferenceValue {true or false}
Remove-Safeguarduserpreference -UserToGet {Username} -PreferenceName {PreferenceName}
PreferenceName PreferenceValue Toggle in Web UI settings.myrequests.calculate_in_use true or false Show Access Request Availability settings.myrequests.show_launch_button true or false Show Session Launch Button settings.myrequests.show_web_launch_button true or false Show Web Launch Button settings.myrequests.usePreviousVersion true or false Use Previous Version settings.myrequests.showVersionBanner true or false Show Version Banner Example:
Set-Safeguarduserpreference -UserToGet User123 -PreferenceName settings.myrequests.show_launch_button -PreferenceValue true
or
Set-Safeguarduserpreference User123 settings.myrequests.show_launch_button true
Swagger has the following options in Core API:
GET /v4/Users/{id}/Preferences
- Gets all preferences for the given userGET /v4/Users/{id}/Preferences/{name}
- Gets a specific preference for the given userPUT /v4/Users/{id}/Preferences/{name}
- Updates or create a preference for the given userDELETE /v4/Users/{id}/Preferences/{name}
- Removes a preference for the given user