v1

latestOpenAPI 3.0.02026-07-246171,3332.1 MB
v2

post/gateway-update-producer-rdp

Request body

allow-user-extend-sessioninteger

AllowUserExtendSession

custom-username-templatestring

Customize how temporary usernames are generated using go template

delete_protectionstring

Protection from accidental deletion of this object [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 fixed-user-only=true)

fixed-user-onlystring

Allow access using externally (IdP) provided username [true/false]

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

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

rdp-admin-namestring

RDP Admin Name

rdp-admin-pwdstring

RDP Admin password

rdp-host-namestring

Hostname

rdp-host-portstring

Port

rdp-user-groupsstring

Groups

secure-access-allow-external-userboolean

Allow providing external user for a domain users

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

secure-access-rdp-userstring

Override the RDP Domain username

tagsstring[]

Add tags attached to this object

target-namestring

Target name

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

user-ttlstring

User TTL

warn-user-before-expirationinteger

WarnBeforeUserExpiration

Response

gatewayUpdateProducerRdpResponse wraps response body.