Skip to content

Latest commit

 

History

History
59 lines (55 loc) · 5.89 KB

UpdateRotatedSecret.md

File metadata and controls

59 lines (55 loc) · 5.89 KB

akeyless.Model.UpdateRotatedSecret

updateRotatedSecret is a command that updates rotated secret. [Deprecated: Use rotated-secret update commands]

Properties

Name Type Description Notes
ProviderType string [optional]
AddTag List<string> List of the new tags that will be attached to this item [optional]
ApiId string API ID to rotate [optional]
ApiKey string API key to rotate [optional]
AutoRotate string Whether to automatically rotate every - -rotation-interval days, or disable existing automatic rotation [true/false] [optional]
AwsRegion string Aws Region (relevant only for aws) [optional] [default to "us-east-2"]
CustomPayload string Secret payload to be sent with rotation request (relevant only for rotator-type=custom) [optional]
Description string Description of the object [optional] [default to "default_metadata"]
GcpKey string Base64-encoded service account private key text [optional]
GraceRotation string Create a new access key without deleting the old key from AWS for backup (relevant only for AWS) [true/false] [optional]
HostProvider string 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]
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 The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used) [optional]
Name string Secret name
NewMetadata string Deprecated - use description [optional] [default to "default_metadata"]
NewName string New item name [optional]
NewVersion bool Deprecated [optional]
RmTag List<string> List of the existent tags that will be removed from this item [optional]
RotateAfterDisconnect string Rotate the value of the secret after SRA session ends [true/false] [optional] [default to "false"]
RotatedPassword string rotated-username 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 [optional]
RotationHour int The Hour of the rotation in UTC [optional]
RotationInterval string The number of days to wait between every automatic key rotation (7-365) [optional]
RotatorCredsType string The credentials to connect with use-self-creds/use-target-creds [optional] [default to "use-self-creds"]
RotatorCustomCmd string &quot;Custom rotation command (relevant only for ssh target) [optional]
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 (relevant only for rdp) [optional] [default to false]
SecureAccessAwsAccountId string The AWS account id (relevant only for aws) [optional]
SecureAccessAwsNativeCli bool The AWS native cli [optional]
SecureAccessBastionIssuer string Path to the SSH Certificate Issuer for your Akeyless Bastion [optional]
SecureAccessDbName string The DB name (relevant only for DB Dynamic-Secret) [optional]
SecureAccessDbSchema string The db schema (relevant only for mssql or postgresql) [optional]
SecureAccessDisableConcurrentConnections bool Enable this flag to prevent simultaneous use of the same secret [optional]
SecureAccessEnable string Enable/Disable secure remote access [true/false] [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 Required when the Dynamic Secret is used for a domain user (relevant only for RDP Dynamic-Secret) [optional]
SecureAccessRdpUser string Override the RDP Domain username (relevant only for rdp) [optional]
SecureAccessUrl string Destination URL to inject secrets [optional]
SecureAccessWeb bool Enable Web Secure Remote Access [optional] [default to false]
SecureAccessWebBrowsing bool Secure browser via Akeyless Web Access Bastion (relevant only for aws or azure) [optional] [default to false]
SecureAccessWebProxy bool Web-Proxy via Akeyless Web Access Bastion (relevant only for aws or azure) [optional] [default to false]
SshPassword string Deprecated: use RotatedPassword [optional]
SshUsername string Deprecated: use RotatedUser [optional]
StorageAccountKeyName string The name of the storage account key to rotate [key1/key2/kerb1/kerb2] [optional]
Token string Authentication token (see `/auth` and `/configure`) [optional]
UidToken string The universal identity token, Required only for universal_identity authentication [optional]
UserAttribute string LDAP User Attribute, Default value &quot;cn&quot; [optional] [default to "cn"]
UserDn string LDAP User Base DN [optional]

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