Create directory

This method creates a directory in the Vault. Any user who is a member of the Vault Admins group can run this web service.

Creating a new directory in the Vault sets up an automated process that obtains user identification and security information via LDAP, and that automatically provisions Vault users based on the external user account, group membership, and attributes.

URL

The Groups category is created automatically when the directory is created. If there is a failure in its creation, no error will be returned, as this is an internal function.

Make sure there are no spaces in the URL.

https://<IIS_Server_Ip>/PasswordVault/API/Configuration/LDAP/Directories/

Resource Information

HTTP method	POST
Content type	application/json

Header parameter

Parameter	Authorization
Type	String
Description	The token that identifies the session.
Valid values	A session token that was returned from the “Logon” method.

Body parameters

{
"DirectoryType": "string",
"DCList ": [{
     "Name":"string", "Port":"int", "SSLConnect":"bool"}
],
"BindUsername": "string",
"BindPassword": "string",
"Port": 0,
"DomainName": "string",
"DomainBaseContext": "string"
}

Parameter	Description
DirectoryType	The name of the directory profile file that the Vault will use when working with the specified LDAP directory. Choose from a list of predefined directory profiles. Type: string Mandatory: yes
DomainName	The address of the domain. Type: string Mandatory: yes
DCList	A list of host servers for External Directory. Each item in the list includes the following: Name Description: The name of the server machine where the external directory is installed Type: string Required: yes Port Description: The port number through which the external directory can be accessed. Type: int Required: no SSLConnect Description: Whether or not to connect to the external directory with SSL. Type: boolean Required: no
BindUsername	The user that will authenticate to the directory server. Type: string Mandatory: yes
BindPassword	The password for the user specified in the Bind User field. Type: string Mandatory: yes
DomainBaseContext	The base context of the External Directory. Type: string Mandatory: yes
Port	The port that will be used to access the specified server. The standard port for SSL LDAP connections is 636, and for non-SSL LDAP connections is 389. Type: int Mandatory: no Default Value: 636

Result

{
"DirectoryType": "string","DCList ": [{
     "Name":"string", "Port":"int", "SSLConnect":"bool"}
],
"BindUsername": "string",
"BindPassword": "string",
"Port": 0,
"DomainName": "string",
"DomainBaseContext": "string"
}

Parameter	Description
DomainName	The address of the domain. Type: string
DirectoryType	The name of the directory profile file that the Vault will use when working with the specified LDAP directory. Choose from a list of predefined directory profiles. Type: string
DCList	A list of host servers for External Directory. Each item in the list includes the following: Name Description: The name of the server machine where the external directory is installed Type: string Port Description: The port number through which the external directory can be accessed. Type: int SSLConnect Description: Whether or not to connect to the external directory with SSL. Type: boolean
BindUsername	The user that will authenticate to the directory server. Type: string
DomainBaseContext	The base context of the External Directory. Type: string
Port	The port that will be used to access the specified server. The standard port for SSL LDAP connections is 636, and for non-SSL LDAP connections is 389. Type: int

Return codes

For a complete list of return codes, see Return Codes.