v1

latestOpenAPI 3.0.02026-07-246171,3332.1 MB
v2

post/gateway-update-producer-ldap

Request body

ProviderTypestring
bind-dnstring

Bind DN

bind-dn-passwordstring

Bind DN Password

custom-username-templatestring

Customize how temporary usernames are generated using go template

delete_protectionstring

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

external-usernamestring

Externally provided username [true/false]

fixed-user-claim-keynamestring

For externally provided users, denotes the key-name of IdP claim to extract the username from (relevant only for external-username=true)

group-dnstring

Group DN which the temporary user should be added

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) Mirrors commands.AgenticRulesParams — kept separate because ResourceDS cannot embed it (different package, different struct layout).

item-custom-fieldsobject

Additional custom fields to associate with the item

jsonboolean

Set output format to JSON

ldap-ca-certstring

CA Certificate File Content

ldap-urlstring

LDAP Server URL

namestring required

Dynamic secret name

new-namestring

Dynamic 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

producer-encryption-key-namestring

Dynamic producer encryption key

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

The delay duration, in seconds, to wait after generating just-in-time credentials. Accepted range: 0-120 seconds

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-rd-gateway-serverstring

RD Gateway server

secure-access-rdp-domainstring

Required when the Dynamic Secret is used for a domain user

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

Target name

tokenstring

Authentication token (see /auth and /configure)

token-expirationstring

Token expiration

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

user-attributestring

User Attribute

user-dnstring

User DN

user-ttlstring

User TTL

Response

gatewayUpdateProducerLdapResponse wraps response body.