HP OneView REST API Reference

logindomains
logindomains.html[10/17/2013 10:36:05 AM]
Updated: October 16, 2013 3:57
MDT
API Specifications Create Read Update Delete
/rest/logindomains POST GET
/rest/logindomains/groups POST
/rest/logindomains/schema GET
/rest/logindomains/users POST
/rest/logindomains/validator POST
/rest/logindomains/{loginDomain} GET PUT DELETE
Resource Model
LoginInfo
LoginDomainConfigInfo
LoginDomainConfigVersion2
HP OneView REST API Reference
logindomains
The logindomains API set helps to configure a directory like Microsoft Active Directory to authenticate users who log in to the appliance. In
addition, this API set enables or disables local user authentication and configures a directory for authentication.
URI: /rest/logindomains
Method API
GET Retrieves a list of configured directories 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
LoginDomainConfigInfo Returns a list of configured directories
Response Codes
REST API Response Codes
Examples
Get https://{appl}/rest/logindomains
The following example retrieves the configured directories
https://example.com/rest/logindomains
POST Adds a directory for user authentication.
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 Directory configuration to be added.
Response Description
LoginDomainConfigVersion2 Returns the added directory
Response Codes
REST API Response Codes
Examples