Directories

Quick Navigation

For more information on related topics, please see Managed Systems.

GET Directories

Returns a list of Directories.

One of: Password Safe System Management (Read), Password Safe Domain Management (Read)

None

Content-type: application/json [ 
    {
        DirectoryID : int, 
        WorkgroupID : int, 
        PlatformID : int, 
        DomainName : string, 
        ForestName : string, 
        NetBiosName : string, 
        UseSSL : bool, 
        Port : int, // can be null 
        Timeout : short, 
        Description : string, 
        ContactEmail : string, 
        PasswordRuleID : int, 
        ReleaseDuration : int, 
        MaxReleaseDuration : int, 
        ISAReleaseDuration : int, 
        AccountNameFormat : int, 
        AutoManagementFlag : bool, 
        FunctionalAccountID : int, // can be null 
        CheckPasswordFlag : bool, 
        ChangePasswordAfterAnyReleaseFlag : bool, 
        ResetPasswordOnMismatchFlag : bool, 
        ChangeFrequencyType : string, 
        ChangeFrequencyDays : int,
    }
]

200 - Request successful. Directory in response body.

For more information, please see Common Response Codes.

GET Directories/{id}

Returns a Directory by ID.

One of: Password Safe System Management (Read), Password Safe Domain Management (Read)

id: ID of the Directory.

None

Content-Type: application/json

{
    DirectoryID : int,
    WorkgroupID : int,
    PlatformID : int,
    DomainName : string,
    ForestName : string,
    NetBiosName : string,
    UseSSL : bool,
    Port : int, // can be null
    Timeout : short,
    Description : string,
    ContactEmail : string,
    PasswordRuleID : int,
    ReleaseDuration : int,
    MaxReleaseDuration : int,
    ISAReleaseDuration : int,
    AccountNameFormat : int,
    AutoManagementFlag : bool,
    FunctionalAccountID : int, // can be null
    CheckPasswordFlag : bool,
    ChangePasswordAfterAnyReleaseFlag : bool,
    ResetPasswordOnMismatchFlag : bool,
    ChangeFrequencyType : string,
    ChangeFrequencyDays : int,
    ChangeTime : string,
}

POST Workgroups/{id}/Directories

Creates a new Directory in the Workgroup referenced by ID.

One of: Password Safe System Management (Read/Write), Password Safe Domain Management (Read/Write)

id: ID of the Workgroup

Content-Type: application/json

