Skip to content

UpdateItem.md

Latest commit

 

History

History
124 lines (118 loc) · 8.42 KB

UpdateItem.md

File metadata and controls

124 lines (118 loc) · 8.42 KB

Akeyless::UpdateItem

Properties

Name Type Description Notes
provider_type String [optional]
accessibility String for personal password manager [optional][default to 'regular']
add_tag Array<String> List of the new tags that will be attached to this item [optional]
cert_file_data String PEM Certificate in a Base64 format. Used for updating RSA keys' certificates. [optional]
certificate_format String [optional]
change_event String Trigger an event when a secret value changed [true/false] (Relevant only for Static Secret) [optional]
delete_protection String Protection from accidental deletion of this object [true/false] [optional]
description String Description of the object [optional][default to 'default_metadata']
expiration_event_in Array<String> How many days before the expiration of the certificate would you like to be notified. [optional]
gcp_sm_regions String GCP Secret Manager regions to query for regional secrets (comma-separated, e.g., us-east1,us-west1). Max 12 regions. USC with GCP targets only. [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]
item_custom_fields Hash<String, String> Additional custom fields to associate with the item [optional]
json Boolean Set output format to JSON [optional][default to false]
lock_during_sra_session String Lock this secret for read/update while an SRA session is active [optional]
max_versions String Set the maximum number of versions, limited by the account settings defaults. [optional]
name String Current item name
new_metadata String Deprecated - use description [optional][default to 'default_metadata']
new_name String New item name [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]
secure_access_add_host Array<String> List of the new hosts that will be attached to SRA servers host [optional]
secure_access_allow_external_user String Allow providing external user for a domain users [true/false] [optional]
secure_access_allow_port_forwading Boolean Enable Port forwarding while using CLI access (relevant only for EKS/GKE/K8s Dynamic-Secret) [optional]
secure_access_api String Bastion's SSH control API endpoint. E.g. https://my.sra-server:9900 (relevant only for ssh cert issuer) [optional]
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 (relevant only for aws) [optional]
secure_access_aws_region String The AWS region (relevant only for aws) [optional]
secure_access_bastion_api String Deprecated. use secure-access-api [optional]
secure_access_bastion_issuer String Deprecated. use secure-access-certificate-issuer [optional]
secure_access_bastion_ssh String Deprecated. use secure-access-ssh [optional]
secure_access_certificate_issuer String Path to the SSH Certificate Issuer for your Akeyless Secure Access [optional]
secure_access_cluster_endpoint String The K8s cluster endpoint URL (relevant only for EKS/GKE/K8s Dynamic-Secret) [optional]
secure_access_dashboard_url String The K8s dashboard url (relevant only for k8s) [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 DB Dynamic-Secret) [optional]
secure_access_enable String Enable/Disable secure remote access [true/false] [optional]
secure_access_gateway String [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_rd_gateway_server String RD Gateway server (relevant only for rdp) [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 [optional]
secure_access_rm_host Array<String> List of the existent hosts that will be removed from SRA servers host [optional]
secure_access_ssh String Bastion's SSH server. E.g. my.sra-server:22 (relevant only for ssh cert issuer) [optional]
secure_access_ssh_creds String Secret values contains SSH Credentials, either Private Key or Password [password/private-key] (relevant only for Static-Secret or Rotated-secret) [optional]
secure_access_ssh_creds_user String SSH username to connect to target server, must be in 'Allowed Users' list (relevant only for ssh cert issuer) [optional]
secure_access_url String Destination URL to inject secrets [optional]
secure_access_use_internal_bastion Boolean Deprecated. Use secure-access-use-internal-ssh-access [optional]
secure_access_use_internal_ssh_access Boolean Use internal SSH Access [optional]
secure_access_web_browsing Boolean Secure browser via Akeyless's Secure Remote Access (SRA) [optional][default to false]
secure_access_web_proxy Boolean Web-Proxy via Akeyless's Secure Remote Access (SRA) [optional][default to false]
token String Authentication token (see `/auth` and `/configure`) [optional]
uid_token String The universal identity token, Required only for universal_identity authentication [optional]
usc_tags String Comma-separated list of tags to apply to all secrets created/synced on the remote USC USC items only. [optional]
use_tags_as_filter String Whether to filter the USC secret list using the specified usc-tags [true/false] USC items only. [optional]

Example

require 'akeyless'

instance = Akeyless::UpdateItem.new(
  provider_type: null,
  accessibility: null,
  add_tag: null,
  cert_file_data: null,
  certificate_format: null,
  change_event: null,
  delete_protection: null,
  description: null,
  expiration_event_in: null,
  gcp_sm_regions: null,
  host_provider: null,
  item_custom_fields: null,
  json: null,
  lock_during_sra_session: null,
  max_versions: null,
  name: null,
  new_metadata: null,
  new_name: null,
  rm_tag: null,
  rotate_after_disconnect: null,
  secure_access_add_host: null,
  secure_access_allow_external_user: null,
  secure_access_allow_port_forwading: null,
  secure_access_api: null,
  secure_access_aws_account_id: null,
  secure_access_aws_native_cli: null,
  secure_access_aws_region: null,
  secure_access_bastion_api: null,
  secure_access_bastion_issuer: null,
  secure_access_bastion_ssh: null,
  secure_access_certificate_issuer: null,
  secure_access_cluster_endpoint: null,
  secure_access_dashboard_url: null,
  secure_access_db_name: null,
  secure_access_db_schema: null,
  secure_access_enable: null,
  secure_access_gateway: null,
  secure_access_host: null,
  secure_access_rd_gateway_server: null,
  secure_access_rdp_domain: null,
  secure_access_rdp_user: null,
  secure_access_rm_host: null,
  secure_access_ssh: null,
  secure_access_ssh_creds: null,
  secure_access_ssh_creds_user: null,
  secure_access_url: null,
  secure_access_use_internal_bastion: null,
  secure_access_use_internal_ssh_access: null,
  secure_access_web_browsing: null,
  secure_access_web_proxy: null,
  token: null,
  uid_token: null,
  usc_tags: null,
  use_tags_as_filter: null
)