akeyless 5.0.20 → 5.0.22
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 +40 -1
- data/docs/AccountGeneralSettings.md +2 -0
- data/docs/ActiveDirectoryPayload.md +6 -0
- data/docs/Auth.md +2 -0
- data/docs/AuthMethodCreateCert.md +2 -0
- data/docs/AuthMethodUpdateCert.md +2 -0
- data/docs/AzureADAccessRules.md +2 -0
- data/docs/AzureTargetDetails.md +2 -0
- data/docs/CertAccessRules.md +2 -0
- data/docs/CertificateChainInfo.md +2 -0
- data/docs/Configure.md +2 -0
- data/docs/ConjurMigration.md +20 -0
- data/docs/ConjurPayload.md +24 -0
- data/docs/CreateAuthMethodCert.md +2 -0
- data/docs/CreateAzureTarget.md +2 -0
- data/docs/CreateUSC.md +10 -0
- data/docs/DSProducerDetails.md +2 -0
- data/docs/DefaultAuthMethodSettings.md +20 -0
- data/docs/GCPPayload.md +5 -1
- data/docs/GatewayCreateMigration.md +20 -2
- data/docs/GatewayUpdateMigration.md +19 -1
- data/docs/GetPKICertificateOutput.md +2 -0
- data/docs/GithubMetadata.md +28 -0
- data/docs/HTTPChallengeInfo.md +26 -0
- data/docs/IssuerOverviewInfo.md +22 -0
- data/docs/ItemGeneralInfo.md +2 -0
- data/docs/LetsEncryptTargetDetails.md +38 -0
- data/docs/MigrationStatusReplyObj.md +2 -0
- data/docs/MigrationsConfigPart.md +2 -0
- data/docs/PoliciesCreateOutput.md +18 -0
- data/docs/PoliciesDelete.md +24 -0
- data/docs/PoliciesGet.md +24 -0
- data/docs/PoliciesGetOutput.md +18 -0
- data/docs/PoliciesList.md +30 -0
- data/docs/PoliciesListOutput.md +18 -0
- data/docs/PolicyCreateKeys.md +34 -0
- data/docs/PolicyOutput.md +34 -0
- data/docs/PolicyUpdateKeys.md +36 -0
- data/docs/RotatedSecretCreateAws.md +4 -2
- data/docs/RotatedSecretCreateAzure.md +4 -2
- data/docs/RotatedSecretCreateCassandra.md +1 -1
- data/docs/RotatedSecretCreateCustom.md +1 -1
- data/docs/RotatedSecretCreateDockerhub.md +1 -1
- data/docs/RotatedSecretCreateGcp.md +4 -2
- data/docs/RotatedSecretCreateHanadb.md +1 -1
- data/docs/RotatedSecretCreateLdap.md +1 -1
- data/docs/RotatedSecretCreateMongodb.md +1 -1
- data/docs/RotatedSecretCreateMssql.md +1 -1
- data/docs/RotatedSecretCreateMysql.md +1 -1
- data/docs/RotatedSecretCreateOpenAI.md +1 -1
- data/docs/RotatedSecretCreateOracledb.md +1 -1
- data/docs/RotatedSecretCreatePostgresql.md +1 -1
- data/docs/RotatedSecretCreateRedis.md +1 -1
- data/docs/RotatedSecretCreateRedshift.md +1 -1
- data/docs/RotatedSecretCreateSnowflake.md +1 -1
- data/docs/RotatedSecretCreateSplunk.md +68 -0
- data/docs/RotatedSecretCreateSsh.md +1 -1
- data/docs/RotatedSecretCreateWindows.md +1 -1
- data/docs/RotatedSecretDetailsInfo.md +2 -0
- data/docs/RotatedSecretUpdateAws.md +3 -1
- data/docs/RotatedSecretUpdateAzure.md +3 -1
- data/docs/RotatedSecretUpdateGcp.md +3 -1
- data/docs/RotatedSecretUpdateSplunk.md +64 -0
- data/docs/SecretInfo.md +2 -0
- data/docs/SplunkPayload.md +30 -0
- data/docs/SplunkTargetDetails.md +34 -0
- data/docs/TargetCreateAzure.md +2 -0
- data/docs/TargetCreateLetsEncrypt.md +46 -0
- data/docs/TargetCreateSplunk.md +42 -0
- data/docs/TargetTypeDetailsInput.md +4 -0
- data/docs/TargetUpdateAzure.md +2 -0
- data/docs/TargetUpdateLetsEncrypt.md +50 -0
- data/docs/UpdateAuthMethodCert.md +2 -0
- data/docs/UpdateAzureTarget.md +2 -0
- data/docs/V2Api.md +756 -0
- data/docs/ValidateCertificateChallenge.md +30 -0
- data/docs/ValidateCertificateChallengeOutput.md +24 -0
- data/docs/VaultAddress.md +20 -0
- data/docs/VaultAddressOutput.md +20 -0
- data/lib/akeyless/api/v2_api.rb +775 -7
- data/lib/akeyless/models/account_general_settings.rb +10 -1
- data/lib/akeyless/models/active_directory_payload.rb +30 -1
- data/lib/akeyless/models/auth.rb +13 -1
- data/lib/akeyless/models/auth_method_create_cert.rb +11 -1
- data/lib/akeyless/models/auth_method_update_cert.rb +11 -1
- data/lib/akeyless/models/azure_ad_access_rules.rb +11 -1
- data/lib/akeyless/models/azure_target_details.rb +10 -1
- data/lib/akeyless/models/cert_access_rules.rb +11 -1
- data/lib/akeyless/models/certificate_chain_info.rb +11 -1
- data/lib/akeyless/models/configure.rb +13 -1
- data/lib/akeyless/models/conjur_migration.rb +223 -0
- data/lib/akeyless/models/conjur_payload.rb +241 -0
- data/lib/akeyless/models/create_auth_method_cert.rb +11 -1
- data/lib/akeyless/models/create_azure_target.rb +13 -1
- data/lib/akeyless/models/create_usc.rb +54 -1
- data/lib/akeyless/models/default_auth_method_settings.rb +223 -0
- data/lib/akeyless/models/ds_producer_details.rb +10 -1
- data/lib/akeyless/models/gateway_create_migration.rb +97 -5
- data/lib/akeyless/models/gateway_update_migration.rb +96 -4
- data/lib/akeyless/models/gcp_payload.rb +22 -4
- data/lib/akeyless/models/get_pki_certificate_output.rb +10 -1
- data/lib/akeyless/models/github_metadata.rb +259 -0
- data/lib/akeyless/models/http_challenge_info.rb +251 -0
- data/lib/akeyless/models/issuer_overview_info.rb +232 -0
- data/lib/akeyless/models/item_general_info.rb +10 -1
- data/lib/akeyless/models/lets_encrypt_target_details.rb +315 -0
- data/lib/akeyless/models/migration_status_reply_obj.rb +10 -1
- data/lib/akeyless/models/migrations_config_part.rb +12 -1
- data/lib/akeyless/models/policies_create_output.rb +214 -0
- data/lib/akeyless/models/policies_delete.rb +254 -0
- data/lib/akeyless/models/policies_get.rb +254 -0
- data/lib/akeyless/models/policies_get_output.rb +214 -0
- data/lib/akeyless/models/policies_list.rb +283 -0
- data/lib/akeyless/models/policies_list_output.rb +216 -0
- data/lib/akeyless/models/policy_create_keys.rb +312 -0
- data/lib/akeyless/models/policy_output.rb +295 -0
- data/lib/akeyless/models/policy_update_keys.rb +322 -0
- data/lib/akeyless/models/rotated_secret_create_aws.rb +13 -3
- data/lib/akeyless/models/rotated_secret_create_azure.rb +13 -3
- data/lib/akeyless/models/rotated_secret_create_cassandra.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_custom.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_dockerhub.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_gcp.rb +13 -3
- data/lib/akeyless/models/rotated_secret_create_hanadb.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_ldap.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_mongodb.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_mssql.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_mysql.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_open_ai.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_oracledb.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_postgresql.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_redis.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_redshift.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_snowflake.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_splunk.rb +497 -0
- data/lib/akeyless/models/rotated_secret_create_ssh.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_windows.rb +1 -1
- data/lib/akeyless/models/rotated_secret_details_info.rb +10 -1
- data/lib/akeyless/models/rotated_secret_update_aws.rb +12 -2
- data/lib/akeyless/models/rotated_secret_update_azure.rb +12 -2
- data/lib/akeyless/models/rotated_secret_update_gcp.rb +12 -2
- data/lib/akeyless/models/rotated_secret_update_splunk.rb +467 -0
- data/lib/akeyless/models/secret_info.rb +10 -1
- data/lib/akeyless/models/splunk_payload.rb +268 -0
- data/lib/akeyless/models/splunk_target_details.rb +294 -0
- data/lib/akeyless/models/target_create_azure.rb +13 -1
- data/lib/akeyless/models/target_create_lets_encrypt.rb +368 -0
- data/lib/akeyless/models/target_create_splunk.rb +354 -0
- data/lib/akeyless/models/target_type_details_input.rb +19 -1
- data/lib/akeyless/models/target_update_azure.rb +13 -1
- data/lib/akeyless/models/target_update_lets_encrypt.rb +388 -0
- data/lib/akeyless/models/update_auth_method_cert.rb +11 -1
- data/lib/akeyless/models/update_azure_target.rb +13 -1
- data/lib/akeyless/models/validate_certificate_challenge.rb +279 -0
- data/lib/akeyless/models/validate_certificate_challenge_output.rb +242 -0
- data/lib/akeyless/models/vault_address.rb +227 -0
- data/lib/akeyless/models/vault_address_output.rb +223 -0
- data/lib/akeyless/version.rb +1 -1
- data/lib/akeyless.rb +27 -0
- data/spec/models/conjur_migration_spec.rb +42 -0
- data/spec/models/conjur_payload_spec.rb +54 -0
- data/spec/models/default_auth_method_settings_spec.rb +42 -0
- data/spec/models/github_metadata_spec.rb +66 -0
- data/spec/models/http_challenge_info_spec.rb +60 -0
- data/spec/models/issuer_overview_info_spec.rb +48 -0
- data/spec/models/lets_encrypt_target_details_spec.rb +96 -0
- data/spec/models/policies_create_output_spec.rb +36 -0
- data/spec/models/policies_delete_spec.rb +54 -0
- data/spec/models/policies_get_output_spec.rb +36 -0
- data/spec/models/policies_get_spec.rb +54 -0
- data/spec/models/policies_list_output_spec.rb +36 -0
- data/spec/models/policies_list_spec.rb +72 -0
- data/spec/models/policy_create_keys_spec.rb +84 -0
- data/spec/models/policy_output_spec.rb +84 -0
- data/spec/models/policy_update_keys_spec.rb +90 -0
- data/spec/models/rotated_secret_create_splunk_spec.rb +186 -0
- data/spec/models/rotated_secret_update_splunk_spec.rb +174 -0
- data/spec/models/splunk_payload_spec.rb +72 -0
- data/spec/models/splunk_target_details_spec.rb +84 -0
- data/spec/models/target_create_lets_encrypt_spec.rb +120 -0
- data/spec/models/target_create_splunk_spec.rb +108 -0
- data/spec/models/target_update_lets_encrypt_spec.rb +132 -0
- data/spec/models/validate_certificate_challenge_output_spec.rb +54 -0
- data/spec/models/validate_certificate_challenge_spec.rb +72 -0
- data/spec/models/vault_address_output_spec.rb +42 -0
- data/spec/models/vault_address_spec.rb +42 -0
- metadata +109 -1
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **service_account_key_decoded** | **String** | | [optional] |
|
|
8
8
|
| **ad_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 --ad-rotation-interval and --ad-rotation-hour parameters (Relevant only for Active Directory migration) | [optional] |
|
|
9
|
+
| **ad_cert_expiration_event_in** | **Array<String>** | How many days before the expiration of discovered certificates would you like to be notified (Relevant only for Active Directory migration with certificate discovery enabled) | [optional] |
|
|
10
|
+
| **ad_certificates_path_template** | **String** | Path location template for migrating certificates e.g.: /Certificates/{{COMMON_NAME}} (Relevant only for Active Directory migration with certificate discovery enabled) | [optional] |
|
|
9
11
|
| **ad_computer_base_dn** | **String** | Distinguished Name of Computer objects (servers) to search in Active Directory e.g.: CN=Computers,DC=example,DC=com (Relevant only for Active Directory migration) | [optional] |
|
|
10
12
|
| **ad_discover_iis_app** | **String** | Enable/Disable discovery of IIS application from each domain server as part of the SSH/Windows Rotated Secrets. Default is false. (Relevant only for Active Directory migration) | [optional][default to 'false'] |
|
|
11
13
|
| **ad_discover_services** | **String** | Enable/Disable discovery of Windows services from each domain server as part of the SSH/Windows Rotated Secrets. Default is false. (Relevant only for Active Directory migration) | [optional][default to 'false'] |
|
|
@@ -28,6 +30,7 @@
|
|
|
28
30
|
| **ad_winrm_over_http** | **String** | Use WinRM over HTTP, by default runs over HTTPS | [optional][default to 'false'] |
|
|
29
31
|
| **ad_winrm_port** | **String** | Set the WinRM Port for further connection to the domain servers. Default is 5986 (Relevant only for Active Directory migration) | [optional][default to '5986'] |
|
|
30
32
|
| **ad_discover_local_users** | **String** | Enable/Disable discovery of local users from each domain server and migrate them as SSH/Windows Rotated Secrets. Default is false: only domain users will be migrated. Discovery of local users might require further installation of SSH on the servers, based on the supplied computer base DN. This will be implemented automatically as part of the migration process (Relevant only for Active Directory migration) Deprecated: use AdDiscoverTypes | [optional] |
|
|
33
|
+
| **ai_certificate_discovery** | **String** | Enable AI-assisted certificate discovery (only when AI Insight is enabled on the Gateway) | [optional] |
|
|
31
34
|
| **aws_key** | **String** | AWS Secret Access Key (relevant only for AWS migration) | [optional] |
|
|
32
35
|
| **aws_key_id** | **String** | AWS Access Key ID with sufficient permissions to get all secrets, e.g. 'arn:aws:secretsmanager:[Region]:[AccountId]:secret:[/path/to/secrets/*]' (relevant only for AWS migration) | [optional] |
|
|
33
36
|
| **aws_region** | **String** | AWS region of the required Secrets Manager (relevant only for AWS migration) | [optional][default to 'us-east-2'] |
|
|
@@ -35,8 +38,13 @@
|
|
|
35
38
|
| **azure_kv_name** | **String** | Azure Key Vault Name (relevant only for Azure Key Vault migration) | [optional] |
|
|
36
39
|
| **azure_secret** | **String** | Azure Key Vault secret (relevant only for Azure Key Vault migration) | [optional] |
|
|
37
40
|
| **azure_tenant_id** | **String** | Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration) | [optional] |
|
|
41
|
+
| **conjur_account** | **String** | Conjur account name set on your Conjur server (relevant only for Conjur migration). | [optional] |
|
|
42
|
+
| **conjur_api_key** | **String** | Conjur API Key for the specified user (relevant only for Conjur migration). | [optional] |
|
|
43
|
+
| **conjur_url** | **String** | Conjur server base URL (relevant only for Conjur migration). If conjur-url is HTTPS and Conjur uses a private CA/self-signed certificate, make the CA bundle available on the Gateway and set CONJUR_SSL_CERT_PATH to its path. | [optional] |
|
|
44
|
+
| **conjur_username** | **String** | Conjur username used to authenticate (relevant only for Conjur migration). | [optional] |
|
|
38
45
|
| **expiration_event_in** | **Array<String>** | How many days before the expiration of the certificate would you like to be notified. | [optional] |
|
|
39
46
|
| **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] |
|
|
47
|
+
| **gcp_project_id** | **String** | GCP Project ID (cross-project override) | [optional] |
|
|
40
48
|
| **hashi_json** | **String** | Import secret key as json value or independent secrets (relevant only for HasiCorp Vault migration) [true/false] | [optional][default to 'true'] |
|
|
41
49
|
| **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] |
|
|
42
50
|
| **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] |
|
|
@@ -65,8 +73,9 @@
|
|
|
65
73
|
| **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) | |
|
|
66
74
|
| **target_location** | **String** | Target location in Akeyless for imported secrets | |
|
|
67
75
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
68
|
-
| **type** | **String** | Migration type (hashi/aws/gcp/k8s/azure_kv/active_directory/server_inventory/certificate) | [optional] |
|
|
76
|
+
| **type** | **String** | Migration type (hashi/aws/gcp/k8s/azure_kv/conjur/active_directory/server_inventory/certificate) | [optional] |
|
|
69
77
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
78
|
+
| **use_gw_cloud_identity** | **Boolean** | Use the GW's Cloud IAM | [optional] |
|
|
70
79
|
|
|
71
80
|
## Example
|
|
72
81
|
|
|
@@ -76,6 +85,8 @@ require 'akeyless'
|
|
|
76
85
|
instance = Akeyless::GatewayCreateMigration.new(
|
|
77
86
|
service_account_key_decoded: null,
|
|
78
87
|
ad_auto_rotate: null,
|
|
88
|
+
ad_cert_expiration_event_in: null,
|
|
89
|
+
ad_certificates_path_template: null,
|
|
79
90
|
ad_computer_base_dn: null,
|
|
80
91
|
ad_discover_iis_app: null,
|
|
81
92
|
ad_discover_services: null,
|
|
@@ -98,6 +109,7 @@ instance = Akeyless::GatewayCreateMigration.new(
|
|
|
98
109
|
ad_winrm_over_http: null,
|
|
99
110
|
ad_winrm_port: null,
|
|
100
111
|
ad_discover_local_users: null,
|
|
112
|
+
ai_certificate_discovery: null,
|
|
101
113
|
aws_key: null,
|
|
102
114
|
aws_key_id: null,
|
|
103
115
|
aws_region: null,
|
|
@@ -105,8 +117,13 @@ instance = Akeyless::GatewayCreateMigration.new(
|
|
|
105
117
|
azure_kv_name: null,
|
|
106
118
|
azure_secret: null,
|
|
107
119
|
azure_tenant_id: null,
|
|
120
|
+
conjur_account: null,
|
|
121
|
+
conjur_api_key: null,
|
|
122
|
+
conjur_url: null,
|
|
123
|
+
conjur_username: null,
|
|
108
124
|
expiration_event_in: null,
|
|
109
125
|
gcp_key: null,
|
|
126
|
+
gcp_project_id: null,
|
|
110
127
|
hashi_json: null,
|
|
111
128
|
hashi_ns: null,
|
|
112
129
|
hashi_token: null,
|
|
@@ -136,7 +153,8 @@ instance = Akeyless::GatewayCreateMigration.new(
|
|
|
136
153
|
target_location: null,
|
|
137
154
|
token: null,
|
|
138
155
|
type: null,
|
|
139
|
-
uid_token: null
|
|
156
|
+
uid_token: null,
|
|
157
|
+
use_gw_cloud_identity: null
|
|
140
158
|
)
|
|
141
159
|
```
|
|
142
160
|
|
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **service_account_key_decoded** | **String** | | [optional] |
|
|
8
8
|
| **ad_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 --ad-rotation-interval and --ad-rotation-hour parameters (Relevant only for Active Directory migration) | [optional] |
|
|
9
|
+
| **ad_cert_expiration_event_in** | **Array<String>** | How many days before the expiration of discovered certificates would you like to be notified (Relevant only for Active Directory migration with certificate discovery enabled) | [optional] |
|
|
10
|
+
| **ad_certificates_path_template** | **String** | Path location template for migrating certificates e.g.: /Certificates/{{COMMON_NAME}} (Relevant only for Active Directory migration with certificate discovery enabled) | [optional] |
|
|
9
11
|
| **ad_computer_base_dn** | **String** | Distinguished Name of Computer objects (servers) to search in Active Directory e.g.: CN=Computers,DC=example,DC=com (Relevant only for Active Directory migration) | [optional] |
|
|
10
12
|
| **ad_discover_iis_app** | **String** | Enable/Disable discovery of IIS application from each domain server as part of the SSH/Windows Rotated Secrets. Default is false. (Relevant only for Active Directory migration) | [optional][default to 'false'] |
|
|
11
13
|
| **ad_discover_services** | **String** | Enable/Disable discovery of Windows services from each domain server as part of the SSH/Windows Rotated Secrets. Default is false. (Relevant only for Active Directory migration) | [optional][default to 'false'] |
|
|
@@ -28,6 +30,7 @@
|
|
|
28
30
|
| **ad_winrm_over_http** | **String** | Use WinRM over HTTP, by default runs over HTTPS | [optional][default to 'false'] |
|
|
29
31
|
| **ad_winrm_port** | **String** | Set the WinRM Port for further connection to the domain servers. Default is 5986 (Relevant only for Active Directory migration) | [optional][default to '5986'] |
|
|
30
32
|
| **ad_discover_local_users** | **String** | Enable/Disable discovery of local users from each domain server and migrate them as SSH/Windows Rotated Secrets. Default is false: only domain users will be migrated. Discovery of local users might require further installation of SSH on the servers, based on the supplied computer base DN. This will be implemented automatically as part of the migration process (Relevant only for Active Directory migration) Deprecated: use AdDiscoverTypes | [optional] |
|
|
33
|
+
| **ai_certificate_discovery** | **String** | Enable AI-assisted certificate discovery (only when AI Insight is enabled on the Gateway) | [optional] |
|
|
31
34
|
| **aws_key** | **String** | AWS Secret Access Key (relevant only for AWS migration) | [optional] |
|
|
32
35
|
| **aws_key_id** | **String** | AWS Access Key ID with sufficient permissions to get all secrets, e.g. 'arn:aws:secretsmanager:[Region]:[AccountId]:secret:[/path/to/secrets/*]' (relevant only for AWS migration) | [optional] |
|
|
33
36
|
| **aws_region** | **String** | AWS region of the required Secrets Manager (relevant only for AWS migration) | [optional][default to 'us-east-2'] |
|
|
@@ -35,8 +38,13 @@
|
|
|
35
38
|
| **azure_kv_name** | **String** | Azure Key Vault Name (relevant only for Azure Key Vault migration) | [optional] |
|
|
36
39
|
| **azure_secret** | **String** | Azure Key Vault secret (relevant only for Azure Key Vault migration) | [optional] |
|
|
37
40
|
| **azure_tenant_id** | **String** | Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration) | [optional] |
|
|
41
|
+
| **conjur_account** | **String** | Conjur account name set on your Conjur server (relevant only for Conjur migration). | [optional] |
|
|
42
|
+
| **conjur_api_key** | **String** | Conjur API Key for the specified user (relevant only for Conjur migration). | [optional] |
|
|
43
|
+
| **conjur_url** | **String** | Conjur server base URL (relevant only for Conjur migration). If conjur-url is HTTPS and Conjur uses a private CA/self-signed certificate, make the CA bundle available on the Gateway and set CONJUR_SSL_CERT_PATH to its path. | [optional] |
|
|
44
|
+
| **conjur_username** | **String** | Conjur username used to authenticate (relevant only for Conjur migration). | [optional] |
|
|
38
45
|
| **expiration_event_in** | **Array<String>** | How many days before the expiration of the certificate would you like to be notified. | [optional] |
|
|
39
46
|
| **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] |
|
|
47
|
+
| **gcp_project_id** | **String** | GCP Project ID (cross-project override) | [optional] |
|
|
40
48
|
| **hashi_json** | **String** | Import secret key as json value or independent secrets (relevant only for HasiCorp Vault migration) [true/false] | [optional][default to 'true'] |
|
|
41
49
|
| **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] |
|
|
42
50
|
| **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] |
|
|
@@ -68,6 +76,7 @@
|
|
|
68
76
|
| **target_location** | **String** | Target location in Akeyless for imported secrets | |
|
|
69
77
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
70
78
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
79
|
+
| **use_gw_cloud_identity** | **Boolean** | Use the GW's Cloud IAM | [optional] |
|
|
71
80
|
|
|
72
81
|
## Example
|
|
73
82
|
|
|
@@ -77,6 +86,8 @@ require 'akeyless'
|
|
|
77
86
|
instance = Akeyless::GatewayUpdateMigration.new(
|
|
78
87
|
service_account_key_decoded: null,
|
|
79
88
|
ad_auto_rotate: null,
|
|
89
|
+
ad_cert_expiration_event_in: null,
|
|
90
|
+
ad_certificates_path_template: null,
|
|
80
91
|
ad_computer_base_dn: null,
|
|
81
92
|
ad_discover_iis_app: null,
|
|
82
93
|
ad_discover_services: null,
|
|
@@ -99,6 +110,7 @@ instance = Akeyless::GatewayUpdateMigration.new(
|
|
|
99
110
|
ad_winrm_over_http: null,
|
|
100
111
|
ad_winrm_port: null,
|
|
101
112
|
ad_discover_local_users: null,
|
|
113
|
+
ai_certificate_discovery: null,
|
|
102
114
|
aws_key: null,
|
|
103
115
|
aws_key_id: null,
|
|
104
116
|
aws_region: null,
|
|
@@ -106,8 +118,13 @@ instance = Akeyless::GatewayUpdateMigration.new(
|
|
|
106
118
|
azure_kv_name: null,
|
|
107
119
|
azure_secret: null,
|
|
108
120
|
azure_tenant_id: null,
|
|
121
|
+
conjur_account: null,
|
|
122
|
+
conjur_api_key: null,
|
|
123
|
+
conjur_url: null,
|
|
124
|
+
conjur_username: null,
|
|
109
125
|
expiration_event_in: null,
|
|
110
126
|
gcp_key: null,
|
|
127
|
+
gcp_project_id: null,
|
|
111
128
|
hashi_json: null,
|
|
112
129
|
hashi_ns: null,
|
|
113
130
|
hashi_token: null,
|
|
@@ -138,7 +155,8 @@ instance = Akeyless::GatewayUpdateMigration.new(
|
|
|
138
155
|
si_users_path_template: null,
|
|
139
156
|
target_location: null,
|
|
140
157
|
token: null,
|
|
141
|
-
uid_token: null
|
|
158
|
+
uid_token: null,
|
|
159
|
+
use_gw_cloud_identity: null
|
|
142
160
|
)
|
|
143
161
|
```
|
|
144
162
|
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **cert_display_id** | **String** | | [optional] |
|
|
8
8
|
| **cert_item_id** | **Integer** | | [optional] |
|
|
9
9
|
| **data** | **String** | | [optional] |
|
|
10
|
+
| **http_challenge_info** | [**HTTPChallengeInfo**](HTTPChallengeInfo.md) | | [optional] |
|
|
10
11
|
| **parent_cert** | **String** | | [optional] |
|
|
11
12
|
| **path** | **String** | | [optional] |
|
|
12
13
|
| **reading_token** | **String** | | [optional] |
|
|
@@ -20,6 +21,7 @@ instance = Akeyless::GetPKICertificateOutput.new(
|
|
|
20
21
|
cert_display_id: null,
|
|
21
22
|
cert_item_id: null,
|
|
22
23
|
data: null,
|
|
24
|
+
http_challenge_info: null,
|
|
23
25
|
parent_cert: null,
|
|
24
26
|
path: null,
|
|
25
27
|
reading_token: null
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Akeyless::GithubMetadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **environment_name** | **String** | | [optional] |
|
|
8
|
+
| **organization_name** | **String** | | [optional] |
|
|
9
|
+
| **repository** | **String** | | [optional] |
|
|
10
|
+
| **repository_access** | **String** | | [optional] |
|
|
11
|
+
| **scope** | **String** | | [optional] |
|
|
12
|
+
| **selected_repositories** | **String** | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'akeyless'
|
|
18
|
+
|
|
19
|
+
instance = Akeyless::GithubMetadata.new(
|
|
20
|
+
environment_name: null,
|
|
21
|
+
organization_name: null,
|
|
22
|
+
repository: null,
|
|
23
|
+
repository_access: null,
|
|
24
|
+
scope: null,
|
|
25
|
+
selected_repositories: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Akeyless::HTTPChallengeInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **file_content** | **String** | | [optional] |
|
|
8
|
+
| **file_path** | **String** | | [optional] |
|
|
9
|
+
| **instructions** | **String** | | [optional] |
|
|
10
|
+
| **key_auth** | **String** | | [optional] |
|
|
11
|
+
| **token** | **String** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'akeyless'
|
|
17
|
+
|
|
18
|
+
instance = Akeyless::HTTPChallengeInfo.new(
|
|
19
|
+
file_content: null,
|
|
20
|
+
file_path: null,
|
|
21
|
+
instructions: null,
|
|
22
|
+
key_auth: null,
|
|
23
|
+
token: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Akeyless::IssuerOverviewInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **certificate_authority_mode** | **String** | | [optional] |
|
|
8
|
+
| **expiration_date** | **Time** | | [optional] |
|
|
9
|
+
| **key_type** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'akeyless'
|
|
15
|
+
|
|
16
|
+
instance = Akeyless::IssuerOverviewInfo.new(
|
|
17
|
+
certificate_authority_mode: null,
|
|
18
|
+
expiration_date: null,
|
|
19
|
+
key_type: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/ItemGeneralInfo.md
CHANGED
|
@@ -14,6 +14,7 @@
|
|
|
14
14
|
| **dynamic_secret_producer_details** | [**DynamicSecretProducerInfo**](DynamicSecretProducerInfo.md) | | [optional] |
|
|
15
15
|
| **expiration_events** | [**Array<CertificateExpirationEvent>**](CertificateExpirationEvent.md) | | [optional] |
|
|
16
16
|
| **importer_info** | [**ImporterInfo**](ImporterInfo.md) | | [optional] |
|
|
17
|
+
| **issuer_overview_info** | [**IssuerOverviewInfo**](IssuerOverviewInfo.md) | | [optional] |
|
|
17
18
|
| **next_rotation_events** | [**Array<NextAutoRotationEvent>**](NextAutoRotationEvent.md) | | [optional] |
|
|
18
19
|
| **oidc_client_info** | [**OidcClientInfo**](OidcClientInfo.md) | | [optional] |
|
|
19
20
|
| **password_policy** | [**PasswordPolicyInfo**](PasswordPolicyInfo.md) | | [optional] |
|
|
@@ -38,6 +39,7 @@ instance = Akeyless::ItemGeneralInfo.new(
|
|
|
38
39
|
dynamic_secret_producer_details: null,
|
|
39
40
|
expiration_events: null,
|
|
40
41
|
importer_info: null,
|
|
42
|
+
issuer_overview_info: null,
|
|
41
43
|
next_rotation_events: null,
|
|
42
44
|
oidc_client_info: null,
|
|
43
45
|
password_policy: null,
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Akeyless::LetsEncryptTargetDetails
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_key_pem** | **String** | ACME Account Private Key (PEM-encoded) Supports ECDSA (P-256, P-384, P-521), RSA (2048+), and Ed25519 Auto-generated as ECDSA P-256 on first certificate issuance if not provided Stored encrypted, required for certificate operations and revocation | [optional] |
|
|
8
|
+
| **account_url** | **String** | ACME Account URL (returned after registration with Let's Encrypt) Used to retrieve existing account instead of re-registering | [optional] |
|
|
9
|
+
| **acme_environment** | **String** | ACMEEnvironment defines Let's Encrypt ACME directory environment | [optional] |
|
|
10
|
+
| **challenge_type** | **String** | ACMEChallengeType defines ACME challenge type for Let's Encrypt | [optional] |
|
|
11
|
+
| **dns_target_name** | **String** | Name of DNS target (transient field - not stored in DB) Used by CLI to pass DNS target name to SDK for creating target_object_assoc Retrieved from target_object_assoc when reading target Required when ChallengeType is \"dns\" | [optional] |
|
|
12
|
+
| **dns_target_type** | **String** | | [optional] |
|
|
13
|
+
| **email** | **String** | Email address for ACME account registration Required | [optional] |
|
|
14
|
+
| **gcp_project** | **String** | GCP Cloud DNS: Project ID Optional - can be derived from service account | [optional] |
|
|
15
|
+
| **hosted_zone** | **String** | AWS Route53: Hosted zone ID Required when DNSTargetType is AWS | [optional] |
|
|
16
|
+
| **resource_group** | **String** | Azure DNS: Resource group name Required when DNSTargetType is Azure | [optional] |
|
|
17
|
+
| **timeout** | **Integer** | A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'akeyless'
|
|
23
|
+
|
|
24
|
+
instance = Akeyless::LetsEncryptTargetDetails.new(
|
|
25
|
+
account_key_pem: null,
|
|
26
|
+
account_url: null,
|
|
27
|
+
acme_environment: null,
|
|
28
|
+
challenge_type: null,
|
|
29
|
+
dns_target_name: null,
|
|
30
|
+
dns_target_type: null,
|
|
31
|
+
email: null,
|
|
32
|
+
gcp_project: null,
|
|
33
|
+
hosted_zone: null,
|
|
34
|
+
resource_group: null,
|
|
35
|
+
timeout: null
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **certificates** | [**MigrationItems**](MigrationItems.md) | | [optional] |
|
|
7
8
|
| **computers** | **Integer** | | [optional] |
|
|
8
9
|
| **duration_time** | **String** | | [optional] |
|
|
9
10
|
| **error** | **String** | | [optional] |
|
|
@@ -26,6 +27,7 @@
|
|
|
26
27
|
require 'akeyless'
|
|
27
28
|
|
|
28
29
|
instance = Akeyless::MigrationStatusReplyObj.new(
|
|
30
|
+
certificates: null,
|
|
29
31
|
computers: null,
|
|
30
32
|
duration_time: null,
|
|
31
33
|
error: null,
|
|
@@ -8,6 +8,7 @@
|
|
|
8
8
|
| **aws_secrets_migrations** | [**Array<AWSSecretsMigration>**](AWSSecretsMigration.md) | | [optional] |
|
|
9
9
|
| **azure_kv_migrations** | [**Array<AzureKeyVaultMigration>**](AzureKeyVaultMigration.md) | | [optional] |
|
|
10
10
|
| **certificate_migrations** | [**Array<CertificateMigration>**](CertificateMigration.md) | | [optional] |
|
|
11
|
+
| **conjur_migrations** | [**Array<ConjurMigration>**](ConjurMigration.md) | | [optional] |
|
|
11
12
|
| **gcp_secrets_migrations** | [**Array<GCPSecretsMigration>**](GCPSecretsMigration.md) | | [optional] |
|
|
12
13
|
| **hashi_migrations** | [**Array<HashiMigration>**](HashiMigration.md) | | [optional] |
|
|
13
14
|
| **k8s_migrations** | [**Array<K8SMigration>**](K8SMigration.md) | | [optional] |
|
|
@@ -25,6 +26,7 @@ instance = Akeyless::MigrationsConfigPart.new(
|
|
|
25
26
|
aws_secrets_migrations: null,
|
|
26
27
|
azure_kv_migrations: null,
|
|
27
28
|
certificate_migrations: null,
|
|
29
|
+
conjur_migrations: null,
|
|
28
30
|
gcp_secrets_migrations: null,
|
|
29
31
|
hashi_migrations: null,
|
|
30
32
|
k8s_migrations: null,
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Akeyless::PoliciesCreateOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'akeyless'
|
|
13
|
+
|
|
14
|
+
instance = Akeyless::PoliciesCreateOutput.new(
|
|
15
|
+
id: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Akeyless::PoliciesDelete
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Policy id | |
|
|
8
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
9
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
10
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'akeyless'
|
|
16
|
+
|
|
17
|
+
instance = Akeyless::PoliciesDelete.new(
|
|
18
|
+
id: null,
|
|
19
|
+
json: null,
|
|
20
|
+
token: null,
|
|
21
|
+
uid_token: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
data/docs/PoliciesGet.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Akeyless::PoliciesGet
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Policy id | |
|
|
8
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
9
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
10
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'akeyless'
|
|
16
|
+
|
|
17
|
+
instance = Akeyless::PoliciesGet.new(
|
|
18
|
+
id: null,
|
|
19
|
+
json: null,
|
|
20
|
+
token: null,
|
|
21
|
+
uid_token: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Akeyless::PoliciesGetOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **policy** | [**PolicyOutput**](PolicyOutput.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'akeyless'
|
|
13
|
+
|
|
14
|
+
instance = Akeyless::PoliciesGetOutput.new(
|
|
15
|
+
policy: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Akeyless::PoliciesList
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **aggregate** | **Boolean** | Aggregate missing configurations from parent policies (requires --paths) | [optional] |
|
|
8
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
9
|
+
| **object_type** | **Array<String>** | Optional object types filter (items or targets) | [optional] |
|
|
10
|
+
| **paths** | **Array<String>** | Filter by exact policy paths | [optional] |
|
|
11
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
12
|
+
| **types** | **Array<String>** | Filter by policy types | [optional] |
|
|
13
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'akeyless'
|
|
19
|
+
|
|
20
|
+
instance = Akeyless::PoliciesList.new(
|
|
21
|
+
aggregate: null,
|
|
22
|
+
json: null,
|
|
23
|
+
object_type: null,
|
|
24
|
+
paths: null,
|
|
25
|
+
token: null,
|
|
26
|
+
types: null,
|
|
27
|
+
uid_token: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Akeyless::PoliciesListOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **policies** | [**Array<PolicyOutput>**](PolicyOutput.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'akeyless'
|
|
13
|
+
|
|
14
|
+
instance = Akeyless::PoliciesListOutput.new(
|
|
15
|
+
policies: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Akeyless::PolicyCreateKeys
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **allowed_algorithms** | **Array<String>** | Specify allowed key algorithms (e.g., [RSA2048,AES128GCM]) | [optional] |
|
|
8
|
+
| **allowed_key_names** | **Array<String>** | Specify allowed protection key names. To enforce using the account's default protection key, use 'default-account-key' | [optional] |
|
|
9
|
+
| **allowed_key_types** | **Array<String>** | Specify allowed key protection types (dfc, classic-key) | [optional] |
|
|
10
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
11
|
+
| **max_rotation_interval_days** | **Integer** | Set the maximum rotation interval for automatic key rotation. | [optional] |
|
|
12
|
+
| **object_types** | **Array<String>** | The object types this policy will apply to (items, targets). If not provided, defaults to [items, targets]. | [optional] |
|
|
13
|
+
| **path** | **String** | The path the policy refers to | |
|
|
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::PolicyCreateKeys.new(
|
|
23
|
+
allowed_algorithms: null,
|
|
24
|
+
allowed_key_names: null,
|
|
25
|
+
allowed_key_types: null,
|
|
26
|
+
json: null,
|
|
27
|
+
max_rotation_interval_days: null,
|
|
28
|
+
object_types: null,
|
|
29
|
+
path: null,
|
|
30
|
+
token: null,
|
|
31
|
+
uid_token: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Akeyless::PolicyOutput
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_id** | **String** | | [optional] |
|
|
8
|
+
| **allowed_algorithms** | **Array<String>** | | [optional] |
|
|
9
|
+
| **allowed_key_names** | **Array<String>** | | [optional] |
|
|
10
|
+
| **allowed_key_types** | **Array<String>** | | [optional] |
|
|
11
|
+
| **id** | **String** | | [optional] |
|
|
12
|
+
| **max_rotation_interval_days** | **Integer** | | [optional] |
|
|
13
|
+
| **object_types** | **Array<String>** | | [optional] |
|
|
14
|
+
| **path** | **String** | | [optional] |
|
|
15
|
+
| **type** | **String** | | [optional] |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'akeyless'
|
|
21
|
+
|
|
22
|
+
instance = Akeyless::PolicyOutput.new(
|
|
23
|
+
account_id: null,
|
|
24
|
+
allowed_algorithms: null,
|
|
25
|
+
allowed_key_names: null,
|
|
26
|
+
allowed_key_types: null,
|
|
27
|
+
id: null,
|
|
28
|
+
max_rotation_interval_days: null,
|
|
29
|
+
object_types: null,
|
|
30
|
+
path: null,
|
|
31
|
+
type: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Akeyless::PolicyUpdateKeys
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **allowed_algorithms** | **Array<String>** | Specify allowed key algorithms (e.g., [RSA2048,AES128GCM]) | [optional] |
|
|
8
|
+
| **allowed_key_names** | **Array<String>** | Specify allowed protection key names. To enforce using the account's default protection key, use 'default-account-key' | [optional] |
|
|
9
|
+
| **allowed_key_types** | **Array<String>** | Specify allowed key protection types (dfc, classic-key) | [optional] |
|
|
10
|
+
| **id** | **String** | Policy id | |
|
|
11
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
12
|
+
| **max_rotation_interval_days** | **Integer** | Set the maximum rotation interval for automatic key rotation. | [optional] |
|
|
13
|
+
| **object_types** | **Array<String>** | The object type this policy will apply to (items, targets) | [optional] |
|
|
14
|
+
| **path** | **String** | The path the policy refers to | [optional] |
|
|
15
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
16
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'akeyless'
|
|
22
|
+
|
|
23
|
+
instance = Akeyless::PolicyUpdateKeys.new(
|
|
24
|
+
allowed_algorithms: null,
|
|
25
|
+
allowed_key_names: null,
|
|
26
|
+
allowed_key_types: null,
|
|
27
|
+
id: null,
|
|
28
|
+
json: null,
|
|
29
|
+
max_rotation_interval_days: null,
|
|
30
|
+
object_types: null,
|
|
31
|
+
path: null,
|
|
32
|
+
token: null,
|
|
33
|
+
uid_token: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -11,9 +11,10 @@
|
|
|
11
11
|
| **aws_region** | **String** | Aws Region | [optional][default to 'us-east-2'] |
|
|
12
12
|
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
13
13
|
| **description** | **String** | Description of the object | [optional] |
|
|
14
|
-
| **grace_rotation** | **String** |
|
|
14
|
+
| **grace_rotation** | **String** | Enable graceful rotation (keep both versions temporarily). When enabled, a new secret version is created while the previous version is kept for the grace period, so both versions exist for a limited time. [true/false] | [optional] |
|
|
15
15
|
| **grace_rotation_hour** | **Integer** | The Hour of the grace rotation in UTC | [optional] |
|
|
16
16
|
| **grace_rotation_interval** | **String** | The number of days to wait before deleting the old key (must be bigger than rotation-interval) | [optional] |
|
|
17
|
+
| **grace_rotation_timing** | **String** | When to create the new version relative to the rotation date [after/before] | [optional] |
|
|
17
18
|
| **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
|
|
18
19
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
19
20
|
| **key** | **String** | The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used) | [optional] |
|
|
@@ -31,7 +32,7 @@
|
|
|
31
32
|
| **secure_access_certificate_issuer** | **String** | Path to the SSH Certificate Issuer for your Akeyless Secure Access | [optional] |
|
|
32
33
|
| **secure_access_enable** | **String** | Enable/Disable secure remote access [true/false] | [optional] |
|
|
33
34
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
34
|
-
| **target_name** | **String** |
|
|
35
|
+
| **target_name** | **String** | The target name to associate | |
|
|
35
36
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
36
37
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
37
38
|
|
|
@@ -51,6 +52,7 @@ instance = Akeyless::RotatedSecretCreateAws.new(
|
|
|
51
52
|
grace_rotation: null,
|
|
52
53
|
grace_rotation_hour: null,
|
|
53
54
|
grace_rotation_interval: null,
|
|
55
|
+
grace_rotation_timing: null,
|
|
54
56
|
item_custom_fields: null,
|
|
55
57
|
json: null,
|
|
56
58
|
key: null,
|