PayloadKit

SAP Privileges

corp.sap.privileges

Use this section to define settings for the SAP Privileges app

macOS
macOS 10.12+

Configuration Keys (29)

Showing 29 of 29 keys

KeyTypeDescriptionDefaultRange

Expiration Interval

integerSet a fixed time interval after which administrator privileges expire and revert to standard user rightsDefault: —Range: 0 – —

Expiration Interval Max

integerSet a maximum time interval for a user to request administrative privilegesDefault: —Range: 0 – —

Allow Privilege Renewal

booleanSpecifies whether expiring administrator privileges can be renewed. When set to true, the user receives a notification one minute before administrator privileges expire and can renew them.Default: falseRange: —

Renewal Follows Auth Setting

booleanWhen set to true, renewing privileges requires the same kind of authentication as initially requesting administrator privileges (for example, Touch ID or password).Default: falseRange: —

Allow CLI Biometric Authenication

booleanSpecifies whether to allow biometric authentication in the PrivilegesCLI to obtain administrator privilegesDefault: falseRange: —

Post Change Executable Path

stringIf set, the PrivilegesAgent executes the given application or script and provides the current user's user name ($1) and its privileges (admin or user, $2) as launch argumentsDefault: —Range: —

Post Change Action On Grant Only

booleanIf set to true, the application or script, specified in PostChangeExecutablePath, will only be executed if administrator privileges are granted to a user, but not the privileges are revoked.Default: falseRange: —

Pass Reason To Executable

booleanSpecifies whether the reason that the user entered when requesting administrator privileges should be passed to the executable configured with the PostChangeExecutablePath key. The reason is passed as the third launch argument ($3).Default: falseRange: —

Revoke Privileges at Login

booleanIf set to true, the user's administrator privileges are revoked at loginDefault: falseRange: —

Revoke At Login Excluded Users

arrayIf RevokePrivilegesAtLogin is set to true, the specified users are excluded from privilege revocation at login. Provide an array of strings containing the short names of the users.Default: —Range: —

User Short Name

stringThe short name of a user to exclude from privilege revocation at login.Default: —Range: —

Hide Other Windows

booleanBy default, Privileges hides open windows to show the desktop and ensure that only the Privileges window is visible on the screenDefault: falseRange: —

Enforce Privileges

stringEnforces certain privileges. Whenever Privileges.app or the PrivilegesCLI command line tool are launched, the corresponding privileges are set.Default: "admin"Range: Admin (admin), User (user), None (none)

Dock Toggle Timeout

integerSets a fixed timeout for the Dock tile's Toggle Privileges command. After this time, the admin rights are removed and set back to standard user rights. A value of 0 disables the timeout and allows the user to permanently toggle privileges.Default: —Range: —

Dock Toggle Max Timeout

integerSet a maximum timeout for the Dock tile's Toggle Privileges command. This generally works the same way as the DockToggleTimeout but allows the user to choose every timeout value up to the one specified. If set to 20 min. for example, the user may decide to set it to a value below 20 instead of being forced to use the 20 minute timeout.Default: —Range: —

Limit to Group

stringLimits the usage of Privileges.app to the given user group.Default: —Range: —

Limit to User

stringLimits the usage of Privileges.app to the given user account.Default: —Range: —

Reason Required

booleanIf ReasonRequired is set to true, the user must provide a reason for needing admin rights.

Depends on: ReasonMinLength

Default: —Range: —

Reason Maximum Length

integerSpecifies the maximum number of characters the user can enter as the reason for becoming an admin

Depends on: ReasonRequired

Default: 250Range: 1 – 250

Reason Minimum Length

integerSpecifies the minimum number of characters the user has to enter as the reason for becoming an admin.

Depends on: ReasonRequired

Default: 10Range: 1 – 100

Reason Preset List

arrayIf ReasonRequired is set to true, this key allows to pre-define a list of possible reasons (for becoming an admin) the user can choose from

Depends on: ReasonRequired

Default: —Range: —
dict
dict—Default: —Range: —
destring

Localization

stringLocalization (de)Default: —Range: —
enstring

Localization

stringLocalization (en)Default: —Range: —
esstring

Localization

stringLocalization (es)Default: —Range: —
itstring

Localization

stringLocalization (it)Default: —Range: —
defaultstring

Unlocalized

stringUnlocalizationDefault: —Range: —

Reason Checking

booleanIf set to true, the text the user enters for a reason is roughly parsed for valid words

Depends on: ReasonRequired

Default: falseRange: —

Hide Settings Button

booleanIf set to true, the Settings button is no longer displayed in the appDefault: falseRange: —

Hide Help Button

booleanIf set to true, the Help (?) button is no longer displayed in the app.Default: falseRange: —

Help Button Custom URL

stringIf specified, this URL is opened instead of the Privileges GitHub URL when the user clicks the help button. Must use http:// or https://.Default: —Range: —

Hide Settings From Dock Menu

booleanIf set to true, the Settings menu item is no longer displayed in the Dock tile's menuDefault: falseRange: —

Hide Settings From Menu Bar

booleanIf set to true, the Settings menu item is no longer displayed in the status item's menu.Default: falseRange: —

Show in Menu Bar

booleanIf set to true, a Privileges status item is displayed in the Menu Bar.Default: falseRange: —

Require User Authentication

booleanRequires authentication before using Privileges.app. If set to true, the logged-in user is prompted to authenticate via Touch ID or by entering their account password.Default: —Range: —

Remote Logging Settings

dictRemote logging settingsDefault: —Range: —

Server Type

string—Default: —Range: Syslog (syslog), Webhook (webhook)

Server Address

stringThis will usually be an IP address, unless the syslog server is set up to respond using a DNS hostname.Default: —Range: —
EnableTCPboolean

Enable TCP

booleanIf set to true, the log messages are sent via TCP instead of UDP. By default, messages are sent via UDP.Default: falseRange: —

Webhook Custom Data

dictA dictionary of custom data (such as machine name or serial number) that is added to the webhook's JSON payload as the custom_data field.Default: —Range: —

Syslog Options

dictSyslog-specific optionsDefault: —Range: —

Log Facility

integerConfigure syslog facility.

Depends on: RemoteLogging.ServerType ∈ [syslog]

Default: 4Range: Kernel (0), User-level (1), Mail System (2), System Daemons (3), Security / Authorization (4), Internal Syslogd (5), Line Printer (6), Network News (7), UUCP (8), Clock Daemon (9), Security / Authorization (10), FTP (11), NTP (12), Log Audit (13), Log Alert (14), Clock Daemon (note 2) (15), Local Use 0 (local0) (16), Local Use 1 (local1) (17), Local Use 2 (local2) (18), Local Use 3 (local3) (19), Local Use 4 (local4) (20), Local Use 5 (local5) (21), Local Use 6 (local6) (22), Local Use 7 (local7) (23)

Log Severity

integerConfigure syslog severity.Default: 6Range: Emergency (0), Alert (1), Critical (2), Error (3), Warning (4), Notice (5), Informational (6), Debug (7)
ServerPortinteger

Server Port

integerThe port of the logging server.Default: 514Range: —

Maximum Message Size

integerSpecify the maximum size of the syslog message (header + event message). If the syslog message is larger than the specified maximum, the message will be truncated at the end.Default: 480Range: 480 – —