akeyless 5.0.27 → 5.0.28

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.
Files changed (128) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +15 -1
  3. data/docs/AccountGeneralSettings.md +2 -0
  4. data/docs/EsmGetSecretOutput.md +7 -1
  5. data/docs/FolderDeleteSync.md +32 -0
  6. data/docs/FolderDeleteSyncOutput.md +24 -0
  7. data/docs/FolderSync.md +34 -0
  8. data/docs/FolderSyncAll.md +26 -0
  9. data/docs/FolderSyncAllOutput.md +18 -0
  10. data/docs/FolderSyncOutput.md +24 -0
  11. data/docs/FolderUSCSyncConfig.md +2 -0
  12. data/docs/OIDCAccessRules.md +2 -0
  13. data/docs/PersonalFolderGlobalMappingSettings.md +20 -0
  14. data/docs/RotatedSecretCreateAws.md +4 -4
  15. data/docs/RotatedSecretCreateAzure.md +6 -4
  16. data/docs/RotatedSecretCreateCassandra.md +4 -4
  17. data/docs/RotatedSecretCreateCustom.md +4 -4
  18. data/docs/RotatedSecretCreateDockerhub.md +4 -4
  19. data/docs/RotatedSecretCreateGcp.md +4 -4
  20. data/docs/RotatedSecretCreateHanadb.md +4 -4
  21. data/docs/RotatedSecretCreateHashiVault.md +60 -0
  22. data/docs/RotatedSecretCreateLdap.md +4 -4
  23. data/docs/RotatedSecretCreateMongodb.md +4 -4
  24. data/docs/RotatedSecretCreateMssql.md +4 -4
  25. data/docs/RotatedSecretCreateMysql.md +4 -4
  26. data/docs/RotatedSecretCreateOpenAI.md +4 -4
  27. data/docs/RotatedSecretCreateOracledb.md +4 -4
  28. data/docs/RotatedSecretCreatePostgresql.md +4 -4
  29. data/docs/RotatedSecretCreateRedis.md +4 -4
  30. data/docs/RotatedSecretCreateRedshift.md +4 -4
  31. data/docs/RotatedSecretCreateSnowflake.md +4 -4
  32. data/docs/RotatedSecretCreateSplunk.md +4 -4
  33. data/docs/RotatedSecretCreateSsh.md +4 -4
  34. data/docs/RotatedSecretCreateWindows.md +4 -4
  35. data/docs/RotatedSecretUpdateAws.md +4 -4
  36. data/docs/RotatedSecretUpdateAzure.md +6 -4
  37. data/docs/RotatedSecretUpdateCassandra.md +4 -4
  38. data/docs/RotatedSecretUpdateCustom.md +4 -4
  39. data/docs/RotatedSecretUpdateDockerhub.md +4 -4
  40. data/docs/RotatedSecretUpdateGcp.md +4 -4
  41. data/docs/RotatedSecretUpdateHanadb.md +4 -4
  42. data/docs/RotatedSecretUpdateHashiVault.md +64 -0
  43. data/docs/RotatedSecretUpdateLdap.md +4 -4
  44. data/docs/RotatedSecretUpdateMongodb.md +4 -4
  45. data/docs/RotatedSecretUpdateMssql.md +4 -4
  46. data/docs/RotatedSecretUpdateMysql.md +4 -4
  47. data/docs/RotatedSecretUpdateOpenAI.md +4 -4
  48. data/docs/RotatedSecretUpdateOracledb.md +4 -4
  49. data/docs/RotatedSecretUpdatePostgresql.md +4 -4
  50. data/docs/RotatedSecretUpdateRedis.md +4 -4
  51. data/docs/RotatedSecretUpdateRedshift.md +4 -4
  52. data/docs/RotatedSecretUpdateSnowflake.md +4 -4
  53. data/docs/RotatedSecretUpdateSplunk.md +4 -4
  54. data/docs/RotatedSecretUpdateSsh.md +4 -4
  55. data/docs/RotatedSecretUpdateWindows.md +4 -4
  56. data/docs/SecretInfo.md +5 -1
  57. data/docs/UscGetSecretOutput.md +7 -1
  58. data/docs/V2Api.md +315 -0
  59. data/lib/akeyless/api/v2_api.rb +320 -0
  60. data/lib/akeyless/models/account_general_settings.rb +10 -1
  61. data/lib/akeyless/models/esm_get_secret_output.rb +35 -4
  62. data/lib/akeyless/models/folder_delete_sync.rb +305 -0
  63. data/lib/akeyless/models/folder_delete_sync_output.rb +245 -0
  64. data/lib/akeyless/models/folder_sync.rb +306 -0
  65. data/lib/akeyless/models/folder_sync_all.rb +266 -0
  66. data/lib/akeyless/models/folder_sync_all_output.rb +214 -0
  67. data/lib/akeyless/models/folder_sync_output.rb +247 -0
  68. data/lib/akeyless/models/folder_usc_sync_config.rb +10 -1
  69. data/lib/akeyless/models/oidc_access_rules.rb +11 -1
  70. data/lib/akeyless/models/personal_folder_global_mapping_settings.rb +223 -0
  71. data/lib/akeyless/models/rotated_secret_create_aws.rb +0 -4
  72. data/lib/akeyless/models/rotated_secret_create_azure.rb +11 -5
  73. data/lib/akeyless/models/rotated_secret_create_cassandra.rb +0 -4
  74. data/lib/akeyless/models/rotated_secret_create_custom.rb +0 -4
  75. data/lib/akeyless/models/rotated_secret_create_dockerhub.rb +0 -4
  76. data/lib/akeyless/models/rotated_secret_create_gcp.rb +0 -4
  77. data/lib/akeyless/models/rotated_secret_create_hanadb.rb +0 -4
  78. data/lib/akeyless/models/rotated_secret_create_hashi_vault.rb +446 -0
  79. data/lib/akeyless/models/rotated_secret_create_ldap.rb +0 -4
  80. data/lib/akeyless/models/rotated_secret_create_mongodb.rb +0 -4
  81. data/lib/akeyless/models/rotated_secret_create_mssql.rb +0 -4
  82. data/lib/akeyless/models/rotated_secret_create_mysql.rb +0 -4
  83. data/lib/akeyless/models/rotated_secret_create_open_ai.rb +0 -4
  84. data/lib/akeyless/models/rotated_secret_create_oracledb.rb +0 -4
  85. data/lib/akeyless/models/rotated_secret_create_postgresql.rb +0 -4
  86. data/lib/akeyless/models/rotated_secret_create_redis.rb +0 -4
  87. data/lib/akeyless/models/rotated_secret_create_redshift.rb +0 -4
  88. data/lib/akeyless/models/rotated_secret_create_snowflake.rb +0 -4
  89. data/lib/akeyless/models/rotated_secret_create_splunk.rb +0 -4
  90. data/lib/akeyless/models/rotated_secret_create_ssh.rb +0 -4
  91. data/lib/akeyless/models/rotated_secret_create_windows.rb +0 -4
  92. data/lib/akeyless/models/rotated_secret_sync.rb +1 -1
  93. data/lib/akeyless/models/rotated_secret_update_aws.rb +0 -4
  94. data/lib/akeyless/models/rotated_secret_update_azure.rb +11 -5
  95. data/lib/akeyless/models/rotated_secret_update_cassandra.rb +0 -4
  96. data/lib/akeyless/models/rotated_secret_update_custom.rb +0 -4
  97. data/lib/akeyless/models/rotated_secret_update_dockerhub.rb +0 -4
  98. data/lib/akeyless/models/rotated_secret_update_gcp.rb +0 -4
  99. data/lib/akeyless/models/rotated_secret_update_hanadb.rb +0 -4
  100. data/lib/akeyless/models/rotated_secret_update_hashi_vault.rb +463 -0
  101. data/lib/akeyless/models/rotated_secret_update_ldap.rb +0 -4
  102. data/lib/akeyless/models/rotated_secret_update_mongodb.rb +0 -4
  103. data/lib/akeyless/models/rotated_secret_update_mssql.rb +0 -4
  104. data/lib/akeyless/models/rotated_secret_update_mysql.rb +0 -4
  105. data/lib/akeyless/models/rotated_secret_update_open_ai.rb +0 -4
  106. data/lib/akeyless/models/rotated_secret_update_oracledb.rb +0 -4
  107. data/lib/akeyless/models/rotated_secret_update_postgresql.rb +0 -4
  108. data/lib/akeyless/models/rotated_secret_update_redis.rb +0 -4
  109. data/lib/akeyless/models/rotated_secret_update_redshift.rb +0 -4
  110. data/lib/akeyless/models/rotated_secret_update_snowflake.rb +0 -4
  111. data/lib/akeyless/models/rotated_secret_update_splunk.rb +0 -4
  112. data/lib/akeyless/models/rotated_secret_update_ssh.rb +0 -4
  113. data/lib/akeyless/models/rotated_secret_update_windows.rb +0 -4
  114. data/lib/akeyless/models/secret_info.rb +24 -4
  115. data/lib/akeyless/models/static_secret_sync.rb +1 -1
  116. data/lib/akeyless/models/usc_get_secret_output.rb +35 -4
  117. data/lib/akeyless/version.rb +1 -1
  118. data/lib/akeyless.rb +9 -0
  119. data/spec/models/folder_delete_sync_output_spec.rb +54 -0
  120. data/spec/models/folder_delete_sync_spec.rb +78 -0
  121. data/spec/models/folder_sync_all_output_spec.rb +36 -0
  122. data/spec/models/folder_sync_all_spec.rb +60 -0
  123. data/spec/models/folder_sync_output_spec.rb +54 -0
  124. data/spec/models/folder_sync_spec.rb +84 -0
  125. data/spec/models/personal_folder_global_mapping_settings_spec.rb +42 -0
  126. data/spec/models/rotated_secret_create_hashi_vault_spec.rb +162 -0
  127. data/spec/models/rotated_secret_update_hashi_vault_spec.rb +174 -0
  128. metadata +38 -2
data/docs/RotatedSecretCreateLdap.md CHANGED
@@ -6,14 +6,14 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **provider_type** | **String** | | [optional] |
8
8
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
9
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
9
+ | **auto_rotate** | **String** | | [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
12
  | **host_provider** | **String** | Host provider type [explicit/target], Default Host provider is explicit, Relevant only for Secure Remote Access of ssh cert issuer, ldap rotated secret and ldap dynamic secret | [optional] |
13
13
  | **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
14
14
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
15
15
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
16
- | **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] |
16
+ | **key** | **String** | | [optional] |
17
17
  | **lock_during_sra_session** | **String** | Lock this secret for read/update while an SRA session is active | [optional] |
18
18
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
19
19
  | **name** | **String** | Rotated secret name | |
@@ -23,8 +23,8 @@
23
23
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=ldap) | [optional] |
24
24
  | **rotated_username** | **String** | username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=ldap) | [optional] |
25
25
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
26
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
27
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
26
+ | **rotation_hour** | **Integer** | | [optional] |
27
+ | **rotation_interval** | **String** | | [optional] |
28
28
  | **rotator_type** | **String** | The rotator type. options: [target/ldap] | |
29
29
  | **secure_access_bastion_issuer** | **String** | Deprecated. use secure-access-certificate-issuer | [optional] |
30
30
  | **secure_access_certificate_issuer** | **String** | Path to the SSH Certificate Issuer for your Akeyless Secure Access | [optional] |
data/docs/RotatedSecretCreateMongodb.md CHANGED
@@ -5,13 +5,13 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
8
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
8
+ | **auto_rotate** | **String** | | [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] |
11
11
  | **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
12
12
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
13
13
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
14
- | **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] |
14
+ | **key** | **String** | | [optional] |
15
15
  | **lock_during_sra_session** | **String** | Lock this secret for read/update while an SRA session is active | [optional] |
16
16
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
17
17
  | **name** | **String** | Rotated secret name | |
@@ -21,8 +21,8 @@
21
21
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
22
22
  | **rotated_username** | **String** | username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password) | [optional] |
23
23
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
24
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
25
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
24
+ | **rotation_hour** | **Integer** | | [optional] |
25
+ | **rotation_interval** | **String** | | [optional] |
26
26
  | **rotator_type** | **String** | The rotator type. options: [target/password] | |
27
27
  | **secure_access_bastion_issuer** | **String** | Deprecated. use secure-access-certificate-issuer | [optional] |
28
28
  | **secure_access_certificate_issuer** | **String** | Path to the SSH Certificate Issuer for your Akeyless Secure Access | [optional] |
data/docs/RotatedSecretCreateMssql.md CHANGED
@@ -5,13 +5,13 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
8
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
8
+ | **auto_rotate** | **String** | | [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] |
11
11
  | **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
12
12
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
13
13
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
14
- | **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] |
14
+ | **key** | **String** | | [optional] |
15
15
  | **lock_during_sra_session** | **String** | Lock this secret for read/update while an SRA session is active | [optional] |
16
16
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
17
17
  | **name** | **String** | Rotated secret name | |
@@ -21,8 +21,8 @@
21
21
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
22
22
  | **rotated_username** | **String** | username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password) | [optional] |
23
23
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
24
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
25
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
24
+ | **rotation_hour** | **Integer** | | [optional] |
25
+ | **rotation_interval** | **String** | | [optional] |
26
26
  | **rotator_type** | **String** | The rotator type. options: [target/password] | |
27
27
  | **secure_access_bastion_issuer** | **String** | Deprecated. use secure-access-certificate-issuer | [optional] |
28
28
  | **secure_access_certificate_issuer** | **String** | Path to the SSH Certificate Issuer for your Akeyless Secure Access | [optional] |
data/docs/RotatedSecretCreateMysql.md CHANGED
@@ -5,13 +5,13 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
8
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
8
+ | **auto_rotate** | **String** | | [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] |
11
11
  | **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
12
12
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
13
13
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
14
- | **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] |
14
+ | **key** | **String** | | [optional] |
15
15
  | **lock_during_sra_session** | **String** | Lock this secret for read/update while an SRA session is active | [optional] |
16
16
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
17
17
  | **name** | **String** | Rotated secret name | |
@@ -21,8 +21,8 @@
21
21
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
22
22
  | **rotated_username** | **String** | username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password) | [optional] |
23
23
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
24
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
25
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
24
+ | **rotation_hour** | **Integer** | | [optional] |
25
+ | **rotation_interval** | **String** | | [optional] |
26
26
  | **rotator_type** | **String** | The rotator type. options: [target/password] | |
27
27
  | **secure_access_bastion_issuer** | **String** | Deprecated. use secure-access-certificate-issuer | [optional] |
28
28
  | **secure_access_certificate_issuer** | **String** | Path to the SSH Certificate Issuer for your Akeyless Secure Access | [optional] |
data/docs/RotatedSecretCreateOpenAI.md CHANGED
@@ -7,20 +7,20 @@
7
7
  | **api_key** | **String** | Admin API key value to rotate (relevant only for rotator-type=api-key) | [optional] |
8
8
  | **api_key_id** | **String** | Admin API key ID to rotate (relevant only for rotator-type=api-key) | [optional] |
9
9
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
10
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
10
+ | **auto_rotate** | **String** | | [optional] |
11
11
  | **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
12
12
  | **description** | **String** | Description of the object | [optional] |
13
13
  | **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
14
14
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
15
15
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
16
- | **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] |
16
+ | **key** | **String** | | [optional] |
17
17
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
18
18
  | **name** | **String** | Rotated secret name | |
19
19
  | **output_rule** | **Array<String>** | Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets) | [optional] |
20
20
  | **password_length** | **String** | The length of the password to be generated | [optional] |
21
21
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
22
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
23
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
22
+ | **rotation_hour** | **Integer** | | [optional] |
23
+ | **rotation_interval** | **String** | | [optional] |
24
24
  | **rotator_type** | **String** | The rotator type. options: [target/api-key] | |
25
25
  | **tags** | **Array<String>** | Add tags attached to this object | [optional] |
26
26
  | **target_name** | **String** | The target name to associate | |
data/docs/RotatedSecretCreateOracledb.md CHANGED
@@ -5,13 +5,13 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
8
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
8
+ | **auto_rotate** | **String** | | [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] |
11
11
  | **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
12
12
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
13
13
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
14
- | **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] |
14
+ | **key** | **String** | | [optional] |
15
15
  | **lock_during_sra_session** | **String** | Lock this secret for read/update while an SRA session is active | [optional] |
16
16
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
17
17
  | **name** | **String** | Rotated secret name | |
@@ -21,8 +21,8 @@
21
21
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
22
22
  | **rotated_username** | **String** | username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password) | [optional] |
23
23
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
24
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
25
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
24
+ | **rotation_hour** | **Integer** | | [optional] |
25
+ | **rotation_interval** | **String** | | [optional] |
26
26
  | **rotator_type** | **String** | The rotator type. options: [target/password] | |
27
27
  | **secure_access_db_name** | **String** | The DB name (relevant only for DB Dynamic-Secret) | [optional] |
28
28
  | **secure_access_enable** | **String** | Enable/Disable secure remote access [true/false] | [optional] |
data/docs/RotatedSecretCreatePostgresql.md CHANGED
@@ -5,13 +5,13 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
8
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
8
+ | **auto_rotate** | **String** | | [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] |
11
11
  | **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
12
12
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
13
13
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
14
- | **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] |
14
+ | **key** | **String** | | [optional] |
15
15
  | **lock_during_sra_session** | **String** | Lock this secret for read/update while an SRA session is active | [optional] |
16
16
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
17
17
  | **name** | **String** | Rotated secret name | |
@@ -21,8 +21,8 @@
21
21
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
22
22
  | **rotated_username** | **String** | username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password) | [optional] |
23
23
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
24
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
25
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
24
+ | **rotation_hour** | **Integer** | | [optional] |
25
+ | **rotation_interval** | **String** | | [optional] |
26
26
  | **rotator_type** | **String** | The rotator type. options: [target/password] | |
27
27
  | **secure_access_bastion_issuer** | **String** | Deprecated. use secure-access-certificate-issuer | [optional] |
28
28
  | **secure_access_certificate_issuer** | **String** | Path to the SSH Certificate Issuer for your Akeyless Secure Access | [optional] |
data/docs/RotatedSecretCreateRedis.md CHANGED
@@ -5,13 +5,13 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
8
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
8
+ | **auto_rotate** | **String** | | [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] |
11
11
  | **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
12
12
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
13
13
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
14
- | **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] |
14
+ | **key** | **String** | | [optional] |
15
15
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
16
16
  | **name** | **String** | Rotated secret name | |
17
17
  | **output_rule** | **Array<String>** | Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets) | [optional] |
@@ -19,8 +19,8 @@
19
19
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
20
20
  | **rotated_username** | **String** | username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password) | [optional] |
21
21
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
22
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
23
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
22
+ | **rotation_hour** | **Integer** | | [optional] |
23
+ | **rotation_interval** | **String** | | [optional] |
24
24
  | **rotator_type** | **String** | The rotator type. options: [target/password] | |
25
25
  | **tags** | **Array<String>** | Add tags attached to this object | [optional] |
26
26
  | **target_name** | **String** | The target name to associate | |
data/docs/RotatedSecretCreateRedshift.md CHANGED
@@ -5,13 +5,13 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
8
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
8
+ | **auto_rotate** | **String** | | [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] |
11
11
  | **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
12
12
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
13
13
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
14
- | **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] |
14
+ | **key** | **String** | | [optional] |
15
15
  | **lock_during_sra_session** | **String** | Lock this secret for read/update while an SRA session is active | [optional] |
16
16
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
17
17
  | **name** | **String** | Rotated secret name | |
@@ -21,8 +21,8 @@
21
21
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
22
22
  | **rotated_username** | **String** | username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password) | [optional] |
23
23
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
24
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
25
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
24
+ | **rotation_hour** | **Integer** | | [optional] |
25
+ | **rotation_interval** | **String** | | [optional] |
26
26
  | **rotator_type** | **String** | The rotator type. options: [target/password] | |
27
27
  | **secure_access_db_name** | **String** | The DB name (relevant only for DB Dynamic-Secret) | [optional] |
28
28
  | **secure_access_enable** | **String** | Enable/Disable secure remote access [true/false] | [optional] |
data/docs/RotatedSecretCreateSnowflake.md CHANGED
@@ -5,13 +5,13 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
8
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
8
+ | **auto_rotate** | **String** | | [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] |
11
11
  | **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
12
12
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
13
13
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
14
- | **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] |
14
+ | **key** | **String** | | [optional] |
15
15
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
16
16
  | **name** | **String** | Rotated secret name | |
17
17
  | **output_rule** | **Array<String>** | Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets) | [optional] |
@@ -21,8 +21,8 @@
21
21
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
22
22
  | **rotated_username** | **String** | username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password or rotator-type=key) | [optional] |
23
23
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
24
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
25
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
24
+ | **rotation_hour** | **Integer** | | [optional] |
25
+ | **rotation_interval** | **String** | | [optional] |
26
26
  | **rotator_type** | **String** | The rotator type. options: [target/password/key] | |
27
27
  | **tags** | **Array<String>** | Add tags attached to this object | [optional] |
28
28
  | **target_name** | **String** | The target name to associate | |
data/docs/RotatedSecretCreateSplunk.md CHANGED
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **audience** | **String** | Token audience for Splunk token creation (required for rotator-type=token) | [optional] |
8
8
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
9
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
9
+ | **auto_rotate** | **String** | | [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
12
  | **expiration_date** | **String** | Token expiration date in YYYY-MM-DD format (required for rotator-type=token when manual rotation is selected and no existing token is provided). Time will be set to 00:00 UTC. | [optional] |
@@ -15,7 +15,7 @@
15
15
  | **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
16
16
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
17
17
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
18
- | **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] |
18
+ | **key** | **String** | | [optional] |
19
19
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
20
20
  | **name** | **String** | Rotated secret name | |
21
21
  | **output_rule** | **Array<String>** | Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets) | [optional] |
@@ -23,8 +23,8 @@
23
23
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
24
24
  | **rotated_username** | **String** | username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password) | [optional] |
25
25
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
26
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
27
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
26
+ | **rotation_hour** | **Integer** | | [optional] |
27
+ | **rotation_interval** | **String** | | [optional] |
28
28
  | **rotator_type** | **String** | The rotator type. options: [target/password/token/hec-token] | |
29
29
  | **splunk_token** | **String** | Current Splunk authentication token to store (relevant only for rotator-type=token). If not provided, a new token will be created in Splunk. | [optional] |
30
30
  | **tags** | **Array<String>** | Add tags attached to this object | [optional] |
data/docs/RotatedSecretCreateSsh.md CHANGED
@@ -5,13 +5,13 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
8
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
8
+ | **auto_rotate** | **String** | | [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] |
11
11
  | **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
12
12
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
13
13
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
14
- | **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] |
14
+ | **key** | **String** | | [optional] |
15
15
  | **key_data_base64** | **String** | Private key file contents encoded using base64 | [optional] |
16
16
  | **lock_during_sra_session** | **String** | Lock this secret for read/update while an SRA session is active | [optional] |
17
17
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
@@ -23,8 +23,8 @@
23
23
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
24
24
  | **rotated_username** | **String** | username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password) | [optional] |
25
25
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
26
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
27
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
26
+ | **rotation_hour** | **Integer** | | [optional] |
27
+ | **rotation_interval** | **String** | | [optional] |
28
28
  | **rotator_custom_cmd** | **String** | Custom rotation command | [optional] |
29
29
  | **rotator_type** | **String** | The rotator type. options: [target/password/key] | |
30
30
  | **same_password** | **String** | Rotate same password for each host from the Linked Target (relevant only for Linked Target) | [optional] |
data/docs/RotatedSecretCreateWindows.md CHANGED
@@ -5,13 +5,13 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
8
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
8
+ | **auto_rotate** | **String** | | [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] |
11
11
  | **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
12
12
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
13
13
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
14
- | **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] |
14
+ | **key** | **String** | | [optional] |
15
15
  | **lock_during_sra_session** | **String** | Lock this secret for read/update while an SRA session is active | [optional] |
16
16
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
17
17
  | **name** | **String** | Rotated secret name | |
@@ -21,8 +21,8 @@
21
21
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
22
22
  | **rotated_username** | **String** | username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password) | [optional] |
23
23
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
24
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
25
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
24
+ | **rotation_hour** | **Integer** | | [optional] |
25
+ | **rotation_interval** | **String** | | [optional] |
26
26
  | **rotator_type** | **String** | The rotator type. options: [target/password] | |
27
27
  | **same_password** | **String** | Rotate same password for each host from the Linked Target (relevant only for Linked Target) | [optional] |
28
28
  | **secure_access_allow_external_user** | **Boolean** | Allow providing external user for a domain users | [optional][default to false] |
data/docs/RotatedSecretUpdateAws.md CHANGED
@@ -8,7 +8,7 @@
8
8
  | **api_id** | **String** | API ID to rotate (relevant only for rotator-type=api-key) | [optional] |
9
9
  | **api_key** | **String** | API key to rotate (relevant only for rotator-type=api-key) | [optional] |
10
10
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
11
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
11
+ | **auto_rotate** | **String** | | [optional] |
12
12
  | **aws_region** | **String** | Aws Region | [optional][default to 'us-east-2'] |
13
13
  | **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
14
14
  | **description** | **String** | Description of the object | [optional][default to 'default_metadata'] |
@@ -20,7 +20,7 @@
20
20
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
21
21
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
22
22
  | **keep_prev_version** | **String** | Whether to keep previous version [true/false]. If not set, use default according to account settings | [optional] |
23
- | **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] |
23
+ | **key** | **String** | | [optional] |
24
24
  | **lock_during_sra_session** | **String** | Lock this secret for read/update while an SRA session is active | [optional] |
25
25
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
26
26
  | **name** | **String** | Rotated secret name | |
@@ -30,8 +30,8 @@
30
30
  | **rm_tag** | **Array<String>** | List of the existent tags that will be removed from this item | [optional] |
31
31
  | **rotate_after_disconnect** | **String** | StringOrBool accepts JSON strings, booleans, and numbers for backward compatibility with older SDK versions that send boolean values for rotate-after-disconnect. | [optional] |
32
32
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
33
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
34
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
33
+ | **rotation_hour** | **Integer** | | [optional] |
34
+ | **rotation_interval** | **String** | | [optional] |
35
35
  | **secure_access_aws_account_id** | **String** | The AWS account id | [optional] |
36
36
  | **secure_access_aws_native_cli** | **Boolean** | The AWS native cli | [optional] |
37
37
  | **secure_access_bastion_issuer** | **String** | Deprecated. use secure-access-certificate-issuer | [optional] |
data/docs/RotatedSecretUpdateAzure.md CHANGED
@@ -9,7 +9,7 @@
9
9
  | **api_key** | **String** | API key to rotate (relevant only for rotator-type=api-key) | [optional] |
10
10
  | **application_id** | **String** | Id of the azure app that hold the serect to be rotated (relevant only for rotator-type=api-key & authentication-credentials=use-target-creds) | [optional] |
11
11
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
12
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
12
+ | **auto_rotate** | **String** | | [optional] |
13
13
  | **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
14
14
  | **description** | **String** | Description of the object | [optional][default to 'default_metadata'] |
15
15
  | **explicitly_set_sa** | **String** | If set, explicitly provide the storage account details [true/false] | [optional][default to 'false'] |
@@ -21,20 +21,21 @@
21
21
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
22
22
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
23
23
  | **keep_prev_version** | **String** | Whether to keep previous version [true/false]. If not set, use default according to account settings | [optional] |
24
- | **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] |
24
+ | **key** | **String** | | [optional] |
25
25
  | **lock_during_sra_session** | **String** | Lock this secret for read/update while an SRA session is active | [optional] |
26
26
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
27
27
  | **name** | **String** | Rotated secret name | |
28
28
  | **new_name** | **String** | New item name | [optional] |
29
29
  | **output_rule** | **Array<String>** | Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets) | [optional] |
30
+ | **password** | **String** | The password for the user principal name to rotate (relevant only for rotator-type=password) | [optional] |
30
31
  | **password_length** | **String** | The length of the password to be generated | [optional] |
31
32
  | **resource_group_name** | **String** | The resource group name (only relevant when explicitly-set-sa=true) | [optional] |
32
33
  | **resource_name** | **String** | The name of the storage account (only relevant when explicitly-set-sa=true) | [optional] |
33
34
  | **rm_tag** | **Array<String>** | List of the existent tags that will be removed from this item | [optional] |
34
35
  | **rotate_after_disconnect** | **String** | StringOrBool accepts JSON strings, booleans, and numbers for backward compatibility with older SDK versions that send boolean values for rotate-after-disconnect. | [optional] |
35
36
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
36
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
37
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
37
+ | **rotation_hour** | **Integer** | | [optional] |
38
+ | **rotation_interval** | **String** | | [optional] |
38
39
  | **secure_access_disable_concurrent_connections** | **Boolean** | Enable this flag to prevent simultaneous use of the same secret | [optional] |
39
40
  | **secure_access_enable** | **String** | Enable/Disable secure remote access [true/false] | [optional] |
40
41
  | **secure_access_url** | **String** | Destination URL to inject secrets | [optional] |
@@ -79,6 +80,7 @@ instance = Akeyless::RotatedSecretUpdateAzure.new(
79
80
  name: null,
80
81
  new_name: null,
81
82
  output_rule: null,
83
+ password: null,
82
84
  password_length: null,
83
85
  resource_group_name: null,
84
86
  resource_name: null,
data/docs/RotatedSecretUpdateCassandra.md CHANGED
@@ -6,14 +6,14 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **add_tag** | **Array<String>** | List of the new tags that will be attached to this item | [optional] |
8
8
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
9
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
9
+ | **auto_rotate** | **String** | | [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][default to 'default_metadata'] |
12
12
  | **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
13
13
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
14
14
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
15
15
  | **keep_prev_version** | **String** | Whether to keep previous version [true/false]. If not set, use default according to account settings | [optional] |
16
- | **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] |
16
+ | **key** | **String** | | [optional] |
17
17
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
18
18
  | **name** | **String** | Rotated secret name | |
19
19
  | **new_name** | **String** | New item name | [optional] |
@@ -23,8 +23,8 @@
23
23
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
24
24
  | **rotated_username** | **String** | username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password) | [optional] |
25
25
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
26
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
27
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
26
+ | **rotation_hour** | **Integer** | | [optional] |
27
+ | **rotation_interval** | **String** | | [optional] |
28
28
  | **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
29
29
  | **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
30
30
  | **use_capital_letters** | **String** | Specifies whether the generated temporary password must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z). [true/false] | [optional] |
data/docs/RotatedSecretUpdateCustom.md CHANGED
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **add_tag** | **Array<String>** | List of the new tags that will be attached to this item | [optional] |
8
8
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
9
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
9
+ | **auto_rotate** | **String** | | [optional] |
10
10
  | **custom_payload** | **String** | Secret payload to be sent with rotation request | [optional] |
11
11
  | **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
12
12
  | **description** | **String** | Description of the object | [optional][default to 'default_metadata'] |
@@ -15,7 +15,7 @@
15
15
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
16
16
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
17
17
  | **keep_prev_version** | **String** | Whether to keep previous version [true/false]. If not set, use default according to account settings | [optional] |
18
- | **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] |
18
+ | **key** | **String** | | [optional] |
19
19
  | **lock_during_sra_session** | **String** | Lock this secret for read/update while an SRA session is active | [optional] |
20
20
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
21
21
  | **name** | **String** | Rotated secret name | |
@@ -25,8 +25,8 @@
25
25
  | **rm_tag** | **Array<String>** | List of the existent tags that will be removed from this item | [optional] |
26
26
  | **rotate_after_disconnect** | **String** | StringOrBool accepts JSON strings, booleans, and numbers for backward compatibility with older SDK versions that send boolean values for rotate-after-disconnect. | [optional] |
27
27
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
28
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
29
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
28
+ | **rotation_hour** | **Integer** | | [optional] |
29
+ | **rotation_interval** | **String** | | [optional] |
30
30
  | **secure_access_allow_external_user** | **Boolean** | Allow providing external user for a domain users | [optional][default to false] |
31
31
  | **secure_access_bastion_issuer** | **String** | Deprecated. use secure-access-certificate-issuer | [optional] |
32
32
  | **secure_access_certificate_issuer** | **String** | Path to the SSH Certificate Issuer for your Akeyless Secure Access | [optional] |
data/docs/RotatedSecretUpdateDockerhub.md CHANGED
@@ -6,14 +6,14 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **add_tag** | **Array<String>** | List of the new tags that will be attached to this item | [optional] |
8
8
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
9
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
9
+ | **auto_rotate** | **String** | | [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][default to 'default_metadata'] |
12
12
  | **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
13
13
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
14
14
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
15
15
  | **keep_prev_version** | **String** | Whether to keep previous version [true/false]. If not set, use default according to account settings | [optional] |
16
- | **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] |
16
+ | **key** | **String** | | [optional] |
17
17
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
18
18
  | **name** | **String** | Rotated secret name | |
19
19
  | **new_name** | **String** | New item name | [optional] |
@@ -21,8 +21,8 @@
21
21
  | **password_length** | **String** | The length of the password to be generated | [optional] |
22
22
  | **rm_tag** | **Array<String>** | List of the existent tags that will be removed from this item | [optional] |
23
23
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
24
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
25
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
24
+ | **rotation_hour** | **Integer** | | [optional] |
25
+ | **rotation_interval** | **String** | | [optional] |
26
26
  | **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
27
27
  | **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
28
28
  | **use_capital_letters** | **String** | Specifies whether the generated temporary password must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z). [true/false] | [optional] |
data/docs/RotatedSecretUpdateGcp.md CHANGED
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **add_tag** | **Array<String>** | List of the new tags that will be attached to this item | [optional] |
8
8
  | **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
9
- | **auto_rotate** | **String** | Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] | [optional] |
9
+ | **auto_rotate** | **String** | | [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][default to 'default_metadata'] |
12
12
  | **gcp_key** | **String** | Base64-encoded service account private key text | [optional] |
@@ -20,7 +20,7 @@
20
20
  | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
21
21
  | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
22
22
  | **keep_prev_version** | **String** | Whether to keep previous version [true/false]. If not set, use default according to account settings | [optional] |
23
- | **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] |
23
+ | **key** | **String** | | [optional] |
24
24
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
25
25
  | **name** | **String** | Rotated secret name | |
26
26
  | **new_name** | **String** | New item name | [optional] |
@@ -28,8 +28,8 @@
28
28
  | **password_length** | **String** | The length of the password to be generated | [optional] |
29
29
  | **rm_tag** | **Array<String>** | List of the existent tags that will be removed from this item | [optional] |
30
30
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
31
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
32
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
31
+ | **rotation_hour** | **Integer** | | [optional] |
32
+ | **rotation_interval** | **String** | | [optional] |
33
33
  | **rotator_type** | **String** | The rotator type. options: [target/service-account-rotator] | |
34
34
  | **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
35
35
  | **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |