API Reference

/dynamic-secret-create-rdp

post
https://api.akeyless.io/dynamic-secret-create-rdp
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

dynamicSecretCreateRdp is a command that creates rdp dynamic secret

string
int64

AllowUserExtendSession

boolean

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

string

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

string

Customize how temporary usernames are generated using go template

string

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

string

Description of the object

boolean

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

boolean

Turns on AI Quorum checks for this item.

string
Defaults to ext_username

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

string
Defaults to false

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

string

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

input-rule
array of strings

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).

input-rule
item-custom-fields
object

Additional custom fields to associate with the item

boolean
Defaults to false

Set output format to JSON

string
required

Dynamic secret name

output-rule
array of strings

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

output-rule
string

The length of the password to be generated

string

Dynamic producer encryption key

string

RDP Admin Name

string

RDP Admin password

string

Hostname

string
Defaults to 22

Port

string

Groups

boolean
Defaults to false

Allow providing external user for a domain users

string

Deprecated. use secure-access-certificate-issuer

string

Path to the SSH Certificate Issuer for your Akeyless Secure Access

int64

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

string

Enable/Disable secure remote access [true/false]

boolean

Enforce connections only to allowed SRA hosts

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
string

RD Gateway server

string

Required when the Dynamic Secret is used for a domain user

string

Override the RDP Domain username

string

If set, dry-run will be skipped

tags
array of strings

Add tags attached to this object

tags
target
array of strings

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

target
string

Target name

string

Authentication token (see /auth and /configure)

string

The universal identity token, Required only for universal_identity authentication

string

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

string

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

string

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

string
string
Defaults to 60m

User TTL

int64

WarnBeforeUserExpiration

Responses

Updated 4 days ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 days ago

Did this page help you?
Footer Section