HP OneView REST API Reference

logindomains
logindomains.html[10/17/2013 10:36:05 AM]
POST https://{appl}/rest/logindomains
The following example adds the directory with name MyDirectory
https://example.com/rest/logindomains
{
"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"}]}
}
URI: /rest/logindomains/groups
Method API
POST Retrieves a list of groups for a specified directory configured in the appliance. The group names are returned as list
of strings.
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
LoginInfo Required
Response Description
String[] Returns a list of groups for the specified directory
Response Codes
REST API Response Codes
Examples
POST
https://example.com/rest/logindomains/groups
The following example retrieves the list of groups for mydirectory
https://example.com/rest/logindomains/groups
{
"userName":"administrator",
"password":"mypassword",
"authLoginDomain":"mydirectory"
}
URI: /rest/logindomains/schema
Method API
GET Retrieves the formatted schema for the directory configuration
Request
Header
Attributes Description
REST API Request Headers NOTE: The X-API-Version header is required for all APIs. For the current release,