Skip to content

UpdateRotatedSecret.md

Latest commit

 

History

History
118 lines (112 loc) · 7.63 KB

UpdateRotatedSecret.md

File metadata and controls

118 lines (112 loc) · 7.63 KB

Akeyless::UpdateRotatedSecret

Properties

Name Type Description Notes
provider_type String [optional]
add_tag Array<String> List of the new tags that will be attached to this item [optional]
api_id String API ID to rotate [optional]
api_key String API key to rotate [optional]
auto_rotate String Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false] [optional]
aws_region String Aws Region (relevant only for aws) [optional][default to 'us-east-2']
custom_payload String Secret payload to be sent with rotation request (relevant only for rotator-type=custom) [optional]
description String Description of the object [optional][default to 'default_metadata']
gcp_key String Base64-encoded service account private key text [optional]
grace_rotation String Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false] [optional]
host_provider String Host provider type [explicit/target], Default Host provider is explicit, Relevant only for Secure Remote Access of ssh cert issuer, ldap rotated secret and ldap dynamic secret [optional]
json Boolean Set output format to JSON [optional][default to false]
keep_prev_version String Whether to keep previous version [true/false]. If not set, use default according to account settings [optional]
key String The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used) [optional]
lock_during_sra_session String Lock this secret for read/update while an SRA session is active [optional]
name String Secret name
new_metadata String Deprecated - use description [optional][default to 'default_metadata']
new_name String New item name [optional]
new_version Boolean Deprecated [optional]
rm_tag Array<String> List of the existent tags that will be removed from this item [optional]
rotate_after_disconnect String StringOrBool accepts JSON strings, booleans, and numbers for backward compatibility with older SDK versions that send boolean values for rotate-after-disconnect. [optional]
rotated_password String rotated-username password [optional]
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 [optional]
rotation_hour Integer The Hour of the rotation in UTC [optional]
rotation_interval String The number of days to wait between every automatic key rotation (7-365) [optional]
rotator_creds_type String The credentials to connect with use-self-creds/use-target-creds [optional][default to 'use-self-creds']
rotator_custom_cmd String &quot;Custom rotation command (relevant only for ssh target) [optional]
same_password String Rotate same password for each host from the Linked Target (relevant only for Linked Target) [optional]
secure_access_allow_external_user Boolean Allow providing external user for a domain users (relevant only for rdp) [optional][default to false]
secure_access_aws_account_id String The AWS account id (relevant only for aws) [optional]
secure_access_aws_native_cli Boolean The AWS native cli [optional]
secure_access_bastion_issuer String Deprecated. use secure-access-certificate-issuer [optional]
secure_access_certificate_issuer String Path to the SSH Certificate Issuer for your Akeyless Secure Access [optional]
secure_access_db_name String The DB name (relevant only for DB Dynamic-Secret) [optional]
secure_access_db_schema String The db schema (relevant only for mssql or postgresql) [optional]
secure_access_disable_concurrent_connections Boolean Enable this flag to prevent simultaneous use of the same secret [optional]
secure_access_enable String Enable/Disable secure remote access [true/false] [optional]
secure_access_host Array<String> Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers) [optional]
secure_access_rdp_domain String Required when the Dynamic Secret is used for a domain user (relevant only for RDP Dynamic-Secret) [optional]
secure_access_rdp_user String Override the RDP Domain username (relevant only for rdp) [optional]
secure_access_url String Destination URL to inject secrets [optional]
secure_access_web Boolean Enable Web Secure Remote Access [optional][default to false]
secure_access_web_browsing Boolean Secure browser viaAkeyless's Secure Remote Access (SRA) (relevant only for aws or azure) [optional][default to false]
secure_access_web_proxy Boolean Web-Proxy via Akeyless's Secure Remote Access (SRA) (relevant only for aws or azure) [optional][default to false]
ssh_password String Deprecated: use RotatedPassword [optional]
ssh_username String Deprecated: use RotatedUser [optional]
storage_account_key_name String The name of the storage account key to rotate [key1/key2/kerb1/kerb2] [optional]
token String Authentication token (see `/auth` and `/configure`) [optional]
uid_token String The universal identity token, Required only for universal_identity authentication [optional]
user_attribute String LDAP User Attribute, Default value &quot;cn&quot; [optional][default to 'cn']
user_dn String LDAP User Base DN [optional]

Example

require 'akeyless'

instance = Akeyless::UpdateRotatedSecret.new(
  provider_type: null,
  add_tag: null,
  api_id: null,
  api_key: null,
  auto_rotate: null,
  aws_region: null,
  custom_payload: null,
  description: null,
  gcp_key: null,
  grace_rotation: null,
  host_provider: null,
  json: null,
  keep_prev_version: null,
  key: null,
  lock_during_sra_session: null,
  name: null,
  new_metadata: null,
  new_name: null,
  new_version: null,
  rm_tag: null,
  rotate_after_disconnect: null,
  rotated_password: null,
  rotated_username: null,
  rotation_hour: null,
  rotation_interval: null,
  rotator_creds_type: null,
  rotator_custom_cmd: null,
  same_password: null,
  secure_access_allow_external_user: null,
  secure_access_aws_account_id: null,
  secure_access_aws_native_cli: null,
  secure_access_bastion_issuer: null,
  secure_access_certificate_issuer: null,
  secure_access_db_name: null,
  secure_access_db_schema: null,
  secure_access_disable_concurrent_connections: null,
  secure_access_enable: null,
  secure_access_host: null,
  secure_access_rdp_domain: null,
  secure_access_rdp_user: null,
  secure_access_url: null,
  secure_access_web: null,
  secure_access_web_browsing: null,
  secure_access_web_proxy: null,
  ssh_password: null,
  ssh_username: null,
  storage_account_key_name: null,
  token: null,
  uid_token: null,
  user_attribute: null,
  user_dn: null
)