HP OneView REST API Reference

logindomains
logindomains.html[10/17/2013 10:36:05 AM]
this must be set to "X-API-Version:3"
Response Description
JsonSchema[] Returns the collection of JSON schemas for the directory
configuration
Response Codes
REST API Response Codes
Examples
GET https://{appl}/rest/logindomains/schema
The following example retrieves the schema for the directory configuration
https://example.com/rest/logindomains/schema
URI: /rest/logindomains/users
Method API
POST Retrieves a list of users who are members of the groups with one or more appliance roles assigned to it. The user
names are returned as list of strings. These users have login previleges to 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"
Request
Body
Attributes Description
LoginInfo Required Login credentials
Response Description
String[] Returns list of user names for the specified directory
Response Codes
REST API Response Codes
Examples
POST
https://{appl}/rest/logindomains/users
The following example retrieves the list of users for the directory, mydirectory.
https://example.com/rest/logindomains/users
{
"userName":"administrator",
"password":"mypassword",
"authLoginDomain":"mydirectory"
}
URI: /rest/logindomains/validator
Method API
POST Validates a directory configuration. For instance, a directory configuration is validated for connectivity before adding to 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"