CoreDirectory
This API is partially documented or under construction.
Overview​
Core Directory API implementation for Synology NAS.
Covers SYNO.Core.Directory.* endpoints including Azure SSO, domain configuration, LDAP, OIDC, and SAML-based SSO settings.
Methods​
directory_azure_sso_get​
Get Azure SSO directory configuration.
Internal API​
SYNO.Core.Directory.Azure.SSO
Returns​
dict[str, object] or str
Azure SSO configuration.
directory_azure_sso_set​
Set Azure SSO directory configuration.
Internal API​
SYNO.Core.Directory.Azure.SSO
Parameters​
enable bool
Enable or disable Azure SSO.
tenant_id str
Azure AD tenant ID.
client_id str
Azure AD client/application ID.
Returns​
dict[str, object] or str
API response.
directory_domain_conf_get​
Get domain directory configuration.
Internal API​
SYNO.Core.Directory.Domain.Conf
Returns​
dict[str, object] or str
Domain configuration.
directory_domain_conf_set​
Set domain directory configuration.
Internal API​
SYNO.Core.Directory.Domain.Conf
Parameters​
conf str
JSON-encoded domain configuration.
Returns​
dict[str, object] or str
API response.
directory_domain_trust_get​
Get domain trust relationship information.
Internal API​
SYNO.Core.Directory.Domain.Trust
Returns​
dict[str, object] or str
Domain trust relationships.
directory_domain_trust_set​
Set domain trust relationship configuration.
Internal API​
SYNO.Core.Directory.Domain.Trust
Parameters​
trust str
JSON-encoded domain trust configuration.
Returns​
dict[str, object] or str
API response.
directory_ldap_base_dn_get​
Get LDAP base DN configuration.
Internal API​
SYNO.Core.Directory.LDAP.BaseDN
Returns​
dict[str, object] or str
LDAP base DN configuration.
directory_ldap_base_dn_set​
Set LDAP base DN configuration.
Internal API​
SYNO.Core.Directory.LDAP.BaseDN
Parameters​
base_dn str
LDAP base distinguished name.
Returns​
dict[str, object] or str
API response.
directory_ldap_login_notify_get​
Get LDAP login notification settings.
Internal API​
SYNO.Core.Directory.LDAP.Login.Notify
Returns​
dict[str, object] or str
LDAP login notification settings.
directory_ldap_login_notify_set​
Set LDAP login notification settings.
Internal API​
SYNO.Core.Directory.LDAP.Login.Notify
Parameters​
enable bool
Enable or disable LDAP login notifications.
Returns​
dict[str, object] or str
API response.
directory_ldap_profile_get​
Get LDAP profile configuration.
Internal API​
SYNO.Core.Directory.LDAP.Profile
Returns​
dict[str, object] or str
LDAP profile configuration.
directory_ldap_profile_set​
Set LDAP profile configuration.
Internal API​
SYNO.Core.Directory.LDAP.Profile
Parameters​
profile str
JSON-encoded LDAP profile configuration.
Returns​
dict[str, object] or str
API response.
directory_ldap_refresh_get​
Get LDAP refresh status.
Internal API​
SYNO.Core.Directory.LDAP.Refresh
Returns​
dict[str, object] or str
LDAP refresh status.
directory_ldap_refresh_set​
Trigger an LDAP refresh.
Internal API​
SYNO.Core.Directory.LDAP.Refresh
Returns​
dict[str, object] or str
API response.
directory_ldap_user_get​
Get LDAP user configuration.
Internal API​
SYNO.Core.Directory.LDAP.User
Returns​
dict[str, object] or str
LDAP user configuration.
directory_ldap_user_set​
Set LDAP user configuration.
Internal API​
SYNO.Core.Directory.LDAP.User
Parameters​
user str
JSON-encoded LDAP user configuration.
Returns​
dict[str, object] or str
API response.
directory_oidc_sso_get​
Get OIDC SSO directory configuration.
Internal API​
SYNO.Core.Directory.OIDC.SSO
Returns​
dict[str, object] or str
OIDC SSO configuration.
directory_oidc_sso_set​
Set OIDC SSO directory configuration.
Internal API​
SYNO.Core.Directory.OIDC.SSO
Parameters​
enable bool
Enable or disable OIDC SSO.
issuer str
OIDC issuer URL.
client_id str
OIDC client ID.
Returns​
dict[str, object] or str
API response.
directory_sso_cas_get​
Get SSO CAS configuration.
Internal API​
SYNO.Core.Directory.SSO.CAS
Returns​
dict[str, object] or str
SSO CAS configuration.
directory_sso_cas_set​
Set SSO CAS configuration.
Internal API​
SYNO.Core.Directory.SSO.CAS
Parameters​
settings str
JSON-encoded SSO CAS settings.
Returns​
dict[str, object] or str
API response.
directory_sso_profile_get​
Get SSO profile configuration.
Internal API​
SYNO.Core.Directory.SSO.Profile
Returns​
dict[str, object] or str
SSO profile configuration.
directory_sso_profile_set​
Set SSO profile configuration.
Internal API​
SYNO.Core.Directory.SSO.Profile
Parameters​
profile str
JSON-encoded SSO profile configuration.
Returns​
dict[str, object] or str
API response.
directory_sso_saml_get​
Get SSO SAML configuration.
Internal API​
SYNO.Core.Directory.SSO.SAML
Returns​
dict[str, object] or str
SSO SAML configuration.
directory_sso_saml_set​
Set SSO SAML configuration.
Internal API​
SYNO.Core.Directory.SSO.SAML
Parameters​
settings str
JSON-encoded SSO SAML settings.
Returns​
dict[str, object] or str
API response.
directory_sso_saml_metadata_get​
Get SSO SAML metadata.
Internal API​
SYNO.Core.Directory.SSO.SAML.Metadata
Returns​
dict[str, object] or str
SSO SAML metadata.
directory_sso_saml_metadata_set​
Set SSO SAML metadata.
Internal API​
SYNO.Core.Directory.SSO.SAML.Metadata
Parameters​
metadata str
SAML metadata XML or JSON-encoded configuration.
Returns​
dict[str, object] or str
API response.
directory_sso_saml_status_get​
Get SSO SAML status.
Internal API​
SYNO.Core.Directory.SSO.SAML.Status
Returns​
dict[str, object] or str
SSO SAML status.
directory_sso_saml_status_set​
Set SSO SAML status.
Internal API​
SYNO.Core.Directory.SSO.SAML.Status
Parameters​
enable bool
Enable or disable SSO SAML.
Returns​
dict[str, object] or str
API response.
directory_sso_setting_get​
Get SSO general settings.
Internal API​
SYNO.Core.Directory.SSO.Setting
Returns​
dict[str, object] or str
SSO general settings.
directory_sso_setting_set​
Set SSO general settings.
Internal API​
SYNO.Core.Directory.SSO.Setting
Parameters​
settings str
JSON-encoded SSO general settings.
Returns​
dict[str, object] or str
API response.
directory_sso_status_get​
Get SSO status.
Internal API​
SYNO.Core.Directory.SSO.Status
Returns​
dict[str, object] or str
SSO status.
directory_sso_status_set​
Set SSO status.
Internal API​
SYNO.Core.Directory.SSO.Status
Parameters​
enable bool
Enable or disable SSO.
Returns​
dict[str, object] or str
API response.
directory_sso_utils_get​
Get SSO utility information.
Internal API​
SYNO.Core.Directory.SSO.utils
Returns​
dict[str, object] or str
SSO utility information.
directory_sso_utils_set​
Set SSO utility configuration.
Internal API​
SYNO.Core.Directory.SSO.utils
Parameters​
data str
JSON-encoded SSO utility data.
Returns​
dict[str, object] or str
API response.
directory_websphere_sso_get​
Get WebSphere SSO directory configuration.
Internal API​
SYNO.Core.Directory.WebSphere.SSO
Returns​
dict[str, object] or str
WebSphere SSO configuration.
directory_websphere_sso_set​
Set WebSphere SSO directory configuration.
Internal API​
SYNO.Core.Directory.WebSphere.SSO
Parameters​
enable bool
Enable or disable WebSphere SSO.
settings str
JSON-encoded WebSphere SSO settings.
Returns​
dict[str, object] or str
API response.