akeyless 5.0.18 → 5.0.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +9 -1
- data/docs/CertificateDiscovery.md +34 -0
- data/docs/CertificateDiscoveryOutput.md +18 -0
- data/docs/CertificateMigration.md +20 -0
- data/docs/CertificatePayload.md +30 -0
- data/docs/CertificateScanTarget.md +20 -0
- data/docs/CreateRole.md +5 -5
- data/docs/GatewayCreateMigration.md +7 -1
- data/docs/GatewayUpdateMigration.md +6 -0
- data/docs/MigrationsConfigPart.md +2 -0
- data/docs/ScanResults.md +32 -0
- data/docs/TargetError.md +22 -0
- data/docs/UpdateRole.md +5 -5
- data/docs/UscDelete.md +2 -0
- data/docs/V2Api.md +65 -2
- data/lib/akeyless/api/v2_api.rb +64 -0
- data/lib/akeyless/models/certificate_discovery.rb +318 -0
- data/lib/akeyless/models/certificate_discovery_output.rb +214 -0
- data/lib/akeyless/models/certificate_migration.rb +223 -0
- data/lib/akeyless/models/certificate_payload.rb +272 -0
- data/lib/akeyless/models/certificate_scan_target.rb +223 -0
- data/lib/akeyless/models/create_role.rb +5 -5
- data/lib/akeyless/models/gateway_create_migration.rb +43 -2
- data/lib/akeyless/models/gateway_update_migration.rb +42 -1
- data/lib/akeyless/models/migrations_config_part.rb +12 -1
- data/lib/akeyless/models/scan_results.rb +282 -0
- data/lib/akeyless/models/target_error.rb +233 -0
- data/lib/akeyless/models/update_role.rb +5 -5
- data/lib/akeyless/models/usc_delete.rb +11 -1
- data/lib/akeyless/version.rb +1 -1
- data/lib/akeyless.rb +7 -0
- data/spec/models/certificate_discovery_output_spec.rb +36 -0
- data/spec/models/certificate_discovery_spec.rb +84 -0
- data/spec/models/certificate_migration_spec.rb +42 -0
- data/spec/models/certificate_payload_spec.rb +72 -0
- data/spec/models/certificate_scan_target_spec.rb +42 -0
- data/spec/models/scan_results_spec.rb +78 -0
- data/spec/models/target_error_spec.rb +48 -0
- metadata +30 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: '06069ce01fc049c064314aa478e51a6452b825df093942c9c22058a21becbb49'
|
|
4
|
+
data.tar.gz: 70d4fd955788d83e20eaeaa51f18287c7d017d389a15fd9ec63b9edc5897ece8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 45960f7a5a0df7034fb1fc999641f3d1356a8cc9a95d61bd7a6f34df6243537894b4c3389e0b274da32631f6d4d3f01dcf6e28483bed26f63a7d0d5249ecfb71
|
|
7
|
+
data.tar.gz: a2bb67cad1e05686881720f441248c69e6176ae3576231aa902372ef2c76de6dc1cb7aeddcaf36f8086b6eee0eb52d692a9fb419739445a6a60aa348b1461966
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ The purpose of this application is to provide access to Akeyless API.
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
9
|
- API version: 3.0
|
|
10
|
-
- Package version: 5.0.
|
|
10
|
+
- Package version: 5.0.19
|
|
11
11
|
- Generator version: 7.10.0
|
|
12
12
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
13
13
|
For more information, please visit [http://akeyless.io](http://akeyless.io)
|
|
@@ -101,6 +101,7 @@ Class | Method | HTTP request | Description
|
|
|
101
101
|
*Akeyless::V2Api* | [**auth_method_update_saml**](docs/V2Api.md#auth_method_update_saml) | **POST** /auth-method-update-saml |
|
|
102
102
|
*Akeyless::V2Api* | [**auth_method_update_universal_identity**](docs/V2Api.md#auth_method_update_universal_identity) | **POST** /auth-method-update-universal-identity |
|
|
103
103
|
*Akeyless::V2Api* | [**calc_password_security_info**](docs/V2Api.md#calc_password_security_info) | **POST** /calc-password-security-info |
|
|
104
|
+
*Akeyless::V2Api* | [**certificate_discovery**](docs/V2Api.md#certificate_discovery) | **POST** /certificate-discovery |
|
|
104
105
|
*Akeyless::V2Api* | [**change_admin_account_password**](docs/V2Api.md#change_admin_account_password) | **POST** /change-admin-account-password |
|
|
105
106
|
*Akeyless::V2Api* | [**configure**](docs/V2Api.md#configure) | **POST** /configure |
|
|
106
107
|
*Akeyless::V2Api* | [**connect**](docs/V2Api.md#connect) | **POST** /connect |
|
|
@@ -755,10 +756,15 @@ Class | Method | HTTP request | Description
|
|
|
755
756
|
- [Akeyless::CertAccessRules](docs/CertAccessRules.md)
|
|
756
757
|
- [Akeyless::CertificateAnalyticAggregation](docs/CertificateAnalyticAggregation.md)
|
|
757
758
|
- [Akeyless::CertificateChainInfo](docs/CertificateChainInfo.md)
|
|
759
|
+
- [Akeyless::CertificateDiscovery](docs/CertificateDiscovery.md)
|
|
760
|
+
- [Akeyless::CertificateDiscoveryOutput](docs/CertificateDiscoveryOutput.md)
|
|
758
761
|
- [Akeyless::CertificateExpirationEvent](docs/CertificateExpirationEvent.md)
|
|
759
762
|
- [Akeyless::CertificateExpirationEventsSettings](docs/CertificateExpirationEventsSettings.md)
|
|
760
763
|
- [Akeyless::CertificateInfo](docs/CertificateInfo.md)
|
|
761
764
|
- [Akeyless::CertificateIssueInfo](docs/CertificateIssueInfo.md)
|
|
765
|
+
- [Akeyless::CertificateMigration](docs/CertificateMigration.md)
|
|
766
|
+
- [Akeyless::CertificatePayload](docs/CertificatePayload.md)
|
|
767
|
+
- [Akeyless::CertificateScanTarget](docs/CertificateScanTarget.md)
|
|
762
768
|
- [Akeyless::CertificateStore](docs/CertificateStore.md)
|
|
763
769
|
- [Akeyless::CertificateTemplateInfo](docs/CertificateTemplateInfo.md)
|
|
764
770
|
- [Akeyless::CertificateVersionInfo](docs/CertificateVersionInfo.md)
|
|
@@ -1529,6 +1535,7 @@ Class | Method | HTTP request | Description
|
|
|
1529
1535
|
- [Akeyless::SSHCertificateIssueDetails](docs/SSHCertificateIssueDetails.md)
|
|
1530
1536
|
- [Akeyless::SSHTargetDetails](docs/SSHTargetDetails.md)
|
|
1531
1537
|
- [Akeyless::SalesforceTargetDetails](docs/SalesforceTargetDetails.md)
|
|
1538
|
+
- [Akeyless::ScanResults](docs/ScanResults.md)
|
|
1532
1539
|
- [Akeyless::SecretInfo](docs/SecretInfo.md)
|
|
1533
1540
|
- [Akeyless::SecretSyncOutput](docs/SecretSyncOutput.md)
|
|
1534
1541
|
- [Akeyless::SectigoTargetDetails](docs/SectigoTargetDetails.md)
|
|
@@ -1603,6 +1610,7 @@ Class | Method | HTTP request | Description
|
|
|
1603
1610
|
- [Akeyless::TargetCreateWindows](docs/TargetCreateWindows.md)
|
|
1604
1611
|
- [Akeyless::TargetCreateZeroSSL](docs/TargetCreateZeroSSL.md)
|
|
1605
1612
|
- [Akeyless::TargetDelete](docs/TargetDelete.md)
|
|
1613
|
+
- [Akeyless::TargetError](docs/TargetError.md)
|
|
1606
1614
|
- [Akeyless::TargetGet](docs/TargetGet.md)
|
|
1607
1615
|
- [Akeyless::TargetGetDetails](docs/TargetGetDetails.md)
|
|
1608
1616
|
- [Akeyless::TargetItemAssociation](docs/TargetItemAssociation.md)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Akeyless::CertificateDiscovery
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **debug** | **Boolean** | Debug mode | [optional][default to false] |
|
|
8
|
+
| **expiration_event_in** | **Array<String>** | How many days before the expiration of the certificate would you like to be notified. | [optional] |
|
|
9
|
+
| **hosts** | **String** | A comma separated list of IPs, CIDR ranges, or DNS names to discovery | |
|
|
10
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
11
|
+
| **port_ranges** | **String** | A comma separated list of port ranges Examples: \"80,443\" or \"80,443,8080-8090\" or \"443\" | [optional][default to '443'] |
|
|
12
|
+
| **protection_key** | **String** | The name of the key that protects the certificate value | [optional] |
|
|
13
|
+
| **target_location** | **String** | The folder where the results will be saved | |
|
|
14
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
15
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'akeyless'
|
|
21
|
+
|
|
22
|
+
instance = Akeyless::CertificateDiscovery.new(
|
|
23
|
+
debug: null,
|
|
24
|
+
expiration_event_in: null,
|
|
25
|
+
hosts: null,
|
|
26
|
+
json: null,
|
|
27
|
+
port_ranges: null,
|
|
28
|
+
protection_key: null,
|
|
29
|
+
target_location: null,
|
|
30
|
+
token: null,
|
|
31
|
+
uid_token: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Akeyless::CertificateDiscoveryOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **results** | [**ScanResults**](ScanResults.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'akeyless'
|
|
13
|
+
|
|
14
|
+
instance = Akeyless::CertificateDiscoveryOutput.new(
|
|
15
|
+
results: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Akeyless::CertificateMigration
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **general** | [**MigrationGeneral**](MigrationGeneral.md) | | [optional] |
|
|
8
|
+
| **payload** | [**CertificatePayload**](CertificatePayload.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'akeyless'
|
|
14
|
+
|
|
15
|
+
instance = Akeyless::CertificateMigration.new(
|
|
16
|
+
general: null,
|
|
17
|
+
payload: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Akeyless::CertificatePayload
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **expiration_events** | [**Array<CertificateExpirationEvent>**](CertificateExpirationEvent.md) | | [optional] |
|
|
8
|
+
| **folder** | **String** | | [optional] |
|
|
9
|
+
| **max_dial_timeout** | **Integer** | | [optional] |
|
|
10
|
+
| **max_scan_duration** | **Integer** | | [optional] |
|
|
11
|
+
| **max_workers** | **Integer** | | [optional] |
|
|
12
|
+
| **port_ranges** | **String** | | [optional] |
|
|
13
|
+
| **targets** | [**Array<CertificateScanTarget>**](CertificateScanTarget.md) | | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'akeyless'
|
|
19
|
+
|
|
20
|
+
instance = Akeyless::CertificatePayload.new(
|
|
21
|
+
expiration_events: null,
|
|
22
|
+
folder: null,
|
|
23
|
+
max_dial_timeout: null,
|
|
24
|
+
max_scan_duration: null,
|
|
25
|
+
max_workers: null,
|
|
26
|
+
port_ranges: null,
|
|
27
|
+
targets: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Akeyless::CertificateScanTarget
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **host** | **String** | | [optional] |
|
|
8
|
+
| **port_ranges** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'akeyless'
|
|
14
|
+
|
|
15
|
+
instance = Akeyless::CertificateScanTarget.new(
|
|
16
|
+
host: null,
|
|
17
|
+
port_ranges: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/CreateRole.md
CHANGED
|
@@ -5,18 +5,18 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **analytics_access** | **String** | Allow this role to view analytics. Currently only 'none', 'own', 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods. | [optional] |
|
|
8
|
-
| **audit_access** | **String** | Allow this role to view audit logs. Currently only 'none', 'own' and 'all' values are supported, allowing associated auth methods to view audit logs produced by the same auth methods. | [optional] |
|
|
8
|
+
| **audit_access** | **String** | Allow this role to view audit logs. Currently only 'none', 'own', 'scoped' and 'all' values are supported, allowing associated auth methods to view audit logs produced by the same auth methods. | [optional] |
|
|
9
9
|
| **comment** | **String** | Deprecated - use description | [optional] |
|
|
10
10
|
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
11
11
|
| **description** | **String** | Description of the object | [optional] |
|
|
12
|
-
| **event_center_access** | **String** | Allow this role to view Event Center. Currently only 'none', '
|
|
12
|
+
| **event_center_access** | **String** | Allow this role to view Event Center. Currently only 'none', 'scoped' and 'all' values are supported | [optional] |
|
|
13
13
|
| **event_forwarders_access** | **String** | Allow this role to manage Event Forwarders. Currently only 'none' and 'all' values are supported. | [optional] |
|
|
14
14
|
| **event_forwarders_name** | **Array<String>** | Allow this role to manage the following Event Forwarders. | [optional] |
|
|
15
|
-
| **gw_analytics_access** | **String** | Allow this role to view gw analytics. Currently only 'none', '
|
|
15
|
+
| **gw_analytics_access** | **String** | Allow this role to view gw analytics. Currently only 'none', 'scoped', 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods. | [optional] |
|
|
16
16
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
17
17
|
| **name** | **String** | Role name | |
|
|
18
|
-
| **reverse_rbac_access** | **String** | Allow this role to view Reverse RBAC. Supported values: '
|
|
19
|
-
| **sra_reports_access** | **String** | Allow this role to view SRA Clusters. Currently only 'none', '
|
|
18
|
+
| **reverse_rbac_access** | **String** | Allow this role to view Reverse RBAC. Supported values: 'scoped', 'all'. | [optional] |
|
|
19
|
+
| **sra_reports_access** | **String** | Allow this role to view SRA Clusters. Currently only 'none', 'scoped', 'all' values are supported. | [optional] |
|
|
20
20
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
21
21
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
22
22
|
| **usage_reports_access** | **String** | Allow this role to view Usage Report. Currently only 'none' and 'all' values are supported. | [optional] |
|
|
@@ -35,11 +35,13 @@
|
|
|
35
35
|
| **azure_kv_name** | **String** | Azure Key Vault Name (relevant only for Azure Key Vault migration) | [optional] |
|
|
36
36
|
| **azure_secret** | **String** | Azure Key Vault secret (relevant only for Azure Key Vault migration) | [optional] |
|
|
37
37
|
| **azure_tenant_id** | **String** | Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration) | [optional] |
|
|
38
|
+
| **expiration_event_in** | **Array<String>** | How many days before the expiration of the certificate would you like to be notified. | [optional] |
|
|
38
39
|
| **gcp_key** | **String** | Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration) | [optional] |
|
|
39
40
|
| **hashi_json** | **String** | Import secret key as json value or independent secrets (relevant only for HasiCorp Vault migration) [true/false] | [optional][default to 'true'] |
|
|
40
41
|
| **hashi_ns** | **Array<String>** | HashiCorp Vault Namespaces is a comma-separated list of namespaces which need to be imported into Akeyless Vault. For every provided namespace, all its child namespaces are imported as well, e.g. nmsp/subnmsp1/subnmsp2,nmsp/anothernmsp. By default, import all namespaces (relevant only for HasiCorp Vault migration) | [optional] |
|
|
41
42
|
| **hashi_token** | **String** | HashiCorp Vault access token with sufficient permissions to preform list & read operations on secrets objects (relevant only for HasiCorp Vault migration) | [optional] |
|
|
42
43
|
| **hashi_url** | **String** | HashiCorp Vault API URL, e.g. https://vault-mgr01:8200 (relevant only for HasiCorp Vault migration) | [optional] |
|
|
44
|
+
| **hosts** | **String** | A comma separated list of IPs, CIDR ranges, or DNS names to scan | |
|
|
43
45
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
44
46
|
| **k8s_ca_certificate** | **Array<Integer>** | For Certificate Authentication method K8s Cluster CA certificate (relevant only for K8s migration with Certificate Authentication method) | [optional] |
|
|
45
47
|
| **k8s_client_certificate** | **Array<Integer>** | K8s Client certificate with sufficient permission to list and get secrets in the namespace(s) you selected (relevant only for K8s migration with Certificate Authentication method) | [optional] |
|
|
@@ -51,6 +53,7 @@
|
|
|
51
53
|
| **k8s_url** | **String** | K8s API Server URL, e.g. https://k8s-api.mycompany.com:6443 (relevant only for K8s migration) | [optional] |
|
|
52
54
|
| **k8s_username** | **String** | For Password Authentication method K8s Client username with sufficient permission to list and get secrets in the namespace(s) you selected (relevant only for K8s migration with Password Authentication method) | [optional] |
|
|
53
55
|
| **name** | **String** | Migration name | |
|
|
56
|
+
| **port_ranges** | **String** | A comma separated list of port ranges Examples: \"80,443\" or \"80,443,8080-8090\" or \"443\" | [optional][default to '443'] |
|
|
54
57
|
| **protection_key** | **String** | The name of the key that protects the classic key value (if empty, the account default key will be used) | [optional] |
|
|
55
58
|
| **si_auto_rotate** | **String** | Enable/Disable automatic/recurrent rotation for migrated secrets. Default is false: only manual rotation is allowed for migrated secrets. If set to true, this command should be combined with --si-rotation-interval and --si-rotation-hour parameters (Relevant only for Server Inventory migration) | [optional] |
|
|
56
59
|
| **si_rotation_hour** | **Integer** | The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration) | [optional] |
|
|
@@ -62,7 +65,7 @@
|
|
|
62
65
|
| **si_users_path_template** | **String** | Path location template for migrating users as Rotated Secrets e.g.: .../Users/{{COMPUTER_NAME}}/{{USERNAME}} (Relevant only for Server Inventory migration) | |
|
|
63
66
|
| **target_location** | **String** | Target location in Akeyless for imported secrets | |
|
|
64
67
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
65
|
-
| **type** | **String** | Migration type (hashi/aws/gcp/k8s/azure_kv/active_directory) | [optional] |
|
|
68
|
+
| **type** | **String** | Migration type (hashi/aws/gcp/k8s/azure_kv/active_directory/server_inventory/certificate) | [optional] |
|
|
66
69
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
67
70
|
|
|
68
71
|
## Example
|
|
@@ -102,11 +105,13 @@ instance = Akeyless::GatewayCreateMigration.new(
|
|
|
102
105
|
azure_kv_name: null,
|
|
103
106
|
azure_secret: null,
|
|
104
107
|
azure_tenant_id: null,
|
|
108
|
+
expiration_event_in: null,
|
|
105
109
|
gcp_key: null,
|
|
106
110
|
hashi_json: null,
|
|
107
111
|
hashi_ns: null,
|
|
108
112
|
hashi_token: null,
|
|
109
113
|
hashi_url: null,
|
|
114
|
+
hosts: null,
|
|
110
115
|
json: null,
|
|
111
116
|
k8s_ca_certificate: null,
|
|
112
117
|
k8s_client_certificate: null,
|
|
@@ -118,6 +123,7 @@ instance = Akeyless::GatewayCreateMigration.new(
|
|
|
118
123
|
k8s_url: null,
|
|
119
124
|
k8s_username: null,
|
|
120
125
|
name: null,
|
|
126
|
+
port_ranges: null,
|
|
121
127
|
protection_key: null,
|
|
122
128
|
si_auto_rotate: null,
|
|
123
129
|
si_rotation_hour: null,
|
|
@@ -35,11 +35,13 @@
|
|
|
35
35
|
| **azure_kv_name** | **String** | Azure Key Vault Name (relevant only for Azure Key Vault migration) | [optional] |
|
|
36
36
|
| **azure_secret** | **String** | Azure Key Vault secret (relevant only for Azure Key Vault migration) | [optional] |
|
|
37
37
|
| **azure_tenant_id** | **String** | Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration) | [optional] |
|
|
38
|
+
| **expiration_event_in** | **Array<String>** | How many days before the expiration of the certificate would you like to be notified. | [optional] |
|
|
38
39
|
| **gcp_key** | **String** | Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration) | [optional] |
|
|
39
40
|
| **hashi_json** | **String** | Import secret key as json value or independent secrets (relevant only for HasiCorp Vault migration) [true/false] | [optional][default to 'true'] |
|
|
40
41
|
| **hashi_ns** | **Array<String>** | HashiCorp Vault Namespaces is a comma-separated list of namespaces which need to be imported into Akeyless Vault. For every provided namespace, all its child namespaces are imported as well, e.g. nmsp/subnmsp1/subnmsp2,nmsp/anothernmsp. By default, import all namespaces (relevant only for HasiCorp Vault migration) | [optional] |
|
|
41
42
|
| **hashi_token** | **String** | HashiCorp Vault access token with sufficient permissions to preform list & read operations on secrets objects (relevant only for HasiCorp Vault migration) | [optional] |
|
|
42
43
|
| **hashi_url** | **String** | HashiCorp Vault API URL, e.g. https://vault-mgr01:8200 (relevant only for HasiCorp Vault migration) | [optional] |
|
|
44
|
+
| **hosts** | **String** | A comma separated list of IPs, CIDR ranges, or DNS names to scan | |
|
|
43
45
|
| **id** | **String** | Migration ID (Can be retrieved with gateway-list-migration command) | [optional] |
|
|
44
46
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
45
47
|
| **k8s_ca_certificate** | **Array<Integer>** | For Certificate Authentication method K8s Cluster CA certificate (relevant only for K8s migration with Certificate Authentication method) | [optional] |
|
|
@@ -53,6 +55,7 @@
|
|
|
53
55
|
| **k8s_username** | **String** | For Password Authentication method K8s Client username with sufficient permission to list and get secrets in the namespace(s) you selected (relevant only for K8s migration with Password Authentication method) | [optional] |
|
|
54
56
|
| **name** | **String** | Migration name | [optional] |
|
|
55
57
|
| **new_name** | **String** | New migration name | [optional] |
|
|
58
|
+
| **port_ranges** | **String** | A comma separated list of port ranges Examples: \"80,443\" or \"80,443,8080-8090\" or \"443\" | [optional][default to '443'] |
|
|
56
59
|
| **protection_key** | **String** | The name of the key that protects the classic key value (if empty, the account default key will be used) | [optional] |
|
|
57
60
|
| **si_auto_rotate** | **String** | Enable/Disable automatic/recurrent rotation for migrated secrets. Default is false: only manual rotation is allowed for migrated secrets. If set to true, this command should be combined with --si-rotation-interval and --si-rotation-hour parameters (Relevant only for Server Inventory migration) | [optional] |
|
|
58
61
|
| **si_rotation_hour** | **Integer** | The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration) | [optional] |
|
|
@@ -103,11 +106,13 @@ instance = Akeyless::GatewayUpdateMigration.new(
|
|
|
103
106
|
azure_kv_name: null,
|
|
104
107
|
azure_secret: null,
|
|
105
108
|
azure_tenant_id: null,
|
|
109
|
+
expiration_event_in: null,
|
|
106
110
|
gcp_key: null,
|
|
107
111
|
hashi_json: null,
|
|
108
112
|
hashi_ns: null,
|
|
109
113
|
hashi_token: null,
|
|
110
114
|
hashi_url: null,
|
|
115
|
+
hosts: null,
|
|
111
116
|
id: null,
|
|
112
117
|
json: null,
|
|
113
118
|
k8s_ca_certificate: null,
|
|
@@ -121,6 +126,7 @@ instance = Akeyless::GatewayUpdateMigration.new(
|
|
|
121
126
|
k8s_username: null,
|
|
122
127
|
name: null,
|
|
123
128
|
new_name: null,
|
|
129
|
+
port_ranges: null,
|
|
124
130
|
protection_key: null,
|
|
125
131
|
si_auto_rotate: null,
|
|
126
132
|
si_rotation_hour: null,
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **active_directory_migrations** | [**Array<ActiveDirectoryMigration>**](ActiveDirectoryMigration.md) | | [optional] |
|
|
8
8
|
| **aws_secrets_migrations** | [**Array<AWSSecretsMigration>**](AWSSecretsMigration.md) | | [optional] |
|
|
9
9
|
| **azure_kv_migrations** | [**Array<AzureKeyVaultMigration>**](AzureKeyVaultMigration.md) | | [optional] |
|
|
10
|
+
| **certificate_migrations** | [**Array<CertificateMigration>**](CertificateMigration.md) | | [optional] |
|
|
10
11
|
| **gcp_secrets_migrations** | [**Array<GCPSecretsMigration>**](GCPSecretsMigration.md) | | [optional] |
|
|
11
12
|
| **hashi_migrations** | [**Array<HashiMigration>**](HashiMigration.md) | | [optional] |
|
|
12
13
|
| **k8s_migrations** | [**Array<K8SMigration>**](K8SMigration.md) | | [optional] |
|
|
@@ -23,6 +24,7 @@ instance = Akeyless::MigrationsConfigPart.new(
|
|
|
23
24
|
active_directory_migrations: null,
|
|
24
25
|
aws_secrets_migrations: null,
|
|
25
26
|
azure_kv_migrations: null,
|
|
27
|
+
certificate_migrations: null,
|
|
26
28
|
gcp_secrets_migrations: null,
|
|
27
29
|
hashi_migrations: null,
|
|
28
30
|
k8s_migrations: null,
|
data/docs/ScanResults.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Akeyless::ScanResults
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **count_existing** | **Integer** | | [optional] |
|
|
8
|
+
| **count_failed** | **Integer** | | [optional] |
|
|
9
|
+
| **count_hosts** | **Integer** | | [optional] |
|
|
10
|
+
| **count_new** | **Integer** | | [optional] |
|
|
11
|
+
| **count_subdomains** | **Integer** | | [optional] |
|
|
12
|
+
| **error** | **String** | | [optional] |
|
|
13
|
+
| **failed_targets** | [**Array<TargetError>**](TargetError.md) | | [optional] |
|
|
14
|
+
| **item_names** | **Array<String>** | | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'akeyless'
|
|
20
|
+
|
|
21
|
+
instance = Akeyless::ScanResults.new(
|
|
22
|
+
count_existing: null,
|
|
23
|
+
count_failed: null,
|
|
24
|
+
count_hosts: null,
|
|
25
|
+
count_new: null,
|
|
26
|
+
count_subdomains: null,
|
|
27
|
+
error: null,
|
|
28
|
+
failed_targets: null,
|
|
29
|
+
item_names: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
data/docs/TargetError.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Akeyless::TargetError
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **error** | **String** | | [optional] |
|
|
8
|
+
| **host** | **String** | | [optional] |
|
|
9
|
+
| **port** | **Integer** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'akeyless'
|
|
15
|
+
|
|
16
|
+
instance = Akeyless::TargetError.new(
|
|
17
|
+
error: null,
|
|
18
|
+
host: null,
|
|
19
|
+
port: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/UpdateRole.md
CHANGED
|
@@ -5,18 +5,18 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **analytics_access** | **String** | Allow this role to view analytics. Currently only 'none', 'own', 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods. | [optional] |
|
|
8
|
-
| **audit_access** | **String** | Allow this role to view audit logs. Currently only 'none', 'own' and 'all' values are supported, allowing associated auth methods to view audit logs produced by the same auth methods. | [optional] |
|
|
8
|
+
| **audit_access** | **String** | Allow this role to view audit logs. Currently only 'none', 'own', 'scoped' and 'all' values are supported, allowing associated auth methods to view audit logs produced by the same auth methods. | [optional] |
|
|
9
9
|
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
10
10
|
| **description** | **String** | Description of the object | [optional][default to 'default_comment'] |
|
|
11
|
-
| **event_center_access** | **String** | Allow this role to view Event Center. Currently only 'none', '
|
|
11
|
+
| **event_center_access** | **String** | Allow this role to view Event Center. Currently only 'none', 'scoped' and 'all' values are supported | [optional] |
|
|
12
12
|
| **event_forwarder_access** | **String** | Allow this role to manage Event Forwarders. Currently only 'none' and 'all' values are supported. | [optional] |
|
|
13
|
-
| **gw_analytics_access** | **String** | Allow this role to view gw analytics. Currently only 'none', '
|
|
13
|
+
| **gw_analytics_access** | **String** | Allow this role to view gw analytics. Currently only 'none', 'scoped', 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods. | [optional] |
|
|
14
14
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
15
15
|
| **name** | **String** | Role name | |
|
|
16
16
|
| **new_comment** | **String** | Deprecated - use description | [optional][default to 'default_comment'] |
|
|
17
17
|
| **new_name** | **String** | New Role name | [optional] |
|
|
18
|
-
| **reverse_rbac_access** | **String** | Allow this role to view Reverse RBAC. Supported values: '
|
|
19
|
-
| **sra_reports_access** | **String** | Allow this role to view SRA Clusters. Currently only 'none', '
|
|
18
|
+
| **reverse_rbac_access** | **String** | Allow this role to view Reverse RBAC. Supported values: 'scoped', 'all'. | [optional] |
|
|
19
|
+
| **sra_reports_access** | **String** | Allow this role to view SRA Clusters. Currently only 'none', 'scoped', 'all' values are supported. | [optional] |
|
|
20
20
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
21
21
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
22
22
|
| **usage_reports_access** | **String** | Allow this role to view Usage Report. Currently only 'none' and 'all' values are supported. | [optional] |
|
data/docs/UscDelete.md
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **force_delete** | **Boolean** | Force delete objects that are soft deleted by default (relavent only for Azure target) | [optional] |
|
|
7
8
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
8
9
|
| **namespace** | **String** | The namespace (relevant for Hashi vault target) | [optional] |
|
|
9
10
|
| **secret_id** | **String** | The universal secrets id (or name, for AWS, Azure, K8s or Hashi vault targets) to delete | |
|
|
@@ -17,6 +18,7 @@
|
|
|
17
18
|
require 'akeyless'
|
|
18
19
|
|
|
19
20
|
instance = Akeyless::UscDelete.new(
|
|
21
|
+
force_delete: null,
|
|
20
22
|
json: null,
|
|
21
23
|
namespace: null,
|
|
22
24
|
secret_id: null,
|
data/docs/V2Api.md
CHANGED
|
@@ -45,6 +45,7 @@ All URIs are relative to *https://api.akeyless.io*
|
|
|
45
45
|
| [**auth_method_update_saml**](V2Api.md#auth_method_update_saml) | **POST** /auth-method-update-saml | |
|
|
46
46
|
| [**auth_method_update_universal_identity**](V2Api.md#auth_method_update_universal_identity) | **POST** /auth-method-update-universal-identity | |
|
|
47
47
|
| [**calc_password_security_info**](V2Api.md#calc_password_security_info) | **POST** /calc-password-security-info | |
|
|
48
|
+
| [**certificate_discovery**](V2Api.md#certificate_discovery) | **POST** /certificate-discovery | |
|
|
48
49
|
| [**change_admin_account_password**](V2Api.md#change_admin_account_password) | **POST** /change-admin-account-password | |
|
|
49
50
|
| [**configure**](V2Api.md#configure) | **POST** /configure | |
|
|
50
51
|
| [**connect**](V2Api.md#connect) | **POST** /connect | |
|
|
@@ -3141,6 +3142,68 @@ No authorization required
|
|
|
3141
3142
|
- **Accept**: application/json
|
|
3142
3143
|
|
|
3143
3144
|
|
|
3145
|
+
## certificate_discovery
|
|
3146
|
+
|
|
3147
|
+
> <CertificateDiscoveryOutput> certificate_discovery(certificate_discovery)
|
|
3148
|
+
|
|
3149
|
+
|
|
3150
|
+
|
|
3151
|
+
### Examples
|
|
3152
|
+
|
|
3153
|
+
```ruby
|
|
3154
|
+
require 'time'
|
|
3155
|
+
require 'akeyless'
|
|
3156
|
+
|
|
3157
|
+
api_instance = Akeyless::V2Api.new
|
|
3158
|
+
certificate_discovery = Akeyless::CertificateDiscovery.new({hosts: 'hosts_example', target_location: 'target_location_example'}) # CertificateDiscovery |
|
|
3159
|
+
|
|
3160
|
+
begin
|
|
3161
|
+
|
|
3162
|
+
result = api_instance.certificate_discovery(certificate_discovery)
|
|
3163
|
+
p result
|
|
3164
|
+
rescue Akeyless::ApiError => e
|
|
3165
|
+
puts "Error when calling V2Api->certificate_discovery: #{e}"
|
|
3166
|
+
end
|
|
3167
|
+
```
|
|
3168
|
+
|
|
3169
|
+
#### Using the certificate_discovery_with_http_info variant
|
|
3170
|
+
|
|
3171
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3172
|
+
|
|
3173
|
+
> <Array(<CertificateDiscoveryOutput>, Integer, Hash)> certificate_discovery_with_http_info(certificate_discovery)
|
|
3174
|
+
|
|
3175
|
+
```ruby
|
|
3176
|
+
begin
|
|
3177
|
+
|
|
3178
|
+
data, status_code, headers = api_instance.certificate_discovery_with_http_info(certificate_discovery)
|
|
3179
|
+
p status_code # => 2xx
|
|
3180
|
+
p headers # => { ... }
|
|
3181
|
+
p data # => <CertificateDiscoveryOutput>
|
|
3182
|
+
rescue Akeyless::ApiError => e
|
|
3183
|
+
puts "Error when calling V2Api->certificate_discovery_with_http_info: #{e}"
|
|
3184
|
+
end
|
|
3185
|
+
```
|
|
3186
|
+
|
|
3187
|
+
### Parameters
|
|
3188
|
+
|
|
3189
|
+
| Name | Type | Description | Notes |
|
|
3190
|
+
| ---- | ---- | ----------- | ----- |
|
|
3191
|
+
| **certificate_discovery** | [**CertificateDiscovery**](CertificateDiscovery.md) | | |
|
|
3192
|
+
|
|
3193
|
+
### Return type
|
|
3194
|
+
|
|
3195
|
+
[**CertificateDiscoveryOutput**](CertificateDiscoveryOutput.md)
|
|
3196
|
+
|
|
3197
|
+
### Authorization
|
|
3198
|
+
|
|
3199
|
+
No authorization required
|
|
3200
|
+
|
|
3201
|
+
### HTTP request headers
|
|
3202
|
+
|
|
3203
|
+
- **Content-Type**: application/json
|
|
3204
|
+
- **Accept**: application/json
|
|
3205
|
+
|
|
3206
|
+
|
|
3144
3207
|
## change_admin_account_password
|
|
3145
3208
|
|
|
3146
3209
|
> Object change_admin_account_password(change_admin_account_password)
|
|
@@ -14254,7 +14317,7 @@ require 'time'
|
|
|
14254
14317
|
require 'akeyless'
|
|
14255
14318
|
|
|
14256
14319
|
api_instance = Akeyless::V2Api.new
|
|
14257
|
-
gateway_create_migration = Akeyless::GatewayCreateMigration.new({name: 'name_example', si_target_name: 'si_target_name_example', si_users_path_template: 'si_users_path_template_example', target_location: 'target_location_example'}) # GatewayCreateMigration |
|
|
14320
|
+
gateway_create_migration = Akeyless::GatewayCreateMigration.new({hosts: 'hosts_example', name: 'name_example', si_target_name: 'si_target_name_example', si_users_path_template: 'si_users_path_template_example', target_location: 'target_location_example'}) # GatewayCreateMigration |
|
|
14258
14321
|
|
|
14259
14322
|
begin
|
|
14260
14323
|
|
|
@@ -18597,7 +18660,7 @@ require 'time'
|
|
|
18597
18660
|
require 'akeyless'
|
|
18598
18661
|
|
|
18599
18662
|
api_instance = Akeyless::V2Api.new
|
|
18600
|
-
gateway_update_migration = Akeyless::GatewayUpdateMigration.new({si_target_name: 'si_target_name_example', si_users_path_template: 'si_users_path_template_example', target_location: 'target_location_example'}) # GatewayUpdateMigration |
|
|
18663
|
+
gateway_update_migration = Akeyless::GatewayUpdateMigration.new({hosts: 'hosts_example', si_target_name: 'si_target_name_example', si_users_path_template: 'si_users_path_template_example', target_location: 'target_location_example'}) # GatewayUpdateMigration |
|
|
18601
18664
|
|
|
18602
18665
|
begin
|
|
18603
18666
|
|
data/lib/akeyless/api/v2_api.rb
CHANGED
|
@@ -2655,6 +2655,70 @@ module Akeyless
|
|
|
2655
2655
|
return data, status_code, headers
|
|
2656
2656
|
end
|
|
2657
2657
|
|
|
2658
|
+
# @param certificate_discovery [CertificateDiscovery]
|
|
2659
|
+
# @param [Hash] opts the optional parameters
|
|
2660
|
+
# @return [CertificateDiscoveryOutput]
|
|
2661
|
+
def certificate_discovery(certificate_discovery, opts = {})
|
|
2662
|
+
data, _status_code, _headers = certificate_discovery_with_http_info(certificate_discovery, opts)
|
|
2663
|
+
data
|
|
2664
|
+
end
|
|
2665
|
+
|
|
2666
|
+
# @param certificate_discovery [CertificateDiscovery]
|
|
2667
|
+
# @param [Hash] opts the optional parameters
|
|
2668
|
+
# @return [Array<(CertificateDiscoveryOutput, Integer, Hash)>] CertificateDiscoveryOutput data, response status code and response headers
|
|
2669
|
+
def certificate_discovery_with_http_info(certificate_discovery, opts = {})
|
|
2670
|
+
if @api_client.config.debugging
|
|
2671
|
+
@api_client.config.logger.debug 'Calling API: V2Api.certificate_discovery ...'
|
|
2672
|
+
end
|
|
2673
|
+
# verify the required parameter 'certificate_discovery' is set
|
|
2674
|
+
if @api_client.config.client_side_validation && certificate_discovery.nil?
|
|
2675
|
+
fail ArgumentError, "Missing the required parameter 'certificate_discovery' when calling V2Api.certificate_discovery"
|
|
2676
|
+
end
|
|
2677
|
+
# resource path
|
|
2678
|
+
local_var_path = '/certificate-discovery'
|
|
2679
|
+
|
|
2680
|
+
# query parameters
|
|
2681
|
+
query_params = opts[:query_params] || {}
|
|
2682
|
+
|
|
2683
|
+
# header parameters
|
|
2684
|
+
header_params = opts[:header_params] || {}
|
|
2685
|
+
# HTTP header 'Accept' (if needed)
|
|
2686
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2687
|
+
# HTTP header 'Content-Type'
|
|
2688
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
2689
|
+
if !content_type.nil?
|
|
2690
|
+
header_params['Content-Type'] = content_type
|
|
2691
|
+
end
|
|
2692
|
+
|
|
2693
|
+
# form parameters
|
|
2694
|
+
form_params = opts[:form_params] || {}
|
|
2695
|
+
|
|
2696
|
+
# http body (model)
|
|
2697
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(certificate_discovery)
|
|
2698
|
+
|
|
2699
|
+
# return_type
|
|
2700
|
+
return_type = opts[:debug_return_type] || 'CertificateDiscoveryOutput'
|
|
2701
|
+
|
|
2702
|
+
# auth_names
|
|
2703
|
+
auth_names = opts[:debug_auth_names] || []
|
|
2704
|
+
|
|
2705
|
+
new_options = opts.merge(
|
|
2706
|
+
:operation => :"V2Api.certificate_discovery",
|
|
2707
|
+
:header_params => header_params,
|
|
2708
|
+
:query_params => query_params,
|
|
2709
|
+
:form_params => form_params,
|
|
2710
|
+
:body => post_body,
|
|
2711
|
+
:auth_names => auth_names,
|
|
2712
|
+
:return_type => return_type
|
|
2713
|
+
)
|
|
2714
|
+
|
|
2715
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
2716
|
+
if @api_client.config.debugging
|
|
2717
|
+
@api_client.config.logger.debug "API called: V2Api#certificate_discovery\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2718
|
+
end
|
|
2719
|
+
return data, status_code, headers
|
|
2720
|
+
end
|
|
2721
|
+
|
|
2658
2722
|
# @param change_admin_account_password [ChangeAdminAccountPassword]
|
|
2659
2723
|
# @param [Hash] opts the optional parameters
|
|
2660
2724
|
# @return [Object]
|