/rotated-secret-update-custom

post

https://api.akeyless.io/rotated-secret-update-custom

Body Params

add-tag

array of strings

List of the new tags that will be attached to this item

add-tag

authentication-credentials

string

Defaults to use-user-creds

The credentials to connect with use-user-creds/use-target-creds

auto-rotate

string

Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false]

custom-payload

string

Secret payload to be sent with rotation request

delete_protection

string

Protection from accidental deletion of this object [true/false]

description

string

Defaults to default_metadata

Description of the object

enable-password-policy

string

Enable password policy

item-custom-fields

object

Additional custom fields to associate with the item

json

boolean

Defaults to false

Set output format to JSON

keep-prev-version

string

Whether to keep previous version [true/false]. If not set, use default according to account settings

key

string

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-session

string

Lock this secret for read/update while an SRA session is active

max-versions

string

Set the maximum number of versions, limited by the account settings defaults.

name

string

required

Rotated secret name

new-name

string

New item name

password-length

string

The length of the password to be generated

rm-tag

array of strings

List of the existent tags that will be removed from this item

rm-tag

rotate-after-disconnect

string

StringOrBool accepts JSON strings, booleans, and numbers for backward compatibility with older SDK versions that send boolean values for rotate-after-disconnect.

rotation-event-in

array of strings

How many days before the rotation of the item would you like to be notified

rotation-event-in

rotation-hour

int32

The Hour of the rotation in UTC

rotation-interval

string

The number of days to wait between every automatic key rotation (1-365)

secure-access-allow-external-user

boolean

Defaults to false

Allow providing external user for a domain users

secure-access-bastion-issuer

string

Deprecated. use secure-access-certificate-issuer

secure-access-certificate-issuer

string

Path to the SSH Certificate Issuer for your Akeyless Secure Access

secure-access-enable

string

Enable/Disable secure remote access [true/false]

secure-access-host

array of strings

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-host

secure-access-rdp-domain

string

Default domain name server. i.e. microsoft.com

secure-access-rdp-user

string

Override the RDP Domain username

secure-access-ssh-user

string

Override the SSH username as indicated in SSH Certificate Issuer

secure-access-url

string

Destination URL to inject secrets

secure-access-web

boolean

Defaults to false

Enable Web Secure Remote Access

secure-access-web-browsing

boolean

Defaults to false

Secure browser via Akeyless's Secure Remote Access (SRA)

secure-access-web-proxy

boolean

Defaults to false

Web-Proxy via Akeyless's Secure Remote Access (SRA)

timeout-sec

int64

Maximum allowed time in seconds for the custom rotator to return the results

token

string

Authentication token (see /auth and /configure)

uid-token

string

The universal identity token, Required only for universal_identity authentication

use-capital-letters

string

Password must contain capital letters [true/false]

use-lower-letters

string

Password must contain lower case letters [true/false]

use-numbers

string

Password must contain numbers [true/false]

use-special-characters

string

Password must contain special characters [true/false]

Responses

201rotatedSecretUpdateCustomResponse wraps response body.

defaulterrorResponse wraps any error to return it as a JSON object with one "error" field.