v1
latestOpenAPI 3.0.02026-07-246171,3332.1 MBRequest body
API ID to rotate (relevant only for rotator-type=api-key)
API key to rotate (relevant only for rotator-type=api-key)
ApplicationId (used in azure)
The credentials to connect with use-user-creds/use-target-creds
Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false]
Aws Region (relevant only for aws)
Secret payload to be sent with rotation request (relevant only for rotator-type=custom)
Protection from accidental deletion of this object [true/false]
Description of the object
Base64-encoded service account private key text
The email of the gcp service account to rotate
The key id of the gcp service account to rotate
Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false]
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
Set output format to JSON
The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
Lock this secret for read/update while an SRA session is active
Deprecated - use description
Secret name
The length of the password to be generated
StringOrBool accepts JSON strings, booleans, and numbers for backward compatibility with older SDK versions that send boolean values for rotate-after-disconnect.
rotated-username password (relevant only for rotator-type=password)
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)
The Hour of the rotation in UTC. Default rotation-hour is 14:00
The number of days to wait between every automatic key rotation (1-365)
Custom rotation command (relevant only for ssh target)
Rotator Type
Rotate same password for each host from the Linked Target (relevant only for Linked Target)
Allow providing external user for a domain users (relevant only for rdp)
The AWS account id (relevant only for aws)
The AWS native cli
Deprecated. use secure-access-certificate-issuer
Path to the SSH Certificate Issuer for your Akeyless Secure Access
The DB name (relevant only for DB Dynamic-Secret)
The db schema (relevant only for mssql or postgresql)
Enable this flag to prevent simultaneous use of the same secret
Enable/Disable secure remote access [true/false]
Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
Required when the Dynamic Secret is used for a domain user (relevant only for RDP Dynamic-Secret)
Override the RDP Domain username (relevant only for rdp)
Destination URL to inject secrets
Enable Web Secure Remote Access
Secure browser viaAkeyless's Secure Remote Access (SRA) (relevant only for aws or azure)
Web-Proxy via Akeyless's Secure Remote Access (SRA) (relevant only for aws or azure)
Deprecated: use RotatedPassword
Deprecated: use RotatedUser
The name of the storage account key to rotate [key1/key2/kerb1/kerb2] (relevat to azure-storage-account)
Add tags attached to this object
A list of linked targets to be associated, Relevant only for Secure Remote Access for ssh cert issuer, ldap rotated secret and ldap dynamic secret, To specify multiple targets use argument multiple times
Target name
Authentication token (see /auth and /configure)
The universal identity token, Required only for universal_identity authentication
LDAP User Attribute, Default value "cn"
LDAP User Base DN
Response
createRotatedSecretResponse wraps response body.