multitenancy/smb/settings/{id}

Endpoint

/v1/multitenancy/smb/settings/{id}

GET

Retrieve current tenant-specific SMB configuration.

Parameters

Name	Description	Required
`id`	The tenant ID of the SMB settings.	Yes

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_smb_settings",
  "type": "object",
  "properties": {
    "session_encryption": {
      "type": "string",
      "enum": [
        "NONE",
        "PREFERRED",
        "REQUIRED"
      ],
      "description": "Session-level encryption setting.:\n * `NONE` - SMB_SESSION_ENCRYPTION_SETTING_NONE,\n * `PREFERRED` - SMB_SESSION_ENCRYPTION_SETTING_PREFERRED,\n * `REQUIRED` - SMB_SESSION_ENCRYPTION_SETTING_REQUIRED"
    },
    "supported_dialects": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "SMB2_DIALECT_2_002",
          "SMB2_DIALECT_2_1",
          "SMB2_DIALECT_3_0",
          "SMB2_DIALECT_3_11"
        ],
        "description": "supported_dialects:\n * `SMB2_DIALECT_2_002` - API_SMB2_DIALECT_2_002,\n * `SMB2_DIALECT_2_1` - API_SMB2_DIALECT_2_1,\n * `SMB2_DIALECT_3_0` - API_SMB2_DIALECT_3_0,\n * `SMB2_DIALECT_3_11` - API_SMB2_DIALECT_3_11"
      }
    },
    "hide_shares_from_unauthorized_users": {
      "description": "If share permissions deny a logged in user access to a share, that share will not be visible in the share listing.",
      "type": "boolean"
    },
    "hide_shares_from_unauthorized_hosts": {
      "description": "If share permissions deny a connected host access to a share, that share will not be visible in the share listing.",
      "type": "boolean"
    },
    "snapshot_directory_mode": {
      "type": "string",
      "enum": [
        "VISIBLE",
        "HIDDEN",
        "DISABLED"
      ],
      "description": "Whether the special .snapshot directory should be visible or accessible.:\n * `DISABLED` - SNAPSHOT_METADIR_DISABLED,\n * `HIDDEN` - SNAPSHOT_METADIR_HIDDEN,\n * `VISIBLE` - SNAPSHOT_METADIR_VISIBLE"
    },
    "bypass_traverse_checking": {
      "description": "Skip directory traversal checking for all users.",
      "type": "boolean"
    },
    "signing_required": {
      "description": "Requires messages from non-guest users to be signed.",
      "type": "boolean"
    }
  }
}

PUT

Set current tenant-specific SMB configuration.

Parameters

