add-tagstring[]
List of the new tags that will be attached to this item
auto-rotatestring
Whether to automatically rotate every --rotation-interval days, or
disable existing automatic rotation [true/false]
aws-regionstring
Aws Region (relevant only for aws)
custom-payloadstring
Secret payload to be sent with rotation request (relevant only for rotator-type=custom)
descriptionstring
Description of the object
gcp-keystring
Base64-encoded service account private key text
grace-rotationstring
Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false]
host-providerstring
Host provider type [explicit/target], Default Host provider is explicit, Relevant only for SRA items.
jsonboolean
Set output format to JSON
keep-prev-versionstring
Whether to keep previous version [true/false]. If not set, use default according to account settings
keystring
The name of a key that used to encrypt the secret value (if empty, the
account default protectionKey key will be used)
lock-during-sra-sessionstring
Lock this secret for read/update while an SRA session is active
lock-on-readstring
Lock this secret after each successful value read
new-metadatastring
Deprecated - use description
rm-tagstring[]
List of the existent tags that will be removed from this item
rotate-after-disconnectstring
StringOrBool accepts JSON strings, booleans, and numbers for backward
compatibility with older SDK versions that send boolean values for
rotate-after-disconnect.
rotate-on-unlockstring
Rotate this secret after it is unlocked
rotated-passwordstring
rotated-username password
rotated-usernamestring
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
rotation-hourinteger
The Hour of the rotation in UTC
rotation-intervalstring
The number of days to wait between every automatic key rotation (7-365)
rotator-creds-typestring
The credentials to connect with use-self-creds/use-target-creds
rotator-custom-cmdstring
"Custom rotation command (relevant only for ssh target)
same-passwordstring
Rotate same password for each host from the Linked Target (relevant only for Linked Target)
secure-access-allow-external-userstring
Allow providing external user for a domain users [true/false]
secure-access-allow-port-forwadingboolean nullable
Deprecated: old misspelled param, kept for backwards-compatibility.
Hidden from help; use secure-access-allow-port-forwarding instead.
secure-access-allow-port-forwardingboolean nullable
Enable Port forwarding while using CLI access (relevant only for EKS/GKE/K8s Dynamic-Secret)
secure-access-aws-account-idstring
The AWS account id (relevant only for aws)
secure-access-aws-native-cliboolean nullable
The AWS native cli (relevant only for aws)
secure-access-bastion-issuerstring
Deprecated. use secure-access-certificate-issuer
secure-access-certificate-issuerstring
Path to the SSH Certificate Issuer for your Akeyless Secure Access
secure-access-db-namestring
The DB name (relevant only for DB Dynamic-Secret)
secure-access-db-schemastring
The db schema (relevant only for mssql or postgresql)
secure-access-disable-concurrent-connectionsboolean
Enable this flag to prevent simultaneous use of the same secret
secure-access-enablestring
Enable/Disable secure remote access [true/false]
secure-access-enforce-hosts-restrictionboolean nullable
Enforce connections only to allowed SRA hosts
secure-access-hoststring[]
Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
secure-access-rdp-domainstring
Required when the Dynamic Secret is used for a domain user (relevant only for RDP Dynamic-Secret)
secure-access-rdp-userstring
Override the RDP Domain username (relevant only for rdp)
secure-access-urlstring
Destination URL to inject secrets
secure-access-use-internal-bastionboolean nullable
Deprecated. Use secure-access-use-internal-ssh-access
secure-access-use-internal-ssh-accessboolean nullable
secure-access-webboolean
Enable Web Secure Remote Access
secure-access-web-browsingboolean nullable
Secure browser via Akeyless's Secure Remote Access (SRA)
secure-access-web-proxyboolean nullable
Web-Proxy via Akeyless's Secure Remote Access (SRA)
ssh-passwordstring
Deprecated: use RotatedPassword
ssh-usernamestring
Deprecated: use RotatedUser
storage-account-key-namestring
The name of the storage account key to rotate [key1/key2/kerb1/kerb2]
targetstring[]
A list of targets to be associated with an SRA item, To specify multiple targets use argument multiple times
tokenstring
Authentication token (see /auth and /configure)
uid-tokenstring
The universal identity token, Required only for universal_identity authentication
user-attributestring
LDAP User Attribute, Default value "cn"