CreateSecret.md

Akeyless::CreateSecret

Properties

Name	Type	Description	Notes
accessibility	String	for personal password manager	[optional][default to 'regular']
change_event	String	Trigger an event when a secret value changed [true/false] (Relevant only for Static Secret)	[optional]
custom_field	Hash<String, String>	For Password Management use, additional fields	[optional]
delete_protection	String	Protection from accidental deletion of this object [true/false]	[optional]
description	String	Description of the object	[optional]
format	String	Secret format [text/json/key-value] (relevant only for type 'generic')	[optional][default to 'text']
inject_url	Array<String>	For Password Management use, reflect the website context	[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]
metadata	String	Deprecated - use description	[optional]
multiline_value	Boolean	The provided value is a multiline value (separated by '\n')	[optional]
name	String	Secret name
password	String	For Password Management use, additional fields	[optional]
protection_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]
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_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_rdp_user	String	Remote Desktop Username	[optional]
secure_access_ssh_creds	String	Static-Secret values contains SSH Credentials, either Private Key or Password [password/private-key]	[optional]
secure_access_ssh_user	String	Override the SSH username as indicated in SSH Certificate Issuer	[optional]
secure_access_url	String	Destination URL to inject secrets	[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]
tags	Array<String>	Add tags attached to this object	[optional]
token	String	Authentication token (see `/auth` and `/configure`)	[optional]
type	String	The secret sub type [generic/password]	[optional][default to 'generic']
uid_token	String	The universal identity token, Required only for universal_identity authentication	[optional]
username	String	For Password Management use	[optional]
value	String	The secret value (relevant only for type 'generic')

Example

require 'akeyless'

instance = Akeyless::CreateSecret.new(
  accessibility: null,
  change_event: null,
  custom_field: null,
  delete_protection: null,
  description: null,
  format: null,
  inject_url: null,
  item_custom_fields: null,
  json: null,
  lock_during_sra_session: null,
  max_versions: null,
  metadata: null,
  multiline_value: null,
  name: null,
  password: null,
  protection_key: null,
  secure_access_bastion_issuer: null,
  secure_access_certificate_issuer: null,
  secure_access_enable: null,
  secure_access_gateway: null,
  secure_access_host: null,
  secure_access_rdp_user: null,
  secure_access_ssh_creds: null,
  secure_access_ssh_user: null,
  secure_access_url: null,
  secure_access_web_browsing: null,
  secure_access_web_proxy: null,
  tags: null,
  token: null,
  type: null,
  uid_token: null,
  username: null,
  value: null
)