API Guide

1 About this document................................................................................................................... 16
2 Overview....................................................................................................................................17
RESTful application programming interface..................................................................................................................... 17
OData.....................................................................................................................................................................................17
JSON data.............................................................................................................................................................................17
HTTPS communication........................................................................................................................................................17
OpenManage Enterprise - Modular Edition.......................................................................................................................17
OpenManage Enterprise..................................................................................................................................................... 18
3 Key integration concepts.............................................................................................................19
Base URI................................................................................................................................................................................19
OEM scheme.................................................................................................................................................................. 19
Redfish scheme.............................................................................................................................................................. 21
Security..................................................................................................................................................................................21
Authentication...................................................................................................................................................................... 21
Authorization........................................................................................................................................................................22
Resource addressing...........................................................................................................................................................24
Resource operations........................................................................................................................................................... 25
Security considerations.......................................................................................................................................................25
Data filtering.........................................................................................................................................................................25
Data sorting..........................................................................................................................................................................26
Data pagination....................................................................................................................................................................26
Request headers..................................................................................................................................................................26
Response codes...................................................................................................................................................................27
Response headers............................................................................................................................................................... 27
4 Application settings....................................................................................................................29
Network................................................................................................................................................................................29
/api/ApplicationService/Network...............................................................................................................................29
/api/ApplicationService/Network/WebServerConfiguration................................................................................. 30
/api/ApplicationService/Network/TimeConfiguration............................................................................................. 31
/api/ApplicationService/Network/TimeZones......................................................................................................... 32
/api/ApplicationService/Network/ProxyConfiguration...........................................................................................32
Security and user management.........................................................................................................................................34
/api/AccountService.....................................................................................................................................................34
/api/AccountService/Accounts.................................................................................................................................. 37
/api/AccountService/Accounts(Id)........................................................................................................................... 39
/api/AccountService/Accounts(userId)/Permissions..............................................................................................41
/api/AccountService/Actions/AccountService.GetPrivileges............................................................................... 42
/api/AccountService/Actions/AccountService.GetPrivilegesForUser................................................................. 42
/api/AccountService/Actions/AccountService.GetUserDetail.............................................................................. 42
/api/AccountService/Actions/AccountService.Enable...........................................................................................43
/api/AccountService/Actions/AccountService.Disable.......................................................................................... 43
Contents
Contents 3