akeyless 5.0.21 → 5.0.23
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 +35 -1
- data/docs/AccountGeneralSettings.md +6 -0
- data/docs/ActiveDirectoryPayload.md +6 -0
- data/docs/Auth.md +2 -0
- data/docs/AuthMethodCreateCert.md +2 -0
- data/docs/AuthMethodCreateUniversalIdentity.md +4 -0
- data/docs/AuthMethodUpdateCert.md +2 -0
- data/docs/AuthMethodUpdateUniversalIdentity.md +4 -0
- data/docs/AwsStorage.md +2 -0
- data/docs/AzureADAccessRules.md +2 -0
- data/docs/AzureTargetDetails.md +2 -0
- data/docs/CertAccessRules.md +2 -0
- data/docs/CertificateChainInfo.md +2 -0
- data/docs/Configure.md +2 -0
- data/docs/ConjurMigration.md +20 -0
- data/docs/ConjurPayload.md +24 -0
- data/docs/CreateAuthMethodCert.md +2 -0
- data/docs/CreateAuthMethodUniversalIdentity.md +4 -0
- data/docs/CreateAzureTarget.md +2 -0
- data/docs/CreateRotatedSecret.md +3 -1
- data/docs/CreateSecret.md +2 -0
- data/docs/CreateUSC.md +10 -0
- data/docs/DSProducerDetails.md +2 -0
- data/docs/DefaultAuthMethodSettings.md +20 -0
- data/docs/DeleteRoleRule.md +1 -1
- data/docs/DescribePermissions.md +1 -1
- data/docs/DigiCertTargetDetails.md +42 -0
- data/docs/EsmListSecretsOutput.md +3 -1
- data/docs/GatewayCreateMigration.md +19 -1
- data/docs/GatewayUpdateMigration.md +18 -0
- data/docs/GatewayUpdateRemoteAccessRdpRecordings.md +2 -0
- data/docs/GeneralConfigPart.md +4 -0
- data/docs/GetPKICertificateOutput.md +2 -0
- data/docs/GithubMetadata.md +28 -0
- data/docs/GoogleTrustTargetDetails.md +42 -0
- data/docs/HTTPChallengeInfo.md +26 -0
- data/docs/HashiPayload.md +5 -1
- data/docs/IssuerOverviewInfo.md +22 -0
- data/docs/Item.md +2 -0
- data/docs/ItemGeneralInfo.md +2 -0
- data/docs/ItemLockingSetting.md +20 -0
- data/docs/LockItem.md +28 -0
- data/docs/LockTarget.md +28 -0
- data/docs/LockingInfo.md +24 -0
- data/docs/MigrationStatusReplyObj.md +4 -0
- data/docs/MigrationsConfigPart.md +2 -0
- data/docs/NetappStorage.md +30 -0
- data/docs/ReverseRBAC.md +1 -1
- data/docs/RotatedSecretCreateAws.md +3 -1
- data/docs/RotatedSecretCreateAzure.md +3 -1
- data/docs/RotatedSecretCreateCustom.md +3 -1
- data/docs/RotatedSecretCreateLdap.md +3 -1
- data/docs/RotatedSecretCreateMongodb.md +3 -1
- data/docs/RotatedSecretCreateMssql.md +3 -1
- data/docs/RotatedSecretCreateMysql.md +3 -1
- data/docs/RotatedSecretCreateOracledb.md +3 -1
- data/docs/RotatedSecretCreatePostgresql.md +3 -1
- data/docs/RotatedSecretCreateRedshift.md +3 -1
- data/docs/RotatedSecretCreateSsh.md +3 -1
- data/docs/RotatedSecretCreateWindows.md +3 -1
- data/docs/RotatedSecretUpdateAws.md +3 -1
- data/docs/RotatedSecretUpdateAzure.md +3 -1
- data/docs/RotatedSecretUpdateCustom.md +3 -1
- data/docs/RotatedSecretUpdateLdap.md +3 -1
- data/docs/RotatedSecretUpdateMongodb.md +3 -1
- data/docs/RotatedSecretUpdateMssql.md +3 -1
- data/docs/RotatedSecretUpdateMysql.md +3 -1
- data/docs/RotatedSecretUpdateOracledb.md +3 -1
- data/docs/RotatedSecretUpdatePostgresql.md +3 -1
- data/docs/RotatedSecretUpdateRedshift.md +3 -1
- data/docs/RotatedSecretUpdateSsh.md +3 -1
- data/docs/RotatedSecretUpdateWindows.md +3 -1
- data/docs/SecretInfo.md +4 -0
- data/docs/SecureRemoteAccess.md +4 -0
- data/docs/SetRoleRule.md +1 -1
- data/docs/SyncCounters.md +22 -0
- data/docs/Target.md +2 -0
- data/docs/TargetCreateAzure.md +2 -0
- data/docs/TargetCreateDigiCert.md +50 -0
- data/docs/TargetCreateGoogleTrust.md +50 -0
- data/docs/TargetCreateLetsEncrypt.md +1 -1
- data/docs/TargetCreateSplunk.md +3 -1
- data/docs/TargetTypeDetailsInput.md +4 -0
- data/docs/TargetUpdateAzure.md +2 -0
- data/docs/TargetUpdateDigiCert.md +54 -0
- data/docs/TargetUpdateGoogleTrust.md +54 -0
- data/docs/TargetUpdateLetsEncrypt.md +1 -1
- data/docs/UniversalIdentityAccessRules.md +4 -0
- data/docs/UnlockItem.md +24 -0
- data/docs/UnlockTarget.md +24 -0
- data/docs/UpdateAccountSettings.md +4 -0
- data/docs/UpdateAuthMethodCert.md +2 -0
- data/docs/UpdateAuthMethodUniversalIdentity.md +4 -0
- data/docs/UpdateAzureTarget.md +2 -0
- data/docs/UpdateItem.md +3 -1
- data/docs/UpdateRotatedSecret.md +3 -1
- data/docs/UscCreate.md +2 -0
- data/docs/UscDelete.md +4 -0
- data/docs/UscGet.md +4 -0
- data/docs/UscListSecretsOutput.md +3 -1
- data/docs/UscUpdate.md +4 -0
- data/docs/V2Api.md +632 -2
- data/docs/ValidateCertificateChallenge.md +30 -0
- data/docs/ValidateCertificateChallengeOutput.md +24 -0
- data/docs/VaultAddress.md +20 -0
- data/docs/VaultAddressOutput.md +20 -0
- data/docs/WebBastionRdpRecord.md +2 -0
- data/lib/akeyless/api/v2_api.rb +640 -0
- data/lib/akeyless/models/account_general_settings.rb +28 -1
- data/lib/akeyless/models/active_directory_payload.rb +30 -1
- data/lib/akeyless/models/auth.rb +13 -1
- data/lib/akeyless/models/auth_method_create_cert.rb +11 -1
- data/lib/akeyless/models/auth_method_create_universal_identity.rb +25 -1
- data/lib/akeyless/models/auth_method_update_cert.rb +11 -1
- data/lib/akeyless/models/auth_method_update_universal_identity.rb +25 -1
- data/lib/akeyless/models/aws_storage.rb +10 -1
- data/lib/akeyless/models/azure_ad_access_rules.rb +11 -1
- data/lib/akeyless/models/azure_target_details.rb +10 -1
- data/lib/akeyless/models/cert_access_rules.rb +11 -1
- data/lib/akeyless/models/certificate_chain_info.rb +11 -1
- data/lib/akeyless/models/configure.rb +13 -1
- data/lib/akeyless/models/conjur_migration.rb +223 -0
- data/lib/akeyless/models/conjur_payload.rb +241 -0
- data/lib/akeyless/models/create_auth_method_cert.rb +11 -1
- data/lib/akeyless/models/create_auth_method_universal_identity.rb +25 -1
- data/lib/akeyless/models/create_azure_target.rb +13 -1
- data/lib/akeyless/models/create_rotated_secret.rb +12 -4
- data/lib/akeyless/models/create_secret.rb +11 -1
- data/lib/akeyless/models/create_usc.rb +54 -1
- data/lib/akeyless/models/default_auth_method_settings.rb +223 -0
- data/lib/akeyless/models/delete_role_rule.rb +1 -1
- data/lib/akeyless/models/describe_permissions.rb +1 -1
- data/lib/akeyless/models/digi_cert_target_details.rb +333 -0
- data/lib/akeyless/models/ds_producer_details.rb +10 -1
- data/lib/akeyless/models/esm_list_secrets_output.rb +15 -4
- data/lib/akeyless/models/gateway_create_migration.rb +94 -2
- data/lib/akeyless/models/gateway_update_migration.rb +93 -1
- data/lib/akeyless/models/gateway_update_remote_access_rdp_recordings.rb +11 -1
- data/lib/akeyless/models/general_config_part.rb +19 -1
- data/lib/akeyless/models/get_pki_certificate_output.rb +10 -1
- data/lib/akeyless/models/github_metadata.rb +259 -0
- data/lib/akeyless/models/google_trust_target_details.rb +335 -0
- data/lib/akeyless/models/hashi_payload.rb +22 -4
- data/lib/akeyless/models/http_challenge_info.rb +251 -0
- data/lib/akeyless/models/issuer_overview_info.rb +232 -0
- data/lib/akeyless/models/item.rb +10 -1
- data/lib/akeyless/models/item_general_info.rb +10 -1
- data/lib/akeyless/models/item_locking_setting.rb +223 -0
- data/lib/akeyless/models/lock_item.rb +274 -0
- data/lib/akeyless/models/lock_target.rb +274 -0
- data/lib/akeyless/models/locking_info.rb +243 -0
- data/lib/akeyless/models/migration_status_reply_obj.rb +19 -1
- data/lib/akeyless/models/migrations_config_part.rb +12 -1
- data/lib/akeyless/models/netapp_storage.rb +268 -0
- data/lib/akeyless/models/reverse_rbac.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_aws.rb +12 -4
- data/lib/akeyless/models/rotated_secret_create_azure.rb +12 -4
- data/lib/akeyless/models/rotated_secret_create_custom.rb +12 -4
- data/lib/akeyless/models/rotated_secret_create_ldap.rb +12 -4
- data/lib/akeyless/models/rotated_secret_create_mongodb.rb +12 -4
- data/lib/akeyless/models/rotated_secret_create_mssql.rb +12 -4
- data/lib/akeyless/models/rotated_secret_create_mysql.rb +12 -4
- data/lib/akeyless/models/rotated_secret_create_oracledb.rb +12 -4
- data/lib/akeyless/models/rotated_secret_create_postgresql.rb +12 -4
- data/lib/akeyless/models/rotated_secret_create_redshift.rb +12 -4
- data/lib/akeyless/models/rotated_secret_create_ssh.rb +12 -4
- data/lib/akeyless/models/rotated_secret_create_windows.rb +12 -4
- data/lib/akeyless/models/rotated_secret_update_aws.rb +12 -4
- data/lib/akeyless/models/rotated_secret_update_azure.rb +12 -4
- data/lib/akeyless/models/rotated_secret_update_custom.rb +12 -4
- data/lib/akeyless/models/rotated_secret_update_ldap.rb +12 -4
- data/lib/akeyless/models/rotated_secret_update_mongodb.rb +12 -4
- data/lib/akeyless/models/rotated_secret_update_mssql.rb +12 -4
- data/lib/akeyless/models/rotated_secret_update_mysql.rb +12 -4
- data/lib/akeyless/models/rotated_secret_update_oracledb.rb +12 -4
- data/lib/akeyless/models/rotated_secret_update_postgresql.rb +12 -4
- data/lib/akeyless/models/rotated_secret_update_redshift.rb +12 -4
- data/lib/akeyless/models/rotated_secret_update_ssh.rb +12 -4
- data/lib/akeyless/models/rotated_secret_update_windows.rb +12 -4
- data/lib/akeyless/models/secret_info.rb +19 -1
- data/lib/akeyless/models/secure_remote_access.rb +19 -1
- data/lib/akeyless/models/set_role_rule.rb +1 -1
- data/lib/akeyless/models/sync_counters.rb +233 -0
- data/lib/akeyless/models/target.rb +10 -1
- data/lib/akeyless/models/target_create_azure.rb +13 -1
- data/lib/akeyless/models/target_create_digi_cert.rb +398 -0
- data/lib/akeyless/models/target_create_google_trust.rb +398 -0
- data/lib/akeyless/models/target_create_lets_encrypt.rb +7 -0
- data/lib/akeyless/models/target_create_splunk.rb +11 -1
- data/lib/akeyless/models/target_type_details_input.rb +19 -1
- data/lib/akeyless/models/target_update_azure.rb +13 -1
- data/lib/akeyless/models/target_update_digi_cert.rb +418 -0
- data/lib/akeyless/models/target_update_google_trust.rb +418 -0
- data/lib/akeyless/models/target_update_lets_encrypt.rb +7 -0
- data/lib/akeyless/models/universal_identity_access_rules.rb +19 -1
- data/lib/akeyless/models/unlock_item.rb +254 -0
- data/lib/akeyless/models/unlock_target.rb +254 -0
- data/lib/akeyless/models/update_account_settings.rb +21 -1
- data/lib/akeyless/models/update_auth_method_cert.rb +11 -1
- data/lib/akeyless/models/update_auth_method_universal_identity.rb +25 -1
- data/lib/akeyless/models/update_azure_target.rb +13 -1
- data/lib/akeyless/models/update_item.rb +12 -4
- data/lib/akeyless/models/update_rotated_secret.rb +12 -4
- data/lib/akeyless/models/usc_create.rb +10 -1
- data/lib/akeyless/models/usc_delete.rb +20 -1
- data/lib/akeyless/models/usc_get.rb +20 -1
- data/lib/akeyless/models/usc_list_secrets_output.rb +15 -4
- data/lib/akeyless/models/usc_update.rb +20 -1
- data/lib/akeyless/models/validate_certificate_challenge.rb +279 -0
- data/lib/akeyless/models/validate_certificate_challenge_output.rb +242 -0
- data/lib/akeyless/models/vault_address.rb +227 -0
- data/lib/akeyless/models/vault_address_output.rb +223 -0
- data/lib/akeyless/models/web_bastion_rdp_record.rb +10 -1
- data/lib/akeyless/version.rb +1 -1
- data/lib/akeyless.rb +24 -0
- data/spec/models/conjur_migration_spec.rb +42 -0
- data/spec/models/conjur_payload_spec.rb +54 -0
- data/spec/models/default_auth_method_settings_spec.rb +42 -0
- data/spec/models/digi_cert_target_details_spec.rb +108 -0
- data/spec/models/github_metadata_spec.rb +66 -0
- data/spec/models/google_trust_target_details_spec.rb +108 -0
- data/spec/models/http_challenge_info_spec.rb +60 -0
- data/spec/models/issuer_overview_info_spec.rb +48 -0
- data/spec/models/item_locking_setting_spec.rb +42 -0
- data/spec/models/lock_item_spec.rb +66 -0
- data/spec/models/lock_target_spec.rb +66 -0
- data/spec/models/locking_info_spec.rb +54 -0
- data/spec/models/netapp_storage_spec.rb +72 -0
- data/spec/models/sync_counters_spec.rb +48 -0
- data/spec/models/target_create_digi_cert_spec.rb +132 -0
- data/spec/models/target_create_google_trust_spec.rb +132 -0
- data/spec/models/target_update_digi_cert_spec.rb +144 -0
- data/spec/models/target_update_google_trust_spec.rb +144 -0
- data/spec/models/unlock_item_spec.rb +54 -0
- data/spec/models/unlock_target_spec.rb +54 -0
- data/spec/models/validate_certificate_challenge_output_spec.rb +54 -0
- data/spec/models/validate_certificate_challenge_spec.rb +72 -0
- data/spec/models/vault_address_output_spec.rb +42 -0
- data/spec/models/vault_address_spec.rb +42 -0
- metadata +1233 -1134
data/docs/CreateSecret.md
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| **inject_url** | **Array<String>** | For Password Management use, reflect the website context | [optional] |
|
|
14
14
|
| **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
|
|
15
15
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
16
|
+
| **lock_during_sra_session** | **String** | Lock this secret for read/update while an SRA session is active | [optional] |
|
|
16
17
|
| **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
|
|
17
18
|
| **metadata** | **String** | Deprecated - use description | [optional] |
|
|
18
19
|
| **multiline_value** | **Boolean** | The provided value is a multiline value (separated by '\\n') | [optional] |
|
|
@@ -52,6 +53,7 @@ instance = Akeyless::CreateSecret.new(
|
|
|
52
53
|
inject_url: null,
|
|
53
54
|
item_custom_fields: null,
|
|
54
55
|
json: null,
|
|
56
|
+
lock_during_sra_session: null,
|
|
55
57
|
max_versions: null,
|
|
56
58
|
metadata: null,
|
|
57
59
|
multiline_value: null,
|
data/docs/CreateUSC.md
CHANGED
|
@@ -7,12 +7,17 @@
|
|
|
7
7
|
| **azure_kv_name** | **String** | Azure Key Vault name (Relevant only for Azure targets) | [optional] |
|
|
8
8
|
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
9
9
|
| **description** | **String** | Description of the Universal Secrets Connector | [optional] |
|
|
10
|
+
| **environment_names** | **String** | The environments in repo-name/environment-name format, comma-separated (only relevant for: github-scope=repository-environment) | [optional] |
|
|
10
11
|
| **gcp_project_id** | **String** | GCP Project ID (Relevant only for GCP targets) | [optional] |
|
|
11
12
|
| **gcp_sm_regions** | **String** | GCP Secret Manager regions to query for regional secrets (comma-separated, e.g., us-east1,us-west1). Max 12 regions. Required when listing with object-type=regional-secrets. | [optional] |
|
|
13
|
+
| **github_scope** | **String** | The scope where secrets will be created, available options: [repository, organization, repository-environment] | [optional][default to 'repository'] |
|
|
12
14
|
| **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
|
|
13
15
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
14
16
|
| **k8s_namespace** | **String** | K8s namespace (Relevant to Kubernetes targets) | [optional] |
|
|
15
17
|
| **name** | **String** | Universal Secrets Connector name | |
|
|
18
|
+
| **organization_name** | **String** | The organization name to create the secret in | [optional] |
|
|
19
|
+
| **repository_access** | **String** | | [optional][default to 'public'] |
|
|
20
|
+
| **repository_names** | **String** | The repository names, comma-separated (only relevant for: github-scope=repository) | [optional] |
|
|
16
21
|
| **tags** | **Array<String>** | List of the tags attached to this Universal Secrets Connector | [optional] |
|
|
17
22
|
| **target_to_associate** | **String** | Target Universal Secrets Connector to connect | |
|
|
18
23
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
@@ -29,12 +34,17 @@ instance = Akeyless::CreateUSC.new(
|
|
|
29
34
|
azure_kv_name: null,
|
|
30
35
|
delete_protection: null,
|
|
31
36
|
description: null,
|
|
37
|
+
environment_names: null,
|
|
32
38
|
gcp_project_id: null,
|
|
33
39
|
gcp_sm_regions: null,
|
|
40
|
+
github_scope: null,
|
|
34
41
|
item_custom_fields: null,
|
|
35
42
|
json: null,
|
|
36
43
|
k8s_namespace: null,
|
|
37
44
|
name: null,
|
|
45
|
+
organization_name: null,
|
|
46
|
+
repository_access: null,
|
|
47
|
+
repository_names: null,
|
|
38
48
|
tags: null,
|
|
39
49
|
target_to_associate: null,
|
|
40
50
|
token: null,
|
data/docs/DSProducerDetails.md
CHANGED
|
@@ -36,6 +36,7 @@
|
|
|
36
36
|
| **azure_app_object_id** | **String** | | [optional] |
|
|
37
37
|
| **azure_client_id** | **String** | | [optional] |
|
|
38
38
|
| **azure_client_secret** | **String** | | [optional] |
|
|
39
|
+
| **azure_cloud** | **String** | | [optional] |
|
|
39
40
|
| **azure_fixed_user_name_sub_claim_key** | **String** | | [optional] |
|
|
40
41
|
| **azure_fixed_user_only** | **Boolean** | | [optional] |
|
|
41
42
|
| **azure_resource_group_name** | **String** | | [optional] |
|
|
@@ -307,6 +308,7 @@ instance = Akeyless::DSProducerDetails.new(
|
|
|
307
308
|
azure_app_object_id: null,
|
|
308
309
|
azure_client_id: null,
|
|
309
310
|
azure_client_secret: null,
|
|
311
|
+
azure_cloud: null,
|
|
310
312
|
azure_fixed_user_name_sub_claim_key: null,
|
|
311
313
|
azure_fixed_user_only: null,
|
|
312
314
|
azure_resource_group_name: null,
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Akeyless::DefaultAuthMethodSettings
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **default_access_id** | **String** | | [optional] |
|
|
8
|
+
| **default_auth_method_type** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'akeyless'
|
|
14
|
+
|
|
15
|
+
instance = Akeyless::DefaultAuthMethodSettings.new(
|
|
16
|
+
default_access_id: null,
|
|
17
|
+
default_auth_method_type: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/DeleteRoleRule.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
8
8
|
| **path** | **String** | The path the rule refers to | |
|
|
9
9
|
| **role_name** | **String** | The role name to be updated | |
|
|
10
|
-
| **rule_type** | **String** | item-rule, role-rule, auth-method-rule, search-rule, reports-rule, gw-reports-rule
|
|
10
|
+
| **rule_type** | **String** | item-rule, role-rule, auth-method-rule, search-rule, reports-rule, gw-reports-rule, sra-reports-rule, sra-rule, ara-rule | [optional][default to 'item-rule'] |
|
|
11
11
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
12
12
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
13
13
|
|
data/docs/DescribePermissions.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
8
8
|
| **path** | **String** | Path to an object | |
|
|
9
9
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
10
|
-
| **type** | **String** | Type of object (item, am, role, target) | |
|
|
10
|
+
| **type** | **String** | Type of object (item, am, role, target, sra, ara) | |
|
|
11
11
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
12
12
|
|
|
13
13
|
## Example
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Akeyless::DigiCertTargetDetails
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_key_pem** | **String** | ACME Account Private Key (PEM-encoded). Supports ECDSA (P-256, P-384, P-521), RSA (2048+), and Ed25519. Auto-generated as ECDSA P-256 during first certificate issuance bootstrap. Stored encrypted, required for certificate operations and revocation. | [optional] |
|
|
8
|
+
| **account_url** | **String** | ACME Account URL (returned after registration with DigiCert ACME). Used to retrieve existing account instead of re-registering. | [optional] |
|
|
9
|
+
| **challenge_type** | **String** | ACMEChallengeType defines ACME challenge type for Let's Encrypt | [optional] |
|
|
10
|
+
| **digicert_directory_type** | **String** | | [optional] |
|
|
11
|
+
| **dns_target_name** | **String** | Name of DNS target (transient field - not stored in DB). Used by CLI to pass DNS target name to SDK for creating target_object_assoc. Retrieved from target_object_assoc when reading target. Required when ChallengeType is dns. | [optional] |
|
|
12
|
+
| **dns_target_type** | **String** | | [optional] |
|
|
13
|
+
| **eab_hmac_key** | **String** | External Account Binding HMAC key. Required until ACME account is bootstrapped on first issuance. | [optional] |
|
|
14
|
+
| **eab_key_id** | **String** | External Account Binding key identifier. Required until ACME account is bootstrapped on first issuance. | [optional] |
|
|
15
|
+
| **email** | **String** | Email address for ACME account registration. Required. | [optional] |
|
|
16
|
+
| **gcp_project** | **String** | GCP Cloud DNS: Project ID. Optional - can be derived from service account. | [optional] |
|
|
17
|
+
| **hosted_zone** | **String** | AWS Route53: Hosted zone ID. Required when DNSTargetType is AWS. | [optional] |
|
|
18
|
+
| **resource_group** | **String** | Azure DNS: Resource group name. Required when DNSTargetType is Azure. | [optional] |
|
|
19
|
+
| **timeout** | **Integer** | A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. | [optional] |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'akeyless'
|
|
25
|
+
|
|
26
|
+
instance = Akeyless::DigiCertTargetDetails.new(
|
|
27
|
+
account_key_pem: null,
|
|
28
|
+
account_url: null,
|
|
29
|
+
challenge_type: null,
|
|
30
|
+
digicert_directory_type: null,
|
|
31
|
+
dns_target_name: null,
|
|
32
|
+
dns_target_type: null,
|
|
33
|
+
eab_hmac_key: null,
|
|
34
|
+
eab_key_id: null,
|
|
35
|
+
email: null,
|
|
36
|
+
gcp_project: null,
|
|
37
|
+
hosted_zone: null,
|
|
38
|
+
resource_group: null,
|
|
39
|
+
timeout: null
|
|
40
|
+
)
|
|
41
|
+
```
|
|
42
|
+
|
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **secrets_list** | [**Array<SecretInfo>**](SecretInfo.md) | | [optional] |
|
|
8
|
+
| **warnings** | **Array<String>** | | [optional] |
|
|
8
9
|
|
|
9
10
|
## Example
|
|
10
11
|
|
|
@@ -12,7 +13,8 @@
|
|
|
12
13
|
require 'akeyless'
|
|
13
14
|
|
|
14
15
|
instance = Akeyless::EsmListSecretsOutput.new(
|
|
15
|
-
secrets_list: null
|
|
16
|
+
secrets_list: null,
|
|
17
|
+
warnings: null
|
|
16
18
|
)
|
|
17
19
|
```
|
|
18
20
|
|
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **service_account_key_decoded** | **String** | | [optional] |
|
|
8
8
|
| **ad_auto_rotate** | **String** | Enable/Disable automatic/recurrent rotation for migrated secrets. Default is false: only manual rotation is allowed for migrated secrets. If set to true, this command should be combined with --ad-rotation-interval and --ad-rotation-hour parameters (Relevant only for Active Directory migration) | [optional] |
|
|
9
|
+
| **ad_cert_expiration_event_in** | **Array<String>** | How many days before the expiration of discovered certificates would you like to be notified (Relevant only for Active Directory migration with certificate discovery enabled) | [optional] |
|
|
10
|
+
| **ad_certificates_path_template** | **String** | Path location template for migrating certificates e.g.: /Certificates/{{COMMON_NAME}} (Relevant only for Active Directory migration with certificate discovery enabled) | [optional] |
|
|
9
11
|
| **ad_computer_base_dn** | **String** | Distinguished Name of Computer objects (servers) to search in Active Directory e.g.: CN=Computers,DC=example,DC=com (Relevant only for Active Directory migration) | [optional] |
|
|
10
12
|
| **ad_discover_iis_app** | **String** | Enable/Disable discovery of IIS application from each domain server as part of the SSH/Windows Rotated Secrets. Default is false. (Relevant only for Active Directory migration) | [optional][default to 'false'] |
|
|
11
13
|
| **ad_discover_services** | **String** | Enable/Disable discovery of Windows services from each domain server as part of the SSH/Windows Rotated Secrets. Default is false. (Relevant only for Active Directory migration) | [optional][default to 'false'] |
|
|
@@ -28,6 +30,7 @@
|
|
|
28
30
|
| **ad_winrm_over_http** | **String** | Use WinRM over HTTP, by default runs over HTTPS | [optional][default to 'false'] |
|
|
29
31
|
| **ad_winrm_port** | **String** | Set the WinRM Port for further connection to the domain servers. Default is 5986 (Relevant only for Active Directory migration) | [optional][default to '5986'] |
|
|
30
32
|
| **ad_discover_local_users** | **String** | Enable/Disable discovery of local users from each domain server and migrate them as SSH/Windows Rotated Secrets. Default is false: only domain users will be migrated. Discovery of local users might require further installation of SSH on the servers, based on the supplied computer base DN. This will be implemented automatically as part of the migration process (Relevant only for Active Directory migration) Deprecated: use AdDiscoverTypes | [optional] |
|
|
33
|
+
| **ai_certificate_discovery** | **String** | Enable AI-assisted certificate discovery (only when AI Insight is enabled on the Gateway) | [optional] |
|
|
31
34
|
| **aws_key** | **String** | AWS Secret Access Key (relevant only for AWS migration) | [optional] |
|
|
32
35
|
| **aws_key_id** | **String** | AWS Access Key ID with sufficient permissions to get all secrets, e.g. 'arn:aws:secretsmanager:[Region]:[AccountId]:secret:[/path/to/secrets/*]' (relevant only for AWS migration) | [optional] |
|
|
33
36
|
| **aws_region** | **String** | AWS region of the required Secrets Manager (relevant only for AWS migration) | [optional][default to 'us-east-2'] |
|
|
@@ -35,6 +38,11 @@
|
|
|
35
38
|
| **azure_kv_name** | **String** | Azure Key Vault Name (relevant only for Azure Key Vault migration) | [optional] |
|
|
36
39
|
| **azure_secret** | **String** | Azure Key Vault secret (relevant only for Azure Key Vault migration) | [optional] |
|
|
37
40
|
| **azure_tenant_id** | **String** | Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration) | [optional] |
|
|
41
|
+
| **conjur_account** | **String** | Conjur account name set on your Conjur server (relevant only for Conjur migration). | [optional] |
|
|
42
|
+
| **conjur_api_key** | **String** | Conjur API Key for the specified user (relevant only for Conjur migration). | [optional] |
|
|
43
|
+
| **conjur_url** | **String** | Conjur server base URL (relevant only for Conjur migration). If conjur-url is HTTPS and Conjur uses a private CA/self-signed certificate, make the CA bundle available on the Gateway and set CONJUR_SSL_CERT_PATH to its path. | [optional] |
|
|
44
|
+
| **conjur_username** | **String** | Conjur username used to authenticate (relevant only for Conjur migration). | [optional] |
|
|
45
|
+
| **delete_remote** | **Boolean** | Delete the secret from the remote target as well, relevant only when usc-name is not empty (relevant only for HasiCorp Vault migration) | [optional] |
|
|
38
46
|
| **expiration_event_in** | **Array<String>** | How many days before the expiration of the certificate would you like to be notified. | [optional] |
|
|
39
47
|
| **gcp_key** | **String** | Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration) | [optional] |
|
|
40
48
|
| **gcp_project_id** | **String** | GCP Project ID (cross-project override) | [optional] |
|
|
@@ -66,8 +74,9 @@
|
|
|
66
74
|
| **si_users_path_template** | **String** | Path location template for migrating users as Rotated Secrets e.g.: .../Users/{{COMPUTER_NAME}}/{{USERNAME}} (Relevant only for Server Inventory migration) | |
|
|
67
75
|
| **target_location** | **String** | Target location in Akeyless for imported secrets | |
|
|
68
76
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
69
|
-
| **type** | **String** | Migration type (hashi/aws/gcp/k8s/azure_kv/active_directory/server_inventory/certificate) | [optional] |
|
|
77
|
+
| **type** | **String** | Migration type (hashi/aws/gcp/k8s/azure_kv/conjur/active_directory/server_inventory/certificate) | [optional] |
|
|
70
78
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
79
|
+
| **usc_name** | **String** | Universal Secret Connector name | [optional] |
|
|
71
80
|
| **use_gw_cloud_identity** | **Boolean** | Use the GW's Cloud IAM | [optional] |
|
|
72
81
|
|
|
73
82
|
## Example
|
|
@@ -78,6 +87,8 @@ require 'akeyless'
|
|
|
78
87
|
instance = Akeyless::GatewayCreateMigration.new(
|
|
79
88
|
service_account_key_decoded: null,
|
|
80
89
|
ad_auto_rotate: null,
|
|
90
|
+
ad_cert_expiration_event_in: null,
|
|
91
|
+
ad_certificates_path_template: null,
|
|
81
92
|
ad_computer_base_dn: null,
|
|
82
93
|
ad_discover_iis_app: null,
|
|
83
94
|
ad_discover_services: null,
|
|
@@ -100,6 +111,7 @@ instance = Akeyless::GatewayCreateMigration.new(
|
|
|
100
111
|
ad_winrm_over_http: null,
|
|
101
112
|
ad_winrm_port: null,
|
|
102
113
|
ad_discover_local_users: null,
|
|
114
|
+
ai_certificate_discovery: null,
|
|
103
115
|
aws_key: null,
|
|
104
116
|
aws_key_id: null,
|
|
105
117
|
aws_region: null,
|
|
@@ -107,6 +119,11 @@ instance = Akeyless::GatewayCreateMigration.new(
|
|
|
107
119
|
azure_kv_name: null,
|
|
108
120
|
azure_secret: null,
|
|
109
121
|
azure_tenant_id: null,
|
|
122
|
+
conjur_account: null,
|
|
123
|
+
conjur_api_key: null,
|
|
124
|
+
conjur_url: null,
|
|
125
|
+
conjur_username: null,
|
|
126
|
+
delete_remote: null,
|
|
110
127
|
expiration_event_in: null,
|
|
111
128
|
gcp_key: null,
|
|
112
129
|
gcp_project_id: null,
|
|
@@ -140,6 +157,7 @@ instance = Akeyless::GatewayCreateMigration.new(
|
|
|
140
157
|
token: null,
|
|
141
158
|
type: null,
|
|
142
159
|
uid_token: null,
|
|
160
|
+
usc_name: null,
|
|
143
161
|
use_gw_cloud_identity: null
|
|
144
162
|
)
|
|
145
163
|
```
|
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **service_account_key_decoded** | **String** | | [optional] |
|
|
8
8
|
| **ad_auto_rotate** | **String** | Enable/Disable automatic/recurrent rotation for migrated secrets. Default is false: only manual rotation is allowed for migrated secrets. If set to true, this command should be combined with --ad-rotation-interval and --ad-rotation-hour parameters (Relevant only for Active Directory migration) | [optional] |
|
|
9
|
+
| **ad_cert_expiration_event_in** | **Array<String>** | How many days before the expiration of discovered certificates would you like to be notified (Relevant only for Active Directory migration with certificate discovery enabled) | [optional] |
|
|
10
|
+
| **ad_certificates_path_template** | **String** | Path location template for migrating certificates e.g.: /Certificates/{{COMMON_NAME}} (Relevant only for Active Directory migration with certificate discovery enabled) | [optional] |
|
|
9
11
|
| **ad_computer_base_dn** | **String** | Distinguished Name of Computer objects (servers) to search in Active Directory e.g.: CN=Computers,DC=example,DC=com (Relevant only for Active Directory migration) | [optional] |
|
|
10
12
|
| **ad_discover_iis_app** | **String** | Enable/Disable discovery of IIS application from each domain server as part of the SSH/Windows Rotated Secrets. Default is false. (Relevant only for Active Directory migration) | [optional][default to 'false'] |
|
|
11
13
|
| **ad_discover_services** | **String** | Enable/Disable discovery of Windows services from each domain server as part of the SSH/Windows Rotated Secrets. Default is false. (Relevant only for Active Directory migration) | [optional][default to 'false'] |
|
|
@@ -28,6 +30,7 @@
|
|
|
28
30
|
| **ad_winrm_over_http** | **String** | Use WinRM over HTTP, by default runs over HTTPS | [optional][default to 'false'] |
|
|
29
31
|
| **ad_winrm_port** | **String** | Set the WinRM Port for further connection to the domain servers. Default is 5986 (Relevant only for Active Directory migration) | [optional][default to '5986'] |
|
|
30
32
|
| **ad_discover_local_users** | **String** | Enable/Disable discovery of local users from each domain server and migrate them as SSH/Windows Rotated Secrets. Default is false: only domain users will be migrated. Discovery of local users might require further installation of SSH on the servers, based on the supplied computer base DN. This will be implemented automatically as part of the migration process (Relevant only for Active Directory migration) Deprecated: use AdDiscoverTypes | [optional] |
|
|
33
|
+
| **ai_certificate_discovery** | **String** | Enable AI-assisted certificate discovery (only when AI Insight is enabled on the Gateway) | [optional] |
|
|
31
34
|
| **aws_key** | **String** | AWS Secret Access Key (relevant only for AWS migration) | [optional] |
|
|
32
35
|
| **aws_key_id** | **String** | AWS Access Key ID with sufficient permissions to get all secrets, e.g. 'arn:aws:secretsmanager:[Region]:[AccountId]:secret:[/path/to/secrets/*]' (relevant only for AWS migration) | [optional] |
|
|
33
36
|
| **aws_region** | **String** | AWS region of the required Secrets Manager (relevant only for AWS migration) | [optional][default to 'us-east-2'] |
|
|
@@ -35,6 +38,11 @@
|
|
|
35
38
|
| **azure_kv_name** | **String** | Azure Key Vault Name (relevant only for Azure Key Vault migration) | [optional] |
|
|
36
39
|
| **azure_secret** | **String** | Azure Key Vault secret (relevant only for Azure Key Vault migration) | [optional] |
|
|
37
40
|
| **azure_tenant_id** | **String** | Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration) | [optional] |
|
|
41
|
+
| **conjur_account** | **String** | Conjur account name set on your Conjur server (relevant only for Conjur migration). | [optional] |
|
|
42
|
+
| **conjur_api_key** | **String** | Conjur API Key for the specified user (relevant only for Conjur migration). | [optional] |
|
|
43
|
+
| **conjur_url** | **String** | Conjur server base URL (relevant only for Conjur migration). If conjur-url is HTTPS and Conjur uses a private CA/self-signed certificate, make the CA bundle available on the Gateway and set CONJUR_SSL_CERT_PATH to its path. | [optional] |
|
|
44
|
+
| **conjur_username** | **String** | Conjur username used to authenticate (relevant only for Conjur migration). | [optional] |
|
|
45
|
+
| **delete_remote** | **Boolean** | Delete the secret from the remote target as well, relevant only when usc-name is not empty (relevant only for HasiCorp Vault migration) | [optional] |
|
|
38
46
|
| **expiration_event_in** | **Array<String>** | How many days before the expiration of the certificate would you like to be notified. | [optional] |
|
|
39
47
|
| **gcp_key** | **String** | Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration) | [optional] |
|
|
40
48
|
| **gcp_project_id** | **String** | GCP Project ID (cross-project override) | [optional] |
|
|
@@ -69,6 +77,7 @@
|
|
|
69
77
|
| **target_location** | **String** | Target location in Akeyless for imported secrets | |
|
|
70
78
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
71
79
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
80
|
+
| **usc_name** | **String** | Universal Secret Connector name | [optional] |
|
|
72
81
|
| **use_gw_cloud_identity** | **Boolean** | Use the GW's Cloud IAM | [optional] |
|
|
73
82
|
|
|
74
83
|
## Example
|
|
@@ -79,6 +88,8 @@ require 'akeyless'
|
|
|
79
88
|
instance = Akeyless::GatewayUpdateMigration.new(
|
|
80
89
|
service_account_key_decoded: null,
|
|
81
90
|
ad_auto_rotate: null,
|
|
91
|
+
ad_cert_expiration_event_in: null,
|
|
92
|
+
ad_certificates_path_template: null,
|
|
82
93
|
ad_computer_base_dn: null,
|
|
83
94
|
ad_discover_iis_app: null,
|
|
84
95
|
ad_discover_services: null,
|
|
@@ -101,6 +112,7 @@ instance = Akeyless::GatewayUpdateMigration.new(
|
|
|
101
112
|
ad_winrm_over_http: null,
|
|
102
113
|
ad_winrm_port: null,
|
|
103
114
|
ad_discover_local_users: null,
|
|
115
|
+
ai_certificate_discovery: null,
|
|
104
116
|
aws_key: null,
|
|
105
117
|
aws_key_id: null,
|
|
106
118
|
aws_region: null,
|
|
@@ -108,6 +120,11 @@ instance = Akeyless::GatewayUpdateMigration.new(
|
|
|
108
120
|
azure_kv_name: null,
|
|
109
121
|
azure_secret: null,
|
|
110
122
|
azure_tenant_id: null,
|
|
123
|
+
conjur_account: null,
|
|
124
|
+
conjur_api_key: null,
|
|
125
|
+
conjur_url: null,
|
|
126
|
+
conjur_username: null,
|
|
127
|
+
delete_remote: null,
|
|
111
128
|
expiration_event_in: null,
|
|
112
129
|
gcp_key: null,
|
|
113
130
|
gcp_project_id: null,
|
|
@@ -142,6 +159,7 @@ instance = Akeyless::GatewayUpdateMigration.new(
|
|
|
142
159
|
target_location: null,
|
|
143
160
|
token: null,
|
|
144
161
|
uid_token: null,
|
|
162
|
+
usc_name: null,
|
|
145
163
|
use_gw_cloud_identity: null
|
|
146
164
|
)
|
|
147
165
|
```
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **aws_storage_access_key_id** | **String** | AWS access key id. For more information refer to https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html | [optional] |
|
|
8
8
|
| **aws_storage_bucket_name** | **String** | The AWS bucket name. For more information refer to https://docs.aws.amazon.com/s3/ | [optional] |
|
|
9
9
|
| **aws_storage_bucket_prefix** | **String** | The folder name in S3 bucket. For more information refer to https://docs.aws.amazon.com/s3/ | [optional] |
|
|
10
|
+
| **aws_storage_endpoint_url** | **String** | Custom AWS endpoint URL for S3-compatible storage (e.g. a private AWS endpoint) | [optional] |
|
|
10
11
|
| **aws_storage_region** | **String** | The region where the storage is located | [optional] |
|
|
11
12
|
| **aws_storage_secret_access_key** | **String** | AWS secret access key. For more information refer to https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html | [optional] |
|
|
12
13
|
| **azure_storage_account_name** | **String** | Azure account name. For more information refer to https://learn.microsoft.com/en-us/azure/storage/common/storage-account-overview | [optional] |
|
|
@@ -32,6 +33,7 @@ instance = Akeyless::GatewayUpdateRemoteAccessRdpRecordings.new(
|
|
|
32
33
|
aws_storage_access_key_id: null,
|
|
33
34
|
aws_storage_bucket_name: null,
|
|
34
35
|
aws_storage_bucket_prefix: null,
|
|
36
|
+
aws_storage_endpoint_url: null,
|
|
35
37
|
aws_storage_region: null,
|
|
36
38
|
aws_storage_secret_access_key: null,
|
|
37
39
|
azure_storage_account_name: null,
|
data/docs/GeneralConfigPart.md
CHANGED
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **akeyless_url** | **String** | AkeylessUrl is here for BC only. Gator will still return it if it exists in the configuration, but new clients (>=2.34.0) will ignore it and override it with what exists in their local file. It will no longer be sent to Gator for update, so new clusters will only have the default value saved in the DB. | [optional] |
|
|
8
8
|
| **api_token_ttl** | **String** | | [optional] |
|
|
9
9
|
| **display_name** | **String** | | [optional] |
|
|
10
|
+
| **enable_json_body_limit** | **Boolean** | | [optional] |
|
|
10
11
|
| **enable_sni_proxy** | **Boolean** | | [optional] |
|
|
11
12
|
| **enable_tls** | **Boolean** | | [optional] |
|
|
12
13
|
| **enable_tls_configure** | **Boolean** | | [optional] |
|
|
@@ -14,6 +15,7 @@
|
|
|
14
15
|
| **enable_tls_hvp** | **Boolean** | | [optional] |
|
|
15
16
|
| **gw_cluster_url** | **String** | | [optional] |
|
|
16
17
|
| **hvp_route_version** | **Integer** | | [optional] |
|
|
18
|
+
| **json_body_limit_mb** | **Integer** | | [optional] |
|
|
17
19
|
| **notify_on_status_change** | **Boolean** | | [optional] |
|
|
18
20
|
| **tcp_port** | **String** | | [optional] |
|
|
19
21
|
| **tls_cert** | **String** | | [optional] |
|
|
@@ -31,6 +33,7 @@ instance = Akeyless::GeneralConfigPart.new(
|
|
|
31
33
|
akeyless_url: null,
|
|
32
34
|
api_token_ttl: null,
|
|
33
35
|
display_name: null,
|
|
36
|
+
enable_json_body_limit: null,
|
|
34
37
|
enable_sni_proxy: null,
|
|
35
38
|
enable_tls: null,
|
|
36
39
|
enable_tls_configure: null,
|
|
@@ -38,6 +41,7 @@ instance = Akeyless::GeneralConfigPart.new(
|
|
|
38
41
|
enable_tls_hvp: null,
|
|
39
42
|
gw_cluster_url: null,
|
|
40
43
|
hvp_route_version: null,
|
|
44
|
+
json_body_limit_mb: null,
|
|
41
45
|
notify_on_status_change: null,
|
|
42
46
|
tcp_port: null,
|
|
43
47
|
tls_cert: null,
|
|
@@ -7,6 +7,7 @@
|
|
|
7
7
|
| **cert_display_id** | **String** | | [optional] |
|
|
8
8
|
| **cert_item_id** | **Integer** | | [optional] |
|
|
9
9
|
| **data** | **String** | | [optional] |
|
|
10
|
+
| **http_challenge_info** | [**HTTPChallengeInfo**](HTTPChallengeInfo.md) | | [optional] |
|
|
10
11
|
| **parent_cert** | **String** | | [optional] |
|
|
11
12
|
| **path** | **String** | | [optional] |
|
|
12
13
|
| **reading_token** | **String** | | [optional] |
|
|
@@ -20,6 +21,7 @@ instance = Akeyless::GetPKICertificateOutput.new(
|
|
|
20
21
|
cert_display_id: null,
|
|
21
22
|
cert_item_id: null,
|
|
22
23
|
data: null,
|
|
24
|
+
http_challenge_info: null,
|
|
23
25
|
parent_cert: null,
|
|
24
26
|
path: null,
|
|
25
27
|
reading_token: null
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Akeyless::GithubMetadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **environment_name** | **String** | | [optional] |
|
|
8
|
+
| **organization_name** | **String** | | [optional] |
|
|
9
|
+
| **repository** | **String** | | [optional] |
|
|
10
|
+
| **repository_access** | **String** | | [optional] |
|
|
11
|
+
| **scope** | **String** | | [optional] |
|
|
12
|
+
| **selected_repositories** | **String** | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'akeyless'
|
|
18
|
+
|
|
19
|
+
instance = Akeyless::GithubMetadata.new(
|
|
20
|
+
environment_name: null,
|
|
21
|
+
organization_name: null,
|
|
22
|
+
repository: null,
|
|
23
|
+
repository_access: null,
|
|
24
|
+
scope: null,
|
|
25
|
+
selected_repositories: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Akeyless::GoogleTrustTargetDetails
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_key_pem** | **String** | ACME Account Private Key (PEM-encoded) Supports ECDSA (P-256, P-384, P-521), RSA (2048+), and Ed25519 Auto-generated as ECDSA P-256 during target creation bootstrap Stored encrypted, required for certificate operations and revocation | [optional] |
|
|
8
|
+
| **account_url** | **String** | ACME Account URL (returned after registration with Google Trust Services) Used to retrieve existing account instead of re-registering | [optional] |
|
|
9
|
+
| **acme_environment** | **String** | ACMEEnvironment defines Let's Encrypt ACME directory environment | [optional] |
|
|
10
|
+
| **challenge_type** | **String** | ACMEChallengeType defines ACME challenge type for Let's Encrypt | [optional] |
|
|
11
|
+
| **dns_target_name** | **String** | Name of DNS target (transient field - not stored in DB) Used by CLI to pass DNS target name to SDK for creating target_object_assoc Retrieved from target_object_assoc when reading target Required when ChallengeType is \"dns\" | [optional] |
|
|
12
|
+
| **dns_target_type** | **String** | | [optional] |
|
|
13
|
+
| **eab_hmac_key** | **String** | External Account Binding HMAC key (required for ACME account bootstrap on target creation) Not persisted after bootstrap | [optional] |
|
|
14
|
+
| **eab_key_id** | **String** | External Account Binding key identifier (required for ACME account bootstrap on target creation) Not persisted after bootstrap | [optional] |
|
|
15
|
+
| **email** | **String** | Email address for ACME account registration Required | [optional] |
|
|
16
|
+
| **gcp_project** | **String** | GCP Cloud DNS: Project ID Optional - can be derived from service account | [optional] |
|
|
17
|
+
| **hosted_zone** | **String** | AWS Route53: Hosted zone ID Required when DNSTargetType is AWS | [optional] |
|
|
18
|
+
| **resource_group** | **String** | Azure DNS: Resource group name Required when DNSTargetType is Azure | [optional] |
|
|
19
|
+
| **timeout** | **Integer** | A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years. | [optional] |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'akeyless'
|
|
25
|
+
|
|
26
|
+
instance = Akeyless::GoogleTrustTargetDetails.new(
|
|
27
|
+
account_key_pem: null,
|
|
28
|
+
account_url: null,
|
|
29
|
+
acme_environment: null,
|
|
30
|
+
challenge_type: null,
|
|
31
|
+
dns_target_name: null,
|
|
32
|
+
dns_target_type: null,
|
|
33
|
+
eab_hmac_key: null,
|
|
34
|
+
eab_key_id: null,
|
|
35
|
+
email: null,
|
|
36
|
+
gcp_project: null,
|
|
37
|
+
hosted_zone: null,
|
|
38
|
+
resource_group: null,
|
|
39
|
+
timeout: null
|
|
40
|
+
)
|
|
41
|
+
```
|
|
42
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Akeyless::HTTPChallengeInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **file_content** | **String** | | [optional] |
|
|
8
|
+
| **file_path** | **String** | | [optional] |
|
|
9
|
+
| **instructions** | **String** | | [optional] |
|
|
10
|
+
| **key_auth** | **String** | | [optional] |
|
|
11
|
+
| **token** | **String** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'akeyless'
|
|
17
|
+
|
|
18
|
+
instance = Akeyless::HTTPChallengeInfo.new(
|
|
19
|
+
file_content: null,
|
|
20
|
+
file_path: null,
|
|
21
|
+
instructions: null,
|
|
22
|
+
key_auth: null,
|
|
23
|
+
token: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/HashiPayload.md
CHANGED
|
@@ -4,10 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **delete_sync_on_deletion** | **Boolean** | | [optional] |
|
|
7
8
|
| **import_as_json** | **Boolean** | | [optional] |
|
|
8
9
|
| **namespaces** | **Array<String>** | | [optional] |
|
|
9
10
|
| **token** | **String** | | [optional] |
|
|
10
11
|
| **url** | **String** | | [optional] |
|
|
12
|
+
| **usc_name** | **String** | | [optional] |
|
|
11
13
|
|
|
12
14
|
## Example
|
|
13
15
|
|
|
@@ -15,10 +17,12 @@
|
|
|
15
17
|
require 'akeyless'
|
|
16
18
|
|
|
17
19
|
instance = Akeyless::HashiPayload.new(
|
|
20
|
+
delete_sync_on_deletion: null,
|
|
18
21
|
import_as_json: null,
|
|
19
22
|
namespaces: null,
|
|
20
23
|
token: null,
|
|
21
|
-
url: null
|
|
24
|
+
url: null,
|
|
25
|
+
usc_name: null
|
|
22
26
|
)
|
|
23
27
|
```
|
|
24
28
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Akeyless::IssuerOverviewInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **certificate_authority_mode** | **String** | | [optional] |
|
|
8
|
+
| **expiration_date** | **Time** | | [optional] |
|
|
9
|
+
| **key_type** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'akeyless'
|
|
15
|
+
|
|
16
|
+
instance = Akeyless::IssuerOverviewInfo.new(
|
|
17
|
+
certificate_authority_mode: null,
|
|
18
|
+
expiration_date: null,
|
|
19
|
+
key_type: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/Item.md
CHANGED
|
@@ -37,6 +37,7 @@
|
|
|
37
37
|
| **last_rotation_date** | **Time** | | [optional] |
|
|
38
38
|
| **last_version** | **Integer** | | [optional] |
|
|
39
39
|
| **linked_details** | [**LinkedDetails**](LinkedDetails.md) | | [optional] |
|
|
40
|
+
| **locking_info** | [**LockingInfo**](LockingInfo.md) | | [optional] |
|
|
40
41
|
| **modification_date** | **Time** | | [optional] |
|
|
41
42
|
| **next_rotation_date** | **Time** | | [optional] |
|
|
42
43
|
| **protection_key_name** | **String** | | [optional] |
|
|
@@ -87,6 +88,7 @@ instance = Akeyless::Item.new(
|
|
|
87
88
|
last_rotation_date: null,
|
|
88
89
|
last_version: null,
|
|
89
90
|
linked_details: null,
|
|
91
|
+
locking_info: null,
|
|
90
92
|
modification_date: null,
|
|
91
93
|
next_rotation_date: null,
|
|
92
94
|
protection_key_name: null,
|
data/docs/ItemGeneralInfo.md
CHANGED
|
@@ -14,6 +14,7 @@
|
|
|
14
14
|
| **dynamic_secret_producer_details** | [**DynamicSecretProducerInfo**](DynamicSecretProducerInfo.md) | | [optional] |
|
|
15
15
|
| **expiration_events** | [**Array<CertificateExpirationEvent>**](CertificateExpirationEvent.md) | | [optional] |
|
|
16
16
|
| **importer_info** | [**ImporterInfo**](ImporterInfo.md) | | [optional] |
|
|
17
|
+
| **issuer_overview_info** | [**IssuerOverviewInfo**](IssuerOverviewInfo.md) | | [optional] |
|
|
17
18
|
| **next_rotation_events** | [**Array<NextAutoRotationEvent>**](NextAutoRotationEvent.md) | | [optional] |
|
|
18
19
|
| **oidc_client_info** | [**OidcClientInfo**](OidcClientInfo.md) | | [optional] |
|
|
19
20
|
| **password_policy** | [**PasswordPolicyInfo**](PasswordPolicyInfo.md) | | [optional] |
|
|
@@ -38,6 +39,7 @@ instance = Akeyless::ItemGeneralInfo.new(
|
|
|
38
39
|
dynamic_secret_producer_details: null,
|
|
39
40
|
expiration_events: null,
|
|
40
41
|
importer_info: null,
|
|
42
|
+
issuer_overview_info: null,
|
|
41
43
|
next_rotation_events: null,
|
|
42
44
|
oidc_client_info: null,
|
|
43
45
|
password_policy: null,
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Akeyless::ItemLockingSetting
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **enable** | **Boolean** | | [optional] |
|
|
8
|
+
| **max_lock_ttl_mins** | **Integer** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'akeyless'
|
|
14
|
+
|
|
15
|
+
instance = Akeyless::ItemLockingSetting.new(
|
|
16
|
+
enable: null,
|
|
17
|
+
max_lock_ttl_mins: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/LockItem.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Akeyless::LockItem
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **actions** | **String** | Comma-separated blocked actions (read, update) | [optional] |
|
|
8
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
9
|
+
| **lock_ttl** | **Integer** | Lock TTL in minutes | [optional] |
|
|
10
|
+
| **name** | **String** | Item name | |
|
|
11
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
12
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'akeyless'
|
|
18
|
+
|
|
19
|
+
instance = Akeyless::LockItem.new(
|
|
20
|
+
actions: null,
|
|
21
|
+
json: null,
|
|
22
|
+
lock_ttl: null,
|
|
23
|
+
name: null,
|
|
24
|
+
token: null,
|
|
25
|
+
uid_token: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
data/docs/LockTarget.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Akeyless::LockTarget
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **actions** | **String** | Comma-separated blocked actions (read, update) | [optional] |
|
|
8
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
9
|
+
| **lock_ttl** | **Integer** | Lock TTL in minutes | [optional] |
|
|
10
|
+
| **name** | **String** | Target name | |
|
|
11
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
12
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'akeyless'
|
|
18
|
+
|
|
19
|
+
instance = Akeyless::LockTarget.new(
|
|
20
|
+
actions: null,
|
|
21
|
+
json: null,
|
|
22
|
+
lock_ttl: null,
|
|
23
|
+
name: null,
|
|
24
|
+
token: null,
|
|
25
|
+
uid_token: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|