Directories
Quick Navigation
- GET Directories
- GET Directories/{id}
- POST Workgroups/{id}/Directories
- PUT Directories/{id}
- DELETE Directories
For more information on related topics, please see Managed Systems.
GET Directories
Purpose
Returns a list of directories.
Required Permissions
One of: Password Safe System Management (Read), Password Safe Domain Management (Read).
Request Body
None.
Response Body
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, } ]
Response Codes
200 - Request successful. Directory in response body.
For more information, please see Common Response Codes.
GET Directories/{id}
Purpose
Returns a directory by ID.
Required Permissions
One of: Password Safe System Management (Read), Password Safe Domain Management (Read).
URL Parameters
id: ID of the directory.
Request Body
None.
Response Body
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
Purpose
Creates a new directory in the Workgroup referenced by ID.
Required Permissions
One of: Password Safe System Management (Read/Write), Password Safe Domain Management (Read/Write).
URL Parameters
id: ID of the Workgroup.
Request Body
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, }
Request Body Details
- 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 1000.
- 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.
Response Body
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, }
Response Codes
201 - Request successful. Directory in response body.
For more information, please see Common Response Codes.
PUT Directories/{id}
Purpose
Updates an existing directory by ID.
Required Permissions
One of: Password Safe System Management (Read/Write), Password Safe Domain Management (Read/Write).
URL Parameters
id: ID of the directory.
Request Body
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
- WorkgroupID: (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 1000.
- 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.
Response Body
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, }
Response Codes
200 - Request successful. Directory in response body.
For more information, please see Common Response Codes.
DELETE Directories
Purpose
Deletes a directory by ID.
Required Permissions
One of: Password Safe System Management (Read/Write), Password Safe Domain Management (Read/Write).
URL Parameters
id: ID of the directory.
Request Body
None.
Response Body
None.
Response Codes
200 – Request successful.
For more information, please see Common Response Codes.