Name	Description	Required
`id`	The tenant ID of the SMB settings.	Yes
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "api_smb_settings",
  "type": "object",
  "properties": {
    "session_encryption": {
      "type": "string",
      "enum": [
        "NONE",
        "PREFERRED",
        "REQUIRED"
      ],
      "description": "Session-level encryption setting.:\n * `NONE` - SMB_SESSION_ENCRYPTION_SETTING_NONE,\n * `PREFERRED` - SMB_SESSION_ENCRYPTION_SETTING_PREFERRED,\n * `REQUIRED` - SMB_SESSION_ENCRYPTION_SETTING_REQUIRED"
    },
    "supported_dialects": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "SMB2_DIALECT_2_002",
          "SMB2_DIALECT_2_1",
          "SMB2_DIALECT_3_0",
          "SMB2_DIALECT_3_11"
        ],
        "description": "supported_dialects:\n * `SMB2_DIALECT_2_002` - API_SMB2_DIALECT_2_002,\n * `SMB2_DIALECT_2_1` - API_SMB2_DIALECT_2_1,\n * `SMB2_DIALECT_3_0` - API_SMB2_DIALECT_3_0,\n * `SMB2_DIALECT_3_11` - API_SMB2_DIALECT_3_11"
      }
    },
    "hide_shares_from_unauthorized_users": {
      "description": "If share permissions deny a logged in user access to a share, that share will not be visible in the share listing.",
      "type": "boolean"
    },
    "hide_shares_from_unauthorized_hosts": {
      "description": "If share permissions deny a connected host access to a share, that share will not be visible in the share listing.",
      "type": "boolean"
    },
    "snapshot_directory_mode": {
      "type": "string",
      "enum": [
        "VISIBLE",
        "HIDDEN",
        "DISABLED"
      ],
      "description": "Whether the special .snapshot directory should be visible or accessible.:\n * `DISABLED` - SNAPSHOT_METADIR_DISABLED,\n * `HIDDEN` - SNAPSHOT_METADIR_HIDDEN,\n * `VISIBLE` - SNAPSHOT_METADIR_VISIBLE"
    },
    "bypass_traverse_checking": {
      "description": "Skip directory traversal checking for all users.",
      "type": "boolean"
    },
    "signing_required": {
      "description": "Requires messages from non-guest users to be signed.",
      "type": "boolean"
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_smb_settings",
  "type": "object",
  "properties": {
    "session_encryption": {
      "type": "string",
      "enum": [
        "NONE",
        "PREFERRED",
        "REQUIRED"
      ],
      "description": "Session-level encryption setting.:\n * `NONE` - SMB_SESSION_ENCRYPTION_SETTING_NONE,\n * `PREFERRED` - SMB_SESSION_ENCRYPTION_SETTING_PREFERRED,\n * `REQUIRED` - SMB_SESSION_ENCRYPTION_SETTING_REQUIRED"
    },
    "supported_dialects": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "SMB2_DIALECT_2_002",
          "SMB2_DIALECT_2_1",
          "SMB2_DIALECT_3_0",
          "SMB2_DIALECT_3_11"
        ],
        "description": "supported_dialects:\n * `SMB2_DIALECT_2_002` - API_SMB2_DIALECT_2_002,\n * `SMB2_DIALECT_2_1` - API_SMB2_DIALECT_2_1,\n * `SMB2_DIALECT_3_0` - API_SMB2_DIALECT_3_0,\n * `SMB2_DIALECT_3_11` - API_SMB2_DIALECT_3_11"
      }
    },
    "hide_shares_from_unauthorized_users": {
      "description": "If share permissions deny a logged in user access to a share, that share will not be visible in the share listing.",
      "type": "boolean"
    },
    "hide_shares_from_unauthorized_hosts": {
      "description": "If share permissions deny a connected host access to a share, that share will not be visible in the share listing.",
      "type": "boolean"
    },
    "snapshot_directory_mode": {
      "type": "string",
      "enum": [
        "VISIBLE",
        "HIDDEN",
        "DISABLED"
      ],
      "description": "Whether the special .snapshot directory should be visible or accessible.:\n * `DISABLED` - SNAPSHOT_METADIR_DISABLED,\n * `HIDDEN` - SNAPSHOT_METADIR_HIDDEN,\n * `VISIBLE` - SNAPSHOT_METADIR_VISIBLE"
    },
    "bypass_traverse_checking": {
      "description": "Skip directory traversal checking for all users.",
      "type": "boolean"
    },
    "signing_required": {
      "description": "Requires messages from non-guest users to be signed.",
      "type": "boolean"
    }
  }
}

DELETE

Delete current SMB configuration, restoring the global settings for this tenant.

Parameters

Name	Description	Required
`id`	The tenant ID of the SMB settings.	Yes
`If-Match`	ETag for expected version	No

Response

Codes

Code	Description
200	Return value on success

PATCH

Modify current tenant-specific SMB configuration.

Parameters

Name	Description	Required
`id`	The tenant ID of the SMB settings.	Yes
`If-Match`	ETag for expected version	No

Request

Schema

