v1

latestOpenAPI 3.0.02026-07-246171,3332.1 MB
v2

post/rotated-secret-create-ldap

Request body

ProviderTypestring
authentication-credentialsstring

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

auto-rotatestring

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

delete_protectionstring

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

descriptionstring

Description of the object

host-providerstring

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

input-rulestring[]

Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input)

item-custom-fieldsobject

Additional custom fields to associate with the item

jsonboolean

Set output format to JSON

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

max-versionsstring

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

namestring required

Rotated secret name

output-rulestring[]

Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets)

password-lengthstring

The length of the password to be generated

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.

rotated-passwordstring

rotated-username password (relevant only for rotator-type=ldap)

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 (relevant only for rotator-type=ldap)

rotation-event-instring[]

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

rotation-hourinteger

The Hour of the rotation in UTC

rotation-intervalstring

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

rotator-typestring required

The rotator type. options: [target/ldap]

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

Enable/Disable secure remote access [true/false]

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

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

secure-access-urlstring

Destination URL to inject secrets

secure-access-webboolean

Enable Web Secure Remote Access

secure-access-web-browsingboolean

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

secure-access-web-proxyboolean

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

tagsstring[]

Add tags attached to this object

targetstring[]

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-namestring required

The target name to associate

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"

user-dnstring

Base DN to Perform User Search

Response

rotatedSecretCreateLdapResponse wraps response body.

namestring