{
    PlatformID : int,
    DomainName : string,
    ForestName : string,
    NetBiosName : string,
    UseSSL : bool,
    Port : int, // can be null
    Timeout : short,
    Description : string,
    ContactEmail : string,
    PasswordRuleID : int,
    ReleaseDuration : int,
    MaxReleaseDuration : int,
    ISAReleaseDuration : int,
    AccountNameFormat : int,
    AutoManagementFlag : bool,
    FunctionalAccountID : int, // can be null
    CheckPasswordFlag : bool,
    ChangePasswordAfterAnyReleaseFlag : bool,
    ResetPasswordOnMismatchFlag : bool,
    ChangeFrequencyType : string,
    ChangeFrequencyDays : int,
    ChangeTime : string,
}
  • PlatformID: (required) ID of the Platform
  • DomainName: (required) Name of the Domain. Max string length is 128.
  • ForestName: (required for Active Directory only, not applicable to LDAP) Name of the Directory Forest. Max string length is 64.
  • NetBiosName: (required for Active Directory, optional for LDAP) NetBIOS Name of the Directory. Max string length is 15.
  • UseSSL: (default: false) True to use an SSL connection, otherwise false.
  • Port: (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.
  • Timeout: (seconds, default: 30) Connection timeout – Length of time in seconds before a slow or unresponsive connection to the system fails.
  • Description: (optional) Description of the directory. Max string length is 255.
  • ContactEmail: Max string length is 128.
  • PasswordRuleID: (default: 0) ID of the default Password Rule assigned to Managed Accounts created under this Managed System.
  • ReleaseDuration: (minutes: 1-525600, default: 120) Default release duration.
  • MaxReleaseDuration: (minutes: 1-525600, default: 525600) Default maximum release duration.
  • ISAReleaseDuration: (minutes: 1-525600, default: 120) Default Information Systems Administrator (ISA) release duration.
  • AccountNameFormat: (Active Directory only, default: 0) 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
  • AutoManagementFlag: (default: 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.
    • ChangeFrequencyType: (default: 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)
    • ChangeFrequencyDays: (days: 1-999, required if ChangeFrequencyType is xdays) When ChangeFrequencyType is “xdays”, password changes take place this configured number of days.
    • ChangeTime: (24hr format: 00:00-23:59, default: 23:30) UTC time of day scheduled password changes take place.

Content-Type: application/json

{
    DirectoryID : int,
    WorkgroupID : int,
    PlatformID : int,
    DomainName : string,
    ForestName : string,
    NetBiosName : string,
    UseSSL : bool,
    Port : int, // can be null
    Timeout : short,
    Description : string,
    ContactEmail : string,
    PasswordRuleID : int,
    ReleaseDuration : int,
    MaxReleaseDuration : int,
    ISAReleaseDuration : int,
    AccountNameFormat : int,
    AutoManagementFlag : bool,
    FunctionalAccountID : int, // can be null
    CheckPasswordFlag : bool,
    ChangePasswordAfterAnyReleaseFlag : bool,
    ResetPasswordOnMismatchFlag : bool,
    ChangeFrequencyType : string,
    ChangeFrequencyDays : int,
    ChangeTime : string,
}

201 - Request successful. Directory in response body.

For more information, please see Common Response Codes.

PUT Directories/{id}

Updates an existing Directory by ID.

One of: Password Safe System Management (Read/Write), Password Safe Domain Management (Read/Write)

id: ID of the Directory

Content-Type: application/json

{
    PlatformID : int,
    WorkgroupID : int,
    DomainName : string,
    ForestName : string,
    NetBiosName : string,
    UseSSL : bool,
    Port : int, // can be null
    Timeout : short,
    Description : string,
    ContactEmail : string,
    PasswordRuleID : int,
    ReleaseDuration : int,
    MaxReleaseDuration : int,
    ISAReleaseDuration : int,
    AccountNameFormat : int,
    AutoManagementFlag : bool,
    FunctionalAccountID : int, // can be null
    CheckPasswordFlag : bool,
    ChangePasswordAfterAnyReleaseFlag : bool,
    ResetPasswordOnMismatchFlag : bool,
    ChangeFrequencyType : string,
    ChangeFrequencyDays : int,
    ChangeTime : string,
}

Request Body Details

  • WorkgropuID: (required) ID of the Workgroup.
  • PlatformID: (required) ID of the Platform.
  • DomainName: (required) Name of the Domain. Max string length is 128.
  • ForestName: (required for Active Directory only, not applicable to LDAP) Name of the Directory Forest. Max string length is 64..
  • NetBiosName: (required for Active Directory, optional for LDAP) NetBIOS Name of the Directory. Max string length is 15.
  • UseSSL: (default: false) True to use an SSL connection, otherwise false.
  • Port: (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.
  • Timeout: (seconds, default: 30) Connection timeout – Length of time in seconds before a slow or unresponsive connection to the system fails.
  • Description: (optional) Description of the directory. Max string length is 255.
  • ContactEmail: Max string length is 128.
  • PasswordRuleID: (default: 0) ID of the default Password Rule assigned to Managed Accounts created under this Managed System.
  • ReleaseDuration: (minutes: 1-525600, default: 120) Default release duration.
  • MaxReleaseDuration: (minutes: 1-525600, default: 525600) Default maximum release duration.
  • ISAReleaseDuration: (minutes: 1-525600, default: 120) Default Information Systems Administrator (ISA) release duration.
  • AccountNameFormat: (Active Directory only, default: 0) 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.
  • AutoManagementFlag: (default: 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.
    • ChangeFrequencyType: (default: 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).
    • ChangeFrequencyDays: (days: 1-999, required if ChangeFrequencyType is xdays) When ChangeFrequencyType is “xdays”, password changes take place this configured number of days.
    • ChangeTime: (24hr format: 00:00-23:59, default: 23:30) UTC time of day scheduled password changes take place.

Content-Type: application/json

{
    DirectoryID : int,
    WorkgroupID : int,
    PlatformID : int,
    DomainName : string,
    ForestName : string,
    NetBiosName : string,
    UseSSL : bool,
    Port : int, // can be null
    Timeout : short,
    Description : string,
    ContactEmail : string,
    PasswordRuleID : int,
    ReleaseDuration : int,
    MaxReleaseDuration : int,
    ISAReleaseDuration : int,
    AccountNameFormat : int,
    AutoManagementFlag : bool,
    FunctionalAccountID : int, // can be null
    CheckPasswordFlag : bool,
    ChangePasswordAfterAnyReleaseFlag : bool,
    ResetPasswordOnMismatchFlag : bool,
    ChangeFrequencyType : string,
    ChangeFrequencyDays : int,
    ChangeTime : string,
}

200 - Request successful. Directory in response body.

For more information, please see Common Response Codes.

DELETE Directories

Deletes a Directory by ID.

One of: Password Safe System Management (Read/Write), Password Safe Domain Management (Read/Write)

id: ID of the Directory.

None

None

200 – Request successful.

For more information, please see Common Response Codes.