AKakeyless
Dynamic Secrets

POST /gateway-update-producer-rdp

Changed on

Request

  • Base URL
    https://api.akeyless.io
  • URL
    https://api.akeyless.io/gateway-update-producer-rdp
  • Auth
    none declared

Request body

ProviderTypestring
allow-user-extend-sessioninteger

AllowUserExtendSession

ara-enabledboolean nullable

Enable or disable Agentic Runtime Authority rule enforcement for this item. Mirrors commands.AgenticRulesParams.AraEnabled.

block-parent-target-accessstring

Block access to the parent target when using a linked target [true/false]. Empty keeps the existing value on update

custom-username-templatestring

Customize how temporary usernames are generated using go template

delete_protectionstring

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

enable-agentic-runtime-authorityboolean nullable

EnableAra is the documented spelling of AraEnabled; --ara-enabled shipped first and stays as an undocumented alias.

enable-ai-quorumboolean nullable

Turns on AI Quorum checks for this item.

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]

host-providerstring

Host provider type [explicit/target], Default Host provider is explicit, Relevant only for SRA items.

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-enforce-hosts-restrictionboolean

Enforce connections only to allowed SRA hosts

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

skip-dry-runboolean nullable

If set, dry-run will be skipped [true/false]

tagsstring[]

Add tags attached to this object

targetstring[]

A list of targets to be associated with an SRA item, To specify multiple targets use argument multiple times

target-namestring

Target name

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

use-capital-lettersstring

Specifies whether the generated temporary password must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z). [true/false]

use-lower-lettersstring

Specifies whether the generated temporary password must contain at least one lowercase character from the ISO basic Latin alphabet (a to z). [true/false]

use-numbersstring

Specifies whether the generated temporary password must contain at least one numeric character (0 to 9). [true/false]

use-special-charactersstring
user-ttlstring

User TTL

warn-user-before-expirationinteger

WarnBeforeUserExpiration

Example request

{
  "use-special-characters": "! @ # $. [true/false]"
}

Response

gatewayUpdateProducerRdpResponse wraps response body.

Changes

  • 4e133adcd48aRevision changes
    • info

      api tag Dynamic Secrets added

    • info

      api tag v2 removed

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status