RotatedSecretUpdateSsh.md

akeyless.Model.RotatedSecretUpdateSsh

Properties

Name	Type	Description	Notes
ProviderType	string		[optional]
AddTag	List<string>	List of the new tags that will be attached to this item	[optional]
AraEnabled	bool	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]
AuthenticationCredentials	string	The credentials to connect with use-user-creds/use-target-creds	[optional] [default to "use-user-creds"]
AutoRotate	string		[optional]
DeleteProtection	string	Protection from accidental deletion of this object [true/false]	[optional]
Description	string	Description of the object	[optional] [default to "default_metadata"]
EnableAgenticRuntimeAuthority	bool	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]
EnableAiQuorum	bool	Turns on AI Quorum checks for this item.	[optional]
HostProvider	string	Host provider type [explicit/target], Default Host provider is explicit, Relevant only for SRA items.	[optional]
InputRule	List<string>	Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input)	[optional]
ItemCustomFields	Dictionary<string, string>	Additional custom fields to associate with the item	[optional]
Json	bool	Set output format to JSON	[optional] [default to false]
KeepPrevVersion	string	Whether to keep previous version [true/false]. If not set, use default according to account settings	[optional]
Key	string		[optional]
KeyAlgorithm	string	The key algorithm to generate with when no private key is supplied, leave empty to keep the current algorithm. options: [ED25519/RSA2048/RSA3072/RSA4096/ECDSA256/ECDSA384/ECDSA521]	[optional]
KeyDataBase64	string	Private key file contents encoded using base64	[optional]
LockDuringSraSession	string	Lock this secret for read/update while an SRA session is active	[optional]
LockOnRead	string	Lock this secret after each successful value read	[optional]
LockTtl	string	Lock TTL in minutes	[optional]
MaxVersions	string	Set the maximum number of versions, limited by the account settings defaults.	[optional]
Name	string	Rotated secret name
NewName	string	New item name	[optional]
OutputRule	List<string>	Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets)	[optional]
PasswordLength	string	The length of the password to be generated	[optional]
PublicKeyRemotePath	string	The path to the public key that will be rotated on the server	[optional]
RmTag	List<string>	List of the existent tags that will be removed from this item	[optional]
RotateAfterDisconnect	string	StringOrBool accepts JSON strings, booleans, and numbers for backward compatibility with older SDK versions that send boolean values for rotate-after-disconnect.	[optional]
RotateOnUnlock	string	Rotate this secret after it is unlocked	[optional]
RotatedPassword	string	rotated-username password (relevant only for rotator-type=password)	[optional]
RotatedUsername	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]
RotationEventIn	List<string>	How many days before the rotation of the item would you like to be notified	[optional]
RotationHour	int		[optional]
RotationInterval	string		[optional]
RotatorCustomCmd	string	Custom rotation command	[optional]
RotatorType	string	The rotator type. options: [target/password/key]
SamePassword	string	Rotate same password for each host from the Linked Target (relevant only for Linked Target)	[optional]
SecureAccessAllowExternalUser	bool	Allow providing external user for a domain users	[optional] [default to false]
SecureAccessBastionIssuer	string	Deprecated. use secure-access-certificate-issuer	[optional]
SecureAccessCertificateIssuer	string	Path to the SSH Certificate Issuer for your Akeyless Secure Access	[optional]
SecureAccessEnable	string	Enable/Disable secure remote access [true/false]	[optional]
SecureAccessEnforceHostsRestriction	bool	Enforce connections only to allowed SRA hosts	[optional]
SecureAccessHost	List<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]
SecureAccessRdpDomain	string	Default domain name server. i.e. microsoft.com	[optional]
SecureAccessRdpUser	string	Override the RDP Domain username	[optional]
SecureAccessSshCreds	string	Secret values contains SSH Credentials, either Private Key or Password [password/private-key] (relevant only for Static-Secret or Rotated-secret)	[optional]
SecureAccessSshUser	string	Override the SSH username as indicated in SSH Certificate Issuer	[optional]
SecureAccessTargetType	string	Specify target type. Options are ssh or rdp	[optional] [default to "false"]
SecureAccessUrl	string	Destination URL to inject secrets	[optional]
SecureAccessWeb	bool	Enable Web Secure Remote Access	[optional] [default to true]
SecureAccessWebBrowsing	bool	Secure browser via Akeyless's Secure Remote Access (SRA)	[optional] [default to false]
SecureAccessWebProxy	bool	Web-Proxy via Akeyless's Secure Remote Access (SRA)	[optional] [default to false]
SkipDryRun	bool	If set, dry-run will be skipped [true/false]	[optional]
Target	List<string>	A list of targets to be associated with an SRA item, To specify multiple targets use argument multiple times	[optional]
Token	string	Authentication token (see `/auth` and `/configure`)	[optional]
UidToken	string	The universal identity token, Required only for universal_identity authentication	[optional]
UseCapitalLetters	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]
UseLowerLetters	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]
UseNumbers	string	Specifies whether the generated temporary password must contain at least one numeric character (0 to 9). [true/false]	[optional]
UseSpecialCharacters	string		[optional]

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