{
  "description": "api_smb_settings_patch",
  "type": "object",
  "properties": {
    "session_encryption": {
      "type": "string",
      "enum": [
        "NONE",
        "PREFERRED",
        "REQUIRED"
      ],
      "description": "Session-level encryption setting.:\n * `NONE` - SMB_SESSION_ENCRYPTION_SETTING_NONE,\n * `PREFERRED` - SMB_SESSION_ENCRYPTION_SETTING_PREFERRED,\n * `REQUIRED` - SMB_SESSION_ENCRYPTION_SETTING_REQUIRED"
    },
    "supported_dialects": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "SMB2_DIALECT_2_002",
          "SMB2_DIALECT_2_1",
          "SMB2_DIALECT_3_0",
          "SMB2_DIALECT_3_11"
        ],
        "description": "supported_dialects:\n * `SMB2_DIALECT_2_002` - API_SMB2_DIALECT_2_002,\n * `SMB2_DIALECT_2_1` - API_SMB2_DIALECT_2_1,\n * `SMB2_DIALECT_3_0` - API_SMB2_DIALECT_3_0,\n * `SMB2_DIALECT_3_11` - API_SMB2_DIALECT_3_11"
      }
    },
    "hide_shares_from_unauthorized_users": {
      "description": "If share permissions deny a logged in user access to a share, that share will not be visible in the share listing.",
      "type": "boolean"
    },
    "hide_shares_from_unauthorized_hosts": {
      "description": "If share permissions deny a connected host access to a share, that share will not be visible in the share listing.",
      "type": "boolean"
    },
    "snapshot_directory_mode": {
      "type": "string",
      "enum": [
        "VISIBLE",
        "HIDDEN",
        "DISABLED"
      ],
      "description": "Whether the special .snapshot directory should be visible or accessible.:\n * `DISABLED` - SNAPSHOT_METADIR_DISABLED,\n * `HIDDEN` - SNAPSHOT_METADIR_HIDDEN,\n * `VISIBLE` - SNAPSHOT_METADIR_VISIBLE"
    },
    "bypass_traverse_checking": {
      "description": "Skip directory traversal checking for all users.",
      "type": "boolean"
    },
    "signing_required": {
      "description": "Requires messages from non-guest users to be signed.",
      "type": "boolean"
    }
  }
}

Response

Codes

Code	Description
200	Return value on success

Schema

{
  "description": "api_smb_settings",
  "type": "object",
  "properties": {
    "session_encryption": {
      "type": "string",
      "enum": [
        "NONE",
        "PREFERRED",
        "REQUIRED"
      ],
      "description": "Session-level encryption setting.:\n * `NONE` - SMB_SESSION_ENCRYPTION_SETTING_NONE,\n * `PREFERRED` - SMB_SESSION_ENCRYPTION_SETTING_PREFERRED,\n * `REQUIRED` - SMB_SESSION_ENCRYPTION_SETTING_REQUIRED"
    },
    "supported_dialects": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "SMB2_DIALECT_2_002",
          "SMB2_DIALECT_2_1",
          "SMB2_DIALECT_3_0",
          "SMB2_DIALECT_3_11"
        ],
        "description": "supported_dialects:\n * `SMB2_DIALECT_2_002` - API_SMB2_DIALECT_2_002,\n * `SMB2_DIALECT_2_1` - API_SMB2_DIALECT_2_1,\n * `SMB2_DIALECT_3_0` - API_SMB2_DIALECT_3_0,\n * `SMB2_DIALECT_3_11` - API_SMB2_DIALECT_3_11"
      }
    },
    "hide_shares_from_unauthorized_users": {
      "description": "If share permissions deny a logged in user access to a share, that share will not be visible in the share listing.",
      "type": "boolean"
    },
    "hide_shares_from_unauthorized_hosts": {
      "description": "If share permissions deny a connected host access to a share, that share will not be visible in the share listing.",
      "type": "boolean"
    },
    "snapshot_directory_mode": {
      "type": "string",
      "enum": [
        "VISIBLE",
        "HIDDEN",
        "DISABLED"
      ],
      "description": "Whether the special .snapshot directory should be visible or accessible.:\n * `DISABLED` - SNAPSHOT_METADIR_DISABLED,\n * `HIDDEN` - SNAPSHOT_METADIR_HIDDEN,\n * `VISIBLE` - SNAPSHOT_METADIR_VISIBLE"
    },
    "bypass_traverse_checking": {
      "description": "Skip directory traversal checking for all users.",
      "type": "boolean"
    },
    "signing_required": {
      "description": "Requires messages from non-guest users to be signed.",
      "type": "boolean"
    }
  }
}