akeyless 5.0.19 → 5.0.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +28 -1
- data/docs/CertificateStore.md +2 -0
- data/docs/CreateUSC.md +2 -0
- data/docs/GCPPayload.md +5 -1
- data/docs/GatewayCreateMigration.md +5 -1
- data/docs/GatewayUpdateMigration.md +5 -1
- data/docs/GatewayUpdateTlsCert.md +2 -0
- data/docs/GeneralConfigPart.md +6 -0
- data/docs/GetKubeExecCreds.md +1 -1
- data/docs/GetPKICertificate.md +1 -1
- data/docs/LetsEncryptTargetDetails.md +38 -0
- data/docs/PoliciesCreateOutput.md +18 -0
- data/docs/PoliciesDelete.md +24 -0
- data/docs/PoliciesGet.md +24 -0
- data/docs/PoliciesGetOutput.md +18 -0
- data/docs/PoliciesList.md +30 -0
- data/docs/PoliciesListOutput.md +18 -0
- data/docs/PolicyCreateKeys.md +34 -0
- data/docs/PolicyOutput.md +34 -0
- data/docs/PolicyUpdateKeys.md +36 -0
- data/docs/RotatedSecretCreateAws.md +4 -2
- data/docs/RotatedSecretCreateAzure.md +4 -2
- data/docs/RotatedSecretCreateCassandra.md +1 -1
- data/docs/RotatedSecretCreateCustom.md +1 -1
- data/docs/RotatedSecretCreateDockerhub.md +1 -1
- data/docs/RotatedSecretCreateGcp.md +4 -2
- data/docs/RotatedSecretCreateHanadb.md +1 -1
- data/docs/RotatedSecretCreateLdap.md +1 -1
- data/docs/RotatedSecretCreateMongodb.md +1 -1
- data/docs/RotatedSecretCreateMssql.md +1 -1
- data/docs/RotatedSecretCreateMysql.md +1 -1
- data/docs/RotatedSecretCreateOpenAI.md +1 -1
- data/docs/RotatedSecretCreateOracledb.md +1 -1
- data/docs/RotatedSecretCreatePostgresql.md +1 -1
- data/docs/RotatedSecretCreateRedis.md +1 -1
- data/docs/RotatedSecretCreateRedshift.md +1 -1
- data/docs/RotatedSecretCreateSnowflake.md +1 -1
- data/docs/RotatedSecretCreateSplunk.md +68 -0
- data/docs/RotatedSecretCreateSsh.md +1 -1
- data/docs/RotatedSecretCreateWindows.md +1 -1
- data/docs/RotatedSecretDetailsInfo.md +2 -0
- data/docs/RotatedSecretUpdateAws.md +3 -1
- data/docs/RotatedSecretUpdateAzure.md +3 -1
- data/docs/RotatedSecretUpdateGcp.md +3 -1
- data/docs/RotatedSecretUpdateSplunk.md +64 -0
- data/docs/SecretInfo.md +2 -0
- data/docs/SplunkPayload.md +30 -0
- data/docs/SplunkTargetDetails.md +34 -0
- data/docs/TargetCreateLetsEncrypt.md +46 -0
- data/docs/TargetCreateSplunk.md +42 -0
- data/docs/TargetTypeDetailsInput.md +4 -0
- data/docs/TargetUpdateLetsEncrypt.md +50 -0
- data/docs/UpdateItem.md +2 -0
- data/docs/UscCreate.md +2 -0
- data/docs/V2Api.md +659 -29
- data/lib/akeyless/api/v2_api.rb +640 -0
- data/lib/akeyless/models/certificate_store.rb +12 -1
- data/lib/akeyless/models/create_usc.rb +11 -1
- data/lib/akeyless/models/gateway_create_migration.rb +24 -4
- data/lib/akeyless/models/gateway_update_migration.rb +24 -4
- data/lib/akeyless/models/gateway_update_tls_cert.rb +13 -1
- data/lib/akeyless/models/gcp_payload.rb +22 -4
- data/lib/akeyless/models/general_config_part.rb +30 -1
- data/lib/akeyless/models/get_kube_exec_creds.rb +1 -1
- data/lib/akeyless/models/get_pki_certificate.rb +1 -1
- data/lib/akeyless/models/lets_encrypt_target_details.rb +315 -0
- data/lib/akeyless/models/policies_create_output.rb +214 -0
- data/lib/akeyless/models/policies_delete.rb +254 -0
- data/lib/akeyless/models/policies_get.rb +254 -0
- data/lib/akeyless/models/policies_get_output.rb +214 -0
- data/lib/akeyless/models/policies_list.rb +283 -0
- data/lib/akeyless/models/policies_list_output.rb +216 -0
- data/lib/akeyless/models/policy_create_keys.rb +312 -0
- data/lib/akeyless/models/policy_output.rb +295 -0
- data/lib/akeyless/models/policy_update_keys.rb +322 -0
- data/lib/akeyless/models/rotated_secret_create_aws.rb +13 -3
- data/lib/akeyless/models/rotated_secret_create_azure.rb +13 -3
- data/lib/akeyless/models/rotated_secret_create_cassandra.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_custom.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_dockerhub.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_gcp.rb +13 -3
- data/lib/akeyless/models/rotated_secret_create_hanadb.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_ldap.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_mongodb.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_mssql.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_mysql.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_open_ai.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_oracledb.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_postgresql.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_redis.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_redshift.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_snowflake.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_splunk.rb +497 -0
- data/lib/akeyless/models/rotated_secret_create_ssh.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_windows.rb +1 -1
- data/lib/akeyless/models/rotated_secret_details_info.rb +10 -1
- data/lib/akeyless/models/rotated_secret_update_aws.rb +12 -2
- data/lib/akeyless/models/rotated_secret_update_azure.rb +12 -2
- data/lib/akeyless/models/rotated_secret_update_gcp.rb +12 -2
- data/lib/akeyless/models/rotated_secret_update_splunk.rb +467 -0
- data/lib/akeyless/models/secret_info.rb +10 -1
- data/lib/akeyless/models/splunk_payload.rb +268 -0
- data/lib/akeyless/models/splunk_target_details.rb +294 -0
- data/lib/akeyless/models/target_create_lets_encrypt.rb +368 -0
- data/lib/akeyless/models/target_create_splunk.rb +354 -0
- data/lib/akeyless/models/target_type_details_input.rb +19 -1
- data/lib/akeyless/models/target_update_lets_encrypt.rb +388 -0
- data/lib/akeyless/models/update_item.rb +11 -1
- data/lib/akeyless/models/usc_create.rb +11 -1
- data/lib/akeyless/version.rb +1 -1
- data/lib/akeyless.rb +17 -0
- data/spec/models/lets_encrypt_target_details_spec.rb +96 -0
- data/spec/models/policies_create_output_spec.rb +36 -0
- data/spec/models/policies_delete_spec.rb +54 -0
- data/spec/models/policies_get_output_spec.rb +36 -0
- data/spec/models/policies_get_spec.rb +54 -0
- data/spec/models/policies_list_output_spec.rb +36 -0
- data/spec/models/policies_list_spec.rb +72 -0
- data/spec/models/policy_create_keys_spec.rb +84 -0
- data/spec/models/policy_output_spec.rb +84 -0
- data/spec/models/policy_update_keys_spec.rb +90 -0
- data/spec/models/rotated_secret_create_splunk_spec.rb +186 -0
- data/spec/models/rotated_secret_update_splunk_spec.rb +174 -0
- data/spec/models/splunk_payload_spec.rb +72 -0
- data/spec/models/splunk_target_details_spec.rb +84 -0
- data/spec/models/target_create_lets_encrypt_spec.rb +120 -0
- data/spec/models/target_create_splunk_spec.rb +108 -0
- data/spec/models/target_update_lets_encrypt_spec.rb +132 -0
- metadata +69 -1
|
@@ -12,9 +12,10 @@
|
|
|
12
12
|
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
13
13
|
| **description** | **String** | Description of the object | [optional] |
|
|
14
14
|
| **explicitly_set_sa** | **String** | If set, explicitly provide the storage account details [true/false] | [optional][default to 'false'] |
|
|
15
|
-
| **grace_rotation** | **String** |
|
|
15
|
+
| **grace_rotation** | **String** | Enable graceful rotation (keep both versions temporarily). When enabled, a new secret version is created while the previous version is kept for the grace period, so both versions exist for a limited time. [true/false] | [optional] |
|
|
16
16
|
| **grace_rotation_hour** | **Integer** | The Hour of the grace rotation in UTC | [optional] |
|
|
17
17
|
| **grace_rotation_interval** | **String** | The number of days to wait before deleting the old key (must be bigger than rotation-interval) | [optional] |
|
|
18
|
+
| **grace_rotation_timing** | **String** | When to create the new version relative to the rotation date [after/before] | [optional] |
|
|
18
19
|
| **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
|
|
19
20
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
20
21
|
| **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] |
|
|
@@ -36,7 +37,7 @@
|
|
|
36
37
|
| **secure_access_web_proxy** | **Boolean** | Web-Proxy via Akeyless's Secure Remote Access (SRA) | [optional][default to false] |
|
|
37
38
|
| **storage_account_key_name** | **String** | The name of the storage account key to rotate [key1/key2/kerb1/kerb2] (relevat to azure-storage-account) | [optional] |
|
|
38
39
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
39
|
-
| **target_name** | **String** |
|
|
40
|
+
| **target_name** | **String** | The target name to associate | |
|
|
40
41
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
41
42
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
42
43
|
| **username** | **String** | The user principal name to rotate his password (relevant only for rotator-type=password) | [optional] |
|
|
@@ -58,6 +59,7 @@ instance = Akeyless::RotatedSecretCreateAzure.new(
|
|
|
58
59
|
grace_rotation: null,
|
|
59
60
|
grace_rotation_hour: null,
|
|
60
61
|
grace_rotation_interval: null,
|
|
62
|
+
grace_rotation_timing: null,
|
|
61
63
|
item_custom_fields: null,
|
|
62
64
|
json: null,
|
|
63
65
|
key: null,
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
| **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
|
|
22
22
|
| **rotator_type** | **String** | The rotator type. options: [target/password] | |
|
|
23
23
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
24
|
-
| **target_name** | **String** |
|
|
24
|
+
| **target_name** | **String** | The target name to associate | |
|
|
25
25
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
26
26
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
27
27
|
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
| **secure_access_web_browsing** | **Boolean** | Secure browser via Akeyless's Secure Remote Access (SRA) | [optional][default to false] |
|
|
34
34
|
| **secure_access_web_proxy** | **Boolean** | Web-Proxy via Akeyless's Secure Remote Access (SRA) | [optional][default to false] |
|
|
35
35
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
36
|
-
| **target_name** | **String** |
|
|
36
|
+
| **target_name** | **String** | The target name to associate | |
|
|
37
37
|
| **timeout_sec** | **Integer** | Maximum allowed time in seconds for the custom rotator to return the results | [optional][default to 40] |
|
|
38
38
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
39
39
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
| **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
|
|
19
19
|
| **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
|
|
20
20
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
21
|
-
| **target_name** | **String** |
|
|
21
|
+
| **target_name** | **String** | The target name to associate | |
|
|
22
22
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
23
23
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
24
24
|
|
|
@@ -11,9 +11,10 @@
|
|
|
11
11
|
| **gcp_key** | **String** | Base64-encoded service account private key text | [optional] |
|
|
12
12
|
| **gcp_service_account_email** | **String** | The email of the gcp service account to rotate | [optional] |
|
|
13
13
|
| **gcp_service_account_key_id** | **String** | The key id of the gcp service account to rotate | [optional] |
|
|
14
|
-
| **grace_rotation** | **String** |
|
|
14
|
+
| **grace_rotation** | **String** | Enable graceful rotation (keep both versions temporarily). When enabled, a new secret version is created while the previous version is kept for the grace period, so both versions exist for a limited time. [true/false] | [optional] |
|
|
15
15
|
| **grace_rotation_hour** | **Integer** | The Hour of the grace rotation in UTC | [optional] |
|
|
16
16
|
| **grace_rotation_interval** | **String** | The number of days to wait before deleting the old key (must be bigger than rotation-interval) | [optional] |
|
|
17
|
+
| **grace_rotation_timing** | **String** | When to create the new version relative to the rotation date [after/before] | [optional] |
|
|
17
18
|
| **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
|
|
18
19
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
19
20
|
| **key** | **String** | The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used) | [optional] |
|
|
@@ -25,7 +26,7 @@
|
|
|
25
26
|
| **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
|
|
26
27
|
| **rotator_type** | **String** | The rotator type. options: [target/service-account-rotator] | |
|
|
27
28
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
28
|
-
| **target_name** | **String** |
|
|
29
|
+
| **target_name** | **String** | The target name to associate | |
|
|
29
30
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
30
31
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
31
32
|
|
|
@@ -45,6 +46,7 @@ instance = Akeyless::RotatedSecretCreateGcp.new(
|
|
|
45
46
|
grace_rotation: null,
|
|
46
47
|
grace_rotation_hour: null,
|
|
47
48
|
grace_rotation_interval: null,
|
|
49
|
+
grace_rotation_timing: null,
|
|
48
50
|
item_custom_fields: null,
|
|
49
51
|
json: null,
|
|
50
52
|
key: null,
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
| **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
|
|
22
22
|
| **rotator_type** | **String** | The rotator type. options: [target/password] | |
|
|
23
23
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
24
|
-
| **target_name** | **String** |
|
|
24
|
+
| **target_name** | **String** | The target name to associate | |
|
|
25
25
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
26
26
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
27
27
|
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
| **secure_access_web_proxy** | **Boolean** | Web-Proxy via Akeyless's Secure Remote Access (SRA) | [optional][default to false] |
|
|
35
35
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
36
36
|
| **target** | **Array<String>** | A list of linked targets to be associated, Relevant only for Secure Remote Access for ssh cert issuer, ldap rotated secret and ldap dynamic secret, To specify multiple targets use argument multiple times | [optional] |
|
|
37
|
-
| **target_name** | **String** |
|
|
37
|
+
| **target_name** | **String** | The target name to associate | |
|
|
38
38
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
39
39
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
40
40
|
| **user_attribute** | **String** | LDAP User Attribute, Default value \"cn\" | [optional][default to 'cn'] |
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
| **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] |
|
|
29
29
|
| **secure_access_web** | **Boolean** | Enable Web Secure Remote Access | [optional][default to false] |
|
|
30
30
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
31
|
-
| **target_name** | **String** |
|
|
31
|
+
| **target_name** | **String** | The target name to associate | |
|
|
32
32
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
33
33
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
34
34
|
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
| **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] |
|
|
30
30
|
| **secure_access_web** | **Boolean** | Enable Web Secure Remote Access | [optional][default to false] |
|
|
31
31
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
32
|
-
| **target_name** | **String** |
|
|
32
|
+
| **target_name** | **String** | The target name to associate | |
|
|
33
33
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
34
34
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
35
35
|
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
| **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] |
|
|
29
29
|
| **secure_access_web** | **Boolean** | Enable Web Secure Remote Access | [optional][default to false] |
|
|
30
30
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
31
|
-
| **target_name** | **String** |
|
|
31
|
+
| **target_name** | **String** | The target name to associate | |
|
|
32
32
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
33
33
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
34
34
|
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
| **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
|
|
22
22
|
| **rotator_type** | **String** | The rotator type. options: [target/api-key] | |
|
|
23
23
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
24
|
-
| **target_name** | **String** |
|
|
24
|
+
| **target_name** | **String** | The target name to associate | |
|
|
25
25
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
26
26
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
27
27
|
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
| **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] |
|
|
27
27
|
| **secure_access_web** | **Boolean** | Enable Web Secure Remote Access | [optional][default to false] |
|
|
28
28
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
29
|
-
| **target_name** | **String** |
|
|
29
|
+
| **target_name** | **String** | The target name to associate | |
|
|
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
|
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
| **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] |
|
|
30
30
|
| **secure_access_web** | **Boolean** | Enable Web Secure Remote Access | [optional][default to false] |
|
|
31
31
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
32
|
-
| **target_name** | **String** |
|
|
32
|
+
| **target_name** | **String** | The target name to associate | |
|
|
33
33
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
34
34
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
35
35
|
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
| **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
|
|
22
22
|
| **rotator_type** | **String** | The rotator type. options: [target/password] | |
|
|
23
23
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
24
|
-
| **target_name** | **String** |
|
|
24
|
+
| **target_name** | **String** | The target name to associate | |
|
|
25
25
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
26
26
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
27
27
|
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
| **secure_access_enable** | **String** | Enable/Disable secure remote access [true/false] | [optional] |
|
|
26
26
|
| **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] |
|
|
27
27
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
28
|
-
| **target_name** | **String** |
|
|
28
|
+
| **target_name** | **String** | The target name to associate | |
|
|
29
29
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
30
30
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
31
31
|
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
| **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
|
|
24
24
|
| **rotator_type** | **String** | The rotator type. options: [target/password/key] | |
|
|
25
25
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
26
|
-
| **target_name** | **String** |
|
|
26
|
+
| **target_name** | **String** | The target name to associate | |
|
|
27
27
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
28
28
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
29
29
|
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
# Akeyless::RotatedSecretCreateSplunk
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **audience** | **String** | Token audience for Splunk token creation (required for rotator-type=token) | [optional] |
|
|
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] |
|
|
10
|
+
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
11
|
+
| **description** | **String** | Description of the object | [optional] |
|
|
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] |
|
|
13
|
+
| **hec_token** | **String** | Current Splunk HEC token value to store (relevant only for rotator-type=hec-token). If not provided, a new HEC input will be created in Splunk. | [optional] |
|
|
14
|
+
| **hec_token_name** | **String** | Splunk HEC input name to manage (required for rotator-type=hec-token) | [optional] |
|
|
15
|
+
| **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
|
|
16
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
17
|
+
| **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
|
+
| **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
|
|
19
|
+
| **name** | **String** | Rotated secret name | |
|
|
20
|
+
| **password_length** | **String** | The length of the password to be generated | [optional] |
|
|
21
|
+
| **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
|
|
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
|
+
| **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] |
|
|
26
|
+
| **rotator_type** | **String** | The rotator type. options: [target/password/token/hec-token] | |
|
|
27
|
+
| **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] |
|
|
28
|
+
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
29
|
+
| **target_name** | **String** | The target name to associate | |
|
|
30
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
31
|
+
| **token_owner** | **String** | Splunk token owner username (relevant only for rotator-type=token) | [optional] |
|
|
32
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
33
|
+
|
|
34
|
+
## Example
|
|
35
|
+
|
|
36
|
+
```ruby
|
|
37
|
+
require 'akeyless'
|
|
38
|
+
|
|
39
|
+
instance = Akeyless::RotatedSecretCreateSplunk.new(
|
|
40
|
+
audience: null,
|
|
41
|
+
authentication_credentials: null,
|
|
42
|
+
auto_rotate: null,
|
|
43
|
+
delete_protection: null,
|
|
44
|
+
description: null,
|
|
45
|
+
expiration_date: null,
|
|
46
|
+
hec_token: null,
|
|
47
|
+
hec_token_name: null,
|
|
48
|
+
item_custom_fields: null,
|
|
49
|
+
json: null,
|
|
50
|
+
key: null,
|
|
51
|
+
max_versions: null,
|
|
52
|
+
name: null,
|
|
53
|
+
password_length: null,
|
|
54
|
+
rotated_password: null,
|
|
55
|
+
rotated_username: null,
|
|
56
|
+
rotation_event_in: null,
|
|
57
|
+
rotation_hour: null,
|
|
58
|
+
rotation_interval: null,
|
|
59
|
+
rotator_type: null,
|
|
60
|
+
splunk_token: null,
|
|
61
|
+
tags: null,
|
|
62
|
+
target_name: null,
|
|
63
|
+
token: null,
|
|
64
|
+
token_owner: null,
|
|
65
|
+
uid_token: null
|
|
66
|
+
)
|
|
67
|
+
```
|
|
68
|
+
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
| **secure_access_ssh_user** | **String** | Override the SSH username as indicated in SSH Certificate Issuer | [optional] |
|
|
36
36
|
| **secure_access_target_type** | **String** | Specify target type. Options are ssh or rdp | [optional][default to 'false'] |
|
|
37
37
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
38
|
-
| **target_name** | **String** |
|
|
38
|
+
| **target_name** | **String** | The target name to associate | |
|
|
39
39
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
40
40
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
41
41
|
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
| **secure_access_rdp_domain** | **String** | Default domain name server. i.e. microsoft.com | [optional] |
|
|
31
31
|
| **secure_access_rdp_user** | **String** | Override the RDP Domain username | [optional] |
|
|
32
32
|
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
33
|
-
| **target_name** | **String** |
|
|
33
|
+
| **target_name** | **String** | The target name to associate | |
|
|
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] |
|
|
36
36
|
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
| **grace_rotation** | **Boolean** | | [optional] |
|
|
10
10
|
| **grace_rotation_hour** | **Integer** | | [optional] |
|
|
11
11
|
| **grace_rotation_interval** | **Integer** | | [optional] |
|
|
12
|
+
| **grace_rotation_timing** | **String** | | [optional] |
|
|
12
13
|
| **gw_cluster_id** | **Integer** | | [optional] |
|
|
13
14
|
| **iis_apps_details** | [**Array<WindowsService>**](WindowsService.md) | | [optional] |
|
|
14
15
|
| **last_rotation_error** | **String** | | [optional] |
|
|
@@ -38,6 +39,7 @@ instance = Akeyless::RotatedSecretDetailsInfo.new(
|
|
|
38
39
|
grace_rotation: null,
|
|
39
40
|
grace_rotation_hour: null,
|
|
40
41
|
grace_rotation_interval: null,
|
|
42
|
+
grace_rotation_timing: null,
|
|
41
43
|
gw_cluster_id: null,
|
|
42
44
|
iis_apps_details: null,
|
|
43
45
|
last_rotation_error: null,
|
|
@@ -12,9 +12,10 @@
|
|
|
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'] |
|
|
15
|
-
| **grace_rotation** | **String** |
|
|
15
|
+
| **grace_rotation** | **String** | Enable graceful rotation (keep both versions temporarily). When enabled, a new secret version is created while the previous version is kept for the grace period, so both versions exist for a limited time. [true/false] | [optional] |
|
|
16
16
|
| **grace_rotation_hour** | **Integer** | The Hour of the grace rotation in UTC | [optional] |
|
|
17
17
|
| **grace_rotation_interval** | **String** | The number of days to wait before deleting the old key (must be bigger than rotation-interval) | [optional] |
|
|
18
|
+
| **grace_rotation_timing** | **String** | When to create the new version relative to the rotation date [after/before] | [optional] |
|
|
18
19
|
| **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
|
|
19
20
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
20
21
|
| **keep_prev_version** | **String** | Whether to keep previous version [true/false]. If not set, use default according to account settings | [optional] |
|
|
@@ -53,6 +54,7 @@ instance = Akeyless::RotatedSecretUpdateAws.new(
|
|
|
53
54
|
grace_rotation: null,
|
|
54
55
|
grace_rotation_hour: null,
|
|
55
56
|
grace_rotation_interval: null,
|
|
57
|
+
grace_rotation_timing: null,
|
|
56
58
|
item_custom_fields: null,
|
|
57
59
|
json: null,
|
|
58
60
|
keep_prev_version: null,
|
|
@@ -13,9 +13,10 @@
|
|
|
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'] |
|
|
16
|
-
| **grace_rotation** | **String** |
|
|
16
|
+
| **grace_rotation** | **String** | Enable graceful rotation (keep both versions temporarily). When enabled, a new secret version is created while the previous version is kept for the grace period, so both versions exist for a limited time. [true/false] | [optional] |
|
|
17
17
|
| **grace_rotation_hour** | **Integer** | The Hour of the grace rotation in UTC | [optional] |
|
|
18
18
|
| **grace_rotation_interval** | **String** | The number of days to wait before deleting the old key (must be bigger than rotation-interval) | [optional] |
|
|
19
|
+
| **grace_rotation_timing** | **String** | When to create the new version relative to the rotation date [after/before] | [optional] |
|
|
19
20
|
| **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
|
|
20
21
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
21
22
|
| **keep_prev_version** | **String** | Whether to keep previous version [true/false]. If not set, use default according to account settings | [optional] |
|
|
@@ -60,6 +61,7 @@ instance = Akeyless::RotatedSecretUpdateAzure.new(
|
|
|
60
61
|
grace_rotation: null,
|
|
61
62
|
grace_rotation_hour: null,
|
|
62
63
|
grace_rotation_interval: null,
|
|
64
|
+
grace_rotation_timing: null,
|
|
63
65
|
item_custom_fields: null,
|
|
64
66
|
json: null,
|
|
65
67
|
keep_prev_version: null,
|
|
@@ -12,9 +12,10 @@
|
|
|
12
12
|
| **gcp_key** | **String** | Base64-encoded service account private key text | [optional] |
|
|
13
13
|
| **gcp_service_account_email** | **String** | The email of the gcp service account to rotate | [optional] |
|
|
14
14
|
| **gcp_service_account_key_id** | **String** | The key id of the gcp service account to rotate | [optional] |
|
|
15
|
-
| **grace_rotation** | **String** |
|
|
15
|
+
| **grace_rotation** | **String** | Enable graceful rotation (keep both versions temporarily). When enabled, a new secret version is created while the previous version is kept for the grace period, so both versions exist for a limited time. [true/false] | [optional] |
|
|
16
16
|
| **grace_rotation_hour** | **Integer** | The Hour of the grace rotation in UTC | [optional] |
|
|
17
17
|
| **grace_rotation_interval** | **String** | The number of days to wait before deleting the old key (must be bigger than rotation-interval) | [optional] |
|
|
18
|
+
| **grace_rotation_timing** | **String** | When to create the new version relative to the rotation date [after/before] | [optional] |
|
|
18
19
|
| **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
|
|
19
20
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
20
21
|
| **keep_prev_version** | **String** | Whether to keep previous version [true/false]. If not set, use default according to account settings | [optional] |
|
|
@@ -48,6 +49,7 @@ instance = Akeyless::RotatedSecretUpdateGcp.new(
|
|
|
48
49
|
grace_rotation: null,
|
|
49
50
|
grace_rotation_hour: null,
|
|
50
51
|
grace_rotation_interval: null,
|
|
52
|
+
grace_rotation_timing: null,
|
|
51
53
|
item_custom_fields: null,
|
|
52
54
|
json: null,
|
|
53
55
|
keep_prev_version: null,
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# Akeyless::RotatedSecretUpdateSplunk
|
|
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
|
+
| **audience** | **String** | Token audience for Splunk token creation (relevant only for rotator-type=token) | [optional] |
|
|
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] |
|
|
11
|
+
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
12
|
+
| **description** | **String** | Description of the object | [optional][default to 'default_metadata'] |
|
|
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] |
|
|
14
|
+
| **hec_token** | **String** | For rotator-type=hec-token, optionally set/replace the stored HEC token value. | [optional] |
|
|
15
|
+
| **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
|
|
16
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
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] |
|
|
19
|
+
| **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
|
|
20
|
+
| **name** | **String** | Rotated secret name | |
|
|
21
|
+
| **new_name** | **String** | New item name | [optional] |
|
|
22
|
+
| **password_length** | **String** | The length of the password to be generated | [optional] |
|
|
23
|
+
| **rm_tag** | **Array<String>** | List of the existent tags that will be removed from this item | [optional] |
|
|
24
|
+
| **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
|
|
25
|
+
| **rotation_hour** | **Integer** | The Hour of the rotation in UTC | [optional] |
|
|
26
|
+
| **rotation_interval** | **String** | The number of days to wait between every automatic key rotation (1-365) | [optional] |
|
|
27
|
+
| **splunk_token** | **String** | For rotator-type=token, optionally set/replace the stored Splunk authentication token value. | [optional] |
|
|
28
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
29
|
+
| **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] |
|
|
30
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
31
|
+
|
|
32
|
+
## Example
|
|
33
|
+
|
|
34
|
+
```ruby
|
|
35
|
+
require 'akeyless'
|
|
36
|
+
|
|
37
|
+
instance = Akeyless::RotatedSecretUpdateSplunk.new(
|
|
38
|
+
add_tag: null,
|
|
39
|
+
audience: null,
|
|
40
|
+
authentication_credentials: null,
|
|
41
|
+
auto_rotate: null,
|
|
42
|
+
delete_protection: null,
|
|
43
|
+
description: null,
|
|
44
|
+
expiration_date: null,
|
|
45
|
+
hec_token: null,
|
|
46
|
+
item_custom_fields: null,
|
|
47
|
+
json: null,
|
|
48
|
+
keep_prev_version: null,
|
|
49
|
+
key: null,
|
|
50
|
+
max_versions: null,
|
|
51
|
+
name: null,
|
|
52
|
+
new_name: null,
|
|
53
|
+
password_length: null,
|
|
54
|
+
rm_tag: null,
|
|
55
|
+
rotation_event_in: null,
|
|
56
|
+
rotation_hour: null,
|
|
57
|
+
rotation_interval: null,
|
|
58
|
+
splunk_token: null,
|
|
59
|
+
token: null,
|
|
60
|
+
token_owner: null,
|
|
61
|
+
uid_token: null
|
|
62
|
+
)
|
|
63
|
+
```
|
|
64
|
+
|
data/docs/SecretInfo.md
CHANGED
|
@@ -11,6 +11,7 @@
|
|
|
11
11
|
| **last_retrieved** | **Time** | | [optional] |
|
|
12
12
|
| **location** | **Object** | | [optional] |
|
|
13
13
|
| **name** | **String** | | [optional] |
|
|
14
|
+
| **region** | **String** | | [optional] |
|
|
14
15
|
| **secret_id** | **String** | | [optional] |
|
|
15
16
|
| **status** | **Boolean** | | [optional] |
|
|
16
17
|
| **tags** | **Hash<String, String>** | | [optional] |
|
|
@@ -31,6 +32,7 @@ instance = Akeyless::SecretInfo.new(
|
|
|
31
32
|
last_retrieved: null,
|
|
32
33
|
location: null,
|
|
33
34
|
name: null,
|
|
35
|
+
region: null,
|
|
34
36
|
secret_id: null,
|
|
35
37
|
status: null,
|
|
36
38
|
tags: null,
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Akeyless::SplunkPayload
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **audience** | **String** | | [optional] |
|
|
8
|
+
| **expiration_date** | **String** | | [optional] |
|
|
9
|
+
| **hec_token_name** | **String** | | [optional] |
|
|
10
|
+
| **token** | **String** | | [optional] |
|
|
11
|
+
| **token_id** | **String** | | [optional] |
|
|
12
|
+
| **token_owner** | **String** | | [optional] |
|
|
13
|
+
| **validity_period_days** | **Integer** | | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'akeyless'
|
|
19
|
+
|
|
20
|
+
instance = Akeyless::SplunkPayload.new(
|
|
21
|
+
audience: null,
|
|
22
|
+
expiration_date: null,
|
|
23
|
+
hec_token_name: null,
|
|
24
|
+
token: null,
|
|
25
|
+
token_id: null,
|
|
26
|
+
token_owner: null,
|
|
27
|
+
validity_period_days: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Akeyless::SplunkTargetDetails
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **audience** | **String** | Token audience | [optional] |
|
|
8
|
+
| **auth_mode** | **String** | Authentication mode: \"username\" or \"token\" | [optional] |
|
|
9
|
+
| **password** | **String** | | [optional] |
|
|
10
|
+
| **splunk_payload** | [**SplunkPayload**](SplunkPayload.md) | | [optional] |
|
|
11
|
+
| **splunk_url** | **String** | Splunk server URL | [optional] |
|
|
12
|
+
| **token** | **String** | Token is used when AuthMode == \"token\" | [optional] |
|
|
13
|
+
| **token_owner** | **String** | Token owner (the Splunk user who owns the token, required for token rotation) | [optional] |
|
|
14
|
+
| **use_tls** | **Boolean** | Use TLS certificate verification when connecting to the Splunk management API. | [optional] |
|
|
15
|
+
| **username** | **String** | Username & Password are used when AuthMode == \"username\" | [optional] |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'akeyless'
|
|
21
|
+
|
|
22
|
+
instance = Akeyless::SplunkTargetDetails.new(
|
|
23
|
+
audience: null,
|
|
24
|
+
auth_mode: null,
|
|
25
|
+
password: null,
|
|
26
|
+
splunk_payload: null,
|
|
27
|
+
splunk_url: null,
|
|
28
|
+
token: null,
|
|
29
|
+
token_owner: null,
|
|
30
|
+
use_tls: null,
|
|
31
|
+
username: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Akeyless::TargetCreateLetsEncrypt
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **acme_challenge** | **String** | | [optional][default to 'http'] |
|
|
8
|
+
| **description** | **String** | Description of the object | [optional] |
|
|
9
|
+
| **dns_target_creds** | **String** | Name of existing cloud target for DNS credentials. Required when acme-challenge=dns. Supported: AWS, Azure, GCP targets | [optional] |
|
|
10
|
+
| **email** | **String** | Email address for ACME account registration | [optional] |
|
|
11
|
+
| **gcp_project** | **String** | GCP Cloud DNS: Project ID. Optional - can be derived from service account | [optional] |
|
|
12
|
+
| **hosted_zone** | **String** | AWS Route53 hosted zone ID. Required when dns-target-creds points to AWS target | [optional] |
|
|
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 target secret value (if empty, the account default protectionKey key will be used) | [optional] |
|
|
15
|
+
| **lets_encrypt_url** | **String** | | [optional][default to 'production'] |
|
|
16
|
+
| **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
|
|
17
|
+
| **name** | **String** | Target name | |
|
|
18
|
+
| **resource_group** | **String** | Azure resource group name. Required when dns-target-creds points to Azure target | [optional] |
|
|
19
|
+
| **timeout** | **String** | | [optional][default to '5m'] |
|
|
20
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
21
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
require 'akeyless'
|
|
27
|
+
|
|
28
|
+
instance = Akeyless::TargetCreateLetsEncrypt.new(
|
|
29
|
+
acme_challenge: null,
|
|
30
|
+
description: null,
|
|
31
|
+
dns_target_creds: null,
|
|
32
|
+
email: null,
|
|
33
|
+
gcp_project: null,
|
|
34
|
+
hosted_zone: null,
|
|
35
|
+
json: null,
|
|
36
|
+
key: null,
|
|
37
|
+
lets_encrypt_url: null,
|
|
38
|
+
max_versions: null,
|
|
39
|
+
name: null,
|
|
40
|
+
resource_group: null,
|
|
41
|
+
timeout: null,
|
|
42
|
+
token: null,
|
|
43
|
+
uid_token: null
|
|
44
|
+
)
|
|
45
|
+
```
|
|
46
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Akeyless::TargetCreateSplunk
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **audience** | **String** | Splunk token audience (required when using token authentication for rotation) | [optional] |
|
|
8
|
+
| **description** | **String** | Description of the object | [optional] |
|
|
9
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
10
|
+
| **key** | **String** | The name of a key that used to encrypt the target secret value (if empty, the account default protectionKey key will be used) | [optional] |
|
|
11
|
+
| **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
|
|
12
|
+
| **name** | **String** | Target name | |
|
|
13
|
+
| **password** | **String** | Splunk Password (used when authenticating with username/password) | [optional] |
|
|
14
|
+
| **token** | **String** | Splunk Token (used when authenticating with token) | [optional] |
|
|
15
|
+
| **token_owner** | **String** | Splunk Token Owner (required when using token authentication for rotation) | [optional] |
|
|
16
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
17
|
+
| **url** | **String** | Splunk server URL | |
|
|
18
|
+
| **use_tls** | **Boolean** | Use TLS certificate verification when connecting to the Splunk management API | [optional][default to true] |
|
|
19
|
+
| **username** | **String** | Splunk Username (used when authenticating with username/password) | [optional] |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'akeyless'
|
|
25
|
+
|
|
26
|
+
instance = Akeyless::TargetCreateSplunk.new(
|
|
27
|
+
audience: null,
|
|
28
|
+
description: null,
|
|
29
|
+
json: null,
|
|
30
|
+
key: null,
|
|
31
|
+
max_versions: null,
|
|
32
|
+
name: null,
|
|
33
|
+
password: null,
|
|
34
|
+
token: null,
|
|
35
|
+
token_owner: null,
|
|
36
|
+
uid_token: null,
|
|
37
|
+
url: null,
|
|
38
|
+
use_tls: null,
|
|
39
|
+
username: null
|
|
40
|
+
)
|
|
41
|
+
```
|
|
42
|
+
|