HP OneView REST API Reference

logindomains
logindomains.html[10/17/2013 10:36:05 AM]
Request Body Attributes Description
LoginDomainConfigVersion2 Required Directory configuration to be validated
Response Description
LoginDomainConfigVersion2 Returns the directory configuration on success. Returns an
error message on failure.
Response Codes
REST API Response Codes
Examples
POST
https://{appl}/rest/logindomains/validator
The following example validates the directory configuration for the directory with name
NewDirectory
https://example.com/rest/logindomains/validator
{
"type":"LoginDomainConfigVersion2Dto",
"name":"NewDirectory","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"}]}
}
URI: /rest/logindomains/{loginDomain}
Method API
GET Retrieves a directory configuration. The specified directory must have been configured already on 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
LoginDomainConfigVersion2 Returns the directory configuration
Response Codes
REST API Response Codes
Examples
GET 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",
...
}