Skip to content

Latest commit

 

History

History
60 lines (56 loc) · 6.08 KB

File metadata and controls

60 lines (56 loc) · 6.08 KB

UpdateItem

Properties

Name Type Description Notes
provider_type str [optional]
accessibility str for personal password manager [optional] [default to 'regular']
add_tag list[str] List of the new tags that will be attached to this item [optional]
cert_file_data str PEM Certificate in a Base64 format. Used for updating RSA keys' certificates. [optional]
certificate_format str [optional]
change_event str Trigger an event when a secret value changed [true/false] (Relevant only for Static Secret) [optional]
delete_protection str Protection from accidental deletion of this object [true/false] [optional]
description str Description of the object [optional] [default to 'default_metadata']
expiration_event_in list[str] How many days before the expiration of the certificate would you like to be notified. [optional]
gcp_sm_regions str 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 str 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 dict(str, str) Additional custom fields to associate with the item [optional]
json bool Set output format to JSON [optional] [default to False]
max_versions str Set the maximum number of versions, limited by the account settings defaults. [optional]
name str Current item name
new_metadata str Deprecated - use description [optional] [default to 'default_metadata']
new_name str New item name [optional]
rm_tag list[str] List of the existent tags that will be removed from this item [optional]
rotate_after_disconnect str Rotate the value of the secret after SRA session ends [true/false] [optional] [default to 'false']
secure_access_add_host list[str] List of the new hosts that will be attached to SRA servers host [optional]
secure_access_allow_external_user str Allow providing external user for a domain users [true/false] [optional]
secure_access_allow_port_forwading bool Enable Port forwarding while using CLI access (relevant only for EKS/GKE/K8s Dynamic-Secret) [optional]
secure_access_api str 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 str The AWS account id (relevant only for aws) [optional]
secure_access_aws_native_cli bool The AWS native cli (relevant only for aws) [optional]
secure_access_aws_region str The AWS region (relevant only for aws) [optional]
secure_access_bastion_api str Deprecated. use secure-access-api [optional]
secure_access_bastion_issuer str Deprecated. use secure-access-certificate-issuer [optional]
secure_access_bastion_ssh str Deprecated. use secure-access-ssh [optional]
secure_access_certificate_issuer str Path to the SSH Certificate Issuer for your Akeyless Secure Access [optional]
secure_access_cluster_endpoint str The K8s cluster endpoint URL (relevant only for EKS/GKE/K8s Dynamic-Secret) [optional]
secure_access_dashboard_url str The K8s dashboard url (relevant only for k8s) [optional]
secure_access_db_name str The DB name (relevant only for DB Dynamic-Secret) [optional]
secure_access_db_schema str The DB schema (relevant only for DB Dynamic-Secret) [optional]
secure_access_enable str Enable/Disable secure remote access [true/false] [optional]
secure_access_gateway str [optional]
secure_access_host list[str] 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 str RD Gateway server (relevant only for rdp) [optional]
secure_access_rdp_domain str Required when the Dynamic Secret is used for a domain user (relevant only for RDP Dynamic-Secret) [optional]
secure_access_rdp_user str Override the RDP Domain username [optional]
secure_access_rm_host list[str] List of the existent hosts that will be removed from SRA servers host [optional]
secure_access_ssh str Bastion's SSH server. E.g. my.sra-server:22 (relevant only for ssh cert issuer) [optional]
secure_access_ssh_creds str 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 str SSH username to connect to target server, must be in 'Allowed Users' list (relevant only for ssh cert issuer) [optional]
secure_access_url str Destination URL to inject secrets [optional]
secure_access_use_internal_bastion bool Deprecated. Use secure-access-use-internal-ssh-access [optional]
secure_access_use_internal_ssh_access bool Use internal SSH Access [optional]
secure_access_web_browsing bool Secure browser via Akeyless's Secure Remote Access (SRA) [optional] [default to False]
secure_access_web_proxy bool Web-Proxy via Akeyless's Secure Remote Access (SRA) [optional] [default to False]
token str Authentication token (see `/auth` and `/configure`) [optional]
uid_token str The universal identity token, Required only for universal_identity authentication [optional]

[Back to Model list] [Back to API list] [Back to README]