cloudmersive-virus-scan-api-client 2.0.6 → 2.0.7
Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 3fdcb9abb84157588a2d7ac8fa456d7c5044aefec34b4019313e115714ec0556
|
|
4
|
+
data.tar.gz: 341629a0efaf466be326a2e95e39d6117b96a5f92e7524723cc667028f9ab182
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9f85f82827d3b6b9114060c760ad402bed18fcee9789906ba7fb6538d6cd532be0a100024c14a0fef03a58c67285642a3d710923d3336744631270985385dd86
|
|
7
|
+
data.tar.gz: 559a7cf44416d36b05d563bcd99884ac90656311262c3c9c4c79b7771e74c2d0c9ee5e2a1e50e935a83c5f6edf2cf01b3ea9330270c6bb329588292e2b0d2b56
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ The Cloudmersive Virus Scan API lets you scan files and content for viruses and
|
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
8
8
|
|
|
9
9
|
- API version: v1
|
|
10
|
-
- Package version: 2.0.
|
|
10
|
+
- Package version: 2.0.7
|
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
|
12
12
|
|
|
13
13
|
## Installation
|
|
@@ -23,15 +23,15 @@ gem build cloudmersive-virus-scan-api-client.gemspec
|
|
|
23
23
|
Then either install the gem locally:
|
|
24
24
|
|
|
25
25
|
```shell
|
|
26
|
-
gem install ./cloudmersive-virus-scan-api-client-2.0.
|
|
26
|
+
gem install ./cloudmersive-virus-scan-api-client-2.0.7.gem
|
|
27
27
|
```
|
|
28
|
-
(for development, run `gem install --dev ./cloudmersive-virus-scan-api-client-2.0.
|
|
28
|
+
(for development, run `gem install --dev ./cloudmersive-virus-scan-api-client-2.0.7.gem` to install the development dependencies)
|
|
29
29
|
|
|
30
30
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
31
31
|
|
|
32
32
|
Finally add this to the Gemfile:
|
|
33
33
|
|
|
34
|
-
gem 'cloudmersive-virus-scan-api-client', '~> 2.0.
|
|
34
|
+
gem 'cloudmersive-virus-scan-api-client', '~> 2.0.7'
|
|
35
35
|
|
|
36
36
|
### Install from Git
|
|
37
37
|
|
|
@@ -92,6 +92,8 @@ Class | Method | HTTP request | Description
|
|
|
92
92
|
*CloudmersiveVirusScanApiClient::ScanCloudStorageApi* | [**scan_cloud_storage_scan_azure_blob_advanced**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_azure_blob_advanced) | **POST** /virus/scan/cloud-storage/azure-blob/single/advanced | Advanced Scan an Azure Blob for viruses
|
|
93
93
|
*CloudmersiveVirusScanApiClient::ScanCloudStorageApi* | [**scan_cloud_storage_scan_gcp_storage_file**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_gcp_storage_file) | **POST** /virus/scan/cloud-storage/gcp-storage/single | Scan an Google Cloud Platform (GCP) Storage file for viruses
|
|
94
94
|
*CloudmersiveVirusScanApiClient::ScanCloudStorageApi* | [**scan_cloud_storage_scan_gcp_storage_file_advanced**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_gcp_storage_file_advanced) | **POST** /virus/scan/cloud-storage/gcp-storage/single/advanced | Advanced Scan an Google Cloud Platform (GCP) Storage file for viruses
|
|
95
|
+
*CloudmersiveVirusScanApiClient::ScanCloudStorageApi* | [**scan_cloud_storage_scan_share_point_online_file**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_share_point_online_file) | **POST** /virus/scan/cloud-storage/sharepoint-online/site/single | Virus Scan a file in a SharePoint Online Site Drive
|
|
96
|
+
*CloudmersiveVirusScanApiClient::ScanCloudStorageApi* | [**scan_cloud_storage_scan_share_point_online_file_advanced**](docs/ScanCloudStorageApi.md#scan_cloud_storage_scan_share_point_online_file_advanced) | **POST** /virus/scan/cloud-storage/sharepoint-online/site/advanced | Advanced Virus Scan a file in a SharePoint Online Site Drive
|
|
95
97
|
|
|
96
98
|
|
|
97
99
|
## Documentation for Models
|
data/docs/ScanCloudStorageApi.md
CHANGED
|
@@ -10,6 +10,8 @@ Method | HTTP request | Description
|
|
|
10
10
|
[**scan_cloud_storage_scan_azure_blob_advanced**](ScanCloudStorageApi.md#scan_cloud_storage_scan_azure_blob_advanced) | **POST** /virus/scan/cloud-storage/azure-blob/single/advanced | Advanced Scan an Azure Blob for viruses
|
|
11
11
|
[**scan_cloud_storage_scan_gcp_storage_file**](ScanCloudStorageApi.md#scan_cloud_storage_scan_gcp_storage_file) | **POST** /virus/scan/cloud-storage/gcp-storage/single | Scan an Google Cloud Platform (GCP) Storage file for viruses
|
|
12
12
|
[**scan_cloud_storage_scan_gcp_storage_file_advanced**](ScanCloudStorageApi.md#scan_cloud_storage_scan_gcp_storage_file_advanced) | **POST** /virus/scan/cloud-storage/gcp-storage/single/advanced | Advanced Scan an Google Cloud Platform (GCP) Storage file for viruses
|
|
13
|
+
[**scan_cloud_storage_scan_share_point_online_file**](ScanCloudStorageApi.md#scan_cloud_storage_scan_share_point_online_file) | **POST** /virus/scan/cloud-storage/sharepoint-online/site/single | Virus Scan a file in a SharePoint Online Site Drive
|
|
14
|
+
[**scan_cloud_storage_scan_share_point_online_file_advanced**](ScanCloudStorageApi.md#scan_cloud_storage_scan_share_point_online_file_advanced) | **POST** /virus/scan/cloud-storage/sharepoint-online/site/advanced | Advanced Virus Scan a file in a SharePoint Online Site Drive
|
|
13
15
|
|
|
14
16
|
|
|
15
17
|
# **scan_cloud_storage_scan_aws_s3_file**
|
|
@@ -115,6 +117,7 @@ opts = {
|
|
|
115
117
|
allow_scripts: true, # BOOLEAN | Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
|
116
118
|
allow_password_protected_files: true, # BOOLEAN | Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
|
117
119
|
allow_macros: true, # BOOLEAN | Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
120
|
+
allow_xml_external_entities: true, # BOOLEAN | Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
118
121
|
restrict_file_types: 'restrict_file_types_example' # String | Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
|
119
122
|
}
|
|
120
123
|
|
|
@@ -141,6 +144,7 @@ Name | Type | Description | Notes
|
|
|
141
144
|
**allow_scripts** | **BOOLEAN**| Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended). | [optional]
|
|
142
145
|
**allow_password_protected_files** | **BOOLEAN**| Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended). | [optional]
|
|
143
146
|
**allow_macros** | **BOOLEAN**| Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
|
147
|
+
**allow_xml_external_entities** | **BOOLEAN**| Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
|
144
148
|
**restrict_file_types** | **String**| Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled. | [optional]
|
|
145
149
|
|
|
146
150
|
### Return type
|
|
@@ -251,6 +255,7 @@ opts = {
|
|
|
251
255
|
allow_scripts: true, # BOOLEAN | Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
|
252
256
|
allow_password_protected_files: true, # BOOLEAN | Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
|
253
257
|
allow_macros: true, # BOOLEAN | Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
258
|
+
allow_xml_external_entities: true, # BOOLEAN | Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
254
259
|
restrict_file_types: 'restrict_file_types_example' # String | Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
|
255
260
|
}
|
|
256
261
|
|
|
@@ -275,6 +280,7 @@ Name | Type | Description | Notes
|
|
|
275
280
|
**allow_scripts** | **BOOLEAN**| Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended). | [optional]
|
|
276
281
|
**allow_password_protected_files** | **BOOLEAN**| Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended). | [optional]
|
|
277
282
|
**allow_macros** | **BOOLEAN**| Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
|
283
|
+
**allow_xml_external_entities** | **BOOLEAN**| Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
|
278
284
|
**restrict_file_types** | **String**| Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled. | [optional]
|
|
279
285
|
|
|
280
286
|
### Return type
|
|
@@ -385,6 +391,7 @@ opts = {
|
|
|
385
391
|
allow_scripts: true, # BOOLEAN | Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
|
386
392
|
allow_password_protected_files: true, # BOOLEAN | Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
|
387
393
|
allow_macros: true, # BOOLEAN | Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
394
|
+
allow_xml_external_entities: true, # BOOLEAN | Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
388
395
|
restrict_file_types: 'restrict_file_types_example' # String | Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
|
389
396
|
}
|
|
390
397
|
|
|
@@ -409,6 +416,161 @@ Name | Type | Description | Notes
|
|
|
409
416
|
**allow_scripts** | **BOOLEAN**| Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended). | [optional]
|
|
410
417
|
**allow_password_protected_files** | **BOOLEAN**| Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended). | [optional]
|
|
411
418
|
**allow_macros** | **BOOLEAN**| Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
|
419
|
+
**allow_xml_external_entities** | **BOOLEAN**| Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
|
420
|
+
**restrict_file_types** | **String**| Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled. | [optional]
|
|
421
|
+
|
|
422
|
+
### Return type
|
|
423
|
+
|
|
424
|
+
[**CloudStorageAdvancedVirusScanResult**](CloudStorageAdvancedVirusScanResult.md)
|
|
425
|
+
|
|
426
|
+
### Authorization
|
|
427
|
+
|
|
428
|
+
[Apikey](../README.md#Apikey)
|
|
429
|
+
|
|
430
|
+
### HTTP request headers
|
|
431
|
+
|
|
432
|
+
- **Content-Type**: multipart/form-data
|
|
433
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
# **scan_cloud_storage_scan_share_point_online_file**
|
|
438
|
+
> CloudStorageVirusScanResult scan_cloud_storage_scan_share_point_online_file(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts)
|
|
439
|
+
|
|
440
|
+
Virus Scan a file in a SharePoint Online Site Drive
|
|
441
|
+
|
|
442
|
+
Virus Scan the contents of a single SharePoint Online Site Drive file and its content for viruses. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.
|
|
443
|
+
|
|
444
|
+
### Example
|
|
445
|
+
```ruby
|
|
446
|
+
# load the gem
|
|
447
|
+
require 'cloudmersive-virus-scan-api-client'
|
|
448
|
+
# setup authorization
|
|
449
|
+
CloudmersiveVirusScanApiClient.configure do |config|
|
|
450
|
+
# Configure API key authorization: Apikey
|
|
451
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
452
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
453
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
454
|
+
end
|
|
455
|
+
|
|
456
|
+
api_instance = CloudmersiveVirusScanApiClient::ScanCloudStorageApi.new
|
|
457
|
+
|
|
458
|
+
client_id = 'client_id_example' # String | Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.
|
|
459
|
+
|
|
460
|
+
client_secret = 'client_secret_example' # String | Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
|
|
461
|
+
|
|
462
|
+
sharepoint_domain_name = 'sharepoint_domain_name_example' # String | SharePoint Online domain name, such as mydomain.sharepoint.com
|
|
463
|
+
|
|
464
|
+
site_id = 'site_id_example' # String | Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
|
465
|
+
|
|
466
|
+
file_path = 'file_path_example' # String | Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
|
467
|
+
|
|
468
|
+
opts = {
|
|
469
|
+
tenant_id: 'tenant_id_example' # String | Optional; Tenant ID of your Azure Active Directory
|
|
470
|
+
}
|
|
471
|
+
|
|
472
|
+
begin
|
|
473
|
+
#Virus Scan a file in a SharePoint Online Site Drive
|
|
474
|
+
result = api_instance.scan_cloud_storage_scan_share_point_online_file(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts)
|
|
475
|
+
p result
|
|
476
|
+
rescue CloudmersiveVirusScanApiClient::ApiError => e
|
|
477
|
+
puts "Exception when calling ScanCloudStorageApi->scan_cloud_storage_scan_share_point_online_file: #{e}"
|
|
478
|
+
end
|
|
479
|
+
```
|
|
480
|
+
|
|
481
|
+
### Parameters
|
|
482
|
+
|
|
483
|
+
Name | Type | Description | Notes
|
|
484
|
+
------------- | ------------- | ------------- | -------------
|
|
485
|
+
**client_id** | **String**| Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal. |
|
|
486
|
+
**client_secret** | **String**| Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal |
|
|
487
|
+
**sharepoint_domain_name** | **String**| SharePoint Online domain name, such as mydomain.sharepoint.com |
|
|
488
|
+
**site_id** | **String**| Site ID (GUID) of the SharePoint site you wish to retrieve the file from |
|
|
489
|
+
**file_path** | **String**| Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf' |
|
|
490
|
+
**tenant_id** | **String**| Optional; Tenant ID of your Azure Active Directory | [optional]
|
|
491
|
+
|
|
492
|
+
### Return type
|
|
493
|
+
|
|
494
|
+
[**CloudStorageVirusScanResult**](CloudStorageVirusScanResult.md)
|
|
495
|
+
|
|
496
|
+
### Authorization
|
|
497
|
+
|
|
498
|
+
[Apikey](../README.md#Apikey)
|
|
499
|
+
|
|
500
|
+
### HTTP request headers
|
|
501
|
+
|
|
502
|
+
- **Content-Type**: multipart/form-data
|
|
503
|
+
- **Accept**: application/json, text/json, application/xml, text/xml
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
# **scan_cloud_storage_scan_share_point_online_file_advanced**
|
|
508
|
+
> CloudStorageAdvancedVirusScanResult scan_cloud_storage_scan_share_point_online_file_advanced(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts)
|
|
509
|
+
|
|
510
|
+
Advanced Virus Scan a file in a SharePoint Online Site Drive
|
|
511
|
+
|
|
512
|
+
Advanced Virus Scan the contents of a single SharePoint Online Site Drive file and its content for viruses and threats. Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.
|
|
513
|
+
|
|
514
|
+
### Example
|
|
515
|
+
```ruby
|
|
516
|
+
# load the gem
|
|
517
|
+
require 'cloudmersive-virus-scan-api-client'
|
|
518
|
+
# setup authorization
|
|
519
|
+
CloudmersiveVirusScanApiClient.configure do |config|
|
|
520
|
+
# Configure API key authorization: Apikey
|
|
521
|
+
config.api_key['Apikey'] = 'YOUR API KEY'
|
|
522
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
523
|
+
#config.api_key_prefix['Apikey'] = 'Bearer'
|
|
524
|
+
end
|
|
525
|
+
|
|
526
|
+
api_instance = CloudmersiveVirusScanApiClient::ScanCloudStorageApi.new
|
|
527
|
+
|
|
528
|
+
client_id = 'client_id_example' # String | Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.
|
|
529
|
+
|
|
530
|
+
client_secret = 'client_secret_example' # String | Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
|
|
531
|
+
|
|
532
|
+
sharepoint_domain_name = 'sharepoint_domain_name_example' # String | SharePoint Online domain name, such as mydomain.sharepoint.com
|
|
533
|
+
|
|
534
|
+
site_id = 'site_id_example' # String | Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
|
535
|
+
|
|
536
|
+
file_path = 'file_path_example' # String | Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
|
537
|
+
|
|
538
|
+
opts = {
|
|
539
|
+
tenant_id: 'tenant_id_example', # String | Optional; Tenant ID of your Azure Active Directory
|
|
540
|
+
allow_executables: true, # BOOLEAN | Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
|
|
541
|
+
allow_invalid_files: true, # BOOLEAN | Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
|
|
542
|
+
allow_scripts: true, # BOOLEAN | Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
|
543
|
+
allow_password_protected_files: true, # BOOLEAN | Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
|
544
|
+
allow_macros: true, # BOOLEAN | Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
545
|
+
allow_xml_external_entities: true, # BOOLEAN | Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
546
|
+
restrict_file_types: 'restrict_file_types_example' # String | Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
|
547
|
+
}
|
|
548
|
+
|
|
549
|
+
begin
|
|
550
|
+
#Advanced Virus Scan a file in a SharePoint Online Site Drive
|
|
551
|
+
result = api_instance.scan_cloud_storage_scan_share_point_online_file_advanced(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts)
|
|
552
|
+
p result
|
|
553
|
+
rescue CloudmersiveVirusScanApiClient::ApiError => e
|
|
554
|
+
puts "Exception when calling ScanCloudStorageApi->scan_cloud_storage_scan_share_point_online_file_advanced: #{e}"
|
|
555
|
+
end
|
|
556
|
+
```
|
|
557
|
+
|
|
558
|
+
### Parameters
|
|
559
|
+
|
|
560
|
+
Name | Type | Description | Notes
|
|
561
|
+
------------- | ------------- | ------------- | -------------
|
|
562
|
+
**client_id** | **String**| Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal. |
|
|
563
|
+
**client_secret** | **String**| Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal |
|
|
564
|
+
**sharepoint_domain_name** | **String**| SharePoint Online domain name, such as mydomain.sharepoint.com |
|
|
565
|
+
**site_id** | **String**| Site ID (GUID) of the SharePoint site you wish to retrieve the file from |
|
|
566
|
+
**file_path** | **String**| Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf' |
|
|
567
|
+
**tenant_id** | **String**| Optional; Tenant ID of your Azure Active Directory | [optional]
|
|
568
|
+
**allow_executables** | **BOOLEAN**| Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended). | [optional]
|
|
569
|
+
**allow_invalid_files** | **BOOLEAN**| Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended). | [optional]
|
|
570
|
+
**allow_scripts** | **BOOLEAN**| Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended). | [optional]
|
|
571
|
+
**allow_password_protected_files** | **BOOLEAN**| Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended). | [optional]
|
|
572
|
+
**allow_macros** | **BOOLEAN**| Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
|
573
|
+
**allow_xml_external_entities** | **BOOLEAN**| Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended). | [optional]
|
|
412
574
|
**restrict_file_types** | **String**| Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled. | [optional]
|
|
413
575
|
|
|
414
576
|
### Return type
|
|
@@ -115,6 +115,7 @@ module CloudmersiveVirusScanApiClient
|
|
|
115
115
|
# @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
|
116
116
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
|
117
117
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
118
|
+
# @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
118
119
|
# @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
|
119
120
|
# @return [CloudStorageAdvancedVirusScanResult]
|
|
120
121
|
def scan_cloud_storage_scan_aws_s3_file_advanced(access_key, secret_key, bucket_region, bucket_name, key_name, opts = {})
|
|
@@ -135,6 +136,7 @@ module CloudmersiveVirusScanApiClient
|
|
|
135
136
|
# @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
|
136
137
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
|
137
138
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
139
|
+
# @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
138
140
|
# @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
|
139
141
|
# @return [Array<(CloudStorageAdvancedVirusScanResult, Fixnum, Hash)>] CloudStorageAdvancedVirusScanResult data, response status code and response headers
|
|
140
142
|
def scan_cloud_storage_scan_aws_s3_file_advanced_with_http_info(access_key, secret_key, bucket_region, bucket_name, key_name, opts = {})
|
|
@@ -183,6 +185,7 @@ module CloudmersiveVirusScanApiClient
|
|
|
183
185
|
header_params[:'allowScripts'] = opts[:'allow_scripts'] if !opts[:'allow_scripts'].nil?
|
|
184
186
|
header_params[:'allowPasswordProtectedFiles'] = opts[:'allow_password_protected_files'] if !opts[:'allow_password_protected_files'].nil?
|
|
185
187
|
header_params[:'allowMacros'] = opts[:'allow_macros'] if !opts[:'allow_macros'].nil?
|
|
188
|
+
header_params[:'allowXmlExternalEntities'] = opts[:'allow_xml_external_entities'] if !opts[:'allow_xml_external_entities'].nil?
|
|
186
189
|
header_params[:'restrictFileTypes'] = opts[:'restrict_file_types'] if !opts[:'restrict_file_types'].nil?
|
|
187
190
|
|
|
188
191
|
# form parameters
|
|
@@ -283,6 +286,7 @@ module CloudmersiveVirusScanApiClient
|
|
|
283
286
|
# @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
|
284
287
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
|
285
288
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
289
|
+
# @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
286
290
|
# @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
|
287
291
|
# @return [CloudStorageAdvancedVirusScanResult]
|
|
288
292
|
def scan_cloud_storage_scan_azure_blob_advanced(connection_string, container_name, blob_path, opts = {})
|
|
@@ -301,6 +305,7 @@ module CloudmersiveVirusScanApiClient
|
|
|
301
305
|
# @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
|
302
306
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
|
303
307
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
308
|
+
# @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
304
309
|
# @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
|
305
310
|
# @return [Array<(CloudStorageAdvancedVirusScanResult, Fixnum, Hash)>] CloudStorageAdvancedVirusScanResult data, response status code and response headers
|
|
306
311
|
def scan_cloud_storage_scan_azure_blob_advanced_with_http_info(connection_string, container_name, blob_path, opts = {})
|
|
@@ -339,6 +344,7 @@ module CloudmersiveVirusScanApiClient
|
|
|
339
344
|
header_params[:'allowScripts'] = opts[:'allow_scripts'] if !opts[:'allow_scripts'].nil?
|
|
340
345
|
header_params[:'allowPasswordProtectedFiles'] = opts[:'allow_password_protected_files'] if !opts[:'allow_password_protected_files'].nil?
|
|
341
346
|
header_params[:'allowMacros'] = opts[:'allow_macros'] if !opts[:'allow_macros'].nil?
|
|
347
|
+
header_params[:'allowXmlExternalEntities'] = opts[:'allow_xml_external_entities'] if !opts[:'allow_xml_external_entities'].nil?
|
|
342
348
|
header_params[:'restrictFileTypes'] = opts[:'restrict_file_types'] if !opts[:'restrict_file_types'].nil?
|
|
343
349
|
|
|
344
350
|
# form parameters
|
|
@@ -439,6 +445,7 @@ module CloudmersiveVirusScanApiClient
|
|
|
439
445
|
# @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
|
440
446
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
|
441
447
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
448
|
+
# @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
442
449
|
# @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
|
443
450
|
# @return [CloudStorageAdvancedVirusScanResult]
|
|
444
451
|
def scan_cloud_storage_scan_gcp_storage_file_advanced(bucket_name, object_name, json_credential_file, opts = {})
|
|
@@ -457,6 +464,7 @@ module CloudmersiveVirusScanApiClient
|
|
|
457
464
|
# @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
|
458
465
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
|
459
466
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
467
|
+
# @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
460
468
|
# @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
|
461
469
|
# @return [Array<(CloudStorageAdvancedVirusScanResult, Fixnum, Hash)>] CloudStorageAdvancedVirusScanResult data, response status code and response headers
|
|
462
470
|
def scan_cloud_storage_scan_gcp_storage_file_advanced_with_http_info(bucket_name, object_name, json_credential_file, opts = {})
|
|
@@ -494,6 +502,7 @@ module CloudmersiveVirusScanApiClient
|
|
|
494
502
|
header_params[:'allowScripts'] = opts[:'allow_scripts'] if !opts[:'allow_scripts'].nil?
|
|
495
503
|
header_params[:'allowPasswordProtectedFiles'] = opts[:'allow_password_protected_files'] if !opts[:'allow_password_protected_files'].nil?
|
|
496
504
|
header_params[:'allowMacros'] = opts[:'allow_macros'] if !opts[:'allow_macros'].nil?
|
|
505
|
+
header_params[:'allowXmlExternalEntities'] = opts[:'allow_xml_external_entities'] if !opts[:'allow_xml_external_entities'].nil?
|
|
497
506
|
header_params[:'restrictFileTypes'] = opts[:'restrict_file_types'] if !opts[:'restrict_file_types'].nil?
|
|
498
507
|
|
|
499
508
|
# form parameters
|
|
@@ -515,5 +524,198 @@ module CloudmersiveVirusScanApiClient
|
|
|
515
524
|
end
|
|
516
525
|
return data, status_code, headers
|
|
517
526
|
end
|
|
527
|
+
# Virus Scan a file in a SharePoint Online Site Drive
|
|
528
|
+
# Virus Scan the contents of a single SharePoint Online Site Drive file and its content for viruses. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.
|
|
529
|
+
# @param client_id Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.
|
|
530
|
+
# @param client_secret Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
|
|
531
|
+
# @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
|
|
532
|
+
# @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
|
533
|
+
# @param file_path Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
|
534
|
+
# @param [Hash] opts the optional parameters
|
|
535
|
+
# @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
|
|
536
|
+
# @return [CloudStorageVirusScanResult]
|
|
537
|
+
def scan_cloud_storage_scan_share_point_online_file(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts = {})
|
|
538
|
+
data, _status_code, _headers = scan_cloud_storage_scan_share_point_online_file_with_http_info(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts)
|
|
539
|
+
data
|
|
540
|
+
end
|
|
541
|
+
|
|
542
|
+
# Virus Scan a file in a SharePoint Online Site Drive
|
|
543
|
+
# Virus Scan the contents of a single SharePoint Online Site Drive file and its content for viruses. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.
|
|
544
|
+
# @param client_id Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.
|
|
545
|
+
# @param client_secret Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
|
|
546
|
+
# @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
|
|
547
|
+
# @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
|
548
|
+
# @param file_path Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
|
549
|
+
# @param [Hash] opts the optional parameters
|
|
550
|
+
# @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
|
|
551
|
+
# @return [Array<(CloudStorageVirusScanResult, Fixnum, Hash)>] CloudStorageVirusScanResult data, response status code and response headers
|
|
552
|
+
def scan_cloud_storage_scan_share_point_online_file_with_http_info(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts = {})
|
|
553
|
+
if @api_client.config.debugging
|
|
554
|
+
@api_client.config.logger.debug 'Calling API: ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file ...'
|
|
555
|
+
end
|
|
556
|
+
# verify the required parameter 'client_id' is set
|
|
557
|
+
if @api_client.config.client_side_validation && client_id.nil?
|
|
558
|
+
fail ArgumentError, "Missing the required parameter 'client_id' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file"
|
|
559
|
+
end
|
|
560
|
+
# verify the required parameter 'client_secret' is set
|
|
561
|
+
if @api_client.config.client_side_validation && client_secret.nil?
|
|
562
|
+
fail ArgumentError, "Missing the required parameter 'client_secret' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file"
|
|
563
|
+
end
|
|
564
|
+
# verify the required parameter 'sharepoint_domain_name' is set
|
|
565
|
+
if @api_client.config.client_side_validation && sharepoint_domain_name.nil?
|
|
566
|
+
fail ArgumentError, "Missing the required parameter 'sharepoint_domain_name' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file"
|
|
567
|
+
end
|
|
568
|
+
# verify the required parameter 'site_id' is set
|
|
569
|
+
if @api_client.config.client_side_validation && site_id.nil?
|
|
570
|
+
fail ArgumentError, "Missing the required parameter 'site_id' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file"
|
|
571
|
+
end
|
|
572
|
+
# verify the required parameter 'file_path' is set
|
|
573
|
+
if @api_client.config.client_side_validation && file_path.nil?
|
|
574
|
+
fail ArgumentError, "Missing the required parameter 'file_path' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file"
|
|
575
|
+
end
|
|
576
|
+
# resource path
|
|
577
|
+
local_var_path = '/virus/scan/cloud-storage/sharepoint-online/site/single'
|
|
578
|
+
|
|
579
|
+
# query parameters
|
|
580
|
+
query_params = {}
|
|
581
|
+
|
|
582
|
+
# header parameters
|
|
583
|
+
header_params = {}
|
|
584
|
+
# HTTP header 'Accept' (if needed)
|
|
585
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
|
586
|
+
# HTTP header 'Content-Type'
|
|
587
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
|
588
|
+
header_params[:'clientID'] = client_id
|
|
589
|
+
header_params[:'clientSecret'] = client_secret
|
|
590
|
+
header_params[:'sharepointDomainName'] = sharepoint_domain_name
|
|
591
|
+
header_params[:'siteID'] = site_id
|
|
592
|
+
header_params[:'filePath'] = file_path
|
|
593
|
+
header_params[:'tenantID'] = opts[:'tenant_id'] if !opts[:'tenant_id'].nil?
|
|
594
|
+
|
|
595
|
+
# form parameters
|
|
596
|
+
form_params = {}
|
|
597
|
+
|
|
598
|
+
# http body (model)
|
|
599
|
+
post_body = nil
|
|
600
|
+
auth_names = ['Apikey']
|
|
601
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
602
|
+
:header_params => header_params,
|
|
603
|
+
:query_params => query_params,
|
|
604
|
+
:form_params => form_params,
|
|
605
|
+
:body => post_body,
|
|
606
|
+
:auth_names => auth_names,
|
|
607
|
+
:return_type => 'CloudStorageVirusScanResult')
|
|
608
|
+
if @api_client.config.debugging
|
|
609
|
+
@api_client.config.logger.debug "API called: ScanCloudStorageApi#scan_cloud_storage_scan_share_point_online_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
610
|
+
end
|
|
611
|
+
return data, status_code, headers
|
|
612
|
+
end
|
|
613
|
+
# Advanced Virus Scan a file in a SharePoint Online Site Drive
|
|
614
|
+
# Advanced Virus Scan the contents of a single SharePoint Online Site Drive file and its content for viruses and threats. Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.
|
|
615
|
+
# @param client_id Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.
|
|
616
|
+
# @param client_secret Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
|
|
617
|
+
# @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
|
|
618
|
+
# @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
|
619
|
+
# @param file_path Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
|
620
|
+
# @param [Hash] opts the optional parameters
|
|
621
|
+
# @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
|
|
622
|
+
# @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
|
|
623
|
+
# @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
|
|
624
|
+
# @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
|
625
|
+
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
|
626
|
+
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
627
|
+
# @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
628
|
+
# @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
|
629
|
+
# @return [CloudStorageAdvancedVirusScanResult]
|
|
630
|
+
def scan_cloud_storage_scan_share_point_online_file_advanced(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts = {})
|
|
631
|
+
data, _status_code, _headers = scan_cloud_storage_scan_share_point_online_file_advanced_with_http_info(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts)
|
|
632
|
+
data
|
|
633
|
+
end
|
|
634
|
+
|
|
635
|
+
# Advanced Virus Scan a file in a SharePoint Online Site Drive
|
|
636
|
+
# Advanced Virus Scan the contents of a single SharePoint Online Site Drive file and its content for viruses and threats. Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.
|
|
637
|
+
# @param client_id Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.
|
|
638
|
+
# @param client_secret Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
|
|
639
|
+
# @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
|
|
640
|
+
# @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
|
641
|
+
# @param file_path Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
|
642
|
+
# @param [Hash] opts the optional parameters
|
|
643
|
+
# @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
|
|
644
|
+
# @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
|
|
645
|
+
# @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
|
|
646
|
+
# @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
|
647
|
+
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
|
648
|
+
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
649
|
+
# @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
650
|
+
# @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
|
651
|
+
# @return [Array<(CloudStorageAdvancedVirusScanResult, Fixnum, Hash)>] CloudStorageAdvancedVirusScanResult data, response status code and response headers
|
|
652
|
+
def scan_cloud_storage_scan_share_point_online_file_advanced_with_http_info(client_id, client_secret, sharepoint_domain_name, site_id, file_path, opts = {})
|
|
653
|
+
if @api_client.config.debugging
|
|
654
|
+
@api_client.config.logger.debug 'Calling API: ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file_advanced ...'
|
|
655
|
+
end
|
|
656
|
+
# verify the required parameter 'client_id' is set
|
|
657
|
+
if @api_client.config.client_side_validation && client_id.nil?
|
|
658
|
+
fail ArgumentError, "Missing the required parameter 'client_id' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file_advanced"
|
|
659
|
+
end
|
|
660
|
+
# verify the required parameter 'client_secret' is set
|
|
661
|
+
if @api_client.config.client_side_validation && client_secret.nil?
|
|
662
|
+
fail ArgumentError, "Missing the required parameter 'client_secret' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file_advanced"
|
|
663
|
+
end
|
|
664
|
+
# verify the required parameter 'sharepoint_domain_name' is set
|
|
665
|
+
if @api_client.config.client_side_validation && sharepoint_domain_name.nil?
|
|
666
|
+
fail ArgumentError, "Missing the required parameter 'sharepoint_domain_name' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file_advanced"
|
|
667
|
+
end
|
|
668
|
+
# verify the required parameter 'site_id' is set
|
|
669
|
+
if @api_client.config.client_side_validation && site_id.nil?
|
|
670
|
+
fail ArgumentError, "Missing the required parameter 'site_id' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file_advanced"
|
|
671
|
+
end
|
|
672
|
+
# verify the required parameter 'file_path' is set
|
|
673
|
+
if @api_client.config.client_side_validation && file_path.nil?
|
|
674
|
+
fail ArgumentError, "Missing the required parameter 'file_path' when calling ScanCloudStorageApi.scan_cloud_storage_scan_share_point_online_file_advanced"
|
|
675
|
+
end
|
|
676
|
+
# resource path
|
|
677
|
+
local_var_path = '/virus/scan/cloud-storage/sharepoint-online/site/advanced'
|
|
678
|
+
|
|
679
|
+
# query parameters
|
|
680
|
+
query_params = {}
|
|
681
|
+
|
|
682
|
+
# header parameters
|
|
683
|
+
header_params = {}
|
|
684
|
+
# HTTP header 'Accept' (if needed)
|
|
685
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
|
|
686
|
+
# HTTP header 'Content-Type'
|
|
687
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
|
688
|
+
header_params[:'clientID'] = client_id
|
|
689
|
+
header_params[:'clientSecret'] = client_secret
|
|
690
|
+
header_params[:'sharepointDomainName'] = sharepoint_domain_name
|
|
691
|
+
header_params[:'siteID'] = site_id
|
|
692
|
+
header_params[:'filePath'] = file_path
|
|
693
|
+
header_params[:'tenantID'] = opts[:'tenant_id'] if !opts[:'tenant_id'].nil?
|
|
694
|
+
header_params[:'allowExecutables'] = opts[:'allow_executables'] if !opts[:'allow_executables'].nil?
|
|
695
|
+
header_params[:'allowInvalidFiles'] = opts[:'allow_invalid_files'] if !opts[:'allow_invalid_files'].nil?
|
|
696
|
+
header_params[:'allowScripts'] = opts[:'allow_scripts'] if !opts[:'allow_scripts'].nil?
|
|
697
|
+
header_params[:'allowPasswordProtectedFiles'] = opts[:'allow_password_protected_files'] if !opts[:'allow_password_protected_files'].nil?
|
|
698
|
+
header_params[:'allowMacros'] = opts[:'allow_macros'] if !opts[:'allow_macros'].nil?
|
|
699
|
+
header_params[:'allowXmlExternalEntities'] = opts[:'allow_xml_external_entities'] if !opts[:'allow_xml_external_entities'].nil?
|
|
700
|
+
header_params[:'restrictFileTypes'] = opts[:'restrict_file_types'] if !opts[:'restrict_file_types'].nil?
|
|
701
|
+
|
|
702
|
+
# form parameters
|
|
703
|
+
form_params = {}
|
|
704
|
+
|
|
705
|
+
# http body (model)
|
|
706
|
+
post_body = nil
|
|
707
|
+
auth_names = ['Apikey']
|
|
708
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
|
709
|
+
:header_params => header_params,
|
|
710
|
+
:query_params => query_params,
|
|
711
|
+
:form_params => form_params,
|
|
712
|
+
:body => post_body,
|
|
713
|
+
:auth_names => auth_names,
|
|
714
|
+
:return_type => 'CloudStorageAdvancedVirusScanResult')
|
|
715
|
+
if @api_client.config.debugging
|
|
716
|
+
@api_client.config.logger.debug "API called: ScanCloudStorageApi#scan_cloud_storage_scan_share_point_online_file_advanced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
717
|
+
end
|
|
718
|
+
return data, status_code, headers
|
|
719
|
+
end
|
|
518
720
|
end
|
|
519
721
|
end
|
|
@@ -62,6 +62,7 @@ describe 'ScanCloudStorageApi' do
|
|
|
62
62
|
# @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
|
63
63
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
|
64
64
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
65
|
+
# @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
65
66
|
# @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
|
66
67
|
# @return [CloudStorageAdvancedVirusScanResult]
|
|
67
68
|
describe 'scan_cloud_storage_scan_aws_s3_file_advanced test' do
|
|
@@ -96,6 +97,7 @@ describe 'ScanCloudStorageApi' do
|
|
|
96
97
|
# @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
|
97
98
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
|
98
99
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
100
|
+
# @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
99
101
|
# @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
|
100
102
|
# @return [CloudStorageAdvancedVirusScanResult]
|
|
101
103
|
describe 'scan_cloud_storage_scan_azure_blob_advanced test' do
|
|
@@ -130,6 +132,7 @@ describe 'ScanCloudStorageApi' do
|
|
|
130
132
|
# @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
|
131
133
|
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
|
132
134
|
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
135
|
+
# @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
133
136
|
# @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
|
134
137
|
# @return [CloudStorageAdvancedVirusScanResult]
|
|
135
138
|
describe 'scan_cloud_storage_scan_gcp_storage_file_advanced test' do
|
|
@@ -138,4 +141,45 @@ describe 'ScanCloudStorageApi' do
|
|
|
138
141
|
end
|
|
139
142
|
end
|
|
140
143
|
|
|
144
|
+
# unit tests for scan_cloud_storage_scan_share_point_online_file
|
|
145
|
+
# Virus Scan a file in a SharePoint Online Site Drive
|
|
146
|
+
# Virus Scan the contents of a single SharePoint Online Site Drive file and its content for viruses. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.
|
|
147
|
+
# @param client_id Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.
|
|
148
|
+
# @param client_secret Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
|
|
149
|
+
# @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
|
|
150
|
+
# @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
|
151
|
+
# @param file_path Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
|
152
|
+
# @param [Hash] opts the optional parameters
|
|
153
|
+
# @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
|
|
154
|
+
# @return [CloudStorageVirusScanResult]
|
|
155
|
+
describe 'scan_cloud_storage_scan_share_point_online_file test' do
|
|
156
|
+
it 'should work' do
|
|
157
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
158
|
+
end
|
|
159
|
+
end
|
|
160
|
+
|
|
161
|
+
# unit tests for scan_cloud_storage_scan_share_point_online_file_advanced
|
|
162
|
+
# Advanced Virus Scan a file in a SharePoint Online Site Drive
|
|
163
|
+
# Advanced Virus Scan the contents of a single SharePoint Online Site Drive file and its content for viruses and threats. Advanced Scan files with 360-degree Content Protection across Viruses and Malware, executables, invalid files, scripts, and even restrictions on accepted file types with complete content verification. Customize threat rules to your needs. Leverage continuously updated signatures for millions of threats, and advanced high-performance scanning capabilities. Over 17 million virus and malware signatures. Continuous cloud-based updates. Block threats beyond viruses including executables, scripts, invalid files, and more. Optionally limit input files to a specific set of file types (e.g. PDF and Word Documents only). Wide file format support including Office, PDF, HTML, Flash. Zip support including .Zip, .Rar, .DMG, .Tar, and other archive formats. Multi-threat scanning across viruses, malware, trojans, ransomware, and spyware. High-speed in-memory scanning delivers subsecond typical response time. To get the Client ID and Client Secret, follow these steps: (1) Navigate to the Azure Portal and click on Azure Active Directory, (2) click on App Registrations on the left hand side, (3) click on Register Application, (4) Name the application CloudmersiveAntiVirus and click on Register, (5) Get the client ID by clicking on Overview and copying the value labeled Application (client) ID, (6) click on Certificates and Secrets, (7) click on New client secret, choose a longer expiration and give the secret a name, (8) copy the secret value to the clipboard and save it securely, this is your Client Secret, (9) Now we need to grant permissions to SharePOint; click on API Permissions on the left hand side, (10) click on Add a permission and choose Microsoft Graph, (11) click on Application Permissions, (12) search for Sites.FullControl.All, (13) Click on Add Permissions, (14) now navigate back to Azure Active Directory and click on Enterprise Applications, click on CloudmersiveAntiVirus and click on Permissions, and (15) click on Grant Admin Consent.
|
|
164
|
+
# @param client_id Client ID access credentials; see description above for instructions on how to get the Client ID from the Azure Active Directory portal.
|
|
165
|
+
# @param client_secret Client Secret access credentials; see description above for instructions on how to get the Client Secret from the Azure Active Directory portal
|
|
166
|
+
# @param sharepoint_domain_name SharePoint Online domain name, such as mydomain.sharepoint.com
|
|
167
|
+
# @param site_id Site ID (GUID) of the SharePoint site you wish to retrieve the file from
|
|
168
|
+
# @param file_path Path to the file within the drive, such as 'hello.pdf' or '/folder/subfolder/world.pdf'
|
|
169
|
+
# @param [Hash] opts the optional parameters
|
|
170
|
+
# @option opts [String] :tenant_id Optional; Tenant ID of your Azure Active Directory
|
|
171
|
+
# @option opts [BOOLEAN] :allow_executables Set to false to block executable files (program code) from being allowed in the input file. Default is false (recommended).
|
|
172
|
+
# @option opts [BOOLEAN] :allow_invalid_files Set to false to block invalid files, such as a PDF file that is not really a valid PDF file, or a Word Document that is not a valid Word Document. Default is false (recommended).
|
|
173
|
+
# @option opts [BOOLEAN] :allow_scripts Set to false to block script files, such as a PHP files, Python scripts, and other malicious content or security threats that can be embedded in the file. Set to true to allow these file types. Default is false (recommended).
|
|
174
|
+
# @option opts [BOOLEAN] :allow_password_protected_files Set to false to block password protected and encrypted files, such as encrypted zip and rar files, and other files that seek to circumvent scanning through passwords. Set to true to allow these file types. Default is false (recommended).
|
|
175
|
+
# @option opts [BOOLEAN] :allow_macros Set to false to block macros and other threats embedded in document files, such as Word, Excel and PowerPoint embedded Macros, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
176
|
+
# @option opts [BOOLEAN] :allow_xml_external_entities Set to false to block XML External Entities and other threats embedded in XML files, and other files that contain embedded content threats. Set to true to allow these file types. Default is false (recommended).
|
|
177
|
+
# @option opts [String] :restrict_file_types Specify a restricted set of file formats to allow as clean as a comma-separated list of file formats, such as .pdf,.docx,.png would allow only PDF, PNG and Word document files. All files must pass content verification against this list of file formats, if they do not, then the result will be returned as CleanResult=false. Set restrictFileTypes parameter to null or empty string to disable; default is disabled.
|
|
178
|
+
# @return [CloudStorageAdvancedVirusScanResult]
|
|
179
|
+
describe 'scan_cloud_storage_scan_share_point_online_file_advanced test' do
|
|
180
|
+
it 'should work' do
|
|
181
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
|
182
|
+
end
|
|
183
|
+
end
|
|
184
|
+
|
|
141
185
|
end
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: cloudmersive-virus-scan-api-client
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 2.0.
|
|
4
|
+
version: 2.0.7
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Cloudmersive
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-
|
|
11
|
+
date: 2021-09-27 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|