Create Managed Account in Managed System

post

https://example.com/beyondtrust/api/public/v3/managedsystems/{managedSystemID}/managedaccounts

Required Permission(s)

Password Safe Account Management (Full control)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

managedSystemID

int32

required

ID of the Managed System

Query Params

version

string

Defaults to 3.0

Request body version:

: Base properties
: Adds UseOwnCredentials
: Adds ChangeIISAppPoolFlag, RestartIISAppPoolFlag
:
Adds WorkgroupID
: Adds ChangeWindowsAutoLogonFlag, ChangeComPlusFlag, ChangeDComFlag, ChangeSComFlag
: Adds ObjectID

Body Params

Managed Account details

Managed Account (Create/Update)

Password

string | null

Account password (required if )

PrivateKey

string | null

DSS private key. Can be set if .

If and no is provided, immediately attempts to generate and set a new public key on the server.

Passphrase

string | null

DSS passphrase. Can be set if . Required when is an encrypted DSS key.

AccountName

string | null

Name of the account

DistinguishedName

string | null

Distinguished name of an LDAP account

UserPrincipalName

string | null

(Active Directory Managed Systems only) User Principal Name of an Active Directory account

SAMAccountName

string | null

(Active Directory Managed Systems only) SAM account name of an Active Directory account

PasswordFallbackFlag

boolean

Defaults to false

True if failed DSS authentication can fall back to password authentication, otherwise false

LoginAccountFlag

boolean

True if the account should use the Managed System login account for SSH sessions, otherwise false

Description

string | null

Description of the account

ApiEnabled

boolean

Defaults to false

True if the account can be requested through the API, otherwise false

PasswordRuleID

int32

Defaults to 0

ID of the assigned Password Rule

ReleaseNotificationEmail

string | null

Email address used for notification emails related to this account

ChangeServicesFlag

boolean

Defaults to false

True if services run as this user should be updated with the new password after a password change, otherwise false

ChangeTasksFlag

boolean

Defaults to false

True if scheduled tasks run as this user should be updated with the new password after a password change, otherwise false

RestartServicesFlag

boolean

Defaults to false

True if services should be restarted after the run as password is changed (see: ), otherwise false

AutoManagementFlag

boolean

Defaults to false

True if password auto-management is enabled, otherwise false

DSSAutoManagementFlag

boolean

Defaults to false

True if DSS key auto-management is enabled, otherwise false. Can be set if .

CheckPasswordFlag

boolean

Defaults to false

True to enable password testing, otherwise false

ChangePasswordAfterAnyReleaseFlag

boolean

Defaults to false

True to change passwords on release of a request, otherwise false

ResetPasswordOnMismatchFlag

boolean

Defaults to false

True to queue a password change when scheduled password test fails, otherwise false

ReleaseDuration

int32

Defaults to 120

(minutes: 1-525600) Default release duration

MaxReleaseDuration

int32

Defaults to 525600

(minutes: 1-525600) Default maximum release duration

ISAReleaseDuration

int32

Defaults to 120

(minutes: 1-525600) Default Information Systems Administrator (ISA) release duration

ChangeFrequencyType

string | null

Defaults to first

Change frequency for scheduled password changes:

: Changes scheduled for the first day of the month
: Changes scheduled for the last day of the month
: Changes scheduled every x days (see: )

ChangeFrequencyDays

int32

(days: 1-999) When is , password changes occur every N days as configured by this property

ChangeTime

string | null

Defaults to 23:30

(24hr: 00:00-23:59) UTC time of day scheduled password changes take place

MaxConcurrentRequests

int32

Defaults to 1

(0-999) (0 is Unlimited) Maximum number of concurrent password requests for this account

NextChangeDate

date-time | null

Date and time of the next scheduled password change

UseOwnCredentials

boolean

True if the current account credentials should be used during change operations, otherwise false

ChangeIISAppPoolFlag

boolean

True if IIS Application Pools run as this user should be updated with the new password after a password change, otherwise false

RestartIISAppPoolFlag

boolean

True if IIS Application Pools should be restarted after the run as password is changed (see: ), otherwise false

WorkgroupID

int32 | null

ID of the assigned Workgroup

ChangeWindowsAutoLogonFlag

boolean

Defaults to false

True if Windows Auto Logon should be updated with the new password after a password change, otherwise false

ChangeComPlusFlag

boolean

Defaults to false

True if COM+ Apps should be updated with the new password after a password change, otherwise false

ChangeDComFlag

boolean

Defaults to false

True if DCOM Apps should be updated with the new password after a password change, otherwise false

ChangeSComFlag

boolean

Defaults to false

True if SCOM Identities should be updated with the new password after a password change, otherwise false

ObjectID

string | null

ObjectID of the account (if applicable). Required when .

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Request successful

400Validation failure

401Unauthorized

403Access forbidden

404Entity not found