CoreSecurityAuth
This API is partially documented or under construction.
Overview​
Core Security Auth API for SmartBlock/OTP/TrustDevice/DisableAdmin.
Covers SYNO.Core.SmartBlock., OTP., TrustDevice, DisableAdmin, SYNO.API.Auth.Key, Auth.Type, Auth.RedirectURI, SYNO.Auth.RescueEmail.
Methods​
smartblock_get​
Get SmartBlock settings.
Internal API​
SYNO.Core.SmartBlock
Returns​
dict[str, object] or str
SmartBlock settings.
smartblock_set​
Set SmartBlock settings.
Internal API​
SYNO.Core.SmartBlock
Parameters​
_kwargs_** object
Key-value pairs of SmartBlock settings to update.
Returns​
dict[str, object] or str
Result of the set operation.
smartblock_device_get​
Get SmartBlock blocked devices.
Internal API​
SYNO.Core.SmartBlock.Device
Returns​
dict[str, object] or str
Blocked device information.
smartblock_device_list​
List SmartBlock blocked devices.
Internal API​
SYNO.Core.SmartBlock.Device
Returns​
dict[str, object] or str
List of blocked devices.
smartblock_device_delete​
Remove devices from the SmartBlock blocked list.
Internal API​
SYNO.Core.SmartBlock.Device
Parameters​
devices list[str]
List of device identifiers to remove.
Returns​
dict[str, object] or str
Result of the delete operation.
smartblock_trusted_get​
Get SmartBlock trusted list.
Internal API​
SYNO.Core.SmartBlock.Trusted
Returns​
dict[str, object] or str
Trusted list entries.
smartblock_trusted_list​
List SmartBlock trusted entries.
Internal API​
SYNO.Core.SmartBlock.Trusted
Returns​
dict[str, object] or str
List of trusted entries.
smartblock_trusted_set​
Set SmartBlock trusted list entries.
Internal API​
SYNO.Core.SmartBlock.Trusted
Parameters​
entries list[dict[str, object]]
List of trusted entry objects to set.
Returns​
dict[str, object] or str
Result of the set operation.
smartblock_trusted_delete​
Delete entries from the SmartBlock trusted list.
Internal API​
SYNO.Core.SmartBlock.Trusted
Parameters​
entries list[str]
List of entry identifiers to remove.
Returns​
dict[str, object] or str
Result of the delete operation.
smartblock_untrusted_get​
Get SmartBlock untrusted list.
Internal API​
SYNO.Core.SmartBlock.Untrusted
Returns​
dict[str, object] or str
Untrusted list entries.
smartblock_untrusted_list​
List SmartBlock untrusted entries.
Internal API​
SYNO.Core.SmartBlock.Untrusted
Returns​
dict[str, object] or str
List of untrusted entries.
smartblock_untrusted_set​
Set SmartBlock untrusted list entries.
Internal API​
SYNO.Core.SmartBlock.Untrusted
Parameters​
entries list[dict[str, object]]
List of untrusted entry objects to set.
Returns​
dict[str, object] or str
Result of the set operation.
smartblock_untrusted_delete​
Delete entries from the SmartBlock untrusted list.
Internal API​
SYNO.Core.SmartBlock.Untrusted
Parameters​
entries list[str]
List of entry identifiers to remove.
Returns​
dict[str, object] or str
Result of the delete operation.
smartblock_user_get​
Get SmartBlock user-level block settings.
Internal API​
SYNO.Core.SmartBlock.User
Returns​
dict[str, object] or str
User-level block settings.
smartblock_user_list​
List SmartBlock user-level blocks.
Internal API​
SYNO.Core.SmartBlock.User
Returns​
dict[str, object] or str
List of user-level blocks.
smartblock_user_set​
Set SmartBlock user-level blocks.
Internal API​
SYNO.Core.SmartBlock.User
Parameters​
users list[dict[str, object]]
List of user block objects to set.
Returns​
dict[str, object] or str
Result of the set operation.
smartblock_user_delete​
Delete SmartBlock user-level blocks.
Internal API​
SYNO.Core.SmartBlock.User
Parameters​
users list[str]
List of user identifiers to unblock.
Returns​
dict[str, object] or str
Result of the delete operation.
otp_get​
Get OTP settings.
Internal API​
SYNO.Core.OTP
Returns​
dict[str, object] or str
OTP settings.
otp_set​
Set OTP settings.
Internal API​
SYNO.Core.OTP
Parameters​
_kwargs_** object
Key-value pairs of OTP settings to update.
Returns​
dict[str, object] or str
Result of the set operation.
otp_admin_get​
Get OTP admin settings.
Internal API​
SYNO.Core.OTP.Admin
Returns​
dict[str, object] or str
OTP admin settings.
otp_admin_set​
Set OTP admin settings.
Internal API​
SYNO.Core.OTP.Admin
Parameters​
_kwargs_** object
Key-value pairs of OTP admin settings to update.
Returns​
dict[str, object] or str
Result of the set operation.
otp_enforce_policy_get​
Get OTP enforcement policy.
Internal API​
SYNO.Core.OTP.EnforcePolicy
Returns​
dict[str, object] or str
OTP enforcement policy settings.
otp_enforce_policy_set​
Set OTP enforcement policy.
Internal API​
SYNO.Core.OTP.EnforcePolicy
Parameters​
_kwargs_** object
Key-value pairs of enforcement policy settings to update.
Returns​
dict[str, object] or str
Result of the set operation.
otp_ex_get​
Get extended OTP settings.
Internal API​
SYNO.Core.OTP.Ex
Returns​
dict[str, object] or str
Extended OTP settings.
otp_ex_set​
Set extended OTP settings.
Internal API​
SYNO.Core.OTP.Ex
Parameters​
_kwargs_** object
Key-value pairs of extended OTP settings to update.
Returns​
dict[str, object] or str
Result of the set operation.
otp_mail_get​
Get OTP mail settings.
Internal API​
SYNO.Core.OTP.Mail
Returns​
dict[str, object] or str
OTP mail settings.
otp_mail_set​
Set OTP mail settings.
Internal API​
SYNO.Core.OTP.Mail
Parameters​
_kwargs_** object
Key-value pairs of OTP mail settings to update.
Returns​
dict[str, object] or str
Result of the set operation.
trust_device_get​
Get trusted device settings.
Internal API​
SYNO.Core.TrustDevice
Returns​
dict[str, object] or str
Trusted device settings.
trust_device_list​
List trusted devices.
Internal API​
SYNO.Core.TrustDevice
Returns​
dict[str, object] or str
List of trusted devices.
trust_device_delete​
Remove devices from the trusted list.
Internal API​
SYNO.Core.TrustDevice
Parameters​
devices list[str]
List of device identifiers to remove.
Returns​
dict[str, object] or str
Result of the delete operation.
disable_admin_get​
Get disabled admin account settings.
Internal API​
SYNO.Core.DisableAdmin
Returns​
dict[str, object] or str
Disabled admin account settings.
disable_admin_set​
Set disabled admin account settings.
Internal API​
SYNO.Core.DisableAdmin
Parameters​
_kwargs_** object
Key-value pairs of admin disable settings to update.
Returns​
dict[str, object] or str
Result of the set operation.
rescue_email_get​
Get rescue email configuration.
Internal API​
SYNO.Auth.RescueEmail
Returns​
dict[str, object] or str
Rescue email settings (verified: bool, email address if set).
rescue_email_set​
Set rescue email address.
Internal API​
SYNO.Auth.RescueEmail
Parameters​
email str
Email address to use for account rescue.
Returns​
dict[str, object] or str
Result of the set operation.
rescue_email_verify​
Verify rescue email with confirmation code.
Internal API​
SYNO.Auth.RescueEmail
Parameters​
code str
Verification code sent to the rescue email.
Returns​
dict[str, object] or str
Result of the verify operation.
auth_key_get​
Get the DSM authentication key.
Internal API​
SYNO.API.Auth.Key
Returns​
dict[str, object] or str
Authentication key data (auth_key: str).
auth_key_grant​
Request a new authentication key grant.
Internal API​
SYNO.API.Auth.Key
Returns​
dict[str, object] or str
Grant response from the DSM auth key service.
auth_key_code_get​
Get the authentication key code (used in login flow).
Internal API​
SYNO.API.Auth.Key.Code
Returns​
dict[str, object] or str
Key code data from SYNO.API.Auth.Key.Code.
auth_type_get​
Get available authentication types on this DSM.
Internal API​
SYNO.API.Auth.Type
Returns​
dict[str, object] or str
List of auth types (e.g. [{"type": "passwd"}]).
auth_redirect_uri_check​
Check if OAuth redirect URI is configured and available.
Internal API​
SYNO.API.Auth.RedirectURI
Returns​
dict[str, object] or str
Redirect URI availability (available: bool, code: int).
auth_redirect_uri_run​
Execute the OAuth redirect URI workflow.
Internal API​
SYNO.API.Auth.RedirectURI
Returns​
dict[str, object] or str
Redirect URI execution result.