HP OneView REST API Reference

logindomains
logindomains.html[10/17/2013 10:36:05 AM]
The following example retrieves the directory configuration for the
specified directory which is identified as 1
https://example.com/rest/logindomains/1
PUT Updates a directory configuration on the appliance. For instance, it helps to add or remove the configured directory servers or
change search context for locating users in the directory.
Request Header Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to
"X-API-Version:3"
Request Body Attributes Description
LoginDomainConfigVersion2 Required
Response Description
LoginDomainConfigVersion2 Returns the updated directory configuration
Response Codes
REST API Response Codes
Examples
PUT https://{appl}/rest/logindomains/{loginDomain}
The following example obtains a directory identifier for directory, MyDirectory
Using GET https://example.com/rest/logindomains
Response:
{"name":"MyDirectory",
"loginDomain":"1",
"uri":"/rest/logindomains/1",
...
}
The following example updates the directory, MyDirectory which is identified as 1.
https://example.com/rest/logindomains/1
{
"type":"LoginDomainConfigVersion2Dto",
"name":"MyDirectory","credential":
{"userName":"administrator","password":"mypassword"},
"authProtocol":"AD","useSsl":true,"top":"dc=example,dc=com","org":"cn=Users","userNameField":"cn",
"directoryServers":[{"type":"LoginDomainDirectoryServerInfoDto",
"directoryServerIpAddress":"192.0.2.0",
"directoryServerCertificateBase64Data":"
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----\n",
"directoryServerSSLPortNumber":"636"}]}
}
DELETE Removes a directory configuration from the appliance.
Request
Header
Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release, this must be set to
"X-API-Version:3"
Response Description
void Returns an empty string on success.
Response Codes