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/RotatedSecretUpdateHanadb.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/RotatedSecretUpdateHashiVault.md ADDED
@@ -0,0 +1,64 @@
1
+ # Akeyless::RotatedSecretUpdateHashiVault
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **add_tag** | **Array<String>** | List of the new tags that will be attached to this item | [optional] |
8
+ | **auto_rotate** | **String** | | [optional] |
9
+ | **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
10
+ | **description** | **String** | Description of the object | [optional][default to 'default_metadata'] |
11
+ | **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
12
+ | **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
13
+ | **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
14
+ | **keep_prev_version** | **String** | Whether to keep previous version [true/false]. If not set, use default according to account settings | [optional] |
15
+ | **key** | **String** | | [optional] |
16
+ | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
17
+ | **name** | **String** | Rotated secret name | |
18
+ | **new_name** | **String** | New item name | [optional] |
19
+ | **output_rule** | **Array<String>** | Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets) | [optional] |
20
+ | **password_length** | **String** | The length of the password to be generated | [optional] |
21
+ | **rm_tag** | **Array<String>** | List of the existent tags that will be removed from this item | [optional] |
22
+ | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
23
+ | **rotation_hour** | **Integer** | | [optional] |
24
+ | **rotation_interval** | **String** | | [optional] |
25
+ | **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
26
+ | **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
27
+ | **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] |
28
+ | **use_lower_letters** | **String** | Specifies whether the generated temporary password must contain at least one lowercase character from the ISO basic Latin alphabet (a to z). [true/false] | [optional] |
29
+ | **use_numbers** | **String** | Specifies whether the generated temporary password must contain at least one numeric character (0 to 9). [true/false] | [optional] |
30
+ | **use_special_characters** | **String** | | [optional] |
31
+
32
+ ## Example
33
+
34
+ ```ruby
35
+ require 'akeyless'
36
+
37
+ instance = Akeyless::RotatedSecretUpdateHashiVault.new(
38
+ add_tag: null,
39
+ auto_rotate: null,
40
+ delete_protection: null,
41
+ description: null,
42
+ input_rule: null,
43
+ item_custom_fields: null,
44
+ json: null,
45
+ keep_prev_version: null,
46
+ key: null,
47
+ max_versions: null,
48
+ name: null,
49
+ new_name: null,
50
+ output_rule: null,
51
+ password_length: null,
52
+ rm_tag: null,
53
+ rotation_event_in: null,
54
+ rotation_hour: null,
55
+ rotation_interval: null,
56
+ token: null,
57
+ uid_token: null,
58
+ use_capital_letters: null,
59
+ use_lower_letters: null,
60
+ use_numbers: null,
61
+ use_special_characters: ! @ # $. [true/false]
62
+ )
63
+ ```
64
+
data/docs/RotatedSecretUpdateLdap.md CHANGED
@@ -7,7 +7,7 @@
7
7
  | **provider_type** | **String** | | [optional] |
8
8
  | **add_tag** | **Array<String>** | List of the new tags that will be attached to this item | [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][default to 'default_metadata'] |
13
13
  | **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] |
@@ -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 | |
@@ -27,8 +27,8 @@
27
27
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=ldap) | [optional] |
28
28
  | **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] |
29
29
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
30
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
31
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
30
+ | **rotation_hour** | **Integer** | | [optional] |
31
+ | **rotation_interval** | **String** | | [optional] |
32
32
  | **secure_access_bastion_issuer** | **String** | Deprecated. use secure-access-certificate-issuer | [optional] |
33
33
  | **secure_access_certificate_issuer** | **String** | Path to the SSH Certificate Issuer for your Akeyless Secure Access | [optional] |
34
34
  | **secure_access_enable** | **String** | Enable/Disable secure remote access [true/false] | [optional] |
data/docs/RotatedSecretUpdateMongodb.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
  | **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 | |
@@ -25,8 +25,8 @@
25
25
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
26
26
  | **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] |
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_bastion_issuer** | **String** | Deprecated. use secure-access-certificate-issuer | [optional] |
31
31
  | **secure_access_certificate_issuer** | **String** | Path to the SSH Certificate Issuer for your Akeyless Secure Access | [optional] |
32
32
  | **secure_access_db_name** | **String** | The DB name (relevant only for DB Dynamic-Secret) | [optional] |
data/docs/RotatedSecretUpdateMssql.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
  | **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 | |
@@ -25,8 +25,8 @@
25
25
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
26
26
  | **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] |
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_bastion_issuer** | **String** | Deprecated. use secure-access-certificate-issuer | [optional] |
31
31
  | **secure_access_certificate_issuer** | **String** | Path to the SSH Certificate Issuer for your Akeyless Secure Access | [optional] |
32
32
  | **secure_access_db_name** | **String** | The DB name (relevant only for DB Dynamic-Secret) | [optional] |
data/docs/RotatedSecretUpdateMysql.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
  | **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 | |
@@ -25,8 +25,8 @@
25
25
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
26
26
  | **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] |
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_bastion_issuer** | **String** | Deprecated. use secure-access-certificate-issuer | [optional] |
31
31
  | **secure_access_certificate_issuer** | **String** | Path to the SSH Certificate Issuer for your Akeyless Secure Access | [optional] |
32
32
  | **secure_access_db_name** | **String** | The DB name (relevant only for DB Dynamic-Secret) | [optional] |
data/docs/RotatedSecretUpdateOpenAI.md CHANGED
@@ -8,14 +8,14 @@
8
8
  | **api_key** | **String** | Admin API key value to update (relevant only for rotator-type=api-key) | [optional] |
9
9
  | **api_key_id** | **String** | Admin API key ID to update (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
  | **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
13
13
  | **description** | **String** | Description of the object | [optional][default to 'default_metadata'] |
14
14
  | **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
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
  | **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
  | **new_name** | **String** | New item name | [optional] |
@@ -23,8 +23,8 @@
23
23
  | **password_length** | **String** | The length of the password to be generated | [optional] |
24
24
  | **rm_tag** | **Array<String>** | List of the existent tags that will be removed from this item | [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/RotatedSecretUpdateOracledb.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
  | **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 | |
@@ -25,8 +25,8 @@
25
25
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
26
26
  | **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] |
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_db_name** | **String** | The DB name (relevant only for DB Dynamic-Secret) | [optional] |
31
31
  | **secure_access_enable** | **String** | Enable/Disable secure remote access [true/false] | [optional] |
32
32
  | **secure_access_host** | **Array<String>** | Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers) | [optional] |
data/docs/RotatedSecretUpdatePostgresql.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
  | **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 | |
@@ -25,8 +25,8 @@
25
25
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
26
26
  | **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] |
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_bastion_issuer** | **String** | Deprecated. use secure-access-certificate-issuer | [optional] |
31
31
  | **secure_access_certificate_issuer** | **String** | Path to the SSH Certificate Issuer for your Akeyless Secure Access | [optional] |
32
32
  | **secure_access_db_name** | **String** | The DB name (relevant only for DB Dynamic-Secret) | [optional] |
data/docs/RotatedSecretUpdateRedis.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/RotatedSecretUpdateRedshift.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
  | **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 | |
@@ -25,8 +25,8 @@
25
25
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
26
26
  | **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] |
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_db_name** | **String** | The DB name (relevant only for DB Dynamic-Secret) | [optional] |
31
31
  | **secure_access_enable** | **String** | Enable/Disable secure remote access [true/false] | [optional] |
32
32
  | **secure_access_host** | **Array<String>** | Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers) | [optional] |
data/docs/RotatedSecretUpdateSnowflake.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] |
@@ -25,8 +25,8 @@
25
25
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
26
26
  | **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] |
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
  | **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
31
31
  | **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
32
32
  | **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/RotatedSecretUpdateSplunk.md CHANGED
@@ -7,7 +7,7 @@
7
7
  | **add_tag** | **Array<String>** | List of the new tags that will be attached to this item | [optional] |
8
8
  | **audience** | **String** | Token audience for Splunk token creation (relevant only for rotator-type=token) | [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][default to 'default_metadata'] |
13
13
  | **expiration_date** | **String** | Token expiration date in YYYY-MM-DD format (relevant only for rotator-type=token when manual rotation is selected). Time will be set to 00:00 UTC. | [optional] |
@@ -16,7 +16,7 @@
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
18
  | **keep_prev_version** | **String** | Whether to keep previous version [true/false]. If not set, use default according to account settings | [optional] |
19
- | **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] |
19
+ | **key** | **String** | | [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 | |
22
22
  | **new_name** | **String** | New item name | [optional] |
@@ -24,8 +24,8 @@
24
24
  | **password_length** | **String** | The length of the password to be generated | [optional] |
25
25
  | **rm_tag** | **Array<String>** | List of the existent tags that will be removed from this item | [optional] |
26
26
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
27
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
28
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
27
+ | **rotation_hour** | **Integer** | | [optional] |
28
+ | **rotation_interval** | **String** | | [optional] |
29
29
  | **splunk_token** | **String** | For rotator-type=token, optionally set/replace the stored Splunk authentication token value. | [optional] |
30
30
  | **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
31
31
  | **token_owner** | **String** | For rotator-type=token, specify the Splunk username that the new token should be issued for. (Splunk 10 requires name=<token-owner> when creating auth tokens.) | [optional] |
data/docs/RotatedSecretUpdateSsh.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
  | **key_data_base64** | **String** | Private key file contents encoded using base64 | [optional] |
18
18
  | **lock_during_sra_session** | **String** | Lock this secret for read/update while an SRA session is active | [optional] |
19
19
  | **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
@@ -27,8 +27,8 @@
27
27
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
28
28
  | **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] |
29
29
  | **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
30
- | **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
31
- | **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
30
+ | **rotation_hour** | **Integer** | | [optional] |
31
+ | **rotation_interval** | **String** | | [optional] |
32
32
  | **rotator_custom_cmd** | **String** | Custom rotation command | [optional] |
33
33
  | **rotator_type** | **String** | The rotator type. options: [target/password/key] | |
34
34
  | **same_password** | **String** | Rotate same password for each host from the Linked Target (relevant only for Linked Target) | [optional] |
data/docs/RotatedSecretUpdateWindows.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
  | **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 | |
@@ -25,8 +25,8 @@
25
25
  | **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
26
26
  | **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] |
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
  | **rotator_type** | **String** | The rotator type. options: [target/password] | |
31
31
  | **same_password** | **String** | Rotate same password for each host from the Linked Target (relevant only for Linked Target) | [optional] |
32
32
  | **secure_access_allow_external_user** | **Boolean** | Allow providing external user for a domain users | [optional][default to false] |
data/docs/SecretInfo.md CHANGED
@@ -21,6 +21,8 @@
21
21
  | **thumbprint** | **String** | | [optional] |
22
22
  | **type** | **String** | | [optional] |
23
23
  | **version** | **Integer** | | [optional] |
24
+ | **version_id** | **String** | | [optional] |
25
+ | **version_ids** | **Array<String>** | | [optional] |
24
26
 
25
27
  ## Example
26
28
 
@@ -44,7 +46,9 @@ instance = Akeyless::SecretInfo.new(
44
46
  tags: null,
45
47
  thumbprint: null,
46
48
  type: null,
47
- version: null
49
+ version: null,
50
+ version_id: null,
51
+ version_ids: null
48
52
  )
49
53
  ```
50
54
 
data/docs/UscGetSecretOutput.md CHANGED
@@ -10,6 +10,9 @@
10
10
  | **metadata** | **Object** | | [optional] |
11
11
  | **name** | **String** | | [optional] |
12
12
  | **value** | **String** | | [optional] |
13
+ | **version_id** | **String** | | [optional] |
14
+ | **version_ids** | **Array<String>** | | [optional] |
15
+ | **warnings** | **Array<String>** | | [optional] |
13
16
 
14
17
  ## Example
15
18
 
@@ -22,7 +25,10 @@ instance = Akeyless::UscGetSecretOutput.new(
22
25
  id: null,
23
26
  metadata: null,
24
27
  name: null,
25
- value: null
28
+ value: null,
29
+ version_id: null,
30
+ version_ids: null,
31
+ warnings: null
26
32
  )
27
33
  ```
28
34