akeyless 5.0.38 → 5.0.40
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/LICENSE +190 -0
- data/README.md +27 -2
- data/akeyless.gemspec +1 -1
- data/docs/AccountGeneralSettings.md +2 -0
- data/docs/AliCloudTargetDetails.md +28 -0
- data/docs/AssocTargetItem.md +17 -1
- data/docs/AuthMethodAccessInfo.md +2 -0
- data/docs/AuthMethodCreateOIDC.md +8 -0
- data/docs/AuthMethodCreateOutput.md +3 -1
- data/docs/AuthMethodCreateSAML.md +8 -0
- data/docs/AuthMethodUpdateOIDC.md +8 -0
- data/docs/AuthMethodUpdateOutput.md +3 -1
- data/docs/AuthMethodUpdateSAML.md +8 -0
- data/docs/ClientEvent.md +26 -0
- data/docs/ClientEventOutput.md +18 -0
- data/docs/Connect.md +2 -0
- data/docs/CreateEventForwarder.md +1 -1
- data/docs/CreateLdapTarget.md +3 -1
- data/docs/CreatePKICertIssuer.md +6 -0
- data/docs/CreateUSC.md +2 -0
- data/docs/DSProducerDetails.md +2 -0
- data/docs/DigiCertTargetDetails.md +8 -0
- data/docs/DynamicSecretCreateEks.md +3 -1
- data/docs/DynamicSecretCreateGke.md +3 -1
- data/docs/DynamicSecretCreateK8s.md +3 -1
- data/docs/DynamicSecretUpdateEks.md +3 -1
- data/docs/DynamicSecretUpdateGke.md +3 -1
- data/docs/DynamicSecretUpdateK8s.md +3 -1
- data/docs/EventForwarderCreateEmail.md +2 -2
- data/docs/EventForwarderCreateServiceNow.md +1 -1
- data/docs/EventForwarderCreateSlack.md +1 -1
- data/docs/EventForwarderCreateTeams.md +1 -1
- data/docs/EventForwarderCreateWebhook.md +1 -1
- data/docs/EventForwarderUpdateEmail.md +2 -2
- data/docs/EventForwarderUpdateServiceNow.md +1 -1
- data/docs/EventForwarderUpdateSlack.md +1 -1
- data/docs/EventForwarderUpdateTeams.md +1 -1
- data/docs/EventForwarderUpdateWebhook.md +1 -1
- data/docs/GatewayCreateAllowedAccess.md +1 -1
- data/docs/GatewayCreateMigration.md +2 -0
- data/docs/GatewayCreateProducerEks.md +3 -1
- data/docs/GatewayCreateProducerGke.md +3 -1
- data/docs/GatewayCreateProducerNativeK8S.md +3 -1
- data/docs/GatewayUpdateAllowedAccess.md +1 -1
- data/docs/GatewayUpdateMigration.md +2 -0
- data/docs/GatewayUpdateProducerEks.md +3 -1
- data/docs/GatewayUpdateProducerGke.md +3 -1
- data/docs/GatewayUpdateProducerNativeK8S.md +3 -1
- data/docs/GenerateIntermediateCA.md +48 -0
- data/docs/GenerateIntermediateCAOutput.md +26 -0
- data/docs/GetGroupOutput.md +13 -1
- data/docs/GetScimStatus.md +24 -0
- data/docs/GoogleTrustTargetDetails.md +8 -0
- data/docs/GrantedRole.md +20 -0
- data/docs/Group.md +13 -1
- data/docs/InjectorCertificateEvent.md +28 -0
- data/docs/Item.md +2 -0
- data/docs/LdapTargetDetails.md +3 -1
- data/docs/LetsEncryptTargetDetails.md +8 -0
- data/docs/ListSRASessions.md +2 -0
- data/docs/ListSraSessionsOutput.md +3 -3
- data/docs/ListTargets.md +1 -1
- data/docs/LockItem.md +1 -1
- data/docs/MigrationGeneral.md +6 -0
- data/docs/PKICertificateIssueDetails.md +4 -0
- data/docs/RequestAccess.md +2 -0
- data/docs/RotatedSecretCreateAliCloud.md +90 -0
- data/docs/RotatedSecretCreateAzure.md +1 -1
- data/docs/RotatedSecretCreateOkta.md +82 -0
- data/docs/RotatedSecretUpdateAliCloud.md +92 -0
- data/docs/RotatedSecretUpdateAzure.md +1 -1
- data/docs/RotatedSecretUpdateOkta.md +84 -0
- data/docs/ScimSettings.md +30 -0
- data/docs/ScimStatus.md +42 -0
- data/docs/Target.md +2 -0
- data/docs/TargetCreateAliCloud.md +52 -0
- data/docs/TargetCreateDigiCert.md +8 -0
- data/docs/TargetCreateGoogleTrust.md +8 -0
- data/docs/TargetCreateLdap.md +3 -1
- data/docs/TargetCreateLetsEncrypt.md +8 -0
- data/docs/TargetList.md +1 -1
- data/docs/TargetTypeDetailsInput.md +2 -0
- data/docs/TargetUpdateAliCloud.md +56 -0
- data/docs/TargetUpdateDigiCert.md +8 -0
- data/docs/TargetUpdateGoogleTrust.md +8 -0
- data/docs/TargetUpdateLdap.md +3 -1
- data/docs/TargetUpdateLetsEncrypt.md +8 -0
- data/docs/UpdateItem.md +3 -1
- data/docs/UpdateLdapTarget.md +3 -1
- data/docs/UpdatePKICertIssuer.md +6 -0
- data/docs/UpdateRotatedSecret.md +3 -1
- data/docs/UscCreate.md +3 -1
- data/docs/UscDelete.md +4 -0
- data/docs/UscGet.md +4 -0
- data/docs/UscList.md +4 -0
- data/docs/UscUpdate.md +4 -0
- data/docs/V2Api.md +579 -9
- data/lib/akeyless/api/v2_api.rb +585 -5
- data/lib/akeyless/models/account_general_settings.rb +13 -1
- data/lib/akeyless/models/ali_cloud_target_details.rb +259 -0
- data/lib/akeyless/models/assoc_target_item.rb +86 -2
- data/lib/akeyless/models/attribute_type_and_value.rb +1 -1
- data/lib/akeyless/models/auth_method_access_info.rb +10 -1
- data/lib/akeyless/models/auth_method_create_oidc.rb +41 -1
- data/lib/akeyless/models/auth_method_create_output.rb +14 -4
- data/lib/akeyless/models/auth_method_create_saml.rb +41 -1
- data/lib/akeyless/models/auth_method_update_oidc.rb +41 -1
- data/lib/akeyless/models/auth_method_update_output.rb +14 -4
- data/lib/akeyless/models/auth_method_update_saml.rb +41 -1
- data/lib/akeyless/models/client_event.rb +256 -0
- data/lib/akeyless/models/client_event_output.rb +214 -0
- data/lib/akeyless/models/connect.rb +11 -1
- data/lib/akeyless/models/create_event_forwarder.rb +1 -1
- data/lib/akeyless/models/create_ldap_target.rb +14 -4
- data/lib/akeyless/models/create_mcp_secret_bearer_token.rb +3 -0
- data/lib/akeyless/models/create_mcp_secret_o_auth_auth_code.rb +3 -0
- data/lib/akeyless/models/create_mcp_secret_o_auth_client_creds.rb +3 -0
- data/lib/akeyless/models/create_pki_cert_issuer.rb +31 -1
- data/lib/akeyless/models/create_secret.rb +3 -0
- data/lib/akeyless/models/create_usc.rb +11 -1
- data/lib/akeyless/models/digi_cert_target_details.rb +43 -1
- data/lib/akeyless/models/ds_producer_details.rb +10 -1
- data/lib/akeyless/models/dynamic_secret_create_eks.rb +12 -2
- data/lib/akeyless/models/dynamic_secret_create_gke.rb +12 -2
- data/lib/akeyless/models/dynamic_secret_create_k8s.rb +12 -2
- data/lib/akeyless/models/dynamic_secret_update_eks.rb +12 -2
- data/lib/akeyless/models/dynamic_secret_update_gke.rb +12 -2
- data/lib/akeyless/models/dynamic_secret_update_k8s.rb +12 -2
- data/lib/akeyless/models/event_forwarder_create_email.rb +2 -2
- data/lib/akeyless/models/event_forwarder_create_service_now.rb +1 -1
- data/lib/akeyless/models/event_forwarder_create_slack.rb +1 -1
- data/lib/akeyless/models/event_forwarder_create_teams.rb +1 -1
- data/lib/akeyless/models/event_forwarder_create_webhook.rb +1 -1
- data/lib/akeyless/models/event_forwarder_update_email.rb +2 -2
- data/lib/akeyless/models/event_forwarder_update_service_now.rb +1 -1
- data/lib/akeyless/models/event_forwarder_update_slack.rb +1 -1
- data/lib/akeyless/models/event_forwarder_update_teams.rb +1 -1
- data/lib/akeyless/models/event_forwarder_update_webhook.rb +1 -1
- data/lib/akeyless/models/gateway_create_allowed_access.rb +1 -1
- data/lib/akeyless/models/gateway_create_migration.rb +12 -1
- data/lib/akeyless/models/gateway_create_producer_artifactory.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_aws.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_azure.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_cassandra.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_chef.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_custom.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_dockerhub.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_eks.rb +16 -2
- data/lib/akeyless/models/gateway_create_producer_gcp.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_github.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_gke.rb +16 -2
- data/lib/akeyless/models/gateway_create_producer_hana_db.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_ldap.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_mongo.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_mssql.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_my_sql.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_native_k8_s.rb +16 -2
- data/lib/akeyless/models/gateway_create_producer_oracle_db.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_ping.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_postgre_sql.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_rabbit_mq.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_rdp.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_redis.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_redshift.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_snowflake.rb +4 -0
- data/lib/akeyless/models/gateway_create_producer_venafi.rb +4 -0
- data/lib/akeyless/models/gateway_delete_producer.rb +4 -0
- data/lib/akeyless/models/gateway_get_producer.rb +4 -0
- data/lib/akeyless/models/gateway_get_tmp_users.rb +4 -0
- data/lib/akeyless/models/gateway_revoke_tmp_users.rb +4 -0
- data/lib/akeyless/models/gateway_start_producer.rb +4 -0
- data/lib/akeyless/models/gateway_stop_producer.rb +4 -0
- data/lib/akeyless/models/gateway_update_allowed_access.rb +1 -1
- data/lib/akeyless/models/gateway_update_migration.rb +12 -1
- data/lib/akeyless/models/gateway_update_producer_artifactory.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_aws.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_azure.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_cassandra.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_chef.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_custom.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_dockerhub.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_eks.rb +16 -2
- data/lib/akeyless/models/gateway_update_producer_gcp.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_github.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_gke.rb +16 -2
- data/lib/akeyless/models/gateway_update_producer_hana_db.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_ldap.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_mongo.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_mssql.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_my_sql.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_native_k8_s.rb +16 -2
- data/lib/akeyless/models/gateway_update_producer_oracle_db.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_ping.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_postgre_sql.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_rabbit_mq.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_rdp.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_redis.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_redshift.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_snowflake.rb +4 -0
- data/lib/akeyless/models/gateway_update_producer_venafi.rb +4 -0
- data/lib/akeyless/models/gateway_update_tmp_users.rb +4 -0
- data/lib/akeyless/models/generate_intermediate_ca.rb +379 -0
- data/lib/akeyless/models/generate_intermediate_ca_output.rb +250 -0
- data/lib/akeyless/models/get_group_output.rb +63 -4
- data/lib/akeyless/models/get_scim_status.rb +254 -0
- data/lib/akeyless/models/google_trust_target_details.rb +43 -1
- data/lib/akeyless/models/granted_role.rb +224 -0
- data/lib/akeyless/models/group.rb +63 -4
- data/lib/akeyless/models/injector_certificate_event.rb +259 -0
- data/lib/akeyless/models/item.rb +10 -1
- data/lib/akeyless/models/ldap_target_details.rb +13 -4
- data/lib/akeyless/models/lets_encrypt_target_details.rb +43 -1
- data/lib/akeyless/models/list_sra_sessions.rb +12 -2
- data/lib/akeyless/models/list_sra_sessions_output.rb +3 -0
- data/lib/akeyless/models/list_targets.rb +1 -1
- data/lib/akeyless/models/lock_item.rb +1 -1
- data/lib/akeyless/models/migration_general.rb +28 -1
- data/lib/akeyless/models/pki_certificate_issue_details.rb +21 -1
- data/lib/akeyless/models/request_access.rb +11 -1
- data/lib/akeyless/models/rotated_secret_create_ali_cloud.rb +605 -0
- data/lib/akeyless/models/rotated_secret_create_azure.rb +1 -1
- data/lib/akeyless/models/rotated_secret_create_okta.rb +556 -0
- data/lib/akeyless/models/rotated_secret_update_ali_cloud.rb +605 -0
- data/lib/akeyless/models/rotated_secret_update_azure.rb +1 -1
- data/lib/akeyless/models/rotated_secret_update_okta.rb +563 -0
- data/lib/akeyless/models/scim_settings.rb +271 -0
- data/lib/akeyless/models/scim_status.rb +323 -0
- data/lib/akeyless/models/target.rb +10 -1
- data/lib/akeyless/models/target_create_ali_cloud.rb +394 -0
- data/lib/akeyless/models/target_create_digi_cert.rb +43 -1
- data/lib/akeyless/models/target_create_google_trust.rb +43 -1
- data/lib/akeyless/models/target_create_ldap.rb +14 -4
- data/lib/akeyless/models/target_create_lets_encrypt.rb +43 -1
- data/lib/akeyless/models/target_list.rb +1 -1
- data/lib/akeyless/models/target_type_details_input.rb +10 -1
- data/lib/akeyless/models/target_update_ali_cloud.rb +414 -0
- data/lib/akeyless/models/target_update_digi_cert.rb +43 -1
- data/lib/akeyless/models/target_update_google_trust.rb +43 -1
- data/lib/akeyless/models/target_update_ldap.rb +14 -4
- data/lib/akeyless/models/target_update_lets_encrypt.rb +43 -1
- data/lib/akeyless/models/update_item.rb +23 -2
- data/lib/akeyless/models/update_ldap_target.rb +14 -4
- data/lib/akeyless/models/update_mcp_secret_bearer_token.rb +3 -0
- data/lib/akeyless/models/update_mcp_secret_o_auth_auth_code.rb +3 -0
- data/lib/akeyless/models/update_mcp_secret_o_auth_client_creds.rb +3 -0
- data/lib/akeyless/models/update_pki_cert_issuer.rb +31 -1
- data/lib/akeyless/models/update_rotated_secret.rb +20 -2
- data/lib/akeyless/models/usc_create.rb +12 -2
- data/lib/akeyless/models/usc_delete.rb +21 -1
- data/lib/akeyless/models/usc_get.rb +21 -1
- data/lib/akeyless/models/usc_list.rb +21 -1
- data/lib/akeyless/models/usc_update.rb +21 -1
- data/lib/akeyless/version.rb +1 -1
- data/lib/akeyless.rb +16 -0
- data/spec/models/ali_cloud_target_details_spec.rb +66 -0
- data/spec/models/client_event_output_spec.rb +36 -0
- data/spec/models/client_event_spec.rb +60 -0
- data/spec/models/generate_intermediate_ca_output_spec.rb +60 -0
- data/spec/models/generate_intermediate_ca_spec.rb +126 -0
- data/spec/models/get_scim_status_spec.rb +54 -0
- data/spec/models/granted_role_spec.rb +42 -0
- data/spec/models/injector_certificate_event_spec.rb +66 -0
- data/spec/models/rotated_secret_create_ali_cloud_spec.rb +252 -0
- data/spec/models/rotated_secret_create_okta_spec.rb +228 -0
- data/spec/models/rotated_secret_update_ali_cloud_spec.rb +258 -0
- data/spec/models/rotated_secret_update_okta_spec.rb +234 -0
- data/spec/models/scim_settings_spec.rb +72 -0
- data/spec/models/scim_status_spec.rb +108 -0
- data/spec/models/target_create_ali_cloud_spec.rb +138 -0
- data/spec/models/target_update_ali_cloud_spec.rb +150 -0
- metadata +75 -10
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# Akeyless::RotatedSecretCreateOkta
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **ara_enabled** | **Boolean** | Enable or disable Agentic Runtime Authority rule enforcement for this item. When false, user-defined input/output rules are stored but not enforced; the base security validation still runs. AraEnabled is tri-state (nil/true/false), not a plain bool: it self-encodes its wire value (see akl.OptionalBool) so an explicit false survives the curl-proxy relay instead of being dropped like a default-false bool flag. | [optional] |
|
|
8
|
+
| **authentication_credentials** | **String** | Okta uses the SSWS token from the target. | [optional] |
|
|
9
|
+
| **auto_rotate** | **String** | | [optional] |
|
|
10
|
+
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
11
|
+
| **description** | **String** | Description of the object. | [optional] |
|
|
12
|
+
| **enable_agentic_runtime_authority** | **Boolean** | EnableAra is the documented spelling of AraEnabled. Both set the same field; --ara-enabled shipped first and stays as an undocumented alias so existing scripts and the Terraform provider keep working. | [optional] |
|
|
13
|
+
| **enable_ai_quorum** | **Boolean** | Turns on AI Quorum checks for this item. | [optional] |
|
|
14
|
+
| **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [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** | | [optional] |
|
|
18
|
+
| **lock_on_read** | **String** | Lock this secret after each successful value read | [optional] |
|
|
19
|
+
| **lock_ttl** | **String** | Lock TTL in minutes | [optional] |
|
|
20
|
+
| **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
|
|
21
|
+
| **name** | **String** | Rotated secret name | |
|
|
22
|
+
| **output_rule** | **Array<String>** | Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets) | [optional] |
|
|
23
|
+
| **password_length** | **String** | The length of the password to be generated | [optional] |
|
|
24
|
+
| **rotate_on_unlock** | **String** | Rotate this secret after it is unlocked | [optional] |
|
|
25
|
+
| **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
|
|
26
|
+
| **rotated_username** | **String** | username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password) | [optional] |
|
|
27
|
+
| **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
|
|
28
|
+
| **rotation_hour** | **Integer** | | [optional] |
|
|
29
|
+
| **rotation_interval** | **String** | | [optional] |
|
|
30
|
+
| **rotator_type** | **String** | The Okta rotator supports only password. | [optional] |
|
|
31
|
+
| **skip_dry_run** | **Boolean** | If set, dry-run will be skipped [true/false] | [optional] |
|
|
32
|
+
| **tags** | **Array<String>** | Add tags attached to this object | [optional] |
|
|
33
|
+
| **target_name** | **String** | The Okta target name to associate. | |
|
|
34
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
35
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
36
|
+
| **use_capital_letters** | **String** | Specifies whether the generated temporary password must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z). [true/false] | [optional] |
|
|
37
|
+
| **use_lower_letters** | **String** | Specifies whether the generated temporary password must contain at least one lowercase character from the ISO basic Latin alphabet (a to z). [true/false] | [optional] |
|
|
38
|
+
| **use_numbers** | **String** | Specifies whether the generated temporary password must contain at least one numeric character (0 to 9). [true/false] | [optional] |
|
|
39
|
+
| **use_special_characters** | **String** | | [optional] |
|
|
40
|
+
|
|
41
|
+
## Example
|
|
42
|
+
|
|
43
|
+
```ruby
|
|
44
|
+
require 'akeyless'
|
|
45
|
+
|
|
46
|
+
instance = Akeyless::RotatedSecretCreateOkta.new(
|
|
47
|
+
ara_enabled: null,
|
|
48
|
+
authentication_credentials: null,
|
|
49
|
+
auto_rotate: null,
|
|
50
|
+
delete_protection: null,
|
|
51
|
+
description: null,
|
|
52
|
+
enable_agentic_runtime_authority: null,
|
|
53
|
+
enable_ai_quorum: null,
|
|
54
|
+
input_rule: null,
|
|
55
|
+
item_custom_fields: null,
|
|
56
|
+
json: null,
|
|
57
|
+
key: null,
|
|
58
|
+
lock_on_read: null,
|
|
59
|
+
lock_ttl: null,
|
|
60
|
+
max_versions: null,
|
|
61
|
+
name: null,
|
|
62
|
+
output_rule: null,
|
|
63
|
+
password_length: null,
|
|
64
|
+
rotate_on_unlock: null,
|
|
65
|
+
rotated_password: null,
|
|
66
|
+
rotated_username: null,
|
|
67
|
+
rotation_event_in: null,
|
|
68
|
+
rotation_hour: null,
|
|
69
|
+
rotation_interval: null,
|
|
70
|
+
rotator_type: null,
|
|
71
|
+
skip_dry_run: null,
|
|
72
|
+
tags: null,
|
|
73
|
+
target_name: null,
|
|
74
|
+
token: null,
|
|
75
|
+
uid_token: null,
|
|
76
|
+
use_capital_letters: null,
|
|
77
|
+
use_lower_letters: null,
|
|
78
|
+
use_numbers: null,
|
|
79
|
+
use_special_characters: ! @ # $. [true/false]
|
|
80
|
+
)
|
|
81
|
+
```
|
|
82
|
+
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# Akeyless::RotatedSecretUpdateAliCloud
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **access_key** | **String** | AliCloud RAM user AccessKey secret to rotate (relevant only for rotator-type=access-key) | [optional] |
|
|
8
|
+
| **access_key_id** | **String** | AliCloud RAM user AccessKey ID to rotate (relevant only for rotator-type=access-key). On create with authentication-credentials=use-target-creds it may be empty, then Akeyless creates the AccessKey on the RAM user of the target and manages it | [optional] |
|
|
9
|
+
| **add_tag** | **Array<String>** | List of the new tags that will be attached to this item | [optional] |
|
|
10
|
+
| **ara_enabled** | **Boolean** | Enable or disable Agentic Runtime Authority rule enforcement for this item. When false, user-defined input/output rules are stored but not enforced; the base security validation still runs. AraEnabled is tri-state (nil/true/false), not a plain bool: it self-encodes its wire value (see akl.OptionalBool) so an explicit false survives the curl-proxy relay instead of being dropped like a default-false bool flag. | [optional] |
|
|
11
|
+
| **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
|
|
12
|
+
| **auto_rotate** | **String** | | [optional] |
|
|
13
|
+
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
14
|
+
| **description** | **String** | Description of the object | [optional][default to 'default_metadata'] |
|
|
15
|
+
| **enable_agentic_runtime_authority** | **Boolean** | EnableAra is the documented spelling of AraEnabled. Both set the same field; --ara-enabled shipped first and stays as an undocumented alias so existing scripts and the Terraform provider keep working. | [optional] |
|
|
16
|
+
| **enable_ai_quorum** | **Boolean** | Turns on AI Quorum checks for this item. | [optional] |
|
|
17
|
+
| **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] |
|
|
18
|
+
| **grace_rotation_hour** | **Integer** | The Hour of the grace rotation in UTC | [optional] |
|
|
19
|
+
| **grace_rotation_interval** | **String** | The number of days to wait before deleting the old key (must be bigger than rotation-interval) | [optional] |
|
|
20
|
+
| **grace_rotation_timing** | **String** | When to create the new version relative to the rotation date [after/before] | [optional] |
|
|
21
|
+
| **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
|
|
22
|
+
| **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
|
|
23
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
24
|
+
| **keep_prev_version** | **String** | Whether to keep previous version [true/false]. If not set, use default according to account settings | [optional] |
|
|
25
|
+
| **key** | **String** | | [optional] |
|
|
26
|
+
| **lock_on_read** | **String** | Lock this secret after each successful value read | [optional] |
|
|
27
|
+
| **lock_ttl** | **String** | Lock TTL in minutes | [optional] |
|
|
28
|
+
| **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
|
|
29
|
+
| **name** | **String** | Rotated secret name | |
|
|
30
|
+
| **new_name** | **String** | New item name | [optional] |
|
|
31
|
+
| **output_rule** | **Array<String>** | Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets) | [optional] |
|
|
32
|
+
| **password_length** | **String** | The length of the password to be generated | [optional] |
|
|
33
|
+
| **rm_tag** | **Array<String>** | List of the existent tags that will be removed from this item | [optional] |
|
|
34
|
+
| **rotate_on_unlock** | **String** | Rotate this secret after it is unlocked | [optional] |
|
|
35
|
+
| **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
|
|
36
|
+
| **rotation_hour** | **Integer** | | [optional] |
|
|
37
|
+
| **rotation_interval** | **String** | | [optional] |
|
|
38
|
+
| **skip_dry_run** | **Boolean** | If set, dry-run will be skipped [true/false] | [optional] |
|
|
39
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
40
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
41
|
+
| **use_capital_letters** | **String** | Specifies whether the generated temporary password must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z). [true/false] | [optional] |
|
|
42
|
+
| **use_lower_letters** | **String** | Specifies whether the generated temporary password must contain at least one lowercase character from the ISO basic Latin alphabet (a to z). [true/false] | [optional] |
|
|
43
|
+
| **use_numbers** | **String** | Specifies whether the generated temporary password must contain at least one numeric character (0 to 9). [true/false] | [optional] |
|
|
44
|
+
| **use_special_characters** | **String** | | [optional] |
|
|
45
|
+
|
|
46
|
+
## Example
|
|
47
|
+
|
|
48
|
+
```ruby
|
|
49
|
+
require 'akeyless'
|
|
50
|
+
|
|
51
|
+
instance = Akeyless::RotatedSecretUpdateAliCloud.new(
|
|
52
|
+
access_key: null,
|
|
53
|
+
access_key_id: null,
|
|
54
|
+
add_tag: null,
|
|
55
|
+
ara_enabled: null,
|
|
56
|
+
authentication_credentials: null,
|
|
57
|
+
auto_rotate: null,
|
|
58
|
+
delete_protection: null,
|
|
59
|
+
description: null,
|
|
60
|
+
enable_agentic_runtime_authority: null,
|
|
61
|
+
enable_ai_quorum: null,
|
|
62
|
+
grace_rotation: null,
|
|
63
|
+
grace_rotation_hour: null,
|
|
64
|
+
grace_rotation_interval: null,
|
|
65
|
+
grace_rotation_timing: null,
|
|
66
|
+
input_rule: null,
|
|
67
|
+
item_custom_fields: null,
|
|
68
|
+
json: null,
|
|
69
|
+
keep_prev_version: null,
|
|
70
|
+
key: null,
|
|
71
|
+
lock_on_read: null,
|
|
72
|
+
lock_ttl: null,
|
|
73
|
+
max_versions: null,
|
|
74
|
+
name: null,
|
|
75
|
+
new_name: null,
|
|
76
|
+
output_rule: null,
|
|
77
|
+
password_length: null,
|
|
78
|
+
rm_tag: null,
|
|
79
|
+
rotate_on_unlock: null,
|
|
80
|
+
rotation_event_in: null,
|
|
81
|
+
rotation_hour: null,
|
|
82
|
+
rotation_interval: null,
|
|
83
|
+
skip_dry_run: null,
|
|
84
|
+
token: null,
|
|
85
|
+
uid_token: null,
|
|
86
|
+
use_capital_letters: null,
|
|
87
|
+
use_lower_letters: null,
|
|
88
|
+
use_numbers: null,
|
|
89
|
+
use_special_characters: ! @ # $. [true/false]
|
|
90
|
+
)
|
|
91
|
+
```
|
|
92
|
+
|
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| **add_tag** | **Array<String>** | List of the new tags that will be attached to this item | [optional] |
|
|
8
8
|
| **api_id** | **String** | API ID to rotate (relevant only for rotator-type=api-key) | [optional] |
|
|
9
9
|
| **api_key** | **String** | API key to rotate (relevant only for rotator-type=api-key) | [optional] |
|
|
10
|
-
| **application_id** | **String** | Id of the azure app that hold the serect to be rotated (relevant only for rotator-type=api-key
|
|
10
|
+
| **application_id** | **String** | Id of the azure app that hold the serect to be rotated (relevant only for rotator-type=api-key) | [optional] |
|
|
11
11
|
| **ara_enabled** | **Boolean** | Enable or disable Agentic Runtime Authority rule enforcement for this item. When false, user-defined input/output rules are stored but not enforced; the base security validation still runs. AraEnabled is tri-state (nil/true/false), not a plain bool: it self-encodes its wire value (see akl.OptionalBool) so an explicit false survives the curl-proxy relay instead of being dropped like a default-false bool flag. | [optional] |
|
|
12
12
|
| **authentication_credentials** | **String** | The credentials to connect with use-user-creds/use-target-creds | [optional][default to 'use-user-creds'] |
|
|
13
13
|
| **auto_rotate** | **String** | | [optional] |
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
# Akeyless::RotatedSecretUpdateOkta
|
|
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. To specify multiple tags use argument multiple times: --add-tag Tag1 --add-tag Tag2 | [optional] |
|
|
8
|
+
| **ara_enabled** | **Boolean** | Enable or disable Agentic Runtime Authority rule enforcement for this item. When false, user-defined input/output rules are stored but not enforced; the base security validation still runs. AraEnabled is tri-state (nil/true/false), not a plain bool: it self-encodes its wire value (see akl.OptionalBool) so an explicit false survives the curl-proxy relay instead of being dropped like a default-false bool flag. | [optional] |
|
|
9
|
+
| **authentication_credentials** | **String** | Okta uses the SSWS token from the target. | [optional] |
|
|
10
|
+
| **auto_rotate** | **String** | | [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
|
+
| **enable_agentic_runtime_authority** | **Boolean** | EnableAra is the documented spelling of AraEnabled. Both set the same field; --ara-enabled shipped first and stays as an undocumented alias so existing scripts and the Terraform provider keep working. | [optional] |
|
|
14
|
+
| **enable_ai_quorum** | **Boolean** | Turns on AI Quorum checks for this item. | [optional] |
|
|
15
|
+
| **input_rule** | **Array<String>** | Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input) | [optional] |
|
|
16
|
+
| **item_custom_fields** | **Hash<String, String>** | Additional custom fields to associate with the item | [optional] |
|
|
17
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
18
|
+
| **keep_prev_version** | **String** | Whether to keep previous version [true/false]. If not set, use default according to account settings | [optional] |
|
|
19
|
+
| **key** | **String** | | [optional] |
|
|
20
|
+
| **lock_on_read** | **String** | Lock this secret after each successful value read | [optional] |
|
|
21
|
+
| **lock_ttl** | **String** | Lock TTL in minutes | [optional] |
|
|
22
|
+
| **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
|
|
23
|
+
| **name** | **String** | Rotated secret name | |
|
|
24
|
+
| **new_name** | **String** | New item name | [optional] |
|
|
25
|
+
| **output_rule** | **Array<String>** | Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets) | [optional] |
|
|
26
|
+
| **password_length** | **String** | The length of the password to be generated | [optional] |
|
|
27
|
+
| **rm_tag** | **Array<String>** | List of the existent tags that will be removed from this item. To specify multiple tags use argument multiple times: --rm-tag Tag1 --rm-tag Tag2 | [optional] |
|
|
28
|
+
| **rotate_on_unlock** | **String** | Rotate this secret after it is unlocked | [optional] |
|
|
29
|
+
| **rotated_password** | **String** | rotated-username password (relevant only for rotator-type=password) | [optional] |
|
|
30
|
+
| **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] |
|
|
31
|
+
| **rotation_event_in** | **Array<String>** | How many days before the rotation of the item would you like to be notified | [optional] |
|
|
32
|
+
| **rotation_hour** | **Integer** | | [optional] |
|
|
33
|
+
| **rotation_interval** | **String** | | [optional] |
|
|
34
|
+
| **skip_dry_run** | **Boolean** | If set, dry-run will be skipped [true/false] | [optional] |
|
|
35
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
36
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
37
|
+
| **use_capital_letters** | **String** | Specifies whether the generated temporary password must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z). [true/false] | [optional] |
|
|
38
|
+
| **use_lower_letters** | **String** | Specifies whether the generated temporary password must contain at least one lowercase character from the ISO basic Latin alphabet (a to z). [true/false] | [optional] |
|
|
39
|
+
| **use_numbers** | **String** | Specifies whether the generated temporary password must contain at least one numeric character (0 to 9). [true/false] | [optional] |
|
|
40
|
+
| **use_special_characters** | **String** | | [optional] |
|
|
41
|
+
|
|
42
|
+
## Example
|
|
43
|
+
|
|
44
|
+
```ruby
|
|
45
|
+
require 'akeyless'
|
|
46
|
+
|
|
47
|
+
instance = Akeyless::RotatedSecretUpdateOkta.new(
|
|
48
|
+
add_tag: null,
|
|
49
|
+
ara_enabled: null,
|
|
50
|
+
authentication_credentials: null,
|
|
51
|
+
auto_rotate: null,
|
|
52
|
+
delete_protection: null,
|
|
53
|
+
description: null,
|
|
54
|
+
enable_agentic_runtime_authority: null,
|
|
55
|
+
enable_ai_quorum: null,
|
|
56
|
+
input_rule: null,
|
|
57
|
+
item_custom_fields: null,
|
|
58
|
+
json: null,
|
|
59
|
+
keep_prev_version: null,
|
|
60
|
+
key: null,
|
|
61
|
+
lock_on_read: null,
|
|
62
|
+
lock_ttl: null,
|
|
63
|
+
max_versions: null,
|
|
64
|
+
name: null,
|
|
65
|
+
new_name: null,
|
|
66
|
+
output_rule: null,
|
|
67
|
+
password_length: null,
|
|
68
|
+
rm_tag: null,
|
|
69
|
+
rotate_on_unlock: null,
|
|
70
|
+
rotated_password: null,
|
|
71
|
+
rotated_username: null,
|
|
72
|
+
rotation_event_in: null,
|
|
73
|
+
rotation_hour: null,
|
|
74
|
+
rotation_interval: null,
|
|
75
|
+
skip_dry_run: null,
|
|
76
|
+
token: null,
|
|
77
|
+
uid_token: null,
|
|
78
|
+
use_capital_letters: null,
|
|
79
|
+
use_lower_letters: null,
|
|
80
|
+
use_numbers: null,
|
|
81
|
+
use_special_characters: ! @ # $. [true/false]
|
|
82
|
+
)
|
|
83
|
+
```
|
|
84
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# Akeyless::ScimSettings
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **bearer_access_id** | **String** | Access ID of the API Key auth method the IdP uses as the SCIM bearer. | [optional] |
|
|
8
|
+
| **default_identity_type** | **String** | | [optional] |
|
|
9
|
+
| **enabled** | **Boolean** | | [optional] |
|
|
10
|
+
| **endpoint** | **String** | | [optional] |
|
|
11
|
+
| **gateway_url** | **String** | URL of the gateway that serves the SCIM endpoint to the IdP, for the private endpoint. | [optional] |
|
|
12
|
+
| **provisioned_access_id** | **String** | ProvisionedAccessId and ProvisionedType are set on the bearer itself, not on the auth method it provisions. They point back to the SAML or OIDC auth method the bearer provisions, so the gateway can find that auth method from the bearer. | [optional] |
|
|
13
|
+
| **provisioned_type** | **String** | | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'akeyless'
|
|
19
|
+
|
|
20
|
+
instance = Akeyless::ScimSettings.new(
|
|
21
|
+
bearer_access_id: null,
|
|
22
|
+
default_identity_type: null,
|
|
23
|
+
enabled: null,
|
|
24
|
+
endpoint: null,
|
|
25
|
+
gateway_url: null,
|
|
26
|
+
provisioned_access_id: null,
|
|
27
|
+
provisioned_type: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
data/docs/ScimStatus.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Akeyless::ScimStatus
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **active_identities** | **Integer** | | [optional] |
|
|
8
|
+
| **base_url** | **String** | | [optional] |
|
|
9
|
+
| **bearer_access_id** | **String** | | [optional] |
|
|
10
|
+
| **connected** | **Boolean** | | [optional] |
|
|
11
|
+
| **degraded** | **Boolean** | Degraded is true when live-token revocation is not active, so deactivation only denies new logins. | [optional] |
|
|
12
|
+
| **enabled** | **Boolean** | | [optional] |
|
|
13
|
+
| **endpoint** | **String** | | [optional] |
|
|
14
|
+
| **gateway_url** | **String** | | [optional] |
|
|
15
|
+
| **groups** | **Integer** | | [optional] |
|
|
16
|
+
| **inactive_identities** | **Integer** | | [optional] |
|
|
17
|
+
| **last_write_action** | **String** | | [optional] |
|
|
18
|
+
| **last_write_status** | **String** | | [optional] |
|
|
19
|
+
| **last_write_ts** | **Time** | | [optional] |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'akeyless'
|
|
25
|
+
|
|
26
|
+
instance = Akeyless::ScimStatus.new(
|
|
27
|
+
active_identities: null,
|
|
28
|
+
base_url: null,
|
|
29
|
+
bearer_access_id: null,
|
|
30
|
+
connected: null,
|
|
31
|
+
degraded: null,
|
|
32
|
+
enabled: null,
|
|
33
|
+
endpoint: null,
|
|
34
|
+
gateway_url: null,
|
|
35
|
+
groups: null,
|
|
36
|
+
inactive_identities: null,
|
|
37
|
+
last_write_action: null,
|
|
38
|
+
last_write_status: null,
|
|
39
|
+
last_write_ts: null
|
|
40
|
+
)
|
|
41
|
+
```
|
|
42
|
+
|
data/docs/Target.md
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| **creation_date** | **Time** | | [optional] |
|
|
14
14
|
| **delete_protection** | **Boolean** | | [optional] |
|
|
15
15
|
| **is_access_request_enabled** | **Boolean** | | [optional] |
|
|
16
|
+
| **last_access_request_status** | **String** | | [optional] |
|
|
16
17
|
| **last_version** | **Integer** | | [optional] |
|
|
17
18
|
| **locking_info** | [**LockingInfo**](LockingInfo.md) | | [optional] |
|
|
18
19
|
| **modification_date** | **Time** | | [optional] |
|
|
@@ -42,6 +43,7 @@ instance = Akeyless::Target.new(
|
|
|
42
43
|
creation_date: null,
|
|
43
44
|
delete_protection: null,
|
|
44
45
|
is_access_request_enabled: null,
|
|
46
|
+
last_access_request_status: null,
|
|
45
47
|
last_version: null,
|
|
46
48
|
locking_info: null,
|
|
47
49
|
modification_date: null,
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Akeyless::TargetCreateAliCloud
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **access_key** | **String** | AliCloud RAM access key secret | [optional] |
|
|
8
|
+
| **access_key_id** | **String** | AliCloud RAM access key ID | [optional] |
|
|
9
|
+
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
10
|
+
| **description** | **String** | Description of the object | [optional] |
|
|
11
|
+
| **generate_external_id** | **Boolean** | A unique auto-generated value used in your AliCloud account when configuring the RAM role trust policy to securely delegate access to Akeyless. Relevant only when using GW cloud ID | [optional] |
|
|
12
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
13
|
+
| **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] |
|
|
14
|
+
| **lock_on_read** | **String** | Lock this secret after each successful value read | [optional] |
|
|
15
|
+
| **lock_ttl** | **String** | Lock TTL in minutes | [optional] |
|
|
16
|
+
| **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
|
|
17
|
+
| **name** | **String** | Target name | |
|
|
18
|
+
| **region** | **String** | AliCloud region. Selects the regional STS endpoint. If empty, the global STS endpoint is used | [optional] |
|
|
19
|
+
| **role_arn** | **String** | AliCloud RAM role ARN that the Gateway will assume in your AliCloud account (acs:ram::<account-id>:role/<role-name>), relevant only when using external ID | [optional] |
|
|
20
|
+
| **rotate_on_unlock** | **String** | Rotate this secret after it is unlocked | [optional] |
|
|
21
|
+
| **session_token** | **String** | Required only for temporary security credentials retrieved using STS | [optional] |
|
|
22
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
23
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
24
|
+
| **use_gw_cloud_identity** | **Boolean** | Use the Gateway cloud identity | [optional] |
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```ruby
|
|
29
|
+
require 'akeyless'
|
|
30
|
+
|
|
31
|
+
instance = Akeyless::TargetCreateAliCloud.new(
|
|
32
|
+
access_key: null,
|
|
33
|
+
access_key_id: null,
|
|
34
|
+
delete_protection: null,
|
|
35
|
+
description: null,
|
|
36
|
+
generate_external_id: null,
|
|
37
|
+
json: null,
|
|
38
|
+
key: null,
|
|
39
|
+
lock_on_read: null,
|
|
40
|
+
lock_ttl: null,
|
|
41
|
+
max_versions: null,
|
|
42
|
+
name: null,
|
|
43
|
+
region: null,
|
|
44
|
+
role_arn: null,
|
|
45
|
+
rotate_on_unlock: null,
|
|
46
|
+
session_token: null,
|
|
47
|
+
token: null,
|
|
48
|
+
uid_token: null,
|
|
49
|
+
use_gw_cloud_identity: null
|
|
50
|
+
)
|
|
51
|
+
```
|
|
52
|
+
|
|
@@ -8,7 +8,11 @@
|
|
|
8
8
|
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
9
9
|
| **description** | **String** | Description of the object | [optional] |
|
|
10
10
|
| **digicert_url** | **String** | DigiCert ACME endpoint selector. Options: [us-production/eu-production/us-demo/eu-demo] | [optional][default to 'us-production'] |
|
|
11
|
+
| **dns_propagation_wait** | **String** | Fixed wait after TXT publish (e.g. 30s, 2m). If omitted with pre-check on, no extra sleep (polling only). If omitted with --dns-skip-precheck, gateway uses 30s. DNS challenge only | [optional] |
|
|
12
|
+
| **dns_resolvers** | **Array<String>** | Custom DNS resolvers (ip:port) for DNS-01. Repeat for multiple. If omitted, Lego uses /etc/resolv.conf or Google Public DNS. DNS challenge only | [optional] |
|
|
13
|
+
| **dns_skip_precheck** | **Boolean** | Skip DNS TXT pre-check before CA validation. If --dns-propagation-wait is omitted and this flag is set, gateway waits 30s before CA validation. DNS challenge only | [optional] |
|
|
11
14
|
| **dns_target_creds** | **String** | Name of existing cloud target for DNS credentials. Required when challenge type is dns. Supported providers: AWS, Azure, GCP, Cloudflare | [optional] |
|
|
15
|
+
| **dns_timeout** | **String** | Per-query DNS lookup timeout during pre-check (e.g. 10s), not total poll time. If omitted with pre-check on, Lego library default applies (10s per query on Linux). Ignored when --dns-skip-precheck is set. DNS challenge only | [optional] |
|
|
12
16
|
| **dns_zone** | **String** | Cloudflare DNS zone identifier. Required when DNS credentials target is Cloudflare | [optional] |
|
|
13
17
|
| **eab_hmac_key** | **String** | External Account Binding HMAC key (required for ACME account bootstrap on create) | [optional] |
|
|
14
18
|
| **eab_key_id** | **String** | External Account Binding key identifier (required for ACME account bootstrap on create) | [optional] |
|
|
@@ -37,7 +41,11 @@ instance = Akeyless::TargetCreateDigiCert.new(
|
|
|
37
41
|
delete_protection: null,
|
|
38
42
|
description: null,
|
|
39
43
|
digicert_url: null,
|
|
44
|
+
dns_propagation_wait: null,
|
|
45
|
+
dns_resolvers: null,
|
|
46
|
+
dns_skip_precheck: null,
|
|
40
47
|
dns_target_creds: null,
|
|
48
|
+
dns_timeout: null,
|
|
41
49
|
dns_zone: null,
|
|
42
50
|
eab_hmac_key: null,
|
|
43
51
|
eab_key_id: null,
|
|
@@ -7,7 +7,11 @@
|
|
|
7
7
|
| **acme_challenge** | **String** | ACME challenge type. Options: [dns] | [optional][default to 'dns'] |
|
|
8
8
|
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
9
9
|
| **description** | **String** | Description of the object | [optional] |
|
|
10
|
+
| **dns_propagation_wait** | **String** | Fixed wait after TXT publish (e.g. 30s, 2m). If omitted with pre-check on, no extra sleep (polling only). If omitted with --dns-skip-precheck, gateway uses 30s. DNS challenge only | [optional] |
|
|
11
|
+
| **dns_resolvers** | **Array<String>** | Custom DNS resolvers (ip:port) for DNS-01. Repeat for multiple. If omitted, Lego uses /etc/resolv.conf or Google Public DNS. DNS challenge only | [optional] |
|
|
12
|
+
| **dns_skip_precheck** | **Boolean** | Skip DNS TXT pre-check before CA validation. If --dns-propagation-wait is omitted and this flag is set, gateway waits 30s before CA validation. DNS challenge only | [optional] |
|
|
10
13
|
| **dns_target_creds** | **String** | Name of existing cloud target for DNS credentials. Required when challenge type is dns. Supported providers: AWS, Azure, GCP, Cloudflare | [optional] |
|
|
14
|
+
| **dns_timeout** | **String** | Per-query DNS lookup timeout during pre-check (e.g. 10s), not total poll time. If omitted with pre-check on, Lego library default applies (10s per query on Linux). Ignored when --dns-skip-precheck is set. DNS challenge only | [optional] |
|
|
11
15
|
| **dns_zone** | **String** | Cloudflare DNS zone identifier. Required when DNS credentials target is Cloudflare | [optional] |
|
|
12
16
|
| **eab_hmac_key** | **String** | External Account Binding HMAC key (required for ACME account bootstrap on create) | [optional] |
|
|
13
17
|
| **eab_key_id** | **String** | External Account Binding key identifier (required for ACME account bootstrap on create) | [optional] |
|
|
@@ -36,7 +40,11 @@ instance = Akeyless::TargetCreateGoogleTrust.new(
|
|
|
36
40
|
acme_challenge: null,
|
|
37
41
|
delete_protection: null,
|
|
38
42
|
description: null,
|
|
43
|
+
dns_propagation_wait: null,
|
|
44
|
+
dns_resolvers: null,
|
|
45
|
+
dns_skip_precheck: null,
|
|
39
46
|
dns_target_creds: null,
|
|
47
|
+
dns_timeout: null,
|
|
40
48
|
dns_zone: null,
|
|
41
49
|
eab_hmac_key: null,
|
|
42
50
|
eab_key_id: null,
|
data/docs/TargetCreateLdap.md
CHANGED
|
@@ -21,6 +21,7 @@
|
|
|
21
21
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
22
22
|
| **token_expiration** | **String** | Token expiration | [optional] |
|
|
23
23
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
24
|
+
| **username** | **String** | Username returned for Rotated Secrets. Use the format required by your application, such as sAMAccountName, with or without the domain. | [optional] |
|
|
24
25
|
|
|
25
26
|
## Example
|
|
26
27
|
|
|
@@ -44,7 +45,8 @@ instance = Akeyless::TargetCreateLdap.new(
|
|
|
44
45
|
server_type: null,
|
|
45
46
|
token: null,
|
|
46
47
|
token_expiration: null,
|
|
47
|
-
uid_token: null
|
|
48
|
+
uid_token: null,
|
|
49
|
+
username: null
|
|
48
50
|
)
|
|
49
51
|
```
|
|
50
52
|
|
|
@@ -7,7 +7,11 @@
|
|
|
7
7
|
| **acme_challenge** | **String** | | [optional][default to 'http'] |
|
|
8
8
|
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
9
9
|
| **description** | **String** | Description of the object | [optional] |
|
|
10
|
+
| **dns_propagation_wait** | **String** | Fixed wait after TXT publish (e.g. 30s, 2m). If omitted with pre-check on, no extra sleep (polling only). If omitted with --dns-skip-precheck, gateway uses 30s. DNS challenge only | [optional] |
|
|
11
|
+
| **dns_resolvers** | **Array<String>** | Custom DNS resolvers (ip:port) for DNS-01. Repeat for multiple. If omitted, Lego uses /etc/resolv.conf or Google Public DNS. DNS challenge only | [optional] |
|
|
12
|
+
| **dns_skip_precheck** | **Boolean** | Skip DNS TXT pre-check before CA validation. If --dns-propagation-wait is omitted and this flag is set, gateway waits 30s before CA validation. DNS challenge only | [optional] |
|
|
10
13
|
| **dns_target_creds** | **String** | Name of existing cloud target for DNS credentials. Required when acme-challenge=dns. Supported: AWS, Azure, GCP, Cloudflare targets | [optional] |
|
|
14
|
+
| **dns_timeout** | **String** | Per-query DNS lookup timeout during pre-check (e.g. 10s), not total poll time. If omitted with pre-check on, Lego library default applies (10s per query on Linux). Ignored when --dns-skip-precheck is set. DNS challenge only | [optional] |
|
|
11
15
|
| **dns_zone** | **String** | Cloudflare DNS zone identifier. Required when dns-target-creds points to Cloudflare target | [optional] |
|
|
12
16
|
| **email** | **String** | Email address for ACME account registration | |
|
|
13
17
|
| **gcp_project** | **String** | GCP Cloud DNS: Project ID. Optional - can be derived from service account | [optional] |
|
|
@@ -34,7 +38,11 @@ instance = Akeyless::TargetCreateLetsEncrypt.new(
|
|
|
34
38
|
acme_challenge: null,
|
|
35
39
|
delete_protection: null,
|
|
36
40
|
description: null,
|
|
41
|
+
dns_propagation_wait: null,
|
|
42
|
+
dns_resolvers: null,
|
|
43
|
+
dns_skip_precheck: null,
|
|
37
44
|
dns_target_creds: null,
|
|
45
|
+
dns_timeout: null,
|
|
38
46
|
dns_zone: null,
|
|
39
47
|
email: null,
|
|
40
48
|
gcp_project: null,
|
data/docs/TargetList.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
9
9
|
| **pagination_token** | **String** | Next page reference | [optional] |
|
|
10
10
|
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
11
|
-
| **type** | **Array<String>** | The target types list . In case it is empty, all types of targets will be returned. options: [hanadb cassandra aws ssh gke eks mysql mongodb snowflake mssql redshift artifactory azure rabbitmq k8s venafi gcp oracle dockerhub cloudflare ldap github chef web salesforce postgres] | [optional] |
|
|
11
|
+
| **type** | **Array<String>** | The target types list . In case it is empty, all types of targets will be returned. options: [hanadb cassandra aws alicloud ssh gke eks mysql mongodb snowflake mssql redshift artifactory azure rabbitmq k8s venafi gcp oracle dockerhub cloudflare ldap github chef web salesforce postgres] | [optional] |
|
|
12
12
|
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
13
13
|
|
|
14
14
|
## Example
|
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **aerospike_target_details** | [**AerospikeTargetDetails**](AerospikeTargetDetails.md) | | [optional] |
|
|
8
|
+
| **alicloud_target_details** | [**AliCloudTargetDetails**](AliCloudTargetDetails.md) | | [optional] |
|
|
8
9
|
| **anthropic_target_details** | [**AnthropicTargetDetails**](AnthropicTargetDetails.md) | | [optional] |
|
|
9
10
|
| **artifactory_target_details** | [**ArtifactoryTargetDetails**](ArtifactoryTargetDetails.md) | | [optional] |
|
|
10
11
|
| **aws_target_details** | [**AWSTargetDetails**](AWSTargetDetails.md) | | [optional] |
|
|
@@ -56,6 +57,7 @@ require 'akeyless'
|
|
|
56
57
|
|
|
57
58
|
instance = Akeyless::TargetTypeDetailsInput.new(
|
|
58
59
|
aerospike_target_details: null,
|
|
60
|
+
alicloud_target_details: null,
|
|
59
61
|
anthropic_target_details: null,
|
|
60
62
|
artifactory_target_details: null,
|
|
61
63
|
aws_target_details: null,
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# Akeyless::TargetUpdateAliCloud
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **access_key** | **String** | AliCloud RAM access key secret | [optional] |
|
|
8
|
+
| **access_key_id** | **String** | AliCloud RAM access key ID | [optional] |
|
|
9
|
+
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
10
|
+
| **description** | **String** | Description of the object | [optional] |
|
|
11
|
+
| **generate_external_id** | **Boolean** | A unique auto-generated value used in your AliCloud account when configuring the RAM role trust policy to securely delegate access to Akeyless. Relevant only when using GW cloud ID | [optional] |
|
|
12
|
+
| **json** | **Boolean** | Set output format to JSON | [optional][default to false] |
|
|
13
|
+
| **keep_prev_version** | **String** | Whether to keep previous version [true/false]. If not set, use default according to account settings | [optional] |
|
|
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
|
+
| **lock_on_read** | **String** | Lock this secret after each successful value read | [optional] |
|
|
16
|
+
| **lock_ttl** | **String** | Lock TTL in minutes | [optional] |
|
|
17
|
+
| **max_versions** | **String** | Set the maximum number of versions, limited by the account settings defaults. | [optional] |
|
|
18
|
+
| **name** | **String** | Target name | |
|
|
19
|
+
| **new_name** | **String** | New target name | [optional] |
|
|
20
|
+
| **region** | **String** | AliCloud region. Selects the regional STS endpoint. If empty, the global STS endpoint is used | [optional] |
|
|
21
|
+
| **role_arn** | **String** | AliCloud RAM role ARN that the Gateway will assume in your AliCloud account (acs:ram::<account-id>:role/<role-name>), relevant only when using external ID | [optional] |
|
|
22
|
+
| **rotate_on_unlock** | **String** | Rotate this secret after it is unlocked | [optional] |
|
|
23
|
+
| **session_token** | **String** | Required only for temporary security credentials retrieved using STS | [optional] |
|
|
24
|
+
| **token** | **String** | Authentication token (see `/auth` and `/configure`) | [optional] |
|
|
25
|
+
| **uid_token** | **String** | The universal identity token, Required only for universal_identity authentication | [optional] |
|
|
26
|
+
| **use_gw_cloud_identity** | **Boolean** | Use the Gateway cloud identity | [optional] |
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
```ruby
|
|
31
|
+
require 'akeyless'
|
|
32
|
+
|
|
33
|
+
instance = Akeyless::TargetUpdateAliCloud.new(
|
|
34
|
+
access_key: null,
|
|
35
|
+
access_key_id: null,
|
|
36
|
+
delete_protection: null,
|
|
37
|
+
description: null,
|
|
38
|
+
generate_external_id: null,
|
|
39
|
+
json: null,
|
|
40
|
+
keep_prev_version: null,
|
|
41
|
+
key: null,
|
|
42
|
+
lock_on_read: null,
|
|
43
|
+
lock_ttl: null,
|
|
44
|
+
max_versions: null,
|
|
45
|
+
name: null,
|
|
46
|
+
new_name: null,
|
|
47
|
+
region: null,
|
|
48
|
+
role_arn: null,
|
|
49
|
+
rotate_on_unlock: null,
|
|
50
|
+
session_token: null,
|
|
51
|
+
token: null,
|
|
52
|
+
uid_token: null,
|
|
53
|
+
use_gw_cloud_identity: null
|
|
54
|
+
)
|
|
55
|
+
```
|
|
56
|
+
|
|
@@ -8,7 +8,11 @@
|
|
|
8
8
|
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
9
9
|
| **description** | **String** | Description of the object | [optional] |
|
|
10
10
|
| **digicert_url** | **String** | DigiCert ACME endpoint selector. Options: [us-production/eu-production/us-demo/eu-demo] | [optional][default to 'us-production'] |
|
|
11
|
+
| **dns_propagation_wait** | **String** | Fixed wait after TXT publish (e.g. 30s, 2m). If omitted with pre-check on, no extra sleep (polling only). If omitted with --dns-skip-precheck, gateway uses 30s. DNS challenge only | [optional] |
|
|
12
|
+
| **dns_resolvers** | **Array<String>** | Custom DNS resolvers (ip:port) for DNS-01. Repeat for multiple. If omitted, Lego uses /etc/resolv.conf or Google Public DNS. DNS challenge only | [optional] |
|
|
13
|
+
| **dns_skip_precheck** | **Boolean** | Skip DNS TXT pre-check before CA validation. If --dns-propagation-wait is omitted and this flag is set, gateway waits 30s before CA validation. DNS challenge only | [optional] |
|
|
11
14
|
| **dns_target_creds** | **String** | Name of existing cloud target for DNS credentials. Required when challenge type is dns. Supported providers: AWS, Azure, GCP, Cloudflare | [optional] |
|
|
15
|
+
| **dns_timeout** | **String** | Per-query DNS lookup timeout during pre-check (e.g. 10s), not total poll time. If omitted with pre-check on, Lego library default applies (10s per query on Linux). Ignored when --dns-skip-precheck is set. DNS challenge only | [optional] |
|
|
12
16
|
| **dns_zone** | **String** | Cloudflare DNS zone identifier. Required when DNS credentials target is Cloudflare | [optional] |
|
|
13
17
|
| **eab_hmac_key** | **String** | External Account Binding HMAC key (required for ACME account bootstrap on create) | [optional] |
|
|
14
18
|
| **eab_key_id** | **String** | External Account Binding key identifier (required for ACME account bootstrap on create) | [optional] |
|
|
@@ -39,7 +43,11 @@ instance = Akeyless::TargetUpdateDigiCert.new(
|
|
|
39
43
|
delete_protection: null,
|
|
40
44
|
description: null,
|
|
41
45
|
digicert_url: null,
|
|
46
|
+
dns_propagation_wait: null,
|
|
47
|
+
dns_resolvers: null,
|
|
48
|
+
dns_skip_precheck: null,
|
|
42
49
|
dns_target_creds: null,
|
|
50
|
+
dns_timeout: null,
|
|
43
51
|
dns_zone: null,
|
|
44
52
|
eab_hmac_key: null,
|
|
45
53
|
eab_key_id: null,
|
|
@@ -7,7 +7,11 @@
|
|
|
7
7
|
| **acme_challenge** | **String** | ACME challenge type. Options: [dns] | [optional][default to 'dns'] |
|
|
8
8
|
| **delete_protection** | **String** | Protection from accidental deletion of this object [true/false] | [optional] |
|
|
9
9
|
| **description** | **String** | Description of the object | [optional] |
|
|
10
|
+
| **dns_propagation_wait** | **String** | Fixed wait after TXT publish (e.g. 30s, 2m). If omitted with pre-check on, no extra sleep (polling only). If omitted with --dns-skip-precheck, gateway uses 30s. DNS challenge only | [optional] |
|
|
11
|
+
| **dns_resolvers** | **Array<String>** | Custom DNS resolvers (ip:port) for DNS-01. Repeat for multiple. If omitted, Lego uses /etc/resolv.conf or Google Public DNS. DNS challenge only | [optional] |
|
|
12
|
+
| **dns_skip_precheck** | **Boolean** | Skip DNS TXT pre-check before CA validation. If --dns-propagation-wait is omitted and this flag is set, gateway waits 30s before CA validation. DNS challenge only | [optional] |
|
|
10
13
|
| **dns_target_creds** | **String** | Name of existing cloud target for DNS credentials. Required when challenge type is dns. Supported providers: AWS, Azure, GCP, Cloudflare | [optional] |
|
|
14
|
+
| **dns_timeout** | **String** | Per-query DNS lookup timeout during pre-check (e.g. 10s), not total poll time. If omitted with pre-check on, Lego library default applies (10s per query on Linux). Ignored when --dns-skip-precheck is set. DNS challenge only | [optional] |
|
|
11
15
|
| **dns_zone** | **String** | Cloudflare DNS zone identifier. Required when DNS credentials target is Cloudflare | [optional] |
|
|
12
16
|
| **eab_hmac_key** | **String** | External Account Binding HMAC key (required for ACME account bootstrap on create) | [optional] |
|
|
13
17
|
| **eab_key_id** | **String** | External Account Binding key identifier (required for ACME account bootstrap on create) | [optional] |
|
|
@@ -38,7 +42,11 @@ instance = Akeyless::TargetUpdateGoogleTrust.new(
|
|
|
38
42
|
acme_challenge: null,
|
|
39
43
|
delete_protection: null,
|
|
40
44
|
description: null,
|
|
45
|
+
dns_propagation_wait: null,
|
|
46
|
+
dns_resolvers: null,
|
|
47
|
+
dns_skip_precheck: null,
|
|
41
48
|
dns_target_creds: null,
|
|
49
|
+
dns_timeout: null,
|
|
42
50
|
dns_zone: null,
|
|
43
51
|
eab_hmac_key: null,
|
|
44
52
|
eab_key_id: null,
|