DocumentationAPI ReferenceRelease Notes
API Reference

Update directory by ID

put
https://example.com/beyondtrust/api/public/v3/directories/

Updates an existing directory by ID.

Required Permission(s)

Any of the following:

  • Password Safe System Management (Full control)
  • Password Safe Domain Management (Full control)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Unique identifier of the directory service to update

Body Params

Updated directory including modified connection and authentication settings

string | null

Name of the domain

string | null

(Required for Active Directory only, not applicable to LDAP) Name of the directory forest

string | null

(Required for Active Directory, optional for LDAP) NetBIOS Name of the directory

boolean
Defaults to false

True to use an SSL connection, otherwise false

int32

(Required) ID of the platform

int32

(Required) ID of the Workgroup

int32 | null

(Set automatically for Active Directory, optional for LDAP) The port used to connect to the host. If null and the related Platform is LDAP, Password Safe uses Platform.DefaultPort

int32
Defaults to 30

Connection timeout (Seconds). Length of time in seconds before a slow or unresponsive connection to the system fails

string | null

(Optional) Description of the directory

string | null

Contact Email

int32
Defaults to 0

ID of the default password rule assigned to managed accounts created under this managed system

int32
Defaults to 120

(Minutes: 1-525600) Default release duration

int32
Defaults to 525600

(Minutes: 1-525600) Default maximum release duration

int32
Defaults to 120

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

boolean
Defaults to false

True if password auto-management is enabled, otherwise false. Can be set if Platform.AutoManagementFlag is true

  • FunctionalAccountID: (required if AutoManagementFlag is true) ID of the functional account used for managed account password changes. FunctionalAccount.PlatformID must match the PlatformID
  • CheckPasswordFlag: True to enable password testing, otherwise false
  • ChangePasswordAfterAnyReleaseFlag: True to change passwords on release of a request, otherwise false
  • ResetPasswordOnMismatchFlag: True to queue a password change when scheduled password test fails, otherwise false
int32 | null

(Required if AutoManagementFlag is true) ID of the functional account used for managed account password changes. FunctionalAccount.PlatformID must match the PlatformID

int32
Defaults to 0

(Active Directory only) Account name format to use:

  • 0: Domain and Account. Use ManagedAccount.DomainName\ManagedAccount.AccountName
  • 1: UPN. Use the Managed Account UPN
  • 2: SAM. Use the Managed Account SAM Account Name
boolean

True to enable password testing, otherwise false

boolean

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

boolean

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

string | null
Defaults to first

The change frequency for scheduled password changes:

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

(days: 1-999, required if ChangeFrequencyType is xdays) When ChangeFrequencyType is xdays, password changes take place this configured number of days

string | null
Defaults to 23:30

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

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 19 days ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 19 days ago

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.