Agents_GetWin32Consoleinternalservererror

IntelEndpointManagementAssistant(IntelEMA)ApplicationProgrammingInterfaceGuideIntelEMAVersion1.
3.
3.
1July2020LegalDisclaimerInteltechnologiesmayrequireenabledhardware,softwareorserviceactivation.
Noproductorcomponentcanbeabsolutelysecure.
Yourcostsandresultsmayvary.
Nolicense(expressorimplied,byestoppelorotherwise)toanyintellectualpropertyrightsisgrantedbythisdocument.
Inteldisclaimsallexpressandimpliedwarranties,includingwithoutlimitation,theimpliedwarrantiesofmerchantability,fitnessforaparticularpurpose,andnon-infringement,aswellasanywarrantyarisingfromcourseofperformance,courseofdealing,orusageintrade.
Theproductsandservicesdescribedmaycontaindefectsorerrorsknownaserratawhichmaycausedeviationsfrompublishedspecifications.
Currentcharacterizederrataareavailableonrequest.
Inteltechnologies'featuresandbenefitsdependonsystemconfigurationandmayrequireenabledhardware,softwareorserviceactivation.
Performancevariesdependingonsystemconfiguration.
Nocomputersystemcanbeabsolutelysecure.
Inteldoesnotassumeanyliabilityforlostorstolendataorsystemsoranydamagesresultingfromsuchlosses.
Checkwithyoursystemmanufacturerorretailerorlearnmoreathttp://www.
intel.
com/technology/vpro.
IntelCorporation.
Intel,theIntellogo,andotherIntelmarksaretrademarksofIntelCorporationoritssubsidiaries.
Othernamesandbrandsmaybeclaimedasthepropertyofothers.
ContentsINTRODUCTION1SolutionOverview.
11APIINTRODUCTION12AUTHENTICATIONANDAUTHORIZATION.
12.
1Authentication.
12.
2Authorization.
23INTELEMAAPIURIDETAILS43.
1802.
1XSETUPS.
4GET/api/v3/802_1XSetups4POST/api/v3/802_1XSetups4GET/api/v3/802_1XSetups/{_802_1XSetupId}8PUT/api/v3/802_1XSetups/{_802_1XSetupId}10DELETE/api/v3/802_1XSetups/{_802_1XSetupId}13GET/api/v3/802_1XSetups/CertificateAuthorities.
133.
2ACCESSTOKENS14GET/api/v3/accessTokens/getUsingExistingToken.
14GET/api/v3/accessTokens/getUsingWindowsCredentials.
15POST/api/v3/accessTokens/getUsingWindowsCredentials.
16DELETE/api/v3/accessTokens/disableExistingToken173.
3AGENTS.
17GET/api/v3/agents/getWin32Console17GET/api/v3/agents/getWin32Service.
18GET/api/v3/agents/getWin64Console18GET/api/v3/agents/getWin64Service.
183.
4AJAXCOOKIES.
19GET/api/v3/ajaxCookies.
193.
5INTELAMTCREDENTIALS.
19GET/api/v3/amtCredentials/{endpointId}193.
6INTELAMTDISCOVERIES20POST/api/v3/amtDiscoveries/discoverByIP.
20POST/api/v3/amtDiscoveries/discoverByIPAutomatically.
21GET/api/v3/amtDiscoveries/{amtDiscoveryId}21GET/api/v3/amtDiscoveries.
23POST/api/v3/amtDiscoveries/{amtDiscoveryId}/cancel25POST/api/v3/amtDiscoveries/discoverBySubnet.
25POST/api/v3/amtDiscoveries/discoverBySubnetAutomatically.
26POST/api/v3/amtDiscoveries/discoverByIPRange.
27POST/api/v3/amtDiscoveries/discoverByIPRangeAutomatically.
27POST/api/v3/amtDiscoveries/discoverByLocalBroadcast.
28POST/api/v3/amtDiscoveries/discoverByLocalBroadcastAutomatically293.
7INTELAMTPROFILES.
30GET/api/v3/amtProfiles.
30POST/api/v3/amtProfiles.
30GET/api/v3/amtProfiles/{amtProfileId}35PUT/api/v3/amtProfiles/{amtProfileId}37DELETE/api/v3/amtProfiles/{amtProfileId}383.
8INTELAMTPROFILETOENDPOINTGROUPSASSIGNMENTS.
38GET/api/v3/amtProfileToEndpointGroupsAssignments/{amtProfileId}383.
9INTELAMTPROVISIONINGCERTIFICATES.
39GET/api/v3/amtProvisioningCertificates.
39GET/api/v3/amtProvisioningCertificates/{amtCertificateId}41DELETE/api/v3/amtProvisioningCertificates/{amtCertificateId}42GET/api/v3/amtProvisioningCertificates/{amtCertificateId}/getFile.
42POST/api/v3/amtProvisioningCertificates/uploadPfx42POST/api/v3/amtProvisioningCertificates/upload443.
10INTELAMTSETUPS45GET/api/v3/amtSetups/endpoints/{amtSetupId}45DELETE/api/v3/amtSetups/endpoints/{amtSetupId}47GET/api/v3/amtSetups/auto/{amtSetupId}48DELETE/api/v3/amtSetups/auto/{amtSetupId}50POST/api/v3/amtSetups/endpoints/provision.
50POST/api/v3/amtSetups/endpoints/unprovision53POST/api/v3/amtSetups/auto/set.
543.
11AUDITEVENTS56GET/api/v3/auditEvents563.
12CLIENTCREDENTIALS58GET/api/v3/clientCredentials58POST/api/v3/clientCredentials/{clientCredentialsId}59DELETE/api/v3/clientCredentials/{clientCredentialsId}60PUT/api/v3/clientCredentials/{clientCredentialsId}603.
13CRL62GET/api/v3/crl62POST/api/v3/crl/AddCrlEntry.
62POST/api/v3/crl/ResetCRL.
633.
14ENDPOINTGROUPS.
63GET/api/v3/endpointGroups63POST/api/v3/endpointGroups64GET/api/v3/endpointGroups/{endpointGroupId}66PUT/api/v3/endpointGroups/{endpointGroupId}67DELETE/api/v3/endpointGroups/{endpointGroupId}69GET/api/v3/endpointGroups/{endpointGroupId}/getMshFile.
69GET/api/v3/endpointGroups/{endpointGroupId}/getUserAccessRights.
693.
15ENDPOINTIBOPERATIONS70POST/api/v3/endpointIBOperations/reboot.
70POST/api/v3/endpointIBOperations/sleep71POST/api/v3/endpointIBOperations/hibernate.
73POST/api/v3/endpointIBOperations/shutdown.
75POST/api/v3/endpointIBOperations/alert.
763.
16ENDPOINTOOBOPERATIONS78POST/api/v3/endpointOOBOperations/Multiple/PowerOn.
78POST/api/v3/endpointOOBOperations/Multiple/Sleep/Light80POST/api/v3/endpointOOBOperations/Multiple/Sleep/Deep.
82POST/api/v3/endpointOOBOperations/Multiple/PowerCycle/OffSoft83POST/api/v3/endpointOOBOperations/Multiple/PowerOff/Hard.
85POST/api/v3/endpointOOBOperations/Multiple/Hibernate87POST/api/v3/endpointOOBOperations/Multiple/PowerOff/Soft88POST/api/v3/endpointOOBOperations/Multiple/PowerCycle/OffHard.
90POST/api/v3/endpointOOBOperations/Multiple/MasterBusReset92POST/api/v3/endpointOOBOperations/Multiple/PowerOff/SoftGraceful.
93POST/api/v3/endpointOOBOperations/Multiple/PowerOff/HardGraceful95POST/api/v3/endpointOOBOperations/Multiple/MasterBusReset/Graceful97POST/api/v3/endpointOOBOperations/Multiple/PowerCycle/OffSoftGraceful.
98POST/api/v3/endpointOOBOperations/Multiple/PowerCycle/OffHardGraceful.
100POST/api/v3/endpointOOBOperations/Single/PowerOn102POST/api/v3/endpointOOBOperations/Single/Sleep/Light103POST/api/v3/endpointOOBOperations/Single/Sleep/Deep.
103POST/api/v3/endpointOOBOperations/Single/PowerCycle/OffSoft.
104POST/api/v3/endpointOOBOperations/Single/PowerOff/Hard.
104POST/api/v3/endpointOOBOperations/Single/Hibernate105POST/api/v3/endpointOOBOperations/Single/PowerOff/Soft106POST/api/v3/endpointOOBOperations/Single/PowerCycle/OffHard106POST/api/v3/endpointOOBOperations/Single/MasterBusReset107POST/api/v3/endpointOOBOperations/Single/PowerOff/SoftGraceful.
108POST/api/v3/endpointOOBOperations/Single/PowerOff/HardGraceful108POST/api/v3/endpointOOBOperations/Single/MasterBusReset/Graceful109POST/api/v3/endpointOOBOperations/Single/PowerCycle/OffSoftGraceful110POST/api/v3/endpointOOBOperations/Single/PowerCycle/OffHardGraceful.
1103.
17ENDPOINTS111GET/api/v3/endpoints/{endpointId}111GET/api/v3/endpoints/{endpointId}/HardwareInfoFromAmt113DELETE/api/v3/endpoints/{endpointId}115GET/api/v3/endpoints1153.
18NETWORKINTERFACES.
117GET/api/v3/networkInterfaces.
1173.
19ROLES.
117GET/api/v3/roles118GET/api/v3/roles/{roleId}1183.
20SERVERCERTIFICATES119GET/api/v3/serverCertificates119GET/api/v3/serverCertificates/{certificateName}120GET/api/v3/serverCertificates/{certificateName}/getFile1213.
21SERVERSETTINGS121GET/api/v3/serverSettings/amtDiscoverySettings121GET/api/v3/serverSettings/ajaxServer122PUT/api/v3/serverSettings/ajaxServer.
124GET/api/v3/serverSettings/manageabilityServer.
125PUT/api/v3/serverSettings/manageabilityServer.
127GET/api/v3/serverSettings/swarmServer.
129PUT/api/v3/serverSettings/swarmServer.
130GET/api/v3/serverSettings/webServer132PUT/api/v3/serverSettings/webServer.
1343.
22TENANTS135GET/api/v3/tenants.
135POST/api/v3/tenants.
136GET/api/v3/tenants/{tenantId}137PUT/api/v3/tenants/{tenantId}138DELETE/api/v3/tenants/{tenantId}1393.
23USERGROUPMEMBERSHIPS.
139GET/api/v3/userGroupMemberships/{userGroupId}139POST/api/v3/userGroupMemberships/{userGroupId}/addMembers.
140POST/api/v3/userGroupMemberships/{userGroupId}/removeMembers1413.
24USERGROUPS142GET/api/v3/userGroups.
142POST/api/v3/userGroups.
143GET/api/v3/userGroups/{userGroupId}144PUT/api/v3/userGroups/{userGroupId}145DELETE/api/v3/userGroups/{userGroupId}1473.
25USERGROUPTOENDPOINTGROUPASSIGNMENTS.
147GET/api/v3/userGroupToEndpointGroupAssignments/{endpointGroupId}147POST/api/v3/userGroupToEndpointGroupAssignments/{endpointGroupId}148DELETE/api/v3/userGroupToEndpointGroupAssignments/{endpointGroupId}/userGroup/{userGroupId}1493.
26USERS.
149GET/api/v3/users.
149POST/api/v3/users.
150GET/api/v3/users/{userId}152PUT/api/v3/users/{userId}153DELETE/api/v3/users/{userId}154GET/api/v3/users/getUserByName.
154POST/api/v3/users/{userId}/resetPassword.
1553.
27WIFISETUPS156GET/api/v3/wifiSetups.
156POST/api/v3/wifiSetups.
157GET/api/v3/wifiSetups/{wifiSetupId}158PUT/api/v3/wifiSetups/{wifiSetupId}159DELETE/api/v3/wifiSetups/{wifiSetupId}1614TROUBLESHOOTING.
1625HTTPSTATUSCODES.
163400BadRequestErrors163401MethodNotAllowedErrors.
167403ForbiddenErrors168404NotFoundErrors.
168405MethodNotAllowedErrors.
168409ConflictErrors169415UnsupportedMediaTypeErrors.
171APPENDIX-802.
1XSETUPUSINGINTELEMAWEBAPI.
172EXAMPLE802.
1XSETUP.
172WiFiSetup173IntelAMTProfiles174EndpointGroup175InstallIntelEMAAgents175Testconnections.
176AddcertificatestoIntelEMAdatabase177802.
1XSETUPSETTINGS.
179IntelEMAAPIGuide–July20201IntroductionSolutionOverviewThisdocumentprovidesanoutlinefordevelopersabouttheIntelEndpointManagementAssistant(IntelEMA)ApplicationProgrammingInterface(API)version3.
0.
1APIIntroductionTheIntelEMAAPIdetailsareavailableinthisdocument,aswellasdisplayedbytheinstalledIntelEMAapplicationitself.
Theweb-basedversionoftheAPIdocumentationisaccessibleathttps:///swagger.
TheAPIdocumentationisimplementedwiththeOpenAPI(orSwagger)specification.
ThedetailedversionofthedocumentationisavailableintheSwaggerJSONformatandisviewablewithaSwaggercomplianteditor,e.
g.
,https://swagger.
io/swagger-editor.
YoucandownloadtheJSONfilebyopeningabrowseronthemachinewhereyouinstalledIntelEMAandnavigatingtohttps:///swagger,andthenclickingthedownloadbutton.
CodesamplesonhowtousetheAPIareavailableinthefolder[IntelEMAinstallationpackagefolder]\Samples.
IMPORTANT!
Thesesamplesshouldneverbehostedinaproductionenvironment.
Forhostinginatestenvironmentfordevelopmentpurposes,copytheSamplesfoldertotheIntelEMAwebsiterootfolder(e.
g.
,C:\inetpub\wwwroot\).
Note:Theversion1(v1)APIswillberemovedinthenextreleaseofIntelEMA(v1.
3.
4).
PleaseupgradeanycustomintegrationcodeyouhavecreatedtouseanewAPIversion.
WerecommendyoualwaysupdatetothelatestAPIversionassoonaspossibleasolderversionswillberemoveduponsubsequentupdates.
2AuthenticationandAuthorizationAuthenticationandauthorizationarecommonlyunderstoodtermsforaframeworkthatexecutesaccesscontroltoensureasecureenvironmentandeffectivenetworkmanagement.
oAuthGrantTypes:TheIntelEMAAPIofferstwotypesofgrantsfortokenrequests:Password–typicaltokenforindividualendusersClientCredentials–usedfornon-interactiveapplications(suchasaCLI,adaemon,oraservice)wherethetokenisissuedtotheapplicationitselfinsteadofanenduser.
WindowsDomainAuthentication:InadditiontooAuthgranttypes,IntelEMAalsoofferstheoptiontouseWindowsdomainauthenticationtoobtainabearertoken.
Fordetails,seeSection3.
2AccessTokens.
2.
1AuthenticationAllrequestsmadetotheIntelEMARESTAPIaremetwithabearertokenchallenge.
ThetokencanbeobtainedviatheOAuth2ResourceOwnerPasswordCredentialsflowinthetokenpathhttps:///api/token.
Toobtainatoken,generateanHTTPSPOSTrequesttothetokenpathusingthefollowingparameters(dependingonyourgranttype)inthemessagebody:IntelEMAAPIGuide–July20202grant_type:valuecanbeeitherpasswordorclient_credentialsusername:theresourceowner'susername(onlyforPasswordgrant)password:theresourceowner'spassword(onlyforPasswordgrant)client_id:theClientCredentialsclientID(onlyforClientCredentialsgrant)client_secret:theClientCredentialssecretpassphrase(onlyforClientCredentialsgrant)IMPORTANT!
Thistokenhasapresetexpiration:adefaultof60minutesforPasswordgrants,andaminimumof60minutesforClientCredentialsgrants(expirationisuserconfigured,seeClientCredentialsAPIlaterinthisdocument).
Duringthattime,thetokencanbeusedtomakeAPIcalls.
Ensurethistokenisprotected,similarlytoausernameandpassword.
ThefollowingexampleillustratesacurlcommandlinetoolusingHTTPSPOSTtoobtainabearertokenviatheHTTPSPOST,replacingtheplaceholdervalues:ForPasswordgrant:$curl-k-dgrant_type=password&username=user@yourdomain.
com&password=https:///api/token.
ForClientCredentialsgrant:$curl-k-dgrant_type=client_credentials&client_id=&client_secret=https:///api/token.
TousethebearertokentoaccessanIntelEMAUniformResourceIdentifier(URI),setthetokenintherequestheaderasdepictedinthefollowingexamplewithcurl:curl-H"Authorization:Bearer"https:///api/v3/2.
2AuthorizationTousetheRESTAPI,callersmustbeinaspecificrolerequiredbytheURI.
Role-basedsecuritysupportsauthorizationbymakingauthorizationdecisionsbasedontheuser'sidentityorrolemembership.
Theauthorizationprocessdetermineswhetheraspecificuserorclientapplicationhasthenecessarypermissionstoenforcespecificcommandsoroperations.
ForPasswordgrants,thesepermissionsarebasedonuserroles.
Aroleisasetofprinciplesthatareunderthesameumbrellaofprivileges,security-wise.
Thus,inthecaseofIntelEMA,thesystemusesrolemembershiptodeterminewhetherauserisauthorizedtoperformarequestedaction.
ForPasswordgrants,theserolesare:GlobalAdministrator:Thisroleperformsusermanagement,tenantmanagement,andservermanagement.
TheGlobalAdministratordoesnotperformendpointmanagementanddoesnot(andcannot)belongtoanyendpointgroup.
TheGlobalAdministrator'scontrolspansalltenantsinasingleIntelEMAserverinstallationinstance.
TenantAdministrator:Thisroleisspecifictoaparticulartenantandcanperformalloperations(usermanagement,endpointmanagement,IntelAMTDiscovery)underthattenant.
Therefore,theTenantAdministratordoesnot(andcannot)belongtoanyusergroupinitstenant.
ATenantAdministratorusercannotmanageaGlobalAdministratoruser.
AccountManager:Thisroleisspecifictoaparticulartenant,andcanperformusermanagementonly.
However,anAccountManagercannotmanageuserswithhigher-levelroles(e.
g.
,aTenantAdministratororGlobalAdministrator).
AccountManagerscannotperformendpointmanagement,andthereforecannotbelongtoanyusergroup.
IntelEMAAPIGuide–July20203EndpointGroupCreator:Thisroleisspecifictoaparticulartenant.
Itcanperformendpointmanagement,aswellascreatenewendpointgroupsandmanageIntelAMTProfiles.
AnEndpointGroupCreatorcanbeamemberofmultipleusergroupsandcanmanageallgroupstowhichtheybelong.
EndpointGroupCreatorscannotperformusermanagement.
However,theycanseethelistofallusergroupsandthelistofallEndpointGroupCreatorsandEndpointGroupUsersinthattenant(i.
e.
,userrolesinthattenantthatareequalorlowerintheuserrolehierarchy;theycannotseeAccountManagers,TenantAdministrators,orGlobalAdministrators).
EndpointGroupUser:Thisroleisspecifictoaparticulartenant,andcanperformendpointmanagementonly.
EndpointGroupUserscanbemembersofmultipleusergroups,buttheycannotperformusermanagement,andcanonlyviewtheirownuserinformation.
SeetheIntelEMAAdministrationandUsageGuidedocumentforfurtherinformationabouttheuserroles.
ForClientCredentialsgrants,suchpermissionsarebasedon"scope,"not"role".
Aclientapplication'sscopedetermineswhatthatapplicationcandowithinIntelEMA.
Inthisrelease,thereisonlyonesupportedscope:Endpointmanagement:canmanage(anyInBandorOut-of-Bandoperation)andprovisionanyendpointwithinagivenTenant,regardlessofwhichusergroupsorendpointgroupstowhichtheendpointbelongs.
Authorizationenablesyoutomakemoregranularchoiceswhenitcomestograntingaccesstospecificresources.
Thereareauthorizationfiltersthataretriggeredbeforeanactionisrequestedtoverifyiftherequestinguserhasthenecessaryprivilegestoperformtheaction.
Iftherequestisnotauthorized,thefilterreturnsanerrormessageandtheactionisnotexecuted.
IntelEMAAPIGuide–July202043IntelEMAAPIURIDetailsThesubsequentsections(3.
1–3.
23)includecontentthatisautomaticallygeneratedfortheIntelEMAAPI.
ItlistsmultipleAPIcallsalongwithitsdescriptions,parameters,andotherrelevantdetailstohelpdevelopersunderstandhowtoleveragethem.
OnlinehelpfortheAPIisimplementedviatheSwaggerAPIframework.
ThissectionisanaccuratedepictionoftheinformationcontainedinSwaggerabouttheAPI.
3.
1802.
1XSetupsGET/api/v3/802_1XSetupsTheGET/api/v3/802_1XSetupscallgetsacollectionof802.
1XSetups(802.
1XSetups_GetSetupsCollection)Rolerequired:TenantAdministrator,EndpointGroupCreator,orEndpointGroupUserClientCredentialscanaccess:NoReturntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{"SetupId":0,"SetupName":"string","TenantId":"string"}]oXML1stringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequesto403:Forbiddeno500:InternalServerErrorPOST/api/v3/802_1XSetupsIntelEMAAPIGuide–July20205ThePOST/api/v3/802_1XSetupscallcreatesan802.
1XSetuptobeusedbyWifiSetupandWired802.
1XinIntelAMTProfiles.
(802.
1XSetups_AddSetup)Rolerequired:TenantAdministratorClientCredentialscanaccess:NoSetupproperties:oTenantId:Thisfieldisnotrequiredforthisoperation.
Ifprovided,itwillbeignored.
oPSK:Thisvalue,ifprovided,mustbeanOctetString(convertibletoabytearray).
oProtectedAccessCredential:Thisvalue,ifprovided,mustbeanOctetString(convertibletoabytearray).
oAuthenticationProtocol:Currently,onlythe0=EAP_TLSoptionisfullysupported.
oClientAuthenticationSettings.
DesignatedUsernameCN:Thedefaultvalueforthispropertyis4=UserPrincipalName.
ThisistheusernamerequiredbytheNetworkPolicyServer(NPS),whichistheRADIUSimplementationbyMicrosoft.
Therequestbodyis_802_1XSetupDTO(required).
Thisisthe802.
1XSetupobjecttocreate.
{"TenantId":"00000000-0000-0000-0000-000000000000","SetupId":0,"SetupName":"string","Data":{"Enabled":"enabled","PSK":"string","ProtectedAccessCredential":"string","Domain":"string","Username":"string","ServerCertificateNameComparisonOption":"other","ServerCertificateName":"string","UseRoamingIdentity":true,"RoamingIdentity":"string","AuthenticationProtocol":"eAP_TLS","PXETimeoutInSeconds":0,"AvailableInS0":true,"ADIntegrationSettings":{"OrganizationUnit":"string","SecurityGroups":["string"]},"ClientAuthenticationSettings":{"ClientCertificateSettings":{"Source":"none","Thumbprint":"string","CAName":"string","Template":"string"},"CommonNamesOption":"default","CommonNames":["dNSFQDN"],"DesignatedSubjectCN":"dNSFQDN","DesignatedUsernameCN":"dNSFQDN"},"RootCertificateSettings":{"Source":"none",IntelEMAAPIGuide–July20206"Thumbprint":"string","CAName":"string"}}}Returntype:_802_1XSetupDTOExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"TenantId":"00000000-0000-0000-0000-000000000000","SetupId":0,"SetupName":"string","Data":{"Enabled":"enabled","PSK":"string","ProtectedAccessCredential":"string","Domain":"string","Username":"string","ServerCertificateNameComparisonOption":"other","ServerCertificateName":"string","UseRoamingIdentity":true,"RoamingIdentity":"string","AuthenticationProtocol":"eAP_TLS","PXETimeoutInSeconds":0,"AvailableInS0":true,"ADIntegrationSettings":{"OrganizationUnit":"string","SecurityGroups":["string"]},"ClientAuthenticationSettings":{"ClientCertificateSettings":{"Source":"none","Thumbprint":"string","CAName":"string","Template":"string"},"CommonNamesOption":"default","CommonNames":["dNSFQDN"],"DesignatedSubjectCN":"dNSFQDN","DesignatedUsernameCN":"dNSFQDN"},"RootCertificateSettings":{"Source":"none","Thumbprint":"string","CAName":"string"}}}IntelEMAAPIGuide–July20207oXML00000000-0000-0000-0000-0000000000001stringenabledstringstringstringstringotherstringtruestringeAP_TLS1truestringstringnonestringstringstringdefaultdNSFQDNdNSFQDNdNSFQDNnonestringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest_802_1XSetupSummaryIntelEMAAPIGuide–July20208o400:InvalidModelStateo403:Forbiddeno409:802.
1XSetupnamealreadyexistso500:InternalServerErrorGET/api/v3/802_1XSetups/{_802_1XSetupId}TheGET/api/v3/802_1XSetups/{_802_1XSetupId}callgetsan802.
1XSetupbyID.
(802.
1XSetups_GetSetupById)Rolerequired:TenantAdministrator,EndpointGroupCreator,orEndpointGroupUserClientCredentialscanaccess:NoReturntype:_802_1XSetupDTOExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"TenantId":"00000000-0000-0000-0000-000000000000","SetupId":0,"SetupName":"string","Data":{"Enabled":"enabled","PSK":"string","ProtectedAccessCredential":"string","Domain":"string","Username":"string","ServerCertificateNameComparisonOption":"other","ServerCertificateName":"string","UseRoamingIdentity":true,"RoamingIdentity":"string","AuthenticationProtocol":"eAP_TLS","PXETimeoutInSeconds":0,"AvailableInS0":true,"ADIntegrationSettings":{"OrganizationUnit":"string","SecurityGroups":["string"]},"ClientAuthenticationSettings":{"ClientCertificateSettings":{"Source":"none","Thumbprint":"string","CAName":"string","Template":"string"},"CommonNamesOption":"default","CommonNames":["dNSFQDN"],"DesignatedSubjectCN":"dNSFQDN","DesignatedUsernameCN":"dNSFQDN"},"RootCertificateSettings":{"Source":"none",IntelEMAAPIGuide–July20209"Thumbprint":"string","CAName":"string"}}}oXML00000000-0000-0000-0000-0000000000001stringenabledstringstringstringstringotherstringtruestringeAP_TLS1truestringstringnonestringstringstringdefaultdNSFQDNdNSFQDNdNSFQDNnonestringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-TyperesponseheaderIntelEMAAPIGuide–July202010oapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturned_802_1XSetupDTOo403:Forbiddeno404:Notfoundo500:InternalServerErrorPUT/api/v3/802_1XSetups/{_802_1XSetupId}ThePUT/api/v3/802_1XSetups/{_802_1XSetupId}callupdatesan802.
1XSetupbyID.
(802.
1XSetups_UpdateSetup)Rolerequired:TenantAdministratorClientCredentialscanaccess:NoSetupproperties:oTenantId:Thisfieldisnotrequiredforthisoperation.
Ifprovided,itwillbeignored.
oPSK:Thisvalue,ifprovided,mustbeanOctetString(convertibletoabytearray).
oProtectedAccessCredential:Thisvalue,ifprovided,mustbeanOctetString(convertibletoabytearray).
oAuthenticationProtocol:Currently,onlythe0=EAP_TLSoptionisfullysupported.
oClientAuthenticationSettings.
DesignatedUsernameCN:Thedefaultvalueforthispropertyis4=UserPrincipalName.
ThisistheusernamerequiredbytheNetworkPolicyServer(NPS),whichistheRADIUSimplementationbyMicrosoft.
Thepathparameteris_802_1XSetupId(required)int32format.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyis_802_1XSetupDTO(required).
Thisisthe802.
1XSetupobjecttoupdate.
{"TenantId":"00000000-0000-0000-0000-000000000000","SetupId":0,"SetupName":"string","Data":{"Enabled":"enabled","PSK":"string","ProtectedAccessCredential":"string","Domain":"string","Username":"string","ServerCertificateNameComparisonOption":"other","ServerCertificateName":"string","UseRoamingIdentity":true,"RoamingIdentity":"string","AuthenticationProtocol":"eAP_TLS","PXETimeoutInSeconds":0,"AvailableInS0":true,"ADIntegrationSettings":{"OrganizationUnit":"string",IntelEMAAPIGuide–July202011"SecurityGroups":["string"]},"ClientAuthenticationSettings":{"ClientCertificateSettings":{"Source":"none","Thumbprint":"string","CAName":"string","Template":"string"},"CommonNamesOption":"default","CommonNames":["dNSFQDN"],"DesignatedSubjectCN":"dNSFQDN","DesignatedUsernameCN":"dNSFQDN"},"RootCertificateSettings":{"Source":"none","Thumbprint":"string","CAName":"string"}}}Returntype:_802_1XSetupDTO.
Exampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"TenantId":"00000000-0000-0000-0000-000000000000","SetupId":0,"SetupName":"string","Data":{"Enabled":"enabled","PSK":"string","ProtectedAccessCredential":"string","Domain":"string","Username":"string","ServerCertificateNameComparisonOption":"other","ServerCertificateName":"string","UseRoamingIdentity":true,"RoamingIdentity":"string","AuthenticationProtocol":"eAP_TLS","PXETimeoutInSeconds":0,"AvailableInS0":true,"ADIntegrationSettings":{"OrganizationUnit":"string","SecurityGroups":["string"]},"ClientAuthenticationSettings":{IntelEMAAPIGuide–July202012"ClientCertificateSettings":{"Source":"none","Thumbprint":"string","CAName":"string","Template":"string"},"CommonNamesOption":"default","CommonNames":["dNSFQDN"],"DesignatedSubjectCN":"dNSFQDN","DesignatedUsernameCN":"dNSFQDN"},"RootCertificateSettings":{"Source":"none","Thumbprint":"string","CAName":"string"}}}oXML00000000-0000-0000-0000-0000000000001stringenabledstringstringstringstringotherstringtruestringeAP_TLS1truestringstringnonestringstringstringIntelEMAAPIGuide–July202013defaultdNSFQDNdNSFQDNdNSFQDNnonestringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequesto400:InvalidModelStateo403:Forbiddeno404:Notfoundo409:802.
1XSetupnamealreadyexistsorSetupIdmismatcho500:InternalServerErrorDELETE/api/v3/802_1XSetups/{_802_1XSetupId}TheDELETE/api/v3/802_1XSetups/{_802_1XSetupId}calldeletesan802.
1XSetupbyID.
(802.
1XSetups_DeleteSetup)Rolerequired:TenantAdministratorClientCredentialscanaccess:NoThepathparameteris_802_1XSetupId(required)int32format.
Responsetypes:o204:Successfulrequest,nocontento403:Forbiddeno404:Notfoundo409:Cannotdelete802.
1XSetupifitisstillassociatedwithIntelAMTProfileorWiFiSetupo500:InternalServerErrorGET/api/v3/802_1XSetups/CertificateAuthoritiesTheGET/api/v3/802_1XSetups/CertificateAuthoritiescallgetsacollectionofCertificateAuthoritiesfoundinthecurrentWindowsdomain.
(802.
1XSetups_GetCAInDomain)Rolerequired:TenantAdministratorClientCredentialscanaccess:NoReturntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{IntelEMAAPIGuide–July202014"CAFullName":"string","CertificateTemplates":["string"],"IsRoot":true}]oXMLstringstringtrueThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:SuccessfulrequestCertificateAuthoritySummaryo403:Forbiddeno500:InternalServerError3.
2AccessTokensGET/api/v3/accessTokens/getUsingExistingTokenTheGET/api/v3/accessTokens/getUsingExistingTokencallgetsanewAccessToken.
(AccessTokens_GetUsingExistingToken)Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,EndpointGroupCreator,orEndpointGroupUser.
ClientCredentialscanaccess:YesThismethodprovidesUsersthemeanstoobtainanewAccessTokenbeforetheircurrentoneexpires.
Returntype:AccessTokenExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"access_token":"string","token_type":"string","expires_in":0,"userName":"string","issued":"string","expires":"string"}oXMLIntelEMAAPIGuide–July202015stringstring1stringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAccessTokeno403:Forbiddeno500:InternalServerErrorGET/api/v3/accessTokens/getUsingWindowsCredentialsTheGET/api/v3/accessTokens/getUsingWindowsCredentialscallgetsanewAccessTokenusingWindowsAuthenticationcredentials.
(AccessTokens_getUsingWindowsCredentials)Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,EndpointGroupCreator,orEndpointGroupUserClientCredentialscanaccess:NoThismethodwillonlygrantanAccessTokenunderthefollowingconditions:1.
IntelEMAmustbeinstalledwithWindowsDomainAuthenticationmode.
2.
TheIntelEMAservermustbejoinedtoanActiveDirectorydomain.
3.
ThecallermusthaveanIntelEMAaccountwithausernamethatmapstoaUserPrincinpalNameinActiveDirectory.
Returntype:AccessTokenExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"access_token":"string","token_type":"string","expires_in":0,"userName":"string","issued":"string","expires":"string"}oXMLstringstringIntelEMAAPIGuide–July2020161stringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAccessTokeno401:Unauthorizedo403:Forbiddeno405:MethodNotAllowedo500:InternalServerErrorPOST/api/v3/accessTokens/getUsingWindowsCredentialsThePOST/api/v3/accessTokens/getUsingWindowsCredentialscallgetsanewAccessTokenusingWindowsusernameandpassword.
TheWindowsusernameneedstobetheUserPrincipalName(UPN)inActiveDirectory.
(AccessTokens_getUsingWindowsCredentials)Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,EndpointGroupCreator,orEndpointGroupUser.
ClientCredentialscanaccess:NoThismethodprovidesUsersthemeanstoobtainanewAccessTokenusingWindowsusernameandpassword.
ThismethodwillonlygrantanAccessTokenunderthefollowingconditions:1.
IntelEMAmustbeinstalledwithWindowsDomainAuthenticationmode.
2.
ThecallermusthaveanIntelEMAaccountwithausernamethatmapstoaUserPrincinpalNameinActiveDirectory.
TherequestbodyisWindowsCredential.
ThisistheWindowsCredentialobject.
{"Upn":"string","Password":"string"}Returntype:AccessTokenExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"access_token":"string","token_type":"string","expires_in":0,"userName":"string","issued":"string","expires":"string"}IntelEMAAPIGuide–July202017oXMLstringstring1stringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAccessTokeno401:Unauthorizedo403:Forbiddeno405:MethodNotAllowedo500:InternalServerErrorDELETE/api/v3/accessTokens/disableExistingTokenTheDELETE/api/v3/accessTokens/deleteExistingTokencalldeletesexpiredorunusedtokens.
(AccessTokens_DisableExistingToken)Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,EndpointGroupCreator,orEndpointGroupUser.
ClientCredentialscanaccess:YesResponsetypes:o204:Successfulrequest,nocontento401:Unauthorizedo405:MethodNotAllowedo500:InternalServerError3.
3AgentsGET/api/v3/agents/getWin32ConsoleTheGET/api/v3/agents/getWin32ConsolecallgetsthelatestagentexecutableforWin32Console(Agents_GetWin32Console)Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,EndpointGroupCreator,orEndpointGroupUserClientCredentialscanaccess:NoThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlIntelEMAAPIGuide–July202018Responsetypes:o200:Successfulrequest,attachmentreturnedo500:InternalServerErrorGET/api/v3/agents/getWin32ServiceTheGET/api/v3/agents/getWin32ServicecallgetsthelatestagentinstallerforWin32Service(Agents_GetWin32Service)Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,EndpointGroupCreator,orEndpointGroupUserClientCredentialscanaccess:NoThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,attachmentreturnedo500:InternalServerErrorGET/api/v3/agents/getWin64ConsoleTheGET/api/v3/agents/getWin64ConsolecallgetsthelatestagentexecutableforWin64Console(Agents_GetWin64Console)Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,EndpointGroupCreator,orEndpointGroupUserClientCredentialscanaccess:NoThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,attachmentreturnedo500:InternalServerErrorGET/api/v3/agents/getWin64ServiceTheGET/api/v3/agents/getWin64ServicecallgetsthelatestagentinstallerforWin64Service(Agents_GetWin64Service)Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,EndpointGroupCreator,orEndpointGroupUserClientCredentialscanaccess:NoThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,attachmentreturnedo500:InternalServerErrorIntelEMAAPIGuide–July2020193.
4AjaxCookiesGET/api/v3/ajaxCookiesTheGET/api/v3/ajaxCookiescallGetsanAjaxcookie.
(AjaxCookies_GetAjaxCookie)Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,EndpointGroupCreator,orEndpointGroupUserClientCredentialscanaccess:YesReturntype:AjaxCookieExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"cookie":"string","expireTime":"2018-10-23T17:09:08.
756Z"}oXMLxmlversion="1.
0">string1970-01-01T00:00:00.
001ZThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAjaxCookieo401:Unauthorizedo500:InternalServerError3.
5IntelAMTCredentialsGET/api/v3/amtCredentials/{endpointId}TheGET/api/v3/amtCredentials/{endpointId}callreturnstheIntelAMTadmincredentialsorIntelMEBxpassword,basedoncredentialtypedefinedinthequerystring,foraprovisionedendpointifitsassociatedAmtSetuprecordisfoundinthedatabase(AmtCredentials_GetById)Rolesrequired:TenantAdministrator,EndpointGroupCreatororEndpointGroupUserwithexecuterighttotheendpointClientCredentialscanaccess:NoWhenreturningtheIntelMEBXpassword,theusernamefieldinIntelAMTcredentialsisalwaysnullReturntype:AmtCredentialsDTOExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{IntelEMAAPIGuide–July202020"userName":"string","password":"string"}oXMLstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAmtCredentialsDTOo400:Badrequesto403:Forbiddeno404:Notfoundo409:Resourceconflictduetonotabletogetthecredentialorpasswordo500:Internalservererror3.
6IntelAMTDiscoveriesPOST/api/v3/amtDiscoveries/discoverByIPThePOST/api/v3/amtDiscoveries/discoverByIPcallsubmitsarequesttoperformremoteIntelAMTDiscoverybyIPaddress.
(AmtDiscoveries_DiscoveryByIp)Rolerequired:TenantAdministratorClientCredentialscanaccess:NoIPcorrespondstotheIPaddressoftheIntelAMTcomputertodiscover.
MACcorrespondstotheMACaddressoftheserver'snetworkinterfacetobeusedforthediscovery.
Theformatis6octetsseparatedbycolons(:).
Forexample:{.
.
.
"MAC":"00:1F:C6:9B:D6:67"}Therequestbodyis(required).
ThisistheIntelAMTDiscoveriesobjecttocreateReturntype:AmtDiscoveryProcessIdExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"amtDiscoveryId":"amtDiscoveryId"IntelEMAAPIGuide–July202021}oXMLstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAmtDiscoveryProcessIdo400:Badrequesto500:InternalservererrorPOST/api/v3/amtDiscoveries/discoverByIPAutomaticallyThePOST/api/v3/amtDiscoveries/discoverByIPAutomaticallycallsubmitsarequesttoperformremoteIntelAMTDiscoveryautomaticallybyIPaddress.
(AmtDiscoveries_DiscoveryByIpAutomatically)Rolerequired:TenantAdministratorClientCredentialscanaccess:NooIntervalreferstotheminutesbetweeneachautomaticdiscoveryexecution.
Interval0turnsoffautomaticdiscoveries.
oRestartManageabilityServerindicateswhethertorestarttheManageabilityServerornot,aschangestoitsconfigurationareappliedonlywhentheserverisrestarted.
oIPcorrespondstotheIPaddressoftheIntelAMTcomputertodiscover.
oMACcorrespondstotheMACaddressoftheserver'snetworkinterfacetobeusedforthediscovery.
Theformatis6octetsseparatedbycolons(:).
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisSingleIPAddressAutomatic(required).
ThisistheIPaddressobject.
{"Interval":0,"RestartManageabilityServer":true,"IP":"string","MAC":"string"}Responsetypes:o204:Successfulrequest,nocontento400:Badrequesto500:InternalservererrorGET/api/v3/amtDiscoveries/{amtDiscoveryId}IntelEMAAPIGuide–July202022TheGET/api/v3/amtDiscoveries/{amtDiscoveryId}callgetstheresultofanIntelAMTDiscoveryprocessbyID.
(AmtDiscoveries_GetAmtDiscoveryResult)Rolerequired:TenantAdministratorClientCredentialscanaccess:NoReturntype:AmtDiscoveryResultExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"AmtDiscoveryId":"00000000-0000-0000-0000-000000000000","Title":"string","Request":{"TenantId":"00000000-0000-0000-0000-000000000000","NetInterfaceMacAddress":"string","DiscoveryType":"singleIP","StartIPAddress":"string","EndIPRange":"string","SubnetMask":"string"},"StartDateStr":"string","EndDateStr":"string","LastUpdatedStr":"string","ExecutionType":"manual","ExecutionTypeStr":"string","DiscoveryTypeStr":"string","Status":"requested","StatusStr":"string","AddressesQuantity":0,"Found":0,"Results":[{"IPAddress":"string","AmtVersion":"string","PortStatus":"waitingForSetup","PortStatusDescription":"string","ProvisioningState":"string","DetailId":0,"ErrorMessage":"string","AddressesQuantity":0,"Hostname":"string"}]}oXML00000000-0000-0000-0000-000000000000string00000000-0000-0000-0000-000000000000stringIntelEMAAPIGuide–July202023singleIPstringstringstringstringstringstringmanualstringstringrequestedstring11stringstringwaitingForSetupstringstring1string1stringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAmtDiscoveryResulto404:Notfoundo500:InternalservererrorGET/api/v3/amtDiscoveriesTheGET/api/v3/amtDiscoveriescallGetsacollectionofIntelAMTDiscoverysummaries.
(AmtDiscoveries_GetAmtDiscoveryStatus)Rolerequired:TenantAdministratorClientCredentialscanaccess:NoTheresultofanIntelAMTDiscoveryisreferencedbyitsprocessidentifier.
TogetthefulllistofIntelAMTDiscoveryprocessesusediscoveryStatus=null.
Returntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[IntelEMAAPIGuide–July202024{"AmtDiscoveryId":"00000000-0000-0000-0000-000000000000","Title":"string","Request":{"TenantId":"00000000-0000-0000-0000-000000000000","NetInterfaceMacAddress":"string","DiscoveryType":"singleIP","StartIPAddress":"string","EndIPRange":"string","SubnetMask":"string"},"StartDateStr":"string","EndDateStr":"string","LastUpdatedStr":"string","ExecutionType":"manual","ExecutionTypeStr":"string","DiscoveryTypeStr":"string","Status":"requested","StatusStr":"string","AddressesQuantity":0,"Found":0}]oXML00000000-0000-0000-0000-000000000000string00000000-0000-0000-0000-000000000000stringsingleIPstringstringstringstringstringstringmanualstringstringrequestedstring11ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonIntelEMAAPIGuide–July202025otext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAmtDiscoveryResultSummaryo500:InternalservererrorPOST/api/v3/amtDiscoveries/{amtDiscoveryId}/cancelThePOST/api/v3/amtDiscoveries/{amtDiscoveryId}/cancelcallSubmitsarequesttocancelarunningremoteIntelAMTDiscoveryprocessbyID.
(AmtDiscoveries_CancelAmtDiscoveryProcess)Rolerequired:TenantAdministratorClientCredentialscanaccess:NoThepathparameterisamtDiscoveryId(required).
IntelAMTDiscoveryprocessID.
CanonicalGUIDform:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx(string)Responsetypes:-204:Successfulrequest,nocontent-404:Notfound-500:InternalservererrorPOST/api/v3/amtDiscoveries/discoverBySubnetThePOST/api/v3/amtDiscoveries/discoverBySubnetcallSubmitsarequesttoperformremoteIntelAMTDiscoveryinasubnet.
Itcantakefromminutestohours,dependingonthenumberofusablehostsinthegivensubnet.
(AmtDiscoveries_DiscoverBySubnet)Rolerequired:TenantAdministratorClientCredentialscanaccess:NoStartIPAddresscorrespondstoanyIPaddressofanIntelAMTcomputerinasubnet,wherethediscoveryisgoingtobeexecuted.
SubnetMaskcanbegivenindot-decimalnotationorCIDRsuffix.
MACcorrespondstotheMACaddressoftheserver'snetworkinterfacetobeusedforthediscovery.
Theformatis6octetsseparatedbycolons(:).
Forexample:{.
.
.
"SubnetMask":"255.
255.
255.
0",or"SubnetMask":"24","MAC":"00:1F:C6:9B:D6:67"}Note:SubnetMask"255.
255.
255.
254"isconsideredinvalid,sinceitsHostAddressRangeis0.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
-application/json-text/json-application/xml-text/xml-application/x-www-form-urlencodedTherequestbodyisSubnet.
ThisistheSubnetobject.
Returntype:AmtDiscoveryProcessIdExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"amtDiscoveryId":"string"IntelEMAAPIGuide–July202026}oXMLstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAmtDiscoveryProcessIdo400:Badrequesto500:InternalservererrorPOST/api/v3/amtDiscoveries/discoverBySubnetAutomaticallyThePOST/api/v3/amtDiscoveries/discoverBySubnetAutomaticallycallsubmitsarequesttoperformremoteIntelAMTDiscoveryautomaticallyinasubnet.
Itcantakefromminutestohours,dependingonthenumberofusablehostsinthegivensubnet.
(AmtDiscoveries_DiscoverBySubnetAutomatically)Rolerequired:TenantAdministratorClientCredentialscanaccess:NoIntervalreferstotheminutesbetweeneachautomaticdiscoveryexecution.
Interval0turnsoffautomaticdiscoveries.
RestartManageabilityServerindicateswhethertorestarttheManageabilityServerornot,aschangestoitsconfigurationareappliedonlywhentheserverisrestarted.
StartIPAddresscorrespondstoanyIPaddressofanIntelAMTcomputerinasubnet,wherethediscoveryisgoingtobeexecuted.
SubnetMaskcanbegivenindot-decimalnotationorCIDRsuffix.
Note:SubnetMask"255.
255.
255.
254"isconsideredinvalid,sinceitsHostAddressRangeis0.
MACcorrespondstotheMACaddressoftheserver'snetworkinterfacetobeusedforthediscovery.
Theformatis6octetsseparatedbycolons(:).
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisSubnetAutomatic(required).
ThisistheSubnetobject.
{"Interval":0,"RestartManageabilityServer":true,"StartIPAddress":"string","SubnetMask":"string","MAC":"string"}Responsetypes:IntelEMAAPIGuide–July202027o204:Successfulrequest,nocontento400:Badrequesto500:InternalservererrorPOST/api/v3/amtDiscoveries/discoverByIPRangeThePOST/api/v3/amtDiscoveries/discoverByIPRangecallSubmitsarequesttoperformremoteIntelAMTDiscoverywithinanIPaddressrange.
(AmtDiscoveries_DiscoverByIPRange)Rolerequired:TenantAdministratorClientCredentialscanaccess:NoStartIPAddresscorrespondstoanyIPaddressofanIntelAMTcomputerinasubnet,wherethediscoveryisgoingtobeexecuted.
EndIPRangecannotbelowerthantheStartIPAddress.
MACcorrespondstotheMACaddressoftheserver'snetworkinterfacetobeusedforthediscovery.
Theformatis6octetsseparatedbycolons(:).
Forexample:{.
.
.
"MAC":"00:1F:C6:9B:D6:67"\}ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyis(required).
ThisistheIntelAMTDiscoveriesobjecttocreateReturntype:AmtDiscoveryProcessIdExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"amtDiscoveryId":"string"}oXMLstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAmtDiscoveryProcessIdo400:Badrequesto500:InternalservererrorPOST/api/v3/amtDiscoveries/discoverByIPRangeAutomaticallyIntelEMAAPIGuide–July202028ThePOST/api/v3/amtDiscoveries/discoverByIPRangeAutomaticallycallSubmitsarequesttoperformremoteIntelAMTDiscoveryautomaticallywithinanIPaddressrange.
(AmtDiscoveries_DiscoverByIPRangeAutomatically)Rolerequired:TenantAdministratorClientCredentialscanaccess:NoIntervalreferstotheminutesbetweeneachautomaticdiscoveryexecution.
Interval0turnsoffautomaticdiscoveries.
RestartManageabilityServerindicateswhethertorestarttheManageabilityServerornot,aschangestoitsconfigurationareappliedonlywhentheserverisrestarted.
StartIPAddresscorrespondstoanyIPaddressofanIntelAMTcomputerinasubnet,wherethediscoveryisgoingtobeexecuted.
EndIPRangecannotbelowerthantheStartIPAddress.
MACcorrespondstotheMACaddressoftheserver'snetworkinterfacetobeusedforthediscovery.
Theformatis6octetsseparatedbycolons(:).
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisIPRangeDiscoveryAutomatic(required).
ThisistheIPaddressrangeobject{"Interval":0,"RestartManageabilityServer":true,"StartIPAddress":"string","EndIPRange":"string","MAC":"string"}Responsetypes:o204:Successfulrequest,nocontento400:Badrequesto500:InternalservererrorPOST/api/v3/amtDiscoveries/discoverByLocalBroadcastThePOST/api/v3/amtDiscoveries/discoverByLocalBroadcastcallsubmitsarequesttoperformremoteIntelAMTDiscoverybylocalbroadcast.
(AmtDiscoveries_DiscoveryByLocalBroadcast)Rolerequired:TenantAdministratorClientCredentialscanaccess:NoMACcorrespondstotheMACaddressoftheserver'snetworkinterfacetobeusedforthediscovery.
Theformatis6octetsseparatedbycolons(:).
Forexample:{.
.
.
"MAC":"00:1F:C6:9B:D6:67"}ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmlIntelEMAAPIGuide–July202029oapplication/x-www-form-urlencodedTherequestbodyis(required).
ThisistheIntelAMTDiscoveriesobjecttocreateReturntype:AmtDiscoveryProcessIdExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"amtDiscoveryId":"string"}oXMLstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAmtDiscoveryProcessIdo400:Badrequesto500:InternalservererrorPOST/api/v3/amtDiscoveries/discoverByLocalBroadcastAutomaticallyThePOST/api/v3/amtDiscoveries/discoverByLocalBroadcastAutomaticallycallSubmitsarequesttoperformremoteIntelAMTDiscoveryautomaticallybylocalbroadcast.
(AmtDiscoveries_DiscoveryByLocalBroadcastAutomatically)Rolerequired:TenantAdministratorClientCredentialscanaccess:NoIntervalreferstotheminutesbetweeneachautomaticdiscoveryexecution.
Interval0turnsoffautomaticdiscoveries.
RestartManageabilityServerindicateswhethertorestarttheManageabilityServerornot,aschangestoitsconfigurationareappliedonlywhentheserverisrestarted.
MACcorrespondstotheMACaddressoftheserver'snetworkinterfacetobeusedforthediscovery.
Theformatis6octetsseparatedbycolons(:).
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisLocalBroadcastAutomatic.
ThisistheLocalBroadcastAutomaticobject.
{"Interval":0,"RestartManageabilityServer":true,"MAC":"string"}IntelEMAAPIGuide–July202030Responsetypes:o204:Successfulrequest,nocontento400:Badrequesto500:Internalservererror3.
7IntelAMTProfilesGET/api/v3/amtProfilesTheGET/api/v3/amtProfilescallgetsalistofIntelAMTProfilesummaries.
(AmtProfiles_GetCollection)Rolerequired:TenantAdministrator,EndpointGroupCreator,orEndpointGroupUserClientCredentialscanaccess:NoReturntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{"AmtProfileId":0,"Name":"string","Description":"string","TenantId":"string"}]oXML1stringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAmtProfileSummaryo500:InternalServerErrorPOST/api/v3/amtProfilesThePOST/api/v3/amtProfilescallcreatesanIntelAMTProfile.
(AmtProfiles_Post)Rolerequired:TenantAdministratororEndpointGroupCreatorClientCredentialscanaccess:NoThefollowingdefinestheprofileobject'soptionalparametersandtheirdefaultvalues.
Ifnoargumentisprovidedforanoptionalparameter,thenitsdefaultvalueisused.
oTlsAuthType:1=TlsNoAuth.
IfthisissettoNoTLS,youneedtospecifytheCIRASettings.
IntelEMAAPIGuide–July202031oPowerPackageSettings.
PowerActiveOn:1=AlwaysOnInAc.
oPowerPackageSettings.
PowerStateIdleTimeoutInMinutes:1.
oManagementInterfacesSettings.
WebUIServiceEnabledState:2=Enabled.
oManagementInterfacesSettings.
KVMInterfaceState:2=Enabled.
oManagementInterfacesSettings.
UserConsentRequired:4294967295=All.
oManagementInterfacesSettings.
SOLEnabled:true.
oManagementInterfacesSettings.
IDEREnabled:true.
oManagementInterfacesSettings.
RedirectionServiceState:SOLEnabled=trueand[IDEREnabled=true:32771(IderOnSolOn);IDEREnabled=false:32770(IderOffSolOn)];SOLEnabled=falseand[IDEREnabled=true:32769(IderOnSolOff);IDEREnabled=false:32768(Disabled)].
oFqdnSettings.
FqdnSource:0=SharedWithHostOS.
oIpSettings.
DHCPEnabled:true.
oIpSettings.
SharedStaticIp:false.
oIpSettings.
Source:0=DHCP.
oWiFiConnectionSettings.
WiFiSetups:Emptycollection(itisoptionalonlyifWiFiConnectionSettings.
WiFiConnectionEnabledConfiguration=0)oWired802_1XSettings:Anobjectcontaining_802_1Setup_DBLookupKey=null.
oCIRASettings(thewholeobject):null.
oCIRASettings.
CIRATunnel:false.
oCIRASettings.
EnvironmentDetectionDomainSuffix:ValuetodisableCIRAwhenthetargetsystemisinthisnetworkdomainwhenCIRATunnel=true;EmptystringwhenCIRATunnel=false.
oCIRASettings.
CIRAProxies(thewholeobject):Emptycollection.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisAmtProfileNew.
ThisistheIntelAMTProfileNewobject.
{"Name":"string","Description":"string","TlsAuthType":"noTLS","PowerPackageSettings":{"PowerActiveOn":"onInS0","PowerStateIdleTimeoutInMinutes":0},"ManagementInterfacesSettings":{"WebUIServiceEnabledState":"enabled","KVMInterfaceState":"enabled","UserConsentRequired":"none","UserConsentDisplayTimeout":0,"SOLEnabled":true,"IDEREnabled":true,"RedirectionServiceState":"disabled"},"FqdnSettings":{"FqdnSource":"sharedWithHostOS"},"IpSettings":{"DHCPEnabled":true,IntelEMAAPIGuide–July202032"SharedStaticIp":true,"Source":"dHCP","IP":"string","SubnetMask":"string","DefaultGateway":"string","PrimaryDNS":"string","SecondaryDNS":"string"},"WiFiConnectionSettings":{"AMTHostWiFiSyncEnabled":"disabled","WiFiConnectionEnabledConfiguration":"noSetup","WiFiEnabledInPowerState":"s0Only","WiFiSetups":[0]},"Wired802_1XSettings":{"_802_1Setup_DBLookupKey":0},"CIRASettings":{"CIRATunnel":true,"CIRAProxies":[{"AccessInfo":"string","InfoFormat":"iPv4","Port":0,"DNSSuffix":"string"}]}}Returntype:AmtProfileExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"AmtProfileId":0,"Name":"string","Description":"string","TlsAuthType":"noTLS","PowerPackageSettings":{"PowerActiveOn":"onInS0","PowerStateIdleTimeoutInMinutes":0},"ManagementInterfacesSettings":{"WebUIServiceEnabledState":"enabled","KVMInterfaceState":"enabled","UserConsentRequired":"none","UserConsentDisplayTimeout":0,"SOLEnabled":true,"IDEREnabled":true,"RedirectionServiceState":"disabled"IntelEMAAPIGuide–July202033},"FqdnSettings":{"FqdnSource":"sharedWithHostOS"},"IpSettings":{"DHCPEnabled":true,"SharedStaticIp":true,"Source":"dHCP","IP":"string","SubnetMask":"string","DefaultGateway":"string","PrimaryDNS":"string","SecondaryDNS":"string"},"WiFiConnectionSettings":{"AMTHostWiFiSyncEnabled":"disabled","WiFiConnectionEnabledConfiguration":"noSetup","WiFiEnabledInPowerState":"s0Only","WiFiSetups":[0]},"Wired802_1XSettings":{"_802_1Setup_DBLookupKey":0},"CIRASettings":{"CIRATunnel":true,"CIRAProxies":[{"AccessInfo":"string","InfoFormat":"iPv4","Port":0,"DNSSuffix":"string"}]},"TenantId":"string"}oXML1stringstringnoTLSonInS01IntelEMAAPIGuide–July202034enabledenablednone1truetruedisabledsharedWithHostOStruetruedHCPstringstringstringstringstringdisablednoSetups0Only11truestringiPv41stringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAmtProfileIntelEMAAPIGuide–July202035o400:BadRequesto409:AMTProfilenamealreadyexistso500:InternalServerErrorGET/api/v3/amtProfiles/{amtProfileId}TheGET/api/v3/amtProfiles/{amtProfileId}callgetsanIntelAMTProfilebyID.
(AmtProfiles_GetAmtProfile)Rolerequired:TenantAdministrator,EndpointGroupCreator,orEndpointGroupUserClientCredentialscanaccess:NoReturntype:AmtProfileExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"AmtProfileId":0,"Name":"string","Description":"string","TlsAuthType":"noTLS","PowerPackageSettings":{"PowerActiveOn":"onInS0","PowerStateIdleTimeoutInMinutes":0},"ManagementInterfacesSettings":{"WebUIServiceEnabledState":"enabled","KVMInterfaceState":"enabled","UserConsentRequired":"none","UserConsentDisplayTimeout":0,"SOLEnabled":true,"IDEREnabled":true,"RedirectionServiceState":"disabled"},"FqdnSettings":{"FqdnSource":"sharedWithHostOS"},"IpSettings":{"DHCPEnabled":true,"SharedStaticIp":true,"Source":"dHCP","IP":"string","SubnetMask":"string","DefaultGateway":"string","PrimaryDNS":"string","SecondaryDNS":"string"},"WiFiConnectionSettings":{"AMTHostWiFiSyncEnabled":"disabled","WiFiConnectionEnabledConfiguration":"noSetup","WiFiEnabledInPowerState":"s0Only","WiFiSetups":[0]},"Wired802_1XSettings":{"_802_1Setup_DBLookupKey":0IntelEMAAPIGuide–July202036},"CIRASettings":{"CIRATunnel":true,"CIRAProxies":[{"AccessInfo":"string","InfoFormat":"iPv4","Port":0,"DNSSuffix":"string"}]},"TenantId":"string"}oXML1stringstringnoTLSonInS01enabledenablednone1truetruedisabledsharedWithHostOStruetruedHCPstringstringstringstringstringdisabledIntelEMAAPIGuide–July202037noSetups0Only11truestringiPv41stringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAmtProfileo403:Forbiddeno404:Notfoundo500:InternalServerErrorPUT/api/v3/amtProfiles/{amtProfileId}ThePUT/api/v3/amtProfiles/{amtProfileId}callupdatesanIntelAMTProfilebyID.
(AmtProfiles_Put)Rolerequired:TenantAdministratororEndpointGroupCreatorClientCredentialscanaccess:NoThepropertiesAmtProfileIdandTenantIdarereadonlyandcannotbeupdated.
Thefollowinglistdefinesthedefaultvaluesthatwouldbeusedforanyoptionalparametersiftheyareomittedfromtheprofileobject:oTlsAuthType:1=TlsNoAuth.
IfthisissettoNoTLS,youneedtospecifytheCIRASettings.
oPowerPackageSettings.
PowerActiveOn:1=AlwaysOnInAc.
oPowerPackageSettings.
PowerStateIdleTimeoutInMinutes:1.
oManagementInterfacesSettings.
WebUIServiceEnabledState:2=Enabled.
oManagementInterfacesSettings.
KVMInterfaceState:2=Enabled.
oManagementInterfacesSettings.
UserConsentRequired:4294967295=All.
oManagementInterfacesSettings.
SOLEnabled:true.
oManagementInterfacesSettings.
IDEREnabled:true.
oManagementInterfacesSettings.
RedirectionServiceState:SOLEnabled=trueand[IDEREnabled=true:32771(IderOnSolOn);IDEREnabled=false:32770(IderOffSolOn)];SOLEnabled=falseand[IDEREnabled=true:32769(IderOnSolOff);IDEREnabled=false:32768(Disabled)].
IntelEMAAPIGuide–July202038oFqdnSettings.
FqdnSource:0=SharedWithHostOS.
oIpSettings.
DHCPEnabled:true.
oIpSettings.
SharedStaticIp:false.
oIpSettings.
Source:0=DHCP.
oWiFiConnectionSettings.
WiFiSetups:Emptycollection(itisoptionalonlyifWiFiConnectionSettings.
WiFiConnectionEnabledConfiguration=0)oWired802_1XSettings:Anobjectcontaining_802_1Setup_DBLookupKey=null.
oCIRASettings(thewholeobject):null.
oCIRASettings.
CIRATunnel:false.
oCIRASettings.
EnvironmentDetectionDomainSuffix:ValuetodisableCIRAwhenthetargetsystemisinthisnetworkdomainwhenCIRATunnel=true;EmptystringwhenCIRATunnel=false.
oCIRASettings.
CIRAProxies(thewholeobject):Emptycollection.
ThepathparameterisamtProfileId.
TheIntelAMTProfiles.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisamtProfileId.
ThisistheIntelAMTProfileIdobject.
Returntype:AmtProfileExampledata:Content-Type=Application/JSONandapplication/XML.
-JSON.
-XMLThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAmtProfileo400:Badrequesto404:Notfoundo409:AMTprofilenamealreadyexistso500:InternalServerErrorDELETE/api/v3/amtProfiles/{amtProfileId}TheDELETE/api/v3/amtProfiles/{amtProfileId}calldeletesanIntelAMTProfilebyID.
(AmtProfiles_Delete)Rolerequired:TenantAdministratororEndpointGroupCreatorClientCredentialscanaccess:NoThepathparameterisamtProfileId.
TheIntelAMTProfiles.
Responsetypes:o204:Successfulrequest,nocontento404:Notfoundo409:CannotbedeletedsincetheAMTProfileisstilllinkedtoatleastoneEndpointGroupo500:InternalServerError3.
8IntelAMTProfileToEndpointGroupsAssignmentsGET/api/v3/amtProfileToEndpointGroupsAssignments/{amtProfileId}IntelEMAAPIGuide–July202039TheGET/api/v3/amtProfileToEndpointGroupsAssignments/{amtProfileId}callgetsalistofEndpointGroupsassociatedwithagivenAmtProfileId.
(AmtProfileToEndpointGroupsAssignments_GetEndpointGroups)Rolerequired:TenantAdministrator,EndpointGroupCreator,orEndpointGroupUserClientCredentialscanaccess:No404willbereturnedifAmtProfileIdisnotfound.
Returntype:AmtProfileToEndpointGroupsAssignmentsExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"EndpointGroupCount":0,"AccessibleEndpointGroups":[{"EndpointGroupId":"string","Name":"string"}]}oXML1stringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAmtProfileToEndpointGroupsAssignmentso403:Forbiddeno404:Notfoundo500:InternalServerError3.
9IntelAMTProvisioningCertificatesGET/api/v3/amtProvisioningCertificatesTheGET/api/v3/amtProvisioningCertificatescallgetsacollectioncertificatesrequiredforIntelAMTprovisioning(AmtProvisioningCertificates_GetCollection)Rolerequired:TenantAdministrator,AccountManager,EndpointGroupCreator,orEndpointGroupUserClientCredentialscanaccess:NoReturntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
IntelEMAAPIGuide–July202040[{"AmtCertificateId":0,"Name":"string","CommonName":"string","NotBefore":"2019-08-01T20:05:00.
491Z","NotAfter":"2019-08-01T20:05:00.
492Z","HasPrivateKey":true,"Thumbprint":"string","IsAmtProvisioningCert":true,"InUseByAmtProfile":true,"Pem":"string","Enabled":true,"TenantId":"00000000-0000-0000-0000-000000000000","CreatedOn":"2019-08-01T20:05:00.
492Z","CreatedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:00.
492Z","ModifiedBy":"00000000-0000-0000-0000-000000000000"}]oXML1stringstring1970-01-01T00:00:00.
001Z1970-01-01T00:00:00.
001Ztruestringtruetruestringtrue00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-000000000000ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAmtCertificateo401:UnauthorizedIntelEMAAPIGuide–July202041o403:Forbiddeno500:InternalservererrorGET/api/v3/amtProvisioningCertificates/{amtCertificateId}TheGET/api/v3/amtProvisioningCertificates/{amtCertificateId}callgetsacertificateusedforIntelAMTprovisioningbyID(AmtProvisioningCertificates_GetById).
Rolerequired:TenantAdministrator,AccountManager,EndpointGroupCreator,orEndpointGroupUserClientCredentialscanaccess:NoThepathparameterisamtCertificateId.
Returntype:AmtCertificateExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"AmtCertificateId":0,"Name":"string","CommonName":"string","NotBefore":"2019-08-01T20:05:00.
508Z","NotAfter":"2019-08-01T20:05:00.
508Z","HasPrivateKey":true,"Thumbprint":"string","IsAmtProvisioningCert":true,"InUseByAmtProfile":true,"Pem":"string","Enabled":true,"TenantId":"00000000-0000-0000-0000-000000000000","CreatedOn":"2019-08-01T20:05:00.
508Z","CreatedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:00.
508Z","ModifiedBy":"00000000-0000-0000-0000-000000000000"}oXML1stringstring1970-01-01T00:00:00.
001Z1970-01-01T00:00:00.
001Ztruestringtruetruestringtrue00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-000000000000IntelEMAAPIGuide–July202042ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAmtCertificateo401:Unauthorizedo403:Forbiddeno404:Notfoundo500:InternalservererrorDELETE/api/v3/amtProvisioningCertificates/{amtCertificateId}TheDELETE/api/v3/amtProvisioningCertificates/{amtCertificateId}calldeletesacertificateusedforIntelAMTprovisioning,aswellasthenextonesinthechainseriallyiftheyarenotapartofanotherchain.
(AmtProvisioningCertificates_DeleteById).
Rolerequired:TenantAdministratorClientCredentialscanaccess:NoThepathparameterisamtCertificateId,TheIntelAMTProvisioningCertificates.
Responsetypes:o204:Successfulrequest,nocontento401:Unauthorizedo403:Forbiddeno404:Notfoundo409:Conflict:certificateisinusebyAMTprofileo500:InternalservererrorGET/api/v3/amtProvisioningCertificates/{amtCertificateId}/getFileTheGET/api/v3/amtProvisioningCertificates/{amtCertificateId}/getFilecallgetsthe.
CERfileofanIntelAMTprovisioningcertificate,oracertificateinitschain,byID(AmtProvisioningCertificates_GetFile)Rolerequired:TenantAdministrator,AccountManager,EndpointGroupCreator,orEndpointGroupUserClientCredentialscanaccess:NoThefilenameofthe.
CERfilewillwillbespecifiedinthe"filename"parameterofthe"Content-Disposition"header.
ThepathparameterisamtCertificateId,TheIntelAMTProvisioningCertificates.
ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-TyperesponseheaderResponsetypes:o200:Successfulrequest,attachmentreturnedo401:Unauthorizedo403:Forbiddeno404:Notfoundo500:InternalservererrorPOST/api/v3/amtProvisioningCertificates/uploadPfxThePOST/api/v3/amtProvisioningCertificates/uploadPfxcallupload.
PFXofIntelAMTprovisioningcertificate(AmtProvisioningCertificates_UploadPfx)Rolerequired:TenantAdministratorIntelEMAAPIGuide–July202043ClientCredentialscanaccess:NoToimportanIntelAMTprovisioningcertificate,POSTwithenctype"multipart/form-data",the.
PFXfileattached,andthefollowingparameters:name:certificatenicknamepassword:passwordforthe.
PFXfileReturntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{"AmtCertificateId":0,"Name":"string","CommonName":"string","NotBefore":"2019-08-01T20:05:00.
522Z","NotAfter":"2019-08-01T20:05:00.
522Z","HasPrivateKey":true,"Thumbprint":"string","IsAmtProvisioningCert":true,"InUseByAmtProfile":true,"Pem":"string","Enabled":true,"TenantId":"00000000-0000-0000-0000-000000000000","CreatedOn":"2019-08-01T20:05:00.
522Z","CreatedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:00.
522Z","ModifiedBy":"00000000-0000-0000-0000-000000000000"}]oXML1stringstring1970-01-01T00:00:00.
001Z1970-01-01T00:00:00.
001Ztruestringtruetruestringtrue00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-000000000000IntelEMAAPIGuide–July202044ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAmtCertificateo400:Invalidfileo401:Unauthorizedo403:Forbiddeno404:Notfoundo409:Conflict:certificatethumbprintalreadyexistso415:Unsupportedmediatypeo500:InternalServerErrorPOST/api/v3/amtProvisioningCertificates/uploadThePOST/api/v3/amtProvisioningCertificates/uploadcallupload.
PFXgeneralcertificates(AmtProvisioningCertificates_Upload)Rolerequired:TenantAdministratorClientCredentialscanaccess:NoToimportancertificate,POSTwithenctype"multipart/form-data",the.
PFXfileattached,andthefollowingparameters:name:certificatenicknamepassword:passwordforthe.
PFXfileReturntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{"AmtCertificateId":0,"Name":"string","CommonName":"string","NotBefore":"2019-08-01T20:05:00.
534Z","NotAfter":"2019-08-01T20:05:00.
534Z","HasPrivateKey":true,"Thumbprint":"string","IsAmtProvisioningCert":true,"InUseByAmtProfile":true,"Pem":"string","Enabled":true,"TenantId":"00000000-0000-0000-0000-000000000000","CreatedOn":"2019-08-01T20:05:00.
535Z","CreatedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:00.
535Z","ModifiedBy":"00000000-0000-0000-0000-000000000000"}]oXMLIntelEMAAPIGuide–July2020451stringstring1970-01-01T00:00:00.
001Z1970-01-01T00:00:00.
001Ztruestringtruetruestringtrue00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-000000000000ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAmtCertificateo400:Invalidfileo401:Unauthorizedo403:Forbiddeno404:Notfoundo415:Unsupportedmediatypeo500:InternalServerError3.
10IntelAMTSetupsGET/api/v3/amtSetups/endpoints/{amtSetupId}TheGET/api/v3/amtSetups/endpoints/{amtSetupId}callgetstheAmtSetup(orprovisioningrecord)ofanEndpoint(AmtSetups_GetManualProvisioningRecordById).
Rolerequired:TenantAdministrator,orEndpointGroupCreatororEndpointGroupUserwithViewrighttotheresource.
ClientCredentialscanaccess:NoThepathparameterisamtSetupId.
UsevalueofEndpointId.
Hexstringwith64charactersandwithoutthe0xprefixReturntype:AmtSetup[String]Exampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"AmtSetupId":"string","Type":"auto","PID":"string","Creation":"2019-08-01T20:05:00.
548Z",IntelEMAAPIGuide–July202046"SetsRandomMebxPassword":true,"Profile":{"UsesTLS":true,"UsesCIRA":true,"UsesEmaAccount":true,"CiraIntranetSuffix":"string","AdminPassword":"string","MebxPasswordState":"doNotSetMebxPassword","ProvisionCertificateHash":"string","ProvisioningDnsSuffix":"string","PPS":"string"},"State":0,"StateString":"string","ExtraAmtInfo":{"LastUpdated":"2019-08-01T20:05:00.
549Z","HECIDriver":{"Name":"string","Status":true,"Details":"string"},"CorporateDNS":{"Name":"string","Status":true,"Details":"string"},"CorporateVPN":{"Name":"string","Status":true,"Details":"string"},"IntelNic":{"Name":"string","Status":true,"Details":"string"}},"AmtProfileId":0}oXMLstringautostring1970-01-01T00:00:00.
001ZtruetruetruetruestringIntelEMAAPIGuide–July202047stringdoNotSetMebxPasswordstringstringstring1string1970-01-01T00:00:00.
001Zstringtruestringstringtruestringstringtruestringstringtruestring1ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAmtSetup[String]o403:Forbiddeno404:Notfoundo500:InternalservererrorDELETE/api/v3/amtSetups/endpoints/{amtSetupId}TheDELETE/api/v3/amtSetups/endpoints/{amtSetupId}calldeletestheAmtSetup(orprovisioningrecord)ofanEndpoint(AmtSetups_DeleteManualProvisioningRecordById).
Rolerequired:TenantAdministrator,orEndpointGroupCreatororEndpointGroupUserwithExecuterighttotheendpoint.
ClientCredentialscanaccess:NoThepathparameterisamtSetupId.
UsevalueofEndpointId.
Hexstringwith64charactersandwithoutthe0xprefixIntelEMAAPIGuide–July202048Responsetypes:o204:Successfulrequest,nocontento403:Forbiddeno404:Notfoundo500:InternalservererrorGET/api/v3/amtSetups/auto/{amtSetupId}TheGET/api/v3/amtSetups/auto/{amtSetupId}callgetstheAmtSetup(orauto-provisioningsetting)ofanEndpointGroup(AmtSetups_GetAutoProvisioningRecordById)Rolerequired:TenantAdministrator,orEndpointGroupCreatororEndpointGroupUserwithViewrighttotheresource.
ClientCredentialscanaccess:NoThepathparameterisamtSetupId.
UsevalueofEndpointGroupId.
Hexstringwith64charactersandwithoutthe0xprefixReturntype:AmtSetup[String]Exampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"AmtSetupId":"string","Type":"auto","PID":"string","Creation":"2019-08-01T20:05:00.
590Z","SetsRandomMebxPassword":true,"Profile":{"UsesTLS":true,"UsesCIRA":true,"UsesEmaAccount":true,"CiraIntranetSuffix":"string","AdminPassword":"string","MebxPasswordState":"doNotSetMebxPassword","ProvisionCertificateHash":"string","ProvisioningDnsSuffix":"string","PPS":"string"},"State":0,"StateString":"string","ExtraAmtInfo":{"LastUpdated":"2019-08-01T20:05:00.
590Z","HECIDriver":{"Name":"string","Status":true,"Details":"string"},"CorporateDNS":{"Name":"string","Status":true,"Details":"string"},"CorporateVPN":{"Name":"string","Status":true,"Details":"string"IntelEMAAPIGuide–July202049},"IntelNic":{"Name":"string","Status":true,"Details":"string"}},"AmtProfileId":0}oXMLstringautostring1970-01-01T00:00:00.
001ZtruetruetruetruestringstringdoNotSetMebxPasswordstringstringstring1string1970-01-01T00:00:00.
001ZstringtruestringstringtruestringstringtruestringstringtruestringIntelEMAAPIGuide–July2020501ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAmtSetup[String]o403:Forbiddeno404:Notfoundo500:InternalservererrorDELETE/api/v3/amtSetups/auto/{amtSetupId}TheDELETE/api/v3/amtSetups/auto/{amtSetupId}calldeletestheAmtSetup(orauto-provisioningsetting)ofanEndpointGroup(AmtSetups_DeleteAutoProvisioningRecordById).
Rolerequired:TenantAdministrator,orEndpointGroupCreatororEndpointGroupUserwithExecuterighttotheendpoint.
ClientCredentialscanaccess:NoThepathparameterisamtSetupId.
UsevalueofEndpointGroupId.
Hexstringwith64charactersandwithoutthe0xprefixResponsetypes:o204:Successfulrequest,nocontento403:Forbiddeno404:Notfoundo500:InternalservererrorPOST/api/v3/amtSetups/endpoints/provisionThePOST/api/v3/amtSetups/endpoints/provisioncallsubmitsarequesttoprovisionanIntelAMTEndpoint(AmtSetups_Provision).
Rolerequired:TenantAdministrator,orEndpointGroupCreatororEndpointGroupUserwithExecuterighttotheendpoint.
ClientCredentialscanaccess:NoCertificateprovisioningwillberequestedonlyifanAMTProvisioningCertificateIdisprovided,otherwisehost-based-provisioningwillberequested.
AdminCredential.
Passwordrequirements:obetween8and31charactersocontainsatleastonenumberocontainsbothlowercaseanduppercasealphacharactersocontainsatleastonespecialcharacter:amp;CiraIntranetSuffixisapplicableonlywhenUsesCiraissettotrue.
Thevalueisastringofuptofourcommaseparateddomainnamesuffixes.
UsesTLSandUsesCiracannotbebothtrueorbothfalse.
Youneedtochooseone.
ThepathparameterisManualProvisioningRequest.
AMTSetuprequestobjectThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedIntelEMAAPIGuide–July202051TherequestbodyisManualProvisioningRequest.
ThisistheIntelAMTSetupsobject.
{"EndpointId":"string","UsesTls":true,"UsesCira":true,"SetsRandomMebxPassword":true,"UsesEmaAccount":true,"AdminCredential":{"Password":"string"},"AmtCertificateId":0}Returntype:AmtSetup[String]Exampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"AmtSetupId":"string","Type":"auto","PID":"string","Creation":"2019-08-01T20:05:00.
600Z","SetsRandomMebxPassword":true,"Profile":{"UsesTLS":true,"UsesCIRA":true,"UsesEmaAccount":true,"AdminPassword":"string","MebxPasswordState":"doNotSetMebxPassword","ProvisionCertificateHash":"string","ProvisioningDnsSuffix":"string","PPS":"string"},"State":0,"StateString":"string","ExtraAmtInfo":{"LastUpdated":"2019-08-01T20:05:00.
600Z","HECIDriver":{"Name":"string","Status":true,"Details":"string"},"CorporateDNS":{"Name":"string","Status":true,"Details":"string"},"CorporateVPN":{"Name":"string","Status":true,"Details":"string"IntelEMAAPIGuide–July202052},"IntelNic":{"Name":"string","Status":true,"Details":"string"}},"AmtProfileId":0}oXMLstringautostring1970-01-01T00:00:00.
001ZtruetruetruetruestringdoNotSetMebxPasswordstringstringstring1string1970-01-01T00:00:00.
001ZstringtruestringstringtruestringstringtruestringstringtruestringIntelEMAAPIGuide–July2020531ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,resultreturnedAmtSetup[String]o400:Badrequesto403:Forbiddeno404:Notfoundo409:Endpoint'sAMTisalreadyprovisionedo500:InternalservererrorPOST/api/v3/amtSetups/endpoints/unprovisionThePOST/api/v3/amtSetups/endpoints/unprovisioncallsubmitsarequesttounprovisionanIntelAMTcapableendpoint(AmtSetups_Unprovision)Rolerequired:TenantAdministrator,orEndpointGroupCreatororEndpointGroupUserwithExecuterighttotheendpoint.
ClientCredentialscanaccess:NoWarning:ThisoperationwillresettheIntelAMTdevicetofactorysettings!
TheIntelAMTadminpasswordisoptionalandshouldonlybeusedtounprovisionanIntelAMTendpointthatwasprovisionedoutsideofIntelEMA,orthathasnoAmtSetup(orProvisioningRecord)inthedatabase.
IftheIntelAMTcapableendpointwasprovisionedwithIntelEMA,andthecorrespondingAmtSetuprecordisinthedatabase,thentheIntelAMTadminpasswordisunnecessary.
AdminCredential.
Passwordrequirements:obetween8and32charactersocontainsatleastonenumberocontainsbothlowercaseanduppercasealphacharactersocontainsatleastonespecialcharacterThepathparameterisManualUnprovisioningRequest.
AnunprovisionIntelAMTrequest.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisManualUnprovisioningRequest.
ThisistheIntelAMTSetupsobject.
{"EndpointId":"string","AdminCredential":{"Password":"string"}}ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-TyperesponseheaderResponsetypes:IntelEMAAPIGuide–July202054o204:Successfulrequest,nocontento400:Badrequesto403:Forbiddeno404:Notfoundo409:AMTendpointnotprovisioned,orTCPRELAYnotenabledbypolicyo500:InternalservererrorPOST/api/v3/amtSetups/auto/setThePOST/api/v3/amtSetups/auto/setcallsetsIntelAMTauto-provisioningforanEndpointGroup.
(AmtSetups_SetAutoProvisioningForEndpointGroup)Rolerequired:TenantAdministrator,orEndpointGroupCreatororEndpointGroupUserwithExecuterighttotheendpoint.
ClientCredentialscanaccess:NoForcertificateprovisioning,provideanAmtCertificateIdintherequest,otherwiseHost-based-provisioningwillbeset.
Tounsetauto-provisioning,deletetheAmtSetuprecordusingtheEndpointGroupIdasAmtSetupId.
ThepathparameterisAutoProvisioningRequest.
TheIntelAMTSetups.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisAutoProvisioningRequest.
ThisistheIntelAMTSetupsobject.
{"EndpointGroupId":"string","AmtProfileId":0,"SetsRandomMebxPassword":true,"AdminCredential":{"Password":"string"},"UsesEmaAccount":true,"AmtCertificateId":0}Returntype:AmtSetup[String]Exampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"AmtSetupId":"string","Type":"auto","PID":"string","Creation":"2019-08-01T20:05:00.
637Z","SetsRandomMebxPassword":true,"Profile":{"UsesTLS":true,"UsesCIRA":true,"UsesEmaAccount":true,"CiraIntranetSuffix":"string","AdminPassword":"string","MebxPasswordState":"doNotSetMebxPassword",IntelEMAAPIGuide–July202055"ProvisionCertificateHash":"string","ProvisioningDnsSuffix":"string","PPS":"string"},"State":0,"StateString":"string","ExtraAmtInfo":{"LastUpdated":"2019-08-01T20:05:00.
637Z","HECIDriver":{"Name":"string","Status":true,"Details":"string"},"CorporateDNS":{"Name":"string","Status":true,"Details":"string"},oXMLstringautostring1970-01-01T00:00:00.
001ZtruetruetruetruestringstringdoNotSetMebxPasswordstringstringstring1string1970-01-01T00:00:00.
001ZstringtruestringstringtruestringIntelEMAAPIGuide–July202056stringtruestringstringtruestring1ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheader-application/json-text/json-application/xml-text/xmlResponsetypes:-200:Successfulrequest,contentreturnedAmtSetup[String]-400:BadRequest-403:Forbidden-404:Notfound-409:Conflict-500:Internalservererror3.
11AuditEventsGET/api/v3/auditEventsTheGET/api/v3/endpointGroupscallgetsalistofAuditEventsfilterablebyoptionalquerystringparameters.
(AuditEvents_GetAuditEvents)Rolerequired:GlobalAdministratororTenantAdministrator.
ClientCredentialscanaccess:NoGlobalAdministratorscanonlyaccessAuditEventsnotassociatedwithaTenantId.
TimestampsarerecordedinUTC.
UseUTCformatwhenfilteringwithstartDateTimeand/orendDateTime.
Forexample,"2020-01-29T15:10:38.
017Z".
FormoreinformationaboutthedatausedinthisAPI,pleaserefertotheappendixofAPIGuide.
Therequestbodyisaserieofparameters.
Thesearetheparameters.
resourceName=string,resourceID=string,callerName=string,callerID="00000000-0000-0000-0000-000000000000",source=string,action=string,resourceType=string,startDateTime="2020-06-11T20:56:40.
815Z",endDateTime="2020-06-11T20:56:40.
815Z"Returntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
IntelEMAAPIGuide–July202057[{"Id":"00000000-0000-0000-0000-000000000000","Timestamp":"2020-06-11T20:56:40.
815Z","Source":"unknown","Action":"noAction","Uri":"string","TenantId":"00000000-0000-0000-0000-000000000000","ResourceId":"string","ResourceName":"string","ResourceType":"nONE","CallerId":"00000000-0000-0000-0000-000000000000","CallerName":"string","CallerIpAddress":"string","CallerUserAgent":"string","Event":"string","ExecutionDurationInMsec":0}]oXML00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001ZunknownnoActionstring00000000-0000-0000-0000-000000000000stringstringnONE00000000-0000-0000-0000-000000000000stringstringstringstring1ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointGroupSummaryo400:InvalidModelStateo401:Unauthorizedo403:UsernotallowedtoexecuteoperationIntelEMAAPIGuide–July2020583.
12ClientCredentialsGET/api/v3/clientCredentialsTheGET/api/v3/clientCredentialscallgetsalistofClientCredentialsobjects.
(ClientCredentials_GetClientCredentials)Rolerequired:GlobalAdministratororTenantAdministrator.
ClientCredentialscanaccess:NoIfcalleruserisGlobalAdministrator,thismethodwillreturnallClientCredentialsinallTenantsunlessaspecifictenantIdisprovided.
IfcalleruserisTenantAdministrator,thismethodwillreturnonlyClientCredentialsforthatTenant.
TherequestbodyistenantId.
Returntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{"id":0,"userId":"00000000-0000-0000-0000-000000000000","name":"string","client_id":"00000000-0000-0000-0000-000000000000","client_secret":"string","tenantId":"00000000-0000-0000-0000-000000000000","scope":"string","maxFailedLoginAttempts":0,"tokenLifetimeHours":0,"enabled":true}]oXML100000000-0000-0000-0000-000000000000string00000000-0000-0000-0000-000000000000string00000000-0000-0000-0000-000000000000string11trueThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlIntelEMAAPIGuide–July202059Responsetypes:o200:Successfulrequest,contentreturnedClientCredentialsAccounto400:InvalidModelStateo401:Unauthorizedo500:InternalservererrorPOST/api/v3/clientCredentials/{clientCredentialsId}ThePOST/api/v3/clientCredentialscallcreatesasetofClientCredentialsforaTenant.
OnlyoneClientCredentialsaccountisallowedperTenant.
(ClientCredentials_PostClientCredentials)Rolerequired:GlobalAdministratororTenantAdministrator.
ClientCredentialscanaccess:NoRequiredparameters:oClient_secretoMaxFailedLoginAttempts-Min5,Max15,Default10oTokenLifetimeHours-Min1,Max24,Default1ClientSecretRequirements:oAtleast12charactersoContainsatleastonenumberoContainsbothlowercaseanduppercasealphacharactersoContainsatleastonespecialcharacterTherequestbodyisClientCredentials.
ThisistheClientCredentialsobject.
{"id":0,"userId":"00000000-0000-0000-0000-000000000000","client_id":"00000000-0000-0000-0000-000000000000","client_secret":"string","tenantId":"00000000-0000-0000-0000-000000000000","maxFailedLoginAttempts":0,"tokenLifetimeHours":0}Returntype:ClientCredentialsAccountExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{"id":0,"userId":"00000000-0000-0000-0000-000000000000","name":"string","client_id":"00000000-0000-0000-0000-000000000000","client_secret":"string","tenantId":"00000000-0000-0000-0000-000000000000","scope":"string","maxFailedLoginAttempts":0,"tokenLifetimeHours":0,"enabled":true}]oXMLIntelEMAAPIGuide–July202060100000000-0000-0000-0000-000000000000string00000000-0000-0000-0000-000000000000string00000000-0000-0000-0000-000000000000string11trueThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedClientCredentialsAccounto400:InvalidModelStateo401:Unauthorizedo500:InternalservererrorDELETE/api/v3/clientCredentials/{clientCredentialsId}TheDELETE/api/v3/clientCredentials/{clientCredentialsId}calldeletesClientCredentialsforaTenant.
(ClientCredentials_DeleteClientCredentials)Rolerequired:GlobalAdministratororTenantAdministrator.
ClientCredentialscanaccess:NoGlobalAdministratorscandeleteanyClientCredentialsaccount.
OnlyTenantAdministratorsthatsharethesameTenantIdwithaClientCredentialsaccountcandeleteit.
TherequestbodyisclientCredentialsId.
Responsetypes:o204:Successfulrequest,nocontento400:InvalidModelStateo401:Unauthorizedo404:Notfoundo500:InternalservererrorPUT/api/v3/clientCredentials/{clientCredentialsId}ThePUT/api/v3/clientCredentialscallupdatesClientCredentialsforaTenant.
(ClientCredentials_PutClientCredentials)Rolerequired:GlobalAdministratororTenantAdministrator.
ClientCredentialscanaccess:NoGlobalAdministratorscanupdateanyClientCredentialsaccount.
OnlyTenantAdministratorsthatsharethesameTenantIdwithaClientCredentialsaccountcanupdateit.
Parametersallowedtobeupdated:oClient_secretIntelEMAAPIGuide–July202061oTokenLifetimeHours-Min1,Max24,Default1oEnabledstatusClientSecretRequirements:oAtleast12charactersoContainsatleastonenumberoContainsbothlowercaseanduppercasealphacharactersoContainsatleastonespecialcharacterTherequestbodyisclientCredentialsId.
ThisistheClientCredentialsDTOobject.
{"client_secret":"string","tokenLifetimeHours":0,"enabled":true}Returntype:ClientCredentialsAccountExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{"id":0,"userId":"00000000-0000-0000-0000-000000000000","name":"string","client_id":"00000000-0000-0000-0000-000000000000","client_secret":"string","tenantId":"00000000-0000-0000-0000-000000000000","scope":"string","maxFailedLoginAttempts":0,"tokenLifetimeHours":0,"enabled":true}]oXML100000000-0000-0000-0000-000000000000string00000000-0000-0000-0000-000000000000string00000000-0000-0000-0000-000000000000string11trueThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheader.
oapplication/jsonotext/jsonoapplication/xmlIntelEMAAPIGuide–July202062otext/xmlResponsetypes:o200:Successfulrequest,contentreturnedClientCredentialsAccounto400:InvalidModelStateo401:Unauthorizedo404:Notfoundo500:Internalservererror3.
13CRLGET/api/v3/crlTheGET/api/v3/crlcallgetsaCertificateRevocationList.
(CRL_GetCRL)Rolerequired:GlobalAdministrator.
ClientCredentialscanaccess:NoReturntype:Application/octet-streamResponsetypes:o200:Successfulrequest,contentreturnedCRLfileo401:Unauthorizedo403:Forbiddeno500:InternalServerErrorPOST/api/v3/crl/AddCrlEntryThePOST/api/v3/crl/AddCrlEntrycalladdsanentrytotheCertificateRevocationList;i.
e.
,itrevokesacertificate.
(CRL_AddCrlEntry)Rolerequired:GlobalAdministrator.
ClientCredentialscanaccess:NoForserialnumberopenthecertificatetoseedetailsinWindowsandfindtheSerialnumber'shexvalue.
Followingaretheacceptedrevocationreasoncodes:oUnspecified(0)okeyCompromise(1)ocACompromise(2)oaffiliationChanged(3)osuperseded(4)ocessationOfOperation(5)ocertificateHold(6)oremoveFromCRL(8)oprivilegeWithdrawn(9)oaACompromise(10)IfrestartEmaComponentissettotrue,itwillimmediatelyrestartalltheIntelEMAserversandtheIISdefaultapppoolhostingtheIntelEMAWebsite.
TherequestbodyisCRLEntryandrestartEmaComponent.
ThisistheCRLEntryobject.
{"serialNumber":"string","reasonCode":0}Responsetypes:o204:Successfulrequest,nocontento400:InvalidModelStateo401:Unauthorizedo403:ForbiddenIntelEMAAPIGuide–July202063o500:InternalservererrorPOST/api/v3/crl/ResetCRLThePOST/api/v3/crl/ResetCRLcallresettheCertificateRevocationListtoemptyCRL.
(CRL_ResetCRL)Rolerequired:GlobalAdministrator.
ClientCredentialscanaccess:NoIfrestartEmaComponentissettotrue,itwillimmediatelyrestartalltheIntelEMAserversandtheIISdefaultapppoolhostingtheIntelEMAWebsite.
TherequestbodyisrestartEmaComponent.
Responsetypes:o204:Successfulrequest,nocontento401:Unauthorizedo403:Forbiddeno500:Internalservererror3.
14EndpointGroupsGET/api/v3/endpointGroupsTheGET/api/v3/endpointGroupscallgetsacollectionofEndpointGroupsummaries.
(EndpointGroups_GetSummariesCollection)Rolerequired:TenantAdministrator,orEndpointGroupCreatororEndpointGroupUserwithReadrighttotheresource.
ClientCredentialscanaccess:NoReturntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{"EndpointGroupId":"string","Name":"string","EndpointCount":0}]oXMLstringstring1ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:IntelEMAAPIGuide–July202064o200:Successfulrequest,contentreturnedEndpointGroupSummaryo500:InternalServerErrorPOST/api/v3/endpointGroupsThePOST/api/v3/endpointGroupscallcreatesanewEndpointGroup(EndpointGroups_Post)Rolerequired:TenantAdministratororEndpointGroupCreator.
ClientCredentialscanaccess:NoPasswordisneededwhentheendpoinggroup'spolicyneedstobemodified.
Currently,themodificationofthepolicyisnotsupportedyet.
Passwordrequirements:oatleast8charactersocontainsatleastonenumberocontainsbothlowercaseanduppercasealphacharactersocontainsatleastonespecialcharacterUserConsentKVM_Timeoutrequirements:otimeoutvaluemustfallbetween1and65otimeoutinsecondsothisvaluewillbetakeniftheAllowUserConsentKVMwebpermissionisenabledThepathparameterisNewEndpointGroup.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisNewEndpointGroup.
ThisistheEndpointGroupsobject.
{"Name":"string","Description":"string","Password":"string","UserConsentKVM_Timeout":0,"Permissions":{"AllowWakeup":true,"AllowSleep":true,"AllowReset":true,"AllowTcpCommunication":true,"AllowAlert":true,"AllowConsole":true,"AllowKvm":true,"AllowFileAccess":true,"AllowWmi":true,"AllowLocation":true,"AllowP2P":true,"AllowUserConsentKVM":true}}Returntype:EndpointGroupExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{IntelEMAAPIGuide–July202065"Name":"string","Description":"string","EndpointGroupId":"string","TenantId":"string","LastUpdated":"2019-08-01T20:05:00.
657Z","UserConsentKVM_Timeout":0,"Permissions":{"AllowWakeup":true,"AllowSleep":true,"AllowReset":true,"AllowTcpCommunication":true,"AllowAlert":true,"AllowConsole":true,"AllowKvm":true,"AllowFileAccess":true,"AllowWmi":true,"AllowLocation":true,"AllowP2P":true,"AllowUserConsentKVM":true}}oXMLstringstringstringstring1970-01-01T00:00:00.
001Z1truetruetruetruetruetruetruetruetruetruetruetrueThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:IntelEMAAPIGuide–July202066o200:Successfulrequest,contentreturnedEndpointGroupo400:InvalidModelStateo409:Conflicto500:InternalServerErrorGET/api/v3/endpointGroups/{endpointGroupId}TheGET/api/v3/endpointGroups/{endpointGroupId}callgetsthedetailsofaEndpointGroupbyID.
(EndpointGroups_GetEndpointGroupById)Rolerequired:TenantAdministrator,orEndpointGroupCreatororEndpointGroupUserwithReadrighttotheresource.
ClientCredentialscanaccess:NoThepathparameterisendpointGroupId.
Hexstringwith64charactersandwithoutthe0xprefixReturntype:EndpointGroupExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Name":"string","Description":"string","EndpointGroupId":"string","TenantId":"string","LastUpdated":"2019-08-01T20:05:00.
674Z","UserConsentKVM_Timeout":0,"Permissions":{"AllowWakeup":true,"AllowSleep":true,"AllowReset":true,"AllowTcpCommunication":true,"AllowAlert":true,"AllowConsole":true,"AllowKvm":true,"AllowFileAccess":true,"AllowWmi":true,"AllowLocation":true,"AllowP2P":true,"AllowUserConsentKVM":true}}oXMLstringstringstringstring1970-01-01T00:00:00.
001Z1truetruetrueIntelEMAAPIGuide–July202067truetruetruetruetruetruetruetruetrueThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointGroupo403:Forbiddeno404:Notfoundo500:InternalServerErrorPUT/api/v3/endpointGroups/{endpointGroupId}ThePUT/api/v3/endpointGroups/{endpointGroupId}callupdatesanEndpointGroup.
(EndpointGroups_Put)Rolerequired:TenantAdministratororEndpointGroupCreator.
ClientCredentialscanaccess:NoTheonlypropertythatcanbeupdatedisDescription.
ThepathparameterisEndpointGroupUpdate.
TheEndpointGroups.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointGroupUpdate.
ThisistheEndpointGroupsobject.
{"Description":"string","EndpointGroupId":"string"}Returntype:EndpointGroupExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Name":"string","Description":"string","EndpointGroupId":"string","TenantId":"string","LastUpdated":"2019-08-01T20:05:00.
683Z","UserConsentKVM_Timeout":0,IntelEMAAPIGuide–July202068"Permissions":{"AllowWakeup":true,"AllowSleep":true,"AllowReset":true,"AllowTcpCommunication":true,"AllowAlert":true,"AllowConsole":true,"AllowKvm":true,"AllowFileAccess":true,"AllowWmi":true,"AllowLocation":true,"AllowP2P":true,"AllowUserConsentKVM":true}}oXMLstringstringstringstring1970-01-01T00:00:00.
001Z1truetruetruetruetruetruetruetruetruetruetruetrueThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointGroupo400:BadRequesto403:Forbiddeno404:Notfoundo409:Conflicto500:InternalServerErrorIntelEMAAPIGuide–July202069DELETE/api/v3/endpointGroups/{endpointGroupId}TheDELETE/api/v3/endpointGroups/{endpointGroupId}calldeletesanEndpointGroup.
(EndpointGroups_Delete).
Rolerequired:TenantAdministratororEndpointGroupCreator.
ClientCredentialscanaccess:NoThepathparameterisendpointGroupId.
Hexstringwith64charactersandwithoutthe0xprefixResponsetypes:o204:Successfulrequest,nocontento403:Forbiddeno404:Notfoundo500:InternalservererrorGET/api/v3/endpointGroups/{endpointGroupId}/getMshFileTheGET/api/v3/endpointGroups/{endpointGroupId}/getMshFilecallgetsthe.
mshfileassociatedwithanEndpointGroup.
(EndpointGroups_GetMshFile).
Rolerequired:TenantAdministrator,orEndpointGroupCreatororEndpointGroupUserwithReadrighttotheresource.
ClientCredentialscanaccess:NoThepathparameterisendpointGroupId.
Hexstringwith64charactersandwithoutthe0xprefixThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedo403:Forbiddeno404:NotfoundGET/api/v3/endpointGroups/{endpointGroupId}/getUserAccessRightsTheGET/api/v3/endpointGroups/{endpointGroupId}/getUserAccessRightscallgetsthehighestaccessrightforaUsertoanEndpointGroup.
(EndpointGroups_GetMaxUserRightsByEndpointGroup)Rolerequired:TenantAdministrator,EndpointGroupCreatororEndpointGroupUser.
ClientCredentialscanaccess:NoTheaccessrightsthataUserhastoanEndpointGroupareobtainedbywayofmembershipinUserGroup(s)assignedtothatEndpointGroup.
ThepathparameterisendpointGroupId.
Hexstringwith64charactersandwithoutthe0xprefixReturntype:UserAccessRightsExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"AccessRightsId":0,"AccessRights":"string"}oXMLIntelEMAAPIGuide–July2020701stringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:SuccessfulrequestUserAccessRightso403:Forbiddeno404:Notfoundo500:Internalservererror3.
15EndpointIBOperationsPOST/api/v3/endpointIBOperations/rebootThePOST/api/v3/endpointIBOperations/rebootcallsubmitsbatchrequesttorebootEndpointsinband(EndpointIBOperations_Reboot)Rolesrequired:TenantAdministrator,EndpointGroupCreatororEndpointGroupUserClientCredentialscanaccess:YesTheactionmustbeallowedbytheEndpoint'sEndpointGroup.
WithanHTTP200,theresponselistwillcontainonlythoseEndpointIdsforwhicharequestwasputonthemessagebus.
EndpointIdsforwhicharequestwasnotputonthemessagebusforonereasonoranotherwillnotappearintheresponselist.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointGroupUpdate.
[{"EndpointId":"string"}]Returntype:EndpointOperationsListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{IntelEMAAPIGuide–July202071"EndpointId":"string"}],"NotFound":[{"EndpointId":"string"}],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}oXMLstringstringstringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerErrorPOST/api/v3/endpointIBOperations/sleepIntelEMAAPIGuide–July202072ThePOST/api/v3/endpointIBOperations/sleepcallsubmitsbatchrequesttosleepEndpointsinband(EndpointIBOperations_Sleep)Rolesrequired:TenantAdministrator,EndpointGroupCreatororEndpointGroupUserClientCredentialscanaccess:YesTheactionmustbeallowedbytheEndpoint'sEndpointGroup.
WithanHTTP200,theresponselistwillcontainonlythoseEndpointIdsforwhicharequestwasputonthemessagebus.
EndpointIdsforwhicharequestwasnotputonthemessagebusforonereasonoranotherwillnotappearintheresponselist.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointGroupUpdate.
ThisistheEndpointIBOperationsobject.
[{"EndpointId":"string"}]Returntype:EndpointOperationsListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}],"NotFound":[{"EndpointId":"string"}],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]IntelEMAAPIGuide–July202073}oXMLstringstringstringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerErrorPOST/api/v3/endpointIBOperations/hibernateThePOST/api/v3/endpointIBOperations/hibernatecallsubmitsbatchrequesttohibernateEndpointsinband(EndpointIBOperations_Hibernate)Rolesrequired:TenantAdministrator,EndpointGroupCreatororEndpointGroupUserClientCredentialscanaccess:YesTheactionmustbeallowedbytheEndpoint'sEndpointGroup.
WithanHTTP200,theresponselistwillcontainonlythoseEndpointIdsforwhicharequestwasputonthemessagebus.
EndpointIdsforwhicharequestwasnotputonthemessagebusforonereasonoranotherwillnotappearintheresponselist.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointGroupUpdate.
ThisistheEndpointIBOperationsobject.
[IntelEMAAPIGuide–July202074{"EndpointId":"string"}]Returntype:EndpointOperationsListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}],"NotFound":[{"EndpointId":"string"}],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}oXMLstringstringstringstringIntelEMAAPIGuide–July202075stringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerErrorPOST/api/v3/endpointIBOperations/shutdownThePOST/api/v3/endpointIBOperations/shutdowncallsubmitsbatchrequesttoshutdownEndpointsinband(EndpointIBOperations_Shutdown)Rolesrequired:TenantAdministrator,EndpointGroupCreatororEndpointGroupUserClientCredentialscanaccess:YesTheactionmustbeallowedbytheEndpoint'sEndpointGroup.
WithanHTTP200,theresponselistwillcontainonlythoseEndpointIdsforwhicharequestwasputonthemessagebus.
EndpointIdsforwhicharequestwasnotputonthemessagebusforonereasonoranotherwillnotappearintheresponselist.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointGroupUpdate.
ThisistheEndpointIBOperationsobject.
[{"EndpointId":"string"}]Returntype:EndpointOperationsListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}IntelEMAAPIGuide–July202076],"NotFound":[{"EndpointId":"string"}],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}oXMLstringstringstringstringstringoThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerErrorPOST/api/v3/endpointIBOperations/alertIntelEMAAPIGuide–July202077ThePOST/api/v3/endpointIBOperations/alertcallsubmitsbatchrequesttoalertEndpointsinband(EndpointIBOperations_Alert)Rolesrequired:TenantAdministrator,EndpointGroupCreatororEndpointGroupUserClientCredentialscanaccess:YesTheactionmustbeallowedbytheEndpoint'sEndpointGroup.
WithanHTTP200,theresponselistwillcontainonlythoseEndpointIdsforwhicharequestwasputonthemessagebus.
EndpointIdsforwhicharequestwasnotputonthemessagebusforonereasonoranotherwillnotappearintheresponselist.
Onreceivinganalert,anEndpoint'sdesktopwillpopupaMessageBoxthatclosesafteraspecifiedduration.
ThepathparameterisAlertRequest.
AnobjectcontainingalistofEndpointstowhichanalertwillpopupwithindicatedmessageandforaspecifiedduration.
oMessage:Allowedcharacters:space,enter,0-9,a-z,A-Z.
Maximumlength:510.
oDuration(seconds):Anumberbetween0and300,with0forindefinite.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisAlertRequest.
ThisistheEndpointIBOperationsobject.
{"EndpointIds":[{"EndpointId":"string"}],"Message":"string","Duration":0}Returntype:EndpointOperationsListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}],"NotFound":[{"EndpointId":"string"}],"BadRequest":[IntelEMAAPIGuide–July202078{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}oXMLstringstringstringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerError3.
16EndpointOOBOperationsPOST/api/v3/endpointOOBOperations/Multiple/PowerOnThePOST/api/v3/endpointOOBOperations/Multiple/PowerOncallsubmitsabatchrequesttoperformanoutofbandPowerOnoperationonmultipleendpoints(EndpointOOBOperations_MultiplePowerOn)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesWithanHTTP200,theresponselistwillcontainthoseEndpointIdsforwhicharequestwasputonthemessagebusinAcceptedlist.
IntelEMAAPIGuide–July202079ItwillsendalsoaWakeonLAN(WOL)requesttoalllistedendpoints,butonlyIntel(R)vPro(TM)endpointsareofficiallysupported.
EndpointIdsforwhicharequestwasnotputonthemessagebuswillappearintheForbidden,NotFound,BadRequestorInternalServerErrorlist,dependingonthecase.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisAlertRequest.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]Returntype:EndpointOperationsListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}],"NotFound":[{"EndpointId":"string"}],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}oXMLIntelEMAAPIGuide–July202080stringstringstringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Multiple/Sleep/LightThePOST/api/v3/endpointOOBOperations/Multiple/Sleep/LightcallsubmitsabatchrequesttoperformanoutofbandSleeplightoperationonmultipleendpoints(EndpointOOBOperations_MultipleSleepLight)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesWithanHTTP200,theresponselistwillcontainthoseEndpointIdsforwhicharequestwasputonthemessagebusinAcceptedlist.
EndpointIdsforwhicharequestwasnotputonthemessagebuswillappearintheForbidden,NotFound,BadRequestorInternalServerErrorlist,dependingonthecase.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisAlertRequest.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]Returntype:EndpointOperationsListIntelEMAAPIGuide–July202081Exampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}],"NotFound":[{"EndpointId":"string"}],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}oXMLstringstringstringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-TyperesponseheaderIntelEMAAPIGuide–July202082oapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Multiple/Sleep/DeepThePOST/api/v3/endpointOOBOperations/Multiple/Sleep/DeepcallsubmitsabatchrequesttoperformanoutofbandSleepDeepoperationonmultipleendpoints(EndpointOOBOperations_MultipleSleepDeep)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesWithanHTTP200,theresponselistwillcontainthoseEndpointIdsforwhicharequestwasputonthemessagebusinAcceptedlist.
EndpointIdsforwhicharequestwasnotputonthemessagebuswillappearintheForbidden,NotFound,BadRequestorInternalServerErrorlist,dependingonthecase.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisAlertRequest.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]Returntype:EndpointOperationsListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}],"NotFound":[{"EndpointId":"string"}IntelEMAAPIGuide–July202083],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}oXMLstringstringstringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Multiple/PowerCycle/OffSoftThePOST/api/v3/endpointOOBOperations/Multiple/PowerCycle/OffSoftcallsubmitsabatchrequesttoperformanoutofbandPowerCycle(Offsoft)operationonmultipleendpoints(EndpointOOBOperations_MultiplePowerCycleOffSoft)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesIntelEMAAPIGuide–July202084WithanHTTP200,theresponselistwillcontainthoseEndpointIdsforwhicharequestwasputonthemessagebusinAcceptedlist.
EndpointIdsforwhicharequestwasnotputonthemessagebuswillappearintheForbidden,NotFound,BadRequestorInternalServerErrorlist,dependingonthecase.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisAlertRequest.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]Returntype:EndpointOperationsListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}],"NotFound":[{"EndpointId":"string"}],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}oXMLIntelEMAAPIGuide–July202085stringstringstringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Multiple/PowerOff/HardThePOST/api/v3/endpointOOBOperations/Multiple/PowerOff/HardcallsubmitsabatchrequesttoperformanoutofbandPoweroff-Hardoperationonmultipleendpoints(EndpointOOBOperations_MultiplePowerOffHard)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesWithanHTTP200,theresponselistwillcontainthoseEndpointIdsforwhicharequestwasputonthemessagebusinAcceptedlist.
EndpointIdsforwhicharequestwasnotputonthemessagebuswillappearintheForbidden,NotFound,BadRequestorInternalServerErrorlist,dependingonthecase.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisAlertRequest.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]IntelEMAAPIGuide–July202086Returntype:EndpointOperationsListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}],"NotFound":[{"EndpointId":"string"}],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}oXMLstringstringstringstringstringIntelEMAAPIGuide–July202087ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Multiple/HibernateThePOST/api/v3/endpointOOBOperations/Multiple/HibernatecallsubmitsabatchrequesttoperformanoutofbandHibernateoperationonmultipleendpoints(EndpointOOBOperations_MultipleHibernate)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesWithanHTTP200,theresponselistwillcontainthoseEndpointIdsforwhicharequestwasputonthemessagebusinAcceptedlist.
EndpointIdsforwhicharequestwasnotputonthemessagebuswillappearintheForbidden,NotFound,BadRequestorInternalServerErrorlist,dependingonthecase.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisAlertRequest.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]Returntype:EndpointOperationsListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}],"NotFound":[{IntelEMAAPIGuide–July202088"EndpointId":"string"}],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}oXMLstringstringstringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Multiple/PowerOff/SoftThePOST/api/v2/endpointOOBOperations/Multiple/PowerOff/SoftcallsubmitsabatchrequesttoperformanoutofbandPowerOff-Softoperationonmultipleendpoints(EndpointOOBOperations_MultiplePowerOffSoft)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
IntelEMAAPIGuide–July202089ClientCredentialscanaccess:YesWithanHTTP200,theresponselistwillcontainthoseEndpointIdsforwhicharequestwasputonthemessagebusinAcceptedlist.
EndpointIdsforwhicharequestwasnotputonthemessagebuswillappearintheForbidden,NotFound,BadRequestorInternalServerErrorlist,dependingonthecase.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisAlertRequest.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]Returntype:EndpointOperationsListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}],"NotFound":[{"EndpointId":"string"}],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}oXMLIntelEMAAPIGuide–July202090stringstringstringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Multiple/PowerCycle/OffHardThePOST/api/v3/endpointOOBOperations/Multiple/PowerCycle/OffHardcallsubmitsabatchrequesttoperformanoutofbandPowerCycle(Offhard)operationonmultipleendpoints(EndpointOOBOperations_MultiplePowerCycleOffHard)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesWithanHTTP200,theresponselistwillcontainthoseEndpointIdsforwhicharequestwasputonthemessagebusinAcceptedlist.
EndpointIdsforwhicharequestwasnotputonthemessagebuswillappearintheForbidden,NotFound,BadRequestorInternalServerErrorlist,dependingonthecase.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisAlertRequest.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}IntelEMAAPIGuide–July202091]Returntype:EndpointOperationsListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}],"NotFound":[{"EndpointId":"string"}],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}oXMLstringstringstringstringstringIntelEMAAPIGuide–July202092ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Multiple/MasterBusResetThePOST/api/v3/endpointOOBOperations/Multiple/MasterBusResetcallsubmitsabatchrequesttoperformanoutofbandMasterBusResetoperationonmultipleendpoints(EndpointOOBOperations_MultipleMasterBusReset)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesWithanHTTP200,theresponselistwillcontainthoseEndpointIdsforwhicharequestwasputonthemessagebusinAcceptedlist.
EndpointIdsforwhicharequestwasnotputonthemessagebuswillappearintheForbidden,NotFound,BadRequestorInternalServerErrorlist,dependingonthecase.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisAlertRequest.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]Returntype:EndpointOperationsListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}],"NotFound":[IntelEMAAPIGuide–July202093{"EndpointId":"string"}],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}oXMLstringstringstringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Multiple/PowerOff/SoftGracefulThePOST/api/v3/endpointOOBOperations/Multiple/PowerOff/SoftGracefulcallsubmitsabatchrequesttoperformanoutofbandPowerOff-SoftGracefuloperationonmultipleendpoints(EndpointOOBOperations_MultiplePowerOffSoftGraceful)IntelEMAAPIGuide–July202094Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesWithanHTTP200,theresponselistwillcontainthoseEndpointIdsforwhicharequestwasputonthemessagebusinAcceptedlist.
EndpointIdsforwhicharequestwasnotputonthemessagebuswillappearintheForbidden,NotFound,BadRequestorInternalServerErrorlist,dependingonthecase.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisAlertRequest.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]Returntype:EndpointOperationsListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}],"NotFound":[{"EndpointId":"string"}],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}oXMLIntelEMAAPIGuide–July202095stringstringstringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Multiple/PowerOff/HardGracefulThePOST/api/v3/endpointOOBOperations/Multiple/PowerOff/HardGracefulcallsubmitsabatchrequesttoperformanoutofbandPowerOff-HardGracefuloperationonmultipleendpoints(EndpointOOBOperations_MultiplePowerOffHardGraceful)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesWithanHTTP200,theresponselistwillcontainthoseEndpointIdsforwhicharequestwasputonthemessagebusinAcceptedlist.
EndpointIdsforwhicharequestwasnotputonthemessagebuswillappearintheForbidden,NotFound,BadRequestorInternalServerErrorlist,dependingonthecase.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisAlertRequest.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"IntelEMAAPIGuide–July202096}]Returntype:EndpointOperationsListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}],"NotFound":[{"EndpointId":"string"}],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}oXMLstringstringstringstringstringIntelEMAAPIGuide–July202097ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Multiple/MasterBusReset/GracefulThePOST/api/v3/endpointOOBOperations/Multiple/MasterBusReset/GracefulcallsubmitsabatchrequesttoperformanoutofbandMasterBusResetGracefuloperationonmultipleendpoints(EndpointOOBOperations_MultipleMasterBusResetGraceful)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesWithanHTTP200,theresponselistwillcontainthoseEndpointIdsforwhicharequestwasputonthemessagebusinAcceptedlist.
EndpointIdsforwhicharequestwasnotputonthemessagebuswillappearintheForbidden,NotFound,BadRequestorInternalServerErrorlist,dependingonthecase.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisAlertRequest.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]Returntype:EndpointOperationsListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}],IntelEMAAPIGuide–July202098"NotFound":[{"EndpointId":"string"}],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}oXMLstringstringstringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Multiple/PowerCycle/OffSoftGracefulThePOST/api/v3/endpointOOBOperations/Multiple/PowerCycle/OffSoftGracefulcallsubmitsabatchrequesttoperformanoutofbandPowerCycle(Off-SoftGraceful)operationonmultipleendpoints(EndpointOOBOperations_MultiplePowerCycleOffSoftGraceful)IntelEMAAPIGuide–July202099Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesWithanHTTP200,theresponselistwillcontainthoseEndpointIdsforwhicharequestwasputonthemessagebusinAcceptedlist.
EndpointIdsforwhicharequestwasnotputonthemessagebuswillappearintheForbidden,NotFound,BadRequestorInternalServerErrorlist,dependingonthecase.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisAlertRequest.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]Returntype:EndpointOperationsListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}],"NotFound":[{"EndpointId":"string"}],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}oXMLIntelEMAAPIGuide–July2020100{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}],"NotFound":[{"EndpointId":"string"}],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Multiple/PowerCycle/OffHardGracefulThePOST/api/v3/endpointOOBOperations/Multiple/PowerCycle/OffHardGracefulcallsubmitsabatchrequesttoperformanoutofbandPowerCycle(Off-HardGraceful)operationonmultipleendpoints(EndpointOOBOperations_MultiplePowerCycleOffHardGraceful)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesWithanHTTP200,theresponselistwillcontainthoseEndpointIdsforwhicharequestwasputonthemessagebusinAcceptedlist.
EndpointIdsforwhicharequestwasnotputonthemessagebuswillappearintheForbidden,NotFound,BadRequestorInternalServerErrorlist,dependingonthecase.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonIntelEMAAPIGuide–July2020101otext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisAlertRequest.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]Returntype:EndpointOperationsListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Accepted":[{"EndpointId":"string"}],"Forbidden":[{"EndpointId":"string"}],"NotFound":[{"EndpointId":"string"}],"BadRequest":[{"EndpointId":"string"}],"InternalServerError":[{"EndpointId":"string"}]}oXMLstringstringIntelEMAAPIGuide–July2020102stringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointOperationsListo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Single/PowerOnThePOST/api/v3/endpointOOBOperations/Single/PowerOncallsubmitsarequesttoperformanoutofbandPowerOnoperation(EndpointOOBOperations_SinglePowerOn)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesThepathparameterisEndpointIdDTOEndpointIdobjectThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointIdDTO.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedo400:InvalidModelStateo403:UsernotallowedtoexecuteoperationIntelEMAAPIGuide–July2020103o409:Endpointnotreadytoexecuteoperationyeto500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Single/Sleep/LightThePOST/api/v3/endpointOOBOperations/Single/Sleep/LightcallsubmitsarequesttoperformanoutofbandSleepLightoperation(EndpointOOBOperations_SingleSleepLight)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesThepathparameterisEndpointIdDTO.
EndpointIdobjectThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointIdDTO.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo409:Endpointnotreadytoexecuteoperationyeto500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Single/Sleep/DeepThePOST/api/v3/endpointOOBOperations/Single/Sleep/DeepcallsubmitsarequesttoperformanoutofbandSleepDeepoperation(EndpointOOBOperations_SingleSleepDeep)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesThepathparameterisEndpointIdDTO.
EndpointIdobjectThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointIdDTO.
ThisistheEndpointOOBOperationsobject.
IntelEMAAPIGuide–July2020104[{"EndpointId":"string"}]ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo409:Endpointnotreadytoexecuteoperationyeto500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Single/PowerCycle/OffSoftThePOST/api/v3/endpointOOBOperations/Single/PowerCycle/OffSoftcallsubmitsarequesttoperformanoutofbandPowerCycle(OffSoft)operation(EndpointOOBOperations_SinglePowerCycleOffSoft)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesThepathparameterisEndpointIdDTO.
EndpointIdobjectThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointIdDTO.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo409:Endpointnotreadytoexecuteoperationyeto500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Single/PowerOff/HardIntelEMAAPIGuide–July2020105ThePOST/api/v3/endpointOOBOperations/Single/PowerOff/HardcallsubmitsarequesttoperformanoutofbandPowerOff-Hardoperation(EndpointOOBOperations_SinglePowerOffHard)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesThepathparameterisEndpointIdDTO.
EndpointIdobjectThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointIdDTO.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo409:Endpointnotreadytoexecuteoperationyeto500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Single/HibernateThePOST/api/v3/endpointOOBOperations/Single/HibernatecallsubmitsarequesttoperformanoutofbandHibernateoperation(EndpointOOBOperations_SingleHibernate)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesThepathparameterisEndpointIdDTO.
EndpointIdobjectThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointIdDTO.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}IntelEMAAPIGuide–July2020106]ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo409:Endpointnotreadytoexecuteoperationyeto500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Single/PowerOff/SoftThePOST/api/v3/endpointOOBOperations/Single/PowerOff/SoftcallsubmitsarequesttoperformanoutofbandPowerOff-Softoperation(EndpointOOBOperations_SinglePowerOffSoft)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesThepathparameterisEndpointIdDTO.
EndpointIdobjectThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointIdDTO.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo409:Endpointnotreadytoexecuteoperationyeto500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Single/PowerCycle/OffHardThePOST/api/v3/endpointOOBOperations/Single/PowerCycle/OffHardcallsubmitsarequesttoperformanoutofbandPowerCycle(OffHard)operation(EndpointOOBOperations_SinglePowerCycleOffHard)IntelEMAAPIGuide–July2020107Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesThepathparameterisEndpointIdDTO.
EndpointIdobjectThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointIdDTO.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo409:Endpointnotreadytoexecuteoperationyeto500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Single/MasterBusResetThePOST/api/v3/endpointOOBOperations/Single/MasterBusResetcallsubmitsarequesttoperformanoutofbandMasterBusResetoperation(EndpointOOBOperations_SingleMasterBusReset)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesThepathparameterisEndpointIdDTO.
EndpointIdobjectThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointIdDTO.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-TyperesponseheaderIntelEMAAPIGuide–July2020108oapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo409:Endpointnotreadytoexecuteoperationyeto500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Single/PowerOff/SoftGracefulThePOST/api/v3/endpointOOBOperations/Single/PowerOff/SoftGracefulcallsubmitsarequesttoperformanoutofbandPowerOff-SoftGracefuloperation(EndpointOOBOperations_SinglePowerOffSoftGraceful)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesThepathparameterisEndpointIdDTO.
EndpointIdobjectThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointIdDTO.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo409:Endpointnotreadytoexecuteoperationyeto500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Single/PowerOff/HardGracefulThePOST/api/v3/endpointOOBOperations/Single/PowerOff/HardGracefulcallsubmitsarequesttoperformanoutofbandPowerOff-HardGracefuloperation(EndpointOOBOperations_SinglePowerOffHardGraceful)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesThepathparameterisEndpointIdDTO.
EndpointIdobjectIntelEMAAPIGuide–July2020109ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointIdDTO.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo409:Endpointnotreadytoexecuteoperationyeto500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Single/MasterBusReset/GracefulThePOST/api/v3/endpointOOBOperations/Single/MasterBusReset/GracefulcallsubmitsarequesttoperformanoutofbandMasterBusResetGracefuloperations(EndpointOOBOperations_SingleMasterBusResetGraceful)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesThepathparameterisEndpointIdDTO.
EndpointIdobjectThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointIdDTO.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlIntelEMAAPIGuide–July2020110otext/xmlResponsetypes:o200:Successfulrequest,contentreturnedo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo409:Endpointnotreadytoexecuteoperationyeto500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Single/PowerCycle/OffSoftGracefulThePOST/api/v3/endpointOOBOperations/Single/PowerCycle/OffSoftGracefulcallsubmitsarequesttoperformanoutofbandPowerCycle(Off-SoftGraceful)operations(EndpointOOBOperations_SinglePowerCycleOffSoftGraceful)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesThepathparameterisEndpointIdDTO.
EndpointIdobjectThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointIdDTO.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo409:Endpointnotreadytoexecuteoperationyeto500:InternalServerErrorPOST/api/v3/endpointOOBOperations/Single/PowerCycle/OffHardGracefulThePOST/api/v3/endpointOOBOperations/Single/PowerCycle/OffHardGracefulcallsubmitsarequesttoperformanoutofbandPowerCycle(Off-HardGraceful)operation(EndpointOOBOperations_SinglePowerCycleOffHardGraceful)Rolesrequired:TenantAdministrator,userinaUserGroupwithExecuteprivilegesassociatedtotargetEndpointGroup.
ClientCredentialscanaccess:YesThepathparameterisEndpointIdDTO.
EndpointIdobjectThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonIntelEMAAPIGuide–July2020111otext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisEndpointIdDTO.
ThisistheEndpointOOBOperationsobject.
[{"EndpointId":"string"}]ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedo400:InvalidModelStateo403:Usernotallowedtoexecuteoperationo409:Endpointnotreadytoexecuteoperationyeto500:InternalServerError3.
17EndpointsGET/api/v3/endpoints/{endpointId}TheGET/api/v3/endpoints/{endpointId}callgetsthedetailsofanEndpointbyID(Endpoints_GetById)Rolerequired:TenantAdministrator,orEndpointGroupCreatororEndpointGroupUserwithReadrighttotheresource.
ClientCredentialscanaccess:YesThepathparameterisendpointId.
Hexstringwith64charactersandwithoutthe0xprefixReturntype:EndpointExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"EndpointId":"string","EndpointGroupId":"string","EndpointGroupName":"string","LastUpdate":"2019-08-01T20:05:01.
006Z","ComputerName":"string","PlatformType":0,"AgentVersion":"string","AgentType":"string","PowerState":0,"PowerStateUpdate":"2019-08-01T20:05:01.
006Z","IsConnected":true,"IsCiraConnected":true,"NodeIdentity":0,"OperatingSystem":"string","NeighborsCount":0,IntelEMAAPIGuide–July2020112"AgentLocalAdminMode":"unknown","NetworkInterfaces":[{"IPv4Address":"string","IPv6Address":"string","Subnet":"string","Gateway":"string","DnsSuffix":"string","Mac":"string","GatewayMac":"string","Description":"string"}],"MEInfo":{"VersionString":"string","IsAmtEnabled":true,"CiraEnabled":true,"AmtProvisioningState":"pre","AmtProvisioningMode":"adminControlMode","AmtControlMode":"notprovisioned","MEVersion":"string","MEFWBuildNumber":0,"IsEHBC":true,"IsAmtVersionValid":true,"Version":0}}oXMLstringstringstring1970-01-01T00:00:00.
001Zstring1stringstring11970-01-01T00:00:00.
001Ztruetrue1string1unknownstringstringstringstringIntelEMAAPIGuide–July2020113stringstringstringstringstringtruetruepreadminControlModenotprovisionedstring1truetrue1ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointo400:BadRequesto403:Forbiddeno404:Notfoundo500:InternalservererrorGET/api/v3/endpoints/{endpointId}/HardwareInfoFromAmtTheGET/api/v3/endpoints/{endpointId}callgetstheHardwareinformationofanEndpointusingIdandAMTconnection(Endpoints_GetById)Rolerequired:TenantAdministrator,orEndpointGroupCreatororEndpointGroupUserwithReadrighttotheresource.
ClientCredentialscanaccess:YesTheReturncodeNotFoundmeansendpointdoesn'texistorhardwareinformationforitisnotfoundastheendpointdoesn'tsupportAMTrequests.
Returntype:EndpointExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"AmtPlatformInfo":{"ComputerModel":"string","ManufacturerName":"string","SerialNumber":"string","VersionNumber":"string","SystemId":"00000000-0000-0000-0000-000000000000"},IntelEMAAPIGuide–July2020114"AmtBaseBoardInfo":{"ManufacturerName":"string","ProductName":"string","VersionNumber":"string","SerialNumber":"string","AssetTag":"string","IsReplaceable":true},"AmtBiosInfo":{"ManufacturerName":"string","VersionNumber":"string","ReleaseDate":"string"},"AmtMemoryModuleInfo":[{"BankLabel":"string","ManufacturerName":"string","SerialNumber":"string","Size":0,"FormFactor":"string","MemoryType":"string","AssetTag":"string","PartNumber":"string"}]}oXMLstringstringstringstring00000000-0000-0000-0000-000000000000stringstringstringstringstringtruestringstringstringstringstringIntelEMAAPIGuide–July2020115string1stringstringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointo400:BadRequesto403:Forbiddeno404:Notfoundo409:Conflicto500:InternalservererrorDELETE/api/v3/endpoints/{endpointId}TheDELETE/api/v3/endpoints/{endpointId}calldeletesanEndpointbyID(Endpoints_Delete)Rolerequired:TenantAdministrator,orEndpointGroupCreatororEndpointGroupUserwithDeleterighttotheresource.
ClientCredentialscanaccess:NoThepathparameterisendpointId.
Hexstringwith64charactersandwithoutthe0xprefixResponsetypes:o204:Successfulrequest,nocontento403:Forbiddeno404:Notfoundo500:InternalservererrorGET/api/v3/endpointsTheGET/api/v3/endpointscallgetacollectionofEndpointsummaries,filterablebyEndpointGroupIdorHostName.
(Endpoints_GetSummariesCollection)Rolerequired:TenantAdministrator,EndpointGroupCreator,orEndpointGroupUser.
ClientCredentialscanaccess:YesIfendpointGroupIdisnotspecifiedorempty,getacollectionofEndpointsummariesforallendpointgroupsthatthisuserhasaccessto.
TheparameterscanbeendpointGroupId,computerName,computerNameStartsWithandcomputerNameContains.
Returntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{"EndpointId":"string","EndpointGroupId":"string","EndpointGroupName":"string",IntelEMAAPIGuide–July2020116"LastUpdate":"2019-08-01T20:05:01.
017Z","MEVersion":"string","ComputerName":"string","PlatformType":0,"AgentVersion":0,"AgentIdentifier":0,"MEFWBuildNumber":0,"PowerState":0,"PowerStateUpdate":"2019-08-01T20:05:01.
017Z","IsConnected":true,"NodeIdentity":0,"IsAmtVersionValid":true,"AmtControlMode":"notprovisioned","AmtProvisioningState":"pre","AmtProvisioningMode":"adminControlMode","IsCiraConnected":true}]oXMLstringstringstring1970-01-01T00:00:00.
001Zstringstring111111970-01-01T00:00:00.
001Ztrue1truenotprovisionedpreadminControlModetrueThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedEndpointSummaryo400:BadRequestIntelEMAAPIGuide–July2020117o404:Notfoundo500:Internalservererror3.
18NetworkInterfacesGET/api/v3/networkInterfacesTheGET/api/v3/networkInterfacescallgetsacollectionofnetworkinterfacesoftheIntelEMAserver.
(NetworkInterfaces_GetNetworkInterfacesInfo)Rolerequired:GlobalAdministratororTenantAdministratorClientCredentialscanaccess:NoReturntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{"IPv4Address":"string","IPv6Address":"string","Subnet":"string","Gateway":"string","DnsSuffix":"string","Mac":"string","GatewayMac":"string","Description":"string"}]oXMLstringstringstringstringstringstringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedNetworkInterfaceo500:Internalservererror3.
19RolesIntelEMAAPIGuide–July2020118GET/api/v3/rolesTheGET/api/v3/rolescallgetsacollectionofRoles.
(Roles_GetAll)Rolerequired:GlobalAdministrator,TenantAdministrator,orAccountManager.
ClientCredentialscanaccess:NoReturntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{"RoleId":0,"Name":"string","Description":"string","LastUpdated":"2019-08-01T20:05:01.
030Z","Enabled":true,"TenantId":"00000000-0000-0000-0000-000000000000"}]oXML1stringstring1970-01-01T00:00:00.
001Ztrue00000000-0000-0000-0000-000000000000ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedRoleo500:InternalServerErrorGET/api/v3/roles/{roleId}TheGET/api/v3/roles/{roleId}callgetsthedetailsofaRolebyID.
(Roles_GetRole)Rolerequired:GlobalAdministrator,TenantAdministrator,orAccountManager.
ClientCredentialscanaccess:NoThepathparameterisroleId.
RoleIDReturntype:RoleExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{IntelEMAAPIGuide–July2020119"RoleId":0,"Name":"string","Description":"string","LastUpdated":"2019-08-01T20:05:01.
035Z","Enabled":true,"TenantId":"00000000-0000-0000-0000-000000000000"}oXML1stringstring1970-01-01T00:00:00.
001Ztrue00000000-0000-0000-0000-000000000000ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedRoleo403:Forbiddeno404:Notfoundo500:InternalServerError3.
20ServerCertificatesGET/api/v3/serverCertificatesTheGET/api/v3/serverCertificatescallgetsacollectionofservercertificates.
Rolerequired:GlobalAdministrator.
ClientCredentialscanaccess:NoReturntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{"Name":"string","CommonName":"string","NotBefore":"2020-06-23T20:12:17.
786Z","NotAfter":"2020-06-23T20:12:17.
786Z","HasPrivateKey":true,"Thumbprint":"string","Pem":"string","LastModified":"2020-06-23T20:12:17.
786Z"}IntelEMAAPIGuide–July2020120]oXMLstringstring1970-01-01T00:00:00.
001Z1970-01-01T00:00:00.
001Ztruestringstring1970-01-01T00:00:00.
001ZThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedListofServerCertificateso401:Unauthorizedo403:Forbiddeno500:InternalServerErrorGET/api/v3/serverCertificates/{certificateName}TheGET/api/v3/serverCertificates/{certificateName}callgetsacertificatebynameRolerequired:GlobalAdministrator.
ClientCredentialscanaccess:NoThepathparameteriscertificateName.
Returntype:CertificateExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Name":"string","CommonName":"string","NotBefore":"2020-06-23T20:12:17.
791Z","NotAfter":"2020-06-23T20:12:17.
791Z","HasPrivateKey":true,"Thumbprint":"string","Pem":"string","LastModified":"2020-06-23T20:12:17.
791Z"}oXMLIntelEMAAPIGuide–July2020121stringstring1970-01-01T00:00:00.
001Z1970-01-01T00:00:00.
001Ztruestringstring1970-01-01T00:00:00.
001ZThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedServercertificateo401:Unauthorizedo403:Forbiddeno404:Notfoundo500:InternalServerErrorGET/api/v3/serverCertificates/{certificateName}/getFileTheGET/api/v3/serverCertificates/{certificateName}/getFilecallgetsthe.
CERfileofaservercertificatebynameRolerequired:GlobalAdministrator.
ClientCredentialscanaccess:NoThepathparameteristhefilenameofthe.
CERfile.
ThecertificatenameusedinIntel(R)EMAdatabase.
Thisisnotthesubjectnameorthecommonname.
Returntype:Application/octet-streamThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,attachmentreturnedo401:Unauthorizedo403:Forbiddeno404:Notfoundo500:InternalServerError3.
21ServerSettingsGET/api/v3/serverSettings/amtDiscoverySettingsTheGET/api/v3/serverSettings/amtDiscoverySettingscallgetsatheautomaticIntelAMTdiscoverysettingsoftheManageabilityserver.
(ServerSettings_GetAmtDiscoverySettings)Rolerequired:GlobalAdministratororTenantAdministrator.
ClientCredentialscanaccess:NoTenatIdcorrespondstotheTenantAdministratorwhosubmittedtheautomaticIntelAMTdiscoveryrequest.
IntelEMAAPIGuide–July2020122Returntype:AutomaticAMTDiscoverySettingsExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Interval":0,"Type":"singleIP","TypeStr":"string","MAC":"string","FirstIPAddress":"string","EndRangeIPAddress":"string","SubnetMask":"string","TenantId":"string"}oXML1singleIPstringstringstringstringstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAutomaticAMTDiscoverySettingso500:InternalservererrorGET/api/v3/serverSettings/ajaxServerTheGET/api/v3/serverSettings/ajaxServercallgetsthesettingsoftheAjaxserver.
(ServerSettings_GetAjaxServerSettings)Rolerequired:GlobalAdministrator.
ClientCredentialscanaccess:NoThepathparameterisServerName.
Returntype:AjaxServerSettingExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Name":"string","Data":{"ajaxCookieAutoRefreshRange":0,IntelEMAAPIGuide–July2020123"ajaxCookieIdleTimeout":0,"httpheader_Access-Control-Allow-Headers":"string","logfilepath":"string","maxdbconnections":0,"swarmserver":[{"ServerID":0,"EndPoint":"string"}],"userAccessFailedMaxCount":0,"expiresessions":true,"serverIps":["string"],"messagePort":0},"ModifiedOn":"2020-06-12T16:14:31.
811Z"}oXMLstring11stringstring11string1truestring11970-01-01T00:00:00.
001ZThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAjaxServerSettingo403:Forbiddeno404:Notfoundo500:InternalservererrorIntelEMAAPIGuide–July2020124PUT/api/v3/serverSettings/ajaxServerThePUT/api/v3/serverSettings/ajaxServercallsetsthesettingsoftheAjaxserver.
(ServerSettings_PutAjaxServerSettings)Rolerequired:GlobalAdministrator.
ClientCredentialscanaccess:NoRestartserviceindicateswhethertorestarttheAjaxServerornot,aschangestoitsconfigurationareappliedonlywhentheserviceisrestarted.
ThepathparameterisServerName,AjaxServerSettingandrestartEMAService.
ThisistheAjaxServerSettingobject.
{"ajaxCookieAutoRefreshRange":0,"ajaxCookieIdleTimeout":0,"httpheader_Access-Control-Allow-Headers":"string","logfilepath":"string","maxdbconnections":0,"swarmserver":[{"ServerID":0,"EndPoint":"string"}],"userAccessFailedMaxCount":0,"expiresessions":true,"serverIps":["string"],"messagePort":0}Returntype:AjaxServerSettingExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Name":"string","Data":{"ajaxCookieAutoRefreshRange":0,"ajaxCookieIdleTimeout":0,"httpheader_Access-Control-Allow-Headers":"string","logfilepath":"string","maxdbconnections":0,"swarmserver":[{"ServerID":0,"EndPoint":"string"}],"userAccessFailedMaxCount":0,"expiresessions":true,"serverIps":["string"],IntelEMAAPIGuide–July2020125"messagePort":0},"ModifiedOn":"2020-06-12T16:14:31.
811Z"}oXMLstring11stringstring11string1truestring11970-01-01T00:00:00.
001ZThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedAjaxServerSettingo400:BadRequesto403:Forbiddeno404:Notfoundo500:InternalservererrorGET/api/v3/serverSettings/manageabilityServerTheGET/api/v3/serverSettings/manageabilityServercallgetsthesettingsoftheManageabilityserver.
(ServerSettings_GetManageabilityServerSettings)Rolerequired:GlobalAdministrator.
ClientCredentialscanaccess:NoThepathparameterisServerName.
Returntype:ManageabilityServerSettingExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Name":"string",IntelEMAAPIGuide–July2020126"Data":{"ciraserver_ip":"string","ciraserver_host":"string","ciraserver_port":0,"logfilepath":"string","maxdbconnections":0,"swarmserver":[{"ServerID":0,"EndPoint":"string"}],"serverIps":["string"],"messagePort":0,"usbrImagesRootDirectory":"string","maxUsbrImageStorageCapacityPerTenantInGigabytes":0,"maxUsbrSlotCountPerTenant":0,"maxUsbrIdleTimeInMinutes":0,"usbrRedirectionManagerLoopIntervalInSeconds":0,"fileUploadRetentionPeriodInDays":0,"fileUploadCleanupIntervalInHours":0},"ModifiedOn":"2020-06-12T16:14:31.
811Z"}oXMLstringstringstring1string11stringstring1string1111IntelEMAAPIGuide–July2020127111970-01-01T00:00:00.
001ZThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedManageabilityServerSettingo403:Forbiddeno404:Notfoundo500:InternalservererrorPUT/api/v3/serverSettings/manageabilityServerThePUT/api/v3/serverSettings/manageabilityServercallsetsthesettingsoftheManageabilityserver.
(ServerSettings_PutManageabilityServerSettings)Rolerequired:GlobalAdministrator.
ClientCredentialscanaccess:NoRestartserviceindicateswhethertorestarttheManageabilityServerornot,aschangestoitsconfigurationareappliedonlywhentheserviceisrestarted.
ThepathparameterisServerName,ManageabilityServerSettingandrestartEMAService.
ThisistheManageabilityServerSettingobject.
{"ciraserver_ip":"string","ciraserver_host":"string","ciraserver_port":0,"logfilepath":"string","maxdbconnections":0,"swarmserver":[{"ServerID":0,"EndPoint":"string"}],"serverIps":["string"],"messagePort":0,"usbrImagesRootDirectory":"string","maxUsbrImageStorageCapacityPerTenantInGigabytes":0,"maxUsbrSlotCountPerTenant":0,"maxUsbrIdleTimeInMinutes":0,"usbrRedirectionManagerLoopIntervalInSeconds":0,"fileUploadRetentionPeriodInDays":0,IntelEMAAPIGuide–July2020128"fileUploadCleanupIntervalInHours":0}Returntype:ManageabilityServerSettingExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Name":"string","Data":{"ciraserver_ip":"string","ciraserver_host":"string","ciraserver_port":0,"logfilepath":"string","maxdbconnections":0,"swarmserver":[{"ServerID":0,"EndPoint":"string"}],"serverIps":["string"],"messagePort":0,"usbrImagesRootDirectory":"string","maxUsbrImageStorageCapacityPerTenantInGigabytes":0,"maxUsbrSlotCountPerTenant":0,"maxUsbrIdleTimeInMinutes":0,"usbrRedirectionManagerLoopIntervalInSeconds":0,"fileUploadRetentionPeriodInDays":0,"fileUploadCleanupIntervalInHours":0},"ModifiedOn":"2020-06-12T16:14:31.
811Z"}oXMLstringstringstring1string11stringstring1stringIntelEMAAPIGuide–July20201291111111970-01-01T00:00:00.
001ZThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedManageabilityServerSettingo400:BadRequesto403:Forbiddeno404:Notfoundo500:InternalservererrorGET/api/v3/serverSettings/swarmServerTheGET/api/v3/serverSettings/swarmServercallgetsthesettingsoftheSwarmserver.
(ServerSettings_GetSwarmServerSettings)Rolerequired:GlobalAdministrator.
ClientCredentialscanaccess:NoThepathparameterisServerName.
Returntype:SwarmServerSettingExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Name":"string","Data":{"adminport":0,"adminportlocal":0,"AuditLogCleanupIntervalInHours":0,"AuditLogRetentionPeriodInDays":0,"logfilepath":"string","enableCIRAPowerPolling":true,"maxdbconnections":0,"swarmserver":[{"ServerID":0,IntelEMAAPIGuide–July2020130"EndPoint":"string"}],"serverIps":["string"],"messagePort":0,"tcpConnRetrySeconds":0,"tcpConnIdleSeconds":0},"ModifiedOn":"2020-06-12T16:14:31.
811Z"}oXMLstring1111stringtrue11stringstring1111970-01-01T00:00:00.
001ZThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedSwarmServerSettingo403:Forbiddeno404:Notfoundo500:InternalservererrorPUT/api/v3/serverSettings/swarmServerIntelEMAAPIGuide–July2020131ThePUT/api/v3/serverSettings/swarmServercallsetsthesettingsoftheSwarmserver.
(ServerSettings_PutSwarmServerSettings)Rolerequired:GlobalAdministrator.
ClientCredentialscanaccess:NoRestartserviceindicateswhethertorestarttheSwarmServerornot,aschangestoitsconfigurationareappliedonlywhentheserviceisrestarted.
ThepathparameterisServerName,SwarmServerSettingandrestartEMAService.
ThisistheSwarmServerSettingobject.
{"adminport":0,"adminportlocal":0,"AuditLogCleanupIntervalInHours":0,"AuditLogRetentionPeriodInDays":0,"logfilepath":"string","enableCIRAPowerPolling":true,"maxdbconnections":0,"swarmserver":[{"ServerID":0,"EndPoint":"string"}],"serverIps":["string"],"messagePort":0,"tcpConnRetrySeconds":0,"tcpConnIdleSeconds":0}Returntype:SwarmServerSettingExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Name":"string","Data":{"adminport":0,"adminportlocal":0,"AuditLogCleanupIntervalInHours":0,"AuditLogRetentionPeriodInDays":0,"logfilepath":"string","enableCIRAPowerPolling":true,"maxdbconnections":0,"swarmserver":[{"ServerID":0,"EndPoint":"string"}],"serverIps":["string"IntelEMAAPIGuide–July2020132],"messagePort":0,"tcpConnRetrySeconds":0,"tcpConnIdleSeconds":0},"ModifiedOn":"2020-06-12T16:14:31.
811Z"}oXMLstring1111stringtrue11stringstring1111970-01-01T00:00:00.
001ZThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedSwarmServerSettingo400:BadRequesto403:Forbiddeno404:Notfoundo500:InternalservererrorGET/api/v3/serverSettings/webServerTheGET/api/v3/serverSettings/webServercallgetsthesettingsoftheWebserver.
(ServerSettings_GetWebServerSettings)Rolerequired:GlobalAdministrator.
IntelEMAAPIGuide–July2020133ClientCredentialscanaccess:NoThepathparameterisServerName.
Returntype:WebServerSettingExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Name":"string","Data":{"AccessTokenTimeToLive":0,"AjaxServerHost":"string","AllowedDomains":"string","EnableAllowedDomains":0,"logfilepath":"string","SwarmServerHost":"string","SwarmServerPort":0,"GlobalCatalogPort":0,"MaxAccesstokenTTL":0,"frontendstoragetype":"string","maxdbconnections":0},"ModifiedOn":"2020-06-12T16:14:31.
811Z"}oXMLstring1stringstring1stringstring111string11970-01-01T00:00:00.
001ZThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedWebServerSettingo403:Forbiddeno404:NotfoundIntelEMAAPIGuide–July2020134o500:InternalservererrorPUT/api/v3/serverSettings/webServerThePUT/api/v3/serverSettings/webServercallsetsthesettingsoftheWebserver.
(ServerSettings_PutWebServerSettings)Rolerequired:GlobalAdministrator.
ClientCredentialscanaccess:NoSyncwebsettingsindicateswhethertosynchronizetheEMAWebsiteappsettings,intheWebserver,withtheWebserversettingsfromtheEMADatabase,ornot.
ThepathparameterisServerName,WebServerSettingandsyncWebSettings.
ThisistheWebServerSettingobject.
{"AccessTokenTimeToLive":0,"AjaxServerHost":"string","AllowedDomains":"string","EnableAllowedDomains":0,"logfilepath":"string","SwarmServerHost":"string","SwarmServerPort":0,"GlobalCatalogPort":0,"MaxAccesstokenTTL":0,"frontendstoragetype":"string","maxdbconnections":0}Returntype:WebServerSettingExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"Name":"string","Data":{"AccessTokenTimeToLive":0,"AjaxServerHost":"string","AllowedDomains":"string","EnableAllowedDomains":0,"logfilepath":"string","SwarmServerHost":"string","SwarmServerPort":0,"GlobalCatalogPort":0,"MaxAccesstokenTTL":0,"frontendstoragetype":"string","maxdbconnections":0},"ModifiedOn":"2020-06-12T16:14:31.
811Z"}oXMLstringIntelEMAAPIGuide–July20201351stringstring1stringstring111string11970-01-01T00:00:00.
001ZThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedWebServerSettingo400:BadRequesto403:Forbiddeno404:Notfoundo500:Internalservererror3.
22TenantsGET/api/v3/tenantsTheGET/api/v3/tenantscallgetsacollectionofTenants.
(Tenants_GetAll)Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,EndpointGroupCreator,orEndpointGroupUser.
ClientCredentialscanaccess:NoReturntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{"CreatedBy":"00000000-0000-0000-0000-000000000000","CreatedOn":"2019-08-01T20:05:01.
090Z","TenantId":"00000000-0000-0000-0000-000000000000","ModifiedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:01.
091Z","Description":"string","Name":"string"}]oXMLIntelEMAAPIGuide–July202013600000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-00000000000000000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001ZstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedTenanto404:Notfoundo500:InternalServerErrorPOST/api/v3/tenantsThePOST/api/v3/tenantscallcreatesaTenant.
(Tenants_Post)Rolerequired:GlobalAdministratorClientCredentialscanaccess:NoThepathparameterisTenant.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisTenant.
ThisistheTenantsobject.
{"CreatedBy":"00000000-0000-0000-0000-000000000000","CreatedOn":"2019-08-01T20:05:01.
099Z","TenantId":"00000000-0000-0000-0000-000000000000","ModifiedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:01.
099Z","Description":"string","Name":"string"}Returntype:TenantExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"CreatedBy":"00000000-0000-0000-0000-000000000000",IntelEMAAPIGuide–July2020137"CreatedOn":"2019-08-01T20:05:01.
095Z","TenantId":"00000000-0000-0000-0000-000000000000","ModifiedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:01.
095Z","Description":"string","Name":"string"}oXML00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-00000000000000000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001ZstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedTenanto400:Badrequesto409:Conflicto500:InternalServerErrorGET/api/v3/tenants/{tenantId}TheGET/api/v3/tenants/{tenantId}callgetsthedetailsofaTenantbyID.
(Tenants_GetById)Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,EndpointGroupCreator,orEndpointGroupUser.
ClientCredentialscanaccess:NoThepathparameteristenantId.
CanonicalGUIDform:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxReturntype:TenantExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"CreatedBy":"00000000-0000-0000-0000-000000000000","CreatedOn":"2019-08-01T20:05:01.
109Z","TenantId":"00000000-0000-0000-0000-000000000000","ModifiedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:01.
109Z","Description":"string","Name":"string"}oXMLIntelEMAAPIGuide–July202013800000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-00000000000000000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001ZstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedTenanto400:BadRequestErroro403:Forbiddeno404:Notfoundo500:InternalServerErrorPUT/api/v3/tenants/{tenantId}ThePUT/api/v3/tenants/{tenantId}callupdatesaTenant.
(Tenants_Put)Rolerequired:GlobalAdministratorClientCredentialscanaccess:NoOnlythefieldsNameandDescriptioncanbeupdated.
ThepathparameteristenantId.
CanonicalGUIDform:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyistenantId.
ThisistheTenantsobject.
{"CreatedBy":"00000000-0000-0000-0000-000000000000","CreatedOn":"2019-08-01T20:05:01.
125Z","TenantId":"00000000-0000-0000-0000-000000000000","ModifiedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:01.
125Z","Description":"string","Name":"string"}Returntype:TenantExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{IntelEMAAPIGuide–July2020139"CreatedBy":"00000000-0000-0000-0000-000000000000","CreatedOn":"2019-08-01T20:05:01.
120Z","TenantId":"00000000-0000-0000-0000-000000000000","ModifiedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:01.
120Z","Description":"string","Name":"string"}oXML00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-00000000000000000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001ZstringstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedTenanto400:Badrequesto404:Notfoundo500:InternalservererrorDELETE/api/v3/tenants/{tenantId}TheDELETE/api/v3/tenants/{tenantId}calldeletesaTenantByID(Tenants_Delete)Rolerequired:GlobalAdministratorClientCredentialscanaccess:NoThepathparameteristenantId.
CanonicalGUIDform:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxResponsetypes:o204:Successfulrequest,nocontento400:Badrequesto404:Notfoundo500:Internalservererror3.
23UserGroupMembershipsGET/api/v3/userGroupMemberships/{userGroupId}TheGET/api/v3/userGroupMemberships/{userGroupId}callgetsacollectionofnamesofUserGroupmembers.
(UserGroupMemberships_GetNames)Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,orEndpointGroupCreator.
ClientCredentialscanaccess:NoIntelEMAAPIGuide–July2020140ThepathparameterisuserGroupId.
UserGroupidentifierReturntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{"UserName":"string"}]oXMLstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedUserGroupMembero404:Notfoundo500:InternalServerErrorPOST/api/v3/userGroupMemberships/{userGroupId}/addMembersThePOST/api/v3/userGroupMemberships/{userGroupId}/addMemberscalladdmemberstoaUserGroup.
(UserGroupMemberships_Post)Rolerequired:GlobalAdministrator,TenantAdministrator,orAccountManager.
ClientCredentialscanaccess:NoWithanHTTP200,theresponselistwillcontainonlythosemembersthatgotaddedtotheUserGroup.
Membersnotaddedforonereasonoranotherwillnotappearintheresponselist.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyistenantId.
ThisistheUserGroupMembershipsobject.
[{"UserName":"string"}]Returntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
IntelEMAAPIGuide–July2020141[{"UserName":"string"}]oXMLstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedUserGroupMembero400:Badrequesto404:Notfoundo500:InternalServerErrorPOST/api/v3/userGroupMemberships/{userGroupId}/removeMembersThePOST/api/v3/userGroupMemberships/{userGroupId}/removeMemberscallremovesmembersfromaUserGroup.
(UserGroupMemberships_RemoveMembers)Rolerequired:GlobalAdministrator,TenantAdministrator,orAccountManager.
ClientCredentialscanaccess:NoWithanHTTP200,theresponselistwillcontainonlythosemembersremovedfromtheUserGroup.
Membersnotremovedforonereasonoranotherwillnotappearintheresponselist.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyistenantId.
ThisistheUserGroupMembershipsobject.
[{"UserName":"string"}]Returntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{IntelEMAAPIGuide–July2020142"UserName":"string"}]oXMLstringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedUserGroupMembero400:Badrequesto404:Notfoundo500:Internalservererror3.
24UserGroupsGET/api/v3/userGroupsTheGET/api/v3/userGroupscallgetsacollectionofUserGroups.
(UserGroups_GetAll)Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,orEndpointGroupCreator.
ClientCredentialscanaccess:NoReturntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{"UserGroupId":0,"Name":"string","TenantId":"00000000-0000-0000-0000-000000000000","Description":"string","CreatedOn":"2019-08-01T20:05:01.
149Z","CreatedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:01.
149Z","ModifiedBy":"00000000-0000-0000-0000-000000000000","RoleId":0,"AccessRightsId":"execute","AccessRights":"string"}]oXMLIntelEMAAPIGuide–July20201431string00000000-0000-0000-0000-000000000000string1970-01-01T00:00:00.
001Z00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-0000000000001executestringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedUserGroupo500:InternalservererrorPOST/api/v3/userGroupsThePOST/api/v3/userGroupscallcreatesanewUserGrouphavingExecuteorViewright.
(UserGroups_InsertUserGroup)Rolerequired:GlobalAdministrator,TenantAdministrator,orAccountManager.
ClientCredentialscanaccess:NoForAccessRightsId,enteroneofthetwofollowingvalues:oExecuteoViewTheroleIdvaluewillbeautomaticallypopulatedbythesystemThepathparameterisUserGroup.
UserGroupobjecttocreateThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xml-application/x-www-form-urlencodedTherequestbodyisUserGroup.
ThisistheUserGroupsobject.
{"UserGroupId":0,"Name":"string","TenantId":"00000000-0000-0000-0000-000000000000","Description":"string","CreatedOn":"2019-08-01T20:05:01.
156Z","CreatedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:01.
156Z",IntelEMAAPIGuide–July2020144"ModifiedBy":"00000000-0000-0000-0000-000000000000","RoleId":0,"AccessRightsId":"execute","AccessRights":"string"}Returntype:UserGroupExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"UserGroupId":0,"Name":"string","TenantId":"00000000-0000-0000-0000-000000000000","Description":"string","CreatedOn":"2019-08-01T20:05:01.
153Z","CreatedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:01.
153Z","ModifiedBy":"00000000-0000-0000-0000-000000000000","RoleId":0,"AccessRightsId":"execute","AccessRights":"string"}oXML1string00000000-0000-0000-0000-000000000000string1970-01-01T00:00:00.
001Z00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-0000000000001executestringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedUserGroupo400:Badrequesto409:Conflict,UserGroupnamealreadyexistso500:InternalServerErrorGET/api/v3/userGroups/{userGroupId}IntelEMAAPIGuide–July2020145TheGET/api/v3/userGroups/{userGroupId}callgetsaUserGroupbyID.
(UserGroups_GetUserGroup)Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,orEndpointGroupCreator.
ClientCredentialscanaccess:NoThepathparameterisuserGroupId.
UserGroupidentifierReturntype:UserGroupExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"UserGroupId":0,"Name":"string","TenantId":"00000000-0000-0000-0000-000000000000","Description":"string","CreatedOn":"2019-08-01T20:05:01.
164Z","CreatedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:01.
165Z","ModifiedBy":"00000000-0000-0000-0000-000000000000","RoleId":0,"AccessRightsId":"execute","AccessRights":"string"}oXML1string00000000-0000-0000-0000-000000000000string1970-01-01T00:00:00.
001Z00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-0000000000001executestringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedUserGroupo400:Badrequesto403:Forbiddeno404:Notfoundo500:InternalservererrorPUT/api/v3/userGroups/{userGroupId}IntelEMAAPIGuide–July2020146ThePUT/api/v3/userGroups/{userGroupId}callupdatesaUserGroupbyID.
(UserGroups_UpdateUserGroup)Rolerequired:GlobalAdministrator,TenantAdministrator,orAccountManager.
ClientCredentialscanaccess:NoTheonlyfieldsthatcanbeupdatedareName,DescriptionandAccessRights.
ForAccessRightsId,enteroneofthetwofollowingvalues:oExecuteoViewTheroleIdvaluewillbeautomaticallypopulatedbythesystemThepathparameterisuserGroupId.
TheUserGroupidentifierThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisuserGroupId.
ThisistheUserGroupsobject.
{"UserGroupId":0,"Name":"string","TenantId":"00000000-0000-0000-0000-000000000000","Description":"string","CreatedOn":"2019-08-01T20:05:01.
174Z","CreatedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:01.
174Z","ModifiedBy":"00000000-0000-0000-0000-000000000000","RoleId":0,"AccessRightsId":"execute","AccessRights":"string"}Returntype:UserGroupExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"UserGroupId":0,"Name":"string","TenantId":"00000000-0000-0000-0000-000000000000","Description":"string","CreatedOn":"2019-08-01T20:05:01.
170Z","CreatedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:01.
170Z","ModifiedBy":"00000000-0000-0000-0000-000000000000","RoleId":0,"AccessRightsId":"execute","AccessRights":"string"}oXMLIntelEMAAPIGuide–July20201471string00000000-0000-0000-0000-000000000000string1970-01-01T00:00:00.
001Z00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-0000000000001executestringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:OK:Returncontent.
UserGroupo400:Badrequesto403:Forbiddeno404:Notfoundo409:Conflict,UserGroupnamealreadyexistso500:InternalServerErrorDELETE/api/v3/userGroups/{userGroupId}TheDELETE/api/v3/userGroups/{userGroupId}calldeletesaUserGroupbyID.
(UserGroups_DeleteUserGroup)Rolerequired:GlobalAdministrator,TenantAdministrator,orAccountManager.
ClientCredentialscanaccess:NoThepathparameterisuserGroupId.
TheUserGroupidentifier.
Responsetypes:o204:Successfulrequest,nocontent.
o403:Forbiddeno404:Notfoundo500:InternalServerError3.
25UserGroupToEndpointGroupAssignmentsGET/api/v3/userGroupToEndpointGroupAssignments/{endpointGroupId}TheGET/api/v3/userGroupToEndpointGroupAssignments/{endpointGroupId}callgetsacollectionofUserGroupsassignedtoanEndpointGroup(UserGroupToEndpointGroupAssignments_GetUserGroups)Rolerequired:TenantAdministrator,orEndpointGroupCreator.
ClientCredentialscanaccess:NoThepathparameterisendpointGroupId.
EndpointGroupID.
Hexstringwith64charactersandwithoutthe0xprefix.
Returntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
IntelEMAAPIGuide–July2020148[{"UserGroupId":0,"Name":"string","Description":"string","AccessRightsId":"execute","AccessRights":"string"}]oXML1stringstringexecutestringThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:OK:Returncontent.
UserGroupIdentifiero400:Badrequesto403:Forbidden:Ifthecallerdoesnothavetherequiredrights.
o500:InternalServerError:Exceptionsthrown.
POST/api/v3/userGroupToEndpointGroupAssignments/{endpointGroupId}ThePOST/api/v3/userGroupToEndpointGroupAssignments/{endpointGroupId}callassignsaUserGrouptoanEndpointGroup(UserGroupToEndpointGroupAssignments_AssignUserGroup)Rolerequired:TenantAdministrator,orEndpointGroupCreatorofasuitableUserGroup.
ClientCredentialscanaccess:NoThepathparameterisendpointGroupId.
EndPointGroupID.
Hexstringwith64charactersandwithoutthe0xprefix.
ThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisendpointGroupId.
ThisistheUserGroupToEndpointGroupAssignmentsobject.
{"UserGroupId":0}IntelEMAAPIGuide–July2020149Returntype:UserGroupIdentifierDTOExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"UserGroupId":0}oXML1ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:OK:Returncontent.
UserGroupIdentifierDTOo400:Badrequest:Ifrequestbodyisnotinrightformat.
o403:Forbidden:Ifthecallerdoesnothavetherequiredrights.
o404:Notfound:If{userGroupId}doesnotexist.
o409:Conflict:If{userGroupId}and{endpointGroupId}arealreadyassociated.
o500:InternalServerError:Exceptionsthrown.
DELETE/api/v3/userGroupToEndpointGroupAssignments/{endpointGroupId}/userGroup/{userGroupId}TheDELETE/api/v3/userGroupToEndpointGroupAssignments/{endpointGroupId}/userGroup/{userGroupId}calldisassociatesanUserGroupfromaEndpointGroup(UserGroupToEndpointGroupAssignments_DisassociateUserGroup)Rolerequired:TenantAdministrator,orEndpointGroupCreatorofasuitableUserGroup.
ClientCredentialscanaccess:NoThepathparameterisendpointGroupId.
EndpointGroupID.
Hexstringwith64charactersandwithoutthe0xprefix.
Responsetypes:o204:Successfulrequest,nocontent.
o400:Badrequest:IfURIisnotformattedrightorIf{endpointGroupId}and{userGroupId}arealreadyassociated.
o403:Forbidden:Ifthecallerdoesnothavetherequiredrights.
o404:Notfound:If{endpointGroupId}or{userGroupId}doesnotexist.
o500:InternalServerError:Exceptionsthrown.
3.
26UsersGET/api/v3/usersIntelEMAAPIGuide–July2020150TheGET/api/v3/userscallgetsacollectionofUsers.
(Users_GetSummariesCollection)Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,orEndpointGroupCreator.
ClientCredentialscanaccess:NoReturntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{"UserId":"string","Username":"string","Enabled":true,"TenantId":"00000000-0000-0000-0000-000000000000","Description":"string","RoleId":0,"SysRole":"none"}]oXMLstringstringtrue00000000-0000-0000-0000-000000000000string1noneThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedUserSummaryo401:Unauthorizedo500:InternalservererrorPOST/api/v3/usersThePOST/api/v3/userscallcreatesaUser(Users_CreateUser)Rolerequired:GlobalAdministrator,TenantAdministrator,orAccountManager.
ClientCredentialscanaccess:NoTenantIdisnotrequiredwhenaGlobalAdminisratorcreatesanotherGlobalAdministrator.
IfIntelEMAinstalledinWindowsDomainAuthenticationmode,theUsernameusedforregisteringanewusermustbeitsUserPrincipleName(UPN).
Usernamemustbeinanemailaddressformat.
IntelEMAAPIGuide–July2020151Creatinga'Locked'userisnotallowed.
The'Enabled'propertyshouldalwaysbepassedas'true'PasswordisrequiredonlywhenIntelEMAisnotinstalledinWindowsDomainAuthenticationmode.
PasswordRequirementsoatleast8charactersocontainsatleastonenumberocontainsbothlowercaseanduppercasealphacharactersocontainsatleastonespecialcharacterThepathparameterisNewUser.
UserobjecttobecreatedThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisNewUser.
ThisistheUsersobject.
{"UserId":"00000000-0000-0000-0000-000000000000","Username":"string","Enabled":true,"TenantId":"00000000-0000-0000-0000-000000000000","Description":"string","Password":"string","RoleId":0}Returntype:UserExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"UserId":"00000000-0000-0000-0000-000000000000","Username":"string","CreatedOn":"2019-08-01T20:05:01.
205Z","CreatedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:01.
205Z","ModifiedBy":"00000000-0000-0000-0000-000000000000","Enabled":true,"TenantId":"00000000-0000-0000-0000-000000000000","Description":"string","RoleId":0,"SysRole":"none"}oXML00000000-0000-0000-0000-000000000000string1970-01-01T00:00:00.
001Z00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-000000000000IntelEMAAPIGuide–July2020152true00000000-0000-0000-0000-000000000000string1noneThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedUsero400:Badrequesto401:Unauthorizedo409:Conflicto500:InternalservererrorGET/api/v3/users/{userId}TheGET/api/v3/users/{userId}callgetsthedetailsofaUserbyID.
(Users_GetById)Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,EndpointGroupCreator,orEndpointGroupUser.
ClientCredentialscanaccess:NoEndpointGroupUserscanseeonlytheirowninformation.
ThepathparameterisuserId.
UserID.
CanonicalGUIDform:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxReturntype:UserExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"UserId":"00000000-0000-0000-0000-000000000000","Username":"string","CreatedOn":"2019-08-01T20:05:01.
217Z","CreatedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:01.
217Z","ModifiedBy":"00000000-0000-0000-0000-000000000000","Enabled":true,"TenantId":"00000000-0000-0000-0000-000000000000","Description":"string","RoleId":0,"SysRole":"none"}oXML00000000-0000-0000-0000-000000000000string1970-01-01T00:00:00.
001Z00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001ZIntelEMAAPIGuide–July202015300000000-0000-0000-0000-000000000000true00000000-0000-0000-0000-000000000000string1noneThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedUsero401:Unauthorizedo403:Forbiddeno404:Notfoundo500:InternalservererrorPUT/api/v3/users/{userId}ThePUT/api/v3/users/{userId}callupdatesaUserbyID.
(Users_UpdateUser)Rolerequired:GlobalAdministrator,TenantAdministrator,orAccountmanager.
ClientCredentialscanaccess:NoOnlyDescription,RoleId,andEnabledcanbeupdated,exceptforTenantIdifconvertingauserfromaGlobalAdmintoaTenantUser.
Allotherfieldsareignored.
Manuallylockingauserbychangingthe'Enabled'propertyto'false'isnotcurrentlysupported.
ThepathparameterisuserId.
UserID.
CanonicalGUIDform:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisuserId.
ThisistheUsersobject.
Returntype:UserExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"UserId":"00000000-0000-0000-0000-000000000000","Username":"string","CreatedOn":"2019-08-01T20:05:01.
263Z","CreatedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:01.
263Z","ModifiedBy":"00000000-0000-0000-0000-000000000000","Enabled":true,"TenantId":"00000000-0000-0000-0000-000000000000","Description":"string","RoleId":0,"SysRole":"none"}IntelEMAAPIGuide–July2020154oXML00000000-0000-0000-0000-000000000000string1970-01-01T00:00:00.
001Z00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-000000000000true00000000-0000-0000-0000-000000000000string1noneThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedUsero400:Badrequesto401:Unauthorizedo403:Forbiddeno404:Notfoundo500:InternalservererrorDELETE/api/v3/users/{userId}TheDELETE/api/v3/users/{userId}calldeletesaUserbyID.
(Users_DeleteUser)Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,EndpointGroupCreator,orEndpointGroupUserClientCredentialscanaccess:NoAlluserscandeletetheirownaccounts.
GlobalAdministratorscandeleteanyuseraccountfromanyTenant.
TenantAdministratorscandeleteanyuseraccountfromthesameTenant.
AccountManagerscandeleteanyuserhavingtheprimaryroleofAccountManager,EndpointGroupCreator,orEndpointGroupUserfromthesameTenant.
ThepathparameterisuserId.
CanonicalGUIDform:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxResponsetypes:o204:Successfulrequest,nocontento401:Unauthorizedo403:Forbiddeno404:Notfoundo500:InternalservererrorGET/api/v3/users/getUserByNameTheGET/api/v3/users/getUserByNamecallgetsthedetailsofaUserbyusername.
(Users_GetByName)Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,EndpointGroupCreator,orEndpointGroupUser.
IntelEMAAPIGuide–July2020155ClientCredentialscanaccess:NoEndpointGroupUserscanseeonlytheirowninformation.
Thepathparameterisusername.
Returntype:UserExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"UserId":"00000000-0000-0000-0000-000000000000","Username":"string","CreatedOn":"2019-08-01T20:05:01.
273Z","CreatedBy":"00000000-0000-0000-0000-000000000000","ModifiedOn":"2019-08-01T20:05:01.
273Z","ModifiedBy":"00000000-0000-0000-0000-000000000000","Enabled":true,"TenantId":"00000000-0000-0000-0000-000000000000","Description":"string","RoleId":0,"SysRole":"none"}oXML00000000-0000-0000-0000-000000000000string1970-01-01T00:00:00.
001Z00000000-0000-0000-0000-0000000000001970-01-01T00:00:00.
001Z00000000-0000-0000-0000-000000000000true00000000-0000-0000-0000-000000000000string1noneThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedUsero400:Badrequesto401:Unauthorizedo403:Forbiddeno404:Notfoundo500:InternalservererrorPOST/api/v3/users/{userId}/resetPasswordThePOST/api/v3/users/{userId}/resetPasswordcallsetaUser'spassword.
(Users_UpdatePassword)IntelEMAAPIGuide–July2020156Rolerequired:GlobalAdministrator,TenantAdministrator,AccountManager,EndpointGroupCreator,orEndpointGroupUser.
ClientCredentialscanaccess:NoGlobalAdministratorscanresetthepasswordsofallUserswithoutprovidingtheircurrentpasswords.
TenantAdministratorscanresetthepasswordsofUsersinthesameTenantwithoutprovidingtheircurrentpasswords.
Allotherusersneedtoprovidetheircurrentpasswordstoresetthem.
PasswordisrequiredonlywhenIntelEMAisnotinstalledinWindowsDomainAuthenticationmode.
PasswordRequirementsoatleast8charactersocontainsatleastonenumberocontainsbothlowercaseanduppercasealphacharactersocontainsatleastonespecialcharacterThepathparameterisuserId.
UserID.
CanonicalGUIDform:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisuserId.
ThisistheUsersobject.
{"CurrentPassword":"string","NewPassword":"string"}ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-TyperesponseheaderResponsetypes:o204:Successfulrequest,nocontento400:Badrequesto401:Unauthorizedo403:Forbiddeno404:Notfoundo500:Internalservererror3.
27WifiSetupsGET/api/v3/wifiSetupsTheGET/api/v3/wifiSetupscallgetsacollectionofWifiSetups.
(WifiSetups_GetCollection)Rolerequired:TenantAdministrator,EndpointGroupCreator,orEndpointGroupUserClientCredentialscanaccess:NoReturntype:ListExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
[{"WifiSetupId":0,"SetupName":"string","Priority":0,"SSID":"string",IntelEMAAPIGuide–July2020157"EncryptionAlgorithm":"tKIP","KeyManagementProtocol":"wPAPSK","Passphrase":"string","TenantId":"string","_802_1_SetupLookupKey":0}]oXML1string1stringtKIPwPAPSKstringstring1ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:SuccessfulrequestWifiSetupo500:InternalServerErrorPOST/api/v3/wifiSetupsThePOST/api/v3/wifiSetupscallcreatesaWifiSetuptobeusedbyIntelAMTProfiles.
(WifiSetups_Post)Rolerequired:TenantAdministratorClientCredentialscanaccess:NoWhentheKeyManagementProtocolisWPAPSKorWPA2PSK,Passphraseisrequired,and_802_1_SetupLookupKeyisnotneededandwillbesettonull.
WhentheKeyManagementProtocolisWPAIEEE802_1orWPA2IEEE802_1,_802_1_SetupLookupKeyisrequired,andPassphraseisnotneededandwillbesettonul.
ThepathparameterisWifiSetupNew.
WifiSetupobjecttocreateThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyisWifiSetupNew.
ThisistheWifiSetupsobject.
{"SetupName":"string","Priority":0,IntelEMAAPIGuide–July2020158"SSID":"string","EncryptionAlgorithm":"tKIP","KeyManagementProtocol":"wPAPSK","Passphrase":"string","TenantId":"string","_802_1_SetupLookupKey":0}Returntype:WifiSetupExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"WifiSetupId":0,"SetupName":"string","Priority":0,"SSID":"string","EncryptionAlgorithm":"tKIP","KeyManagementProtocol":"wPAPSK","Passphrase":"string","TenantId":"string","_802_1_SetupLookupKey":0oXML1string1stringtKIPwPAPSKstringstring1ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:SuccessfulrequestWifiSetupo400:InvalidModelStateo409:WifiSetupnamealreadyexistso500:InternalServerErrorGET/api/v3/wifiSetups/{wifiSetupId}TheGET/api/v3/wifiSetups/{wifiSetupId}callgetsaWiFiSetupbyID.
(WifiSetups_GetById)Rolerequired:TenantAdministrator,EndpointGroupCreator,orEndpointGroupUserClientCredentialscanaccess:NoIntelEMAAPIGuide–July2020159ThepathparameteriswifiSetupId.
WifiSetupIDReturntype:WifiSetupExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"WifiSetupId":0,"SetupName":"string","Priority":0,"SSID":"string","EncryptionAlgorithm":"tKIP","KeyManagementProtocol":"wPAPSK","Passphrase":"string","TenantId":"string","_802_1_SetupLookupKey":0}oXML1string1stringtKIPwPAPSKstringstring1ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:Successfulrequest,contentreturnedWifiSetupo404:Notfoundo500:InternalServerErrorPUT/api/v3/wifiSetups/{wifiSetupId}ThePUT/api/v3/wifiSetups/{wifiSetupId}callupdatesaWiFiSetupbyID.
(WifiSetups_Put)Rolerequired:TenantAdministratorClientCredentialscanaccess:NoWhentheKeyManagementProtocolisWPAPSKorWPA2PSKandtheoriginalKeyManagementProtocolisWPAPSKorWPA2PSK,Passphraseisoptional,and_802_1_SetupLookupKeyisnotneededandwillbesettonullinternally.
IfPassphraseisnotprovidedorempty,theoriginalPassphrasewillbeused.
WhentheKeyManagementProtocolisWPAPSKorWPA2PSKandtheoriginalKeyManagementProtocolisWPAIEEE802_1orWPA2IEEE802_1,Passphraseisrequired,and_802_1_SetupLookupKeyisnotneededandwillbesettonullinternally.
IntelEMAAPIGuide–July2020160WhentheKeyManagementProtocolisWPAIEEE802_1orWPA2IEEE802_1,_802_1_SetupLookupKeyisrequired,andPassphraseisnotneededandwillbesettonullinternally.
ThepathparameteriswifiSetupId.
WifiSetupIDThisAPIcallconsumesthefollowingmediatypesviatheContent-Typerequestheader.
oapplication/jsonotext/jsonoapplication/xmlotext/xmloapplication/x-www-form-urlencodedTherequestbodyiswifiSetupId.
ThisistheWifiSetupsobject.
{"WifiSetupId":0,"SetupName":"string","Priority":0,"SSID":"string","EncryptionAlgorithm":"tKIP","KeyManagementProtocol":"wPAPSK","Passphrase":"string","TenantId":"string","_802_1_SetupLookupKey":0}Returntype:WifiSetupExampledata:Content-Type=Application/JSONandapplication/XML.
oJSON.
{"WifiSetupId":0,"SetupName":"string","Priority":0,"SSID":"string","EncryptionAlgorithm":"tKIP","KeyManagementProtocol":"wPAPSK","Passphrase":"string","TenantId":"string","_802_1_SetupLookupKey":0}oXML1string1stringtKIPwPAPSKstringstring1IntelEMAAPIGuide–July2020161ThisAPIcallproducesthefollowingmediatypesaccordingtotheAcceptrequestheader;themediatypewillbeconveyedbytheContent-Typeresponseheaderoapplication/jsonotext/jsonoapplication/xmlotext/xmlResponsetypes:o200:ReturnsupdatedWifiSetupWifiSetupo400:Badrequesto404:Notfoundo409:WifiSetupnamealreadyexistso500:InternalServerErrorDELETE/api/v3/wifiSetups/{wifiSetupId}TheDELETE/api/v3/wifiSetups/{wifiSetupId}calldeletesaWiFiSetupbyID.
(WifiSetups_Delete)Rolerequired:TenantAdministratorClientCredentialscanaccess:NoThepathparameteriswifiSetupId.
WifiSetupIDResponsetypes:o204:Successfulrequest,nocontento404:Notfoundo409:CannotdeleteWifisetupifitisstillassociatedwithAMTProfileo500:InternalServerErrorIntelEMAAPIGuide–July20201624TroubleshootingTheIntelEMAServerusestheNLogtologIntelEMAAPIerrorsanddebuginformation.
Theconfigurationfileislocatedinc:\inetpub\wwwroot\NLog.
config.
ThedefaultdirectorywherethetroubleshootinglogsarewrittenisC:\ProgramFiles(x86)\Intel\PlatformManager\EMALogs.
TroubleshootinglogsarewritteninthesubdirectoryEmaWebApiLogswithin,whichisadirectoryforeachtenant.
Forthisrelease,thewritepermissiontoC:\ProgramFiles(x86)\Intel\PlatformManager\EMALogsmustbeconfiguredforthesystemaccountIISAppPool\DefaultAppPool.
Figure4.
1:EMALogsPropertiesIntelEMAAPIGuide–July20201635HTTPStatusCodesTheIntelEMAAPIusesHTTPstatuscodesthatgenerallyfollowRESTconventionswhere2xxindicatessuccess,4xxindicatesclienterrors,and5xxindicatesservererrors.
ThefollowingerrorcodesarecommonlyusedintheIntelEMAAPI.
200OK:Successfulrequestwithcontentreturned.
204NoContent:Successfulrequestwithnocontentreturned.
400BadRequest:badrequestfromtheclient.
401Unauthorized:theclientisnotauthenticated.
403Forbidden:theclientdoesnothavethecorrectpermissionstoaccesstheresource.
404NotFound:therequestedresourceisnotfound.
405MethodNotAllowed:therequestedmethodisnotsupportedbytheresource.
409Conflict:therequestcouldnotbecompleteddotoaconflictwiththecurrentstateoftheresource.
415UnsupportedMediaType:theresourcedoesnotsupportthemediatypefromtherequest.
500InternalServerError:theserverencounteredanunexpectederror.
InsomecasestheerrormessageswillbereturnedastheIntelEMAAPIExtendedErrorsinfollowingformat:{"Message":{"ExtendedCode":string,"ExtendedMessage":"string"}}400BadRequestErrorsThefollowingisatablelistingtheIntelEMAAPIExtendedErrorsforerrorcode400.
Table5.
1:400ExtendedIntelEMAAPIErrorsExtendedCodeErrorTypeExtendedMessage1000OFFSET_PARAMETER_INVALID_400Offsetparameterisinvalid1001PAGESIZE_PARAMETER_INVALID_400pageSizeparameterisinvalid1002POWERSTATE_PARAMETER_INVALID_400powerStateparameterisinvalid1003CONNECTIONSTATE_PARAMETER_INVALID_400connectionStateparameterisinvalid1004STARTDATE_PARAMETER_INVALID_400startDateparameterisinvalid1005ENDDATE_PARAMETER_INVALID_400endDateparameterisinvalid1006ENABLED_PARAMETER_INVALID_400enabledparameterisinvalid1007TENANTID_PARAMETER_INVALID_400tenantIdparameterisinvalid1008ROLEID_PARAMETER_INVALID_400roleIdparameterisinvalid1009SEARCHTYPE_PARAMETER_INVALID_400searchTypeparameterisinvalidIntelEMAAPIGuide–July20201641010SEARCHVALUE_PARAMETER_INVALID_400searchValueparameterisinvalid1011SEARCH_PARAMETERS_INVALID_400bothsearchparametersarerequired1012UPDATE_PARAMETERS_INVALID_400updateparametersarerequired1013ENDPOINTGROUPID_PARAMETER_INVALID_400endpointGroupIdparameterisinvliad1014USERGROUP_DISSOCIATION_INVALID_400userGroupparameterisinvalid1015IP_ADDRESS_INVALID_400IPaddressisinvalid1016START_IP_ADDRESS_INVALID_400StartIPaddressisinvalid1017END_IP_ADDRESS_INVALID_400EndIPaddressisinvalid1018SUBNETMASK_INVALID_400Subnetmaskisinvalid1019AMT_NOT_SUPPORTED_400EndpointdoesnothaveIntelAMTsupport1020AMT_FW_INVALID_400EndpointIntelMEversionisinvalidforIntelAMTprovisioning1021AMT_ONLY_EITHER_TLS_OR_CIRA_CAN_BE_SELECTED_400OnlyeitherTLSorCIRAcanbeselectedforIntelAMTprovisioning1022AMT_USB_PROVISIONING_NOT_SUPPORTED_400EndpointdoesnotsupportIntelAMTprovisioningusingUSB1023AMT_HBP_PROVISIONING_NOT_SUPPORTED_400EndpointdoesnotsupportIntelAMThostbasedprovisioning1024AMT_PKI_PROVISIONING_NOT_SUPPORTED_400EndpointdoesnotsupportIntelAMTPKIcertificatebasedprovisioning1025AMT_PROVISIONING_CERT_HASH_TYPE_UNKNOWN_400IntelAMTprovisioningcertificatehashtypeisunknown1026AMT_CIRA_NOT_SUPPORTED_400EndpointdoesnotsupportCIRA1027CURRENT_PASSWORD_CANNOT_BE_NULL_OR_EMPTY_400Currentpasswordcannotbenullorempty1028CALLERID_PARAMETER_INVALID_400callerIdparameterisinvalid1029WIFISETUP_ENABLED_BUT_NO_WIFISETUPID_SELECTED_400WifiConnectionSetupenabled,butnoWifiSetupIdselected1030WIFISETUP_NOT_ENABLED_BUT_WIFISETUPID_SELECTED_400WifiConnectionSetupnotenabled,butWifiSetupId(s)selected1031ENDPOINTGROUP_AMTPROFILEID_NOT_EXISTS_400CannotupdateEndpointGroupsinceAmtProfileIDnotexists1032PASSWORD_RESET_FAILED_DUE_TO_BAD_CREDENTIALS_400PasswordresetfailedduetobadcredentialsIntelEMAAPIGuide–July20201651033WIFISETUP_IDS_NOT_IN_DATABASE_400WiFiSetupIds(s)associatedwithIntelAMTProfilewerenotfoundintheDatabase1034MODEL_CANNOT_BE_NULL_400Modelcannotbenull1035CALLER_NOT_PERMITTED_TO_CREATE_USER_HAVING_SELECTED_ROLE_400Callernotpermittedtocreateanewuserwithselectedrole1036CALLER_NOT_PERMITTED_TO_CREATE_USER_WITH_SELECTED_TENANTID_400Callernotpermittedtocreateanewuserwithadifferenttenant1037CALLER_NOT_PERMITTED_TO_CREATE_USER_WITHOUT_TENANTID_400Callernotpermittedtocreateanewuserwithoutatenant1038CALLER_NOT_PERMITTED_TO_UPDATE_USER_WITH_SELECTED_ROLE_ID_400Callernotpermittedtoupdateuserwithselectedrole1039NAME_ONLY_ONE_PER_REQUEST_400Onlyonenameperrequestallowed1040PASSWORD_ONLY_ONE_PER_REQUEST_400Onlyonepasswordperrequestallowed1041FILE_ONLY_ONE_PER_REQUEST_400Onlyonefileperrequestallowed1042FILE_INVALID_400Uploadedfileisinvalid1043CERTIFICATE_NAME_INVALID_400Certificatenameisinvalid1044CERTIFICATE_PASSWORD_INVALID_400Certificatepasswordisinvalid1045CERTIFICATE_IMPORT_FAILED_400Certificateimportfailed.
Pleasecheckthatthe.
PFXfileandpasswordarevalid1046UPLOADED_FILE_NOT_AMT_PROVISIONING_CERTIFICATE_400UploadedfileisnotanIntelAMTprovisioningcertificate1047CERTIFICATE_ID_INVALID_400CertificateIDisinvalid1048CERTIFICATE_IS_NOT_FOR_AMT_PROVISIONING_400CertificateisnotforIntelAMTprovisioning1049AMTSETUPID_SPECIFIED_IN_REQUEST_IS_INVALID_400TheAmtSetupIdspecifiedintherequestisinvalid1050AMTPROFILE_ID_INVALID_400IntelAMTProfileIDisinvalid1051CERTIFICATE_HAS_EXPIRED_400Certificatehasexpired1052CIRA_INTRANET_SUFFIX_INVALID_400CIRAIntranetSuffixisinvalid1053CIRA_LIMIT_EXCEEDEDCIRAProxieslimitexceeded1054CREATE_DISABLED_USER_NOT_ALLOWED_400Creatingnewuserwithenabledsettofalseisnotpermitted1055_802_1X_SETUP_ROOT_CERTIFICATE_REQUIRED_400ArootcertificateisrequiredforthespecifiedauthenticationprotocolIntelEMAAPIGuide–July20201661056_802_1X_SETUP_CLIENT_CERTIFICATE_REQUIRED_400Aclientcertificateisrequiredforthespecifiedauthenticationprotocol1057_802_1X_SETUP_INVALID_CONFIGURATION_SETTINGS_REQUIRED_400Invalidconfigurationsettingsforcertificate(required),pleasereview1058_802_1X_SETUP_INVALID_CONFIGURATION_SETTINGS_400Invalidconfigurationsettingsforcertificate,pleasereview1059_802_1X_SETUP_PSK_PARAMETER_INVALID_400ThefieldPSKisnotavalidOctetString1060_802_1X_SETUP_PROTECTED_ACCESS_CREDENTIAL_PARAMETER_INVALID_400ThefieldProtectedAccessCredentialisnotavalidOctetString1061_802_1X_SETUP_SERVER_CERTIFICATE_NAME_COMPARISON_OPTION_INVALID_400ThefieldServerCertificateNameComparisonOptionisnotavalidnumber1062MAX_FILE_SIZE_EXCEEDED_400Thefilesizeexceedsthemaximumallowed1063ENDPOINTS_LIST_CANNOT_BE_EMPTY_400Endpointslistcannotbeempty1064_802_1X_SETUP_PROTOCOL_INVALID_400Theauthenticationprotocolisnotsupported.
1065AMT_GLOBALLY_DISABLED_400IntelAMTinEndpointisgloballydisabledandcannotbeprovisioned.
1066MEBX_PASS_CHANGE_HBP_NOT_SUPPORTED_400IntelMEBxpasswordchangeisnotsupportedduringHostBasedProvisioning1067_802_1X_SETUP_SERVER_CERTIFICATE_DESIGNATEDCN_COMMONNAME_MISMATCH_400InvalidDesignatedCN,itisnotpartoftheCommonNames.
1068_802_1X_SETUP_INVALID_ROOT_CERTIFICATE_400Rootcertificateisnotvalidordoesnotexist.
1069_802_1X_SETUP_INVALID_CLIENT_CERTIFICATE_400Clientcertificateisnotvalidordoesnotexist.
1070_802_1X_SETUP_INVALID_COMMON_NAMES_400InvalidoremptyCommonNames.
1071HOSTNAME_PARAMETER_INVALID_400InputHostNameparameterisinvalid.
1072ENDPOINT_NOT_ROUTABLE_400Endpointisnotroutable.
1073BAD_PROVISIONING_STATE_400Endpointprovisioningstateisnotcorrect.
1074POWER_OP_NOT_SUPPORTED_400Poweroperationsentisnotsupported.
IntelEMAAPIGuide–July20201671075INVALID_AMT_CREDENTIAL_TYPE_400InputIntelAMTcredentialtypeisinvalid.
1076INVALID_USERNAME_FORMAT_400Invalidusernameformat.
1083INVALID_CLIENT_CREDENTIALS_UPDATE_400Aclientcredentialsaccountcannotbeupdatedusingthismethod.
PleaseupdatetheaccountusingtheClientCredentialsAPI.
1084_802_1X_INVALID_SECURITY_GROUP_LENGTH_400Invalidlengthforsecuritygroup.
1085_802_1X_MAX_SECURITY_GROUPS_NUMBER_EXCEEDED_400Maximumnumberofsecuritygroupsexceeded.
2031USER_DELETING_CLIENT_CREDENTIALS_400Aclientcredentialsaccountcannotbedeletedusingthismethod.
PleasedeletetheaccountusingtheClientCredentialsAPI.
3002RESOURCEID_ON_PATH_AND_MODEL_DO_NOT_MATCH_400ResourceIdvalueonthepathtothecontrollerandResourceIdintheinputmodeldonotmatch3003ENDPOINTID_PARAMETER_INVALID_400InputendpointIdparameterisinvalid3004USERGROUPID_PARAMETER_INVALID_400InputendpointIdparameterisinvalid3005TENANTID_OF_REQUESTED_ROLE_AND_TARGET_USER_DO_NOT_MATCH_400TenantIdofrequestedroleandtargetuserdonotmatch3008MAC_ADDRESS_INVALID_400MACaddressisinvalidordoesnotexist3009IP_RANGE_INVALID_400EndIPAddresscannotbelowerthanStartIPAddress3011INVALID_PASSWORD_FORMAT_400Invalidpasswordformat3012UPN_IS_NOT_IN_DOMAIN_400UPNusedisnotregisteredinthisdomain3017MANUAL_USER_LOCKING_NOT_SUPPORTED_400Manuallylockinguserisnotcurrentlysupported3018POWER_OP_NOT_SUPPORTED_IN_FW_400Endpointdoesnotsupportthepoweroperationsent401MethodNotAllowedErrorsThefollowingisatablelistingtheIntelEMAAPIExtendedErrorsforerrorcode401.
Table5.
2:401IntelEMAAPIExtendedErrorsExtendedCodeErrorTypeExtendedMessageIntelEMAAPIGuide–July20201684000UNAUTHORIZED_USER_NOT_REGISTERED_401UserisnotregisteredinIntelEMAsystem4001INVALID_USERNAME_OR_PASSWORD_401Theusernameorpasswordmaybeincorrect,ortheaccountmaybelocked.
403ForbiddenErrorsThefollowingisatablelistingtheIntelEMAAPIExtendedErrorsforerrorcode403.
Table5.
3:403IntelEMAAPIExtendedErrorsExtendedCodeErrorTypeExtendedMessage3006USER_LOCKED_OR_DELETED_403Theuserislockedordoesn'texist3015AMT_PROVISION_RECORD_RETRIEVE_FORBIDDENUserhasinsufficientrightstoretrieveIntelAMTcredentials3019POWER_OP_NOT_ALLOWED_403Endpointisnotallowedtoexecutethispoweroperation3023POWER_OP_USER_FORBIDDEN_403Usernotallowedtoexecutepoweroperations404NotFoundErrorsThefollowingisatablelistingtheIntelEMAAPIExtendedErrorsforerrorcode404.
Table5.
4:404IntelEMAAPIExtendedErrorsExtendedCodeErrorTypeExtendedMessage3013AMT_PROVISION_RECORD_NOT_FOUNDIntelAMTProvisioningRecorddoesnotexistindatabase3014UNABLE_TO_RETRIEVE_AMT_PROVISION_RECORDIntelAMTProvisioningRecorddoesnotexistindatabas3016ENDPOINTID_RECORD_NOT_FOUNDEndpointrecorddoesnotexistindatabase3025UNABLE_TO_RETRIEVE_MEBX_PASSWORDIntelMEBxpassworddoesn'texistinthedatabase405MethodNotAllowedErrorsThefollowingisatablelistingtheIntelEMAAPIExtendedErrorsforerrorcode405.
Table5.
5:405IntelEMAAPIExtendedErrorsExtendedCodeErrorTypeExtendedMessageIntelEMAAPIGuide–July20201693010METHOD_NOT_ALLOWED_WRONG_AUTH_MODE_405Methodnotallowedduetocurrentauthenticationmode409ConflictErrorsThefollowingisatablelistingtheIntelEMAAPIExtendedErrorsforerrorcode409.
Table5.
6:409ExtendedIntelEMAAPIErrorsExtendedCodeErrorTypeExtendedMessage2001USER_GROUP_NAME_CONFLICT_409UserGroup.
Namealreadyexists2002ENDPOINT_GROUP_NAME_CONFLICT_409EndpointGroup.
Namealreadyexists2003USER_NAME_CONFLICT_409User.
Namealreadyexists2004TENANT_NAME_CONFLICT_409Tenant.
Namealreadyexists2005USER_GROUP_TO_ENDPOINT_GROUP_CONFLICT_409UserGroupandEndpointGrouparealreadyassociated2006AMT_NOT_PROVISIONED_UNPROVISIONING_NOT_POSSIBLE_409Unprovisionisnotpossiblesinceendpointisnotprovisioned2007AMT_ALREADY_PROVISIONED_409IntelAMTisalreadyprovisioned2008WIFISETUP_NAME_CONFLICT_409WiFiSetup.
SetupNamealreadyexists2009AMTPROFILE_NAME_CONFLICT_409AMTProfile.
Namealreadyexists2010AMTPROFILE_STILL_LINKED_TO_ENDPOINTGROUP_CONFLICT_409CannotdeleteIntelAMTProfilesinceitisstilllinkedtoatleastoneEndpointGroup2011WIFISETUP_STILL_LINKED_TO_AMTPROFILE_CONFLICT_409CannotdeleteWifiSetupsinceitisstilllinkedtoIntelAMTProfile2012REQUEST_NOT_POSSIBLE_TCPRELAY_DISABLED_IN_POLICY_409RequestisnotpossiblebecauseTCPRELAYisdisabledinthePolicyGroup2013AMTCERTIFICATE_PART_OF_ANOTHER_CHAIN_409IntelAMTcertificatecouldnotbedeleted,sinceitispartofanotherIntelAMTCertificateChainIntelEMAAPIGuide–July20201702014AMTCERTIFICATE_IN_USE_BY_PROFILE_409IntelAMTcertificatecouldnotbedeleted,sinceitisuseinanIntelAMTProfileforprovisioning2015CERTIFICATE_THUMBPRINT_ALREADY_EXISTS_409Certificatecouldnotbeimported,sinceitsthumbprintalreadyexistsinthedatabase2016CERTIFICATE_NAME_ALREADY_EXISTS_409Certificatenotimported,sinceitsnameisalreadyinuse2017_802_1X_SETUP_NAME_CONFLICT_409802_1XSetup.
SetupNamealreadyexists2018_802_1X_SETUP_ID_CONFLICT_409SetupIdinmodelandfromrequestdon'tmatch2019_802_1X_SETUP_STILL_LINKED_TO_WIFISETUP_CONFLICT_409Cannotdelete802.
1xSetupsinceitisstilllinkedtoWiFiSeup2020_802_1X_SETUP_STILL_LINKED_TO_AMTPROFILE_CONFLICT_409Cannotdelete802.
1xSetupsinceitisstilllinkedtoIntelAMTProfile2021AMTPROFILE_STILL_LINKED_TO_INTELAMTSETUP_CONFLICT_409CannotdeleteIntelAMTProfilesinceitisstilllinkedtoatleastoneIntelAMTSetuprecord2022FW_NOT_READY_409Endpointisnotreadytoexecutethisoperationyet,pleasewaitandretry.
2023AMT_CONNECTION_CONFLICT_409IntelAMTconnectionproblem.
2024AMT_PROVISION_STATE_CONFLICT_409IntelAMTmustbeinpost-provisioningstate.
2025ENDPOINT_NOT_ROUTABLE_CONFLICT_409EndpointmustbeCIRAconnectedorhaveneighbors.
2026CIRA_CANT_USE_STATIC_IP_409CIRASetupdoesn'tallowprofileswithStaticIP.
2027REALM_CONFLICT_409DifferentrealmreportedbyEndpoint,operationcancelled.
2028CLIENT_CREDENTIALS_TENANT_CONFLICT_409AClientCredentialsaccountalreadyexistsforthistenant.
IntelEMAAPIGuide–July20201712029FILENAME_NOT_UNIQUE_409Filenamehasalreadybeentaken.
415UnsupportedMediaTypeErrorsThefollowingisatablelistingtheIntelEMAAPIExtendedErrorsforerrorcode415.
Table5.
7:405IntelEMAAPIExtendedErrorsExtendedCodeErrorTypeExtendedMessage3000BAD_MEDIA_ONLY_TEXT_FILE_ACCEPTED_415OnlythetextfileisacceptedIntelEMAAPIGuide–July2020172Appendix-802.
1xSetupUsingIntelEMAWebAPINote:YoumustbeloggedinasaTenantAdministratorusertoperformthestepsinthissection.
Thesamplefilesareinthefolder[IntelEMAinstallationpackagefolder]\Samples.
ThesefilesarenotautomaticallyhostedontheIntelEMAwebsiteduringinstallation.
Thesesamplefilesareimplementedusingbare-minimumcodetodemonstratehowtousetheAPIanddonotusesecurecodingpracticestoguardagainstsecurityconcernslikecross-sitescripting.
IMPORTANT!
Thesesamplesshouldneverbehostedinaproductionenvironment.
Forhostinginatestenvironmentfordevelopmentpurposes,copytheSamplesfoldertotheIntelEMAwebsiterootfolder(e.
g.
,C:\inetpub\wwwroot\).
Example802.
1XSetupThisexampleshowshowtocreatean802.
1Xsetuptobeusedbybothnetworkconnectiontypes.
Thisexampleisintendedforlearningpurposesandisnotintendedforuse"asis"inproductionenvironmentswheresecurityisaconcern.
1.
AccessIntelEMAWebAPIsample802_1XSetup.
htmlandGetToken.
(YoucanalsousetheIntelEMAwebsiteGUItoperformthis.
2.
GotoGettheCertificateAuthoritiesintheDomainsectionandclicktheGetCAsbutton.
Note:ThisendpointwillreturnalistoftheCertificationAuthoritiesinthenetworkanditsCertificateTemplates.
Thesevalueswillbeusedbelowtocreatethe802.
1Xsetup.
3.
GotothePOST802.
1XSetupsection.
SpecifyaNameforthesetup,thenspecifythefollowingsettingstouseEAP-TLSprotocolandrequesttheclientcertificatetotheCertificationAuthority(refertothe802.
1XSetupSettingssectionforadetaileddescriptionofeachproperty):IntelEMAAPIGuide–July20201734.
ClickPost802.
1XSetuptocreatethesetupandgetitscorrespondingID.
WiFiSetupCreateaWiFiSetuptobeusedbytheIntelAMTProfileforwirelessconnection.
1.
AccessIntelEMAWebAPIsampleWifiSetup.
htmlandGetToken.
(YoucanalsousetheIntelEMAwebsiteGUItoperformthis.
SeetheIntelEMAAdministrationandUsageGuideforfurtherdetails.
)2.
GotothePOSTWiFiSetupsection,andspecifyaNameforthesetup,andthefollowingvalues:SSIDName:"NETGEAR45"KeyManagementProtocol:WiFiProtectedAccessIIEnterprise(WPA2-802.
1X)EncryptionAlgorithm:CountermodeCBCMACProtocol802.
1XSetupID:TheIDobtainedinthe802.
1XSetupsubsectionNote:IncasetheWPAencryptionmodewassetintheWirelessConnectionsubsection,thevaluescombinationmustbe"KMP=WiFiProtectedAccessEnterprise(WPA-802.
1X);EA=TemporalKeyIntegrityProtocol"3.
ClickPostWiFiSetuptocreatethesetupandgetitscorrespondingID.
{"UseRoamingIdentity":false,"AuthenticationProtocol":0,"AvailableInS0":true,"PSK":null,"PACPassword":null,"ProtectedAccessCredential":null,"Domain":null,"Password":null,"Username":null,"ServerCertificateName":"WIN-GUVUHKBNQ69.
vprodemo.
com","ServerCertificateNameComparisonOption":2,"RoamingIdentity":null,"PXETimeoutInSeconds":300,"ADIntegrationSettings":{"OrganizationUnit":"VProDevComputers","SecurityGroups":["CN=vPro8021XComputers,DC=VPRODEMO,DC=COM"],"DomainName":"vprodemo.
com"},"ClientAuthenticationSettings":{"ClientCertificateSettings":{"Source":1,"Thumbprint":null,"CAName":"192.
168.
1.
2\\VPRODEMO-WIN-GUVUHKBNQ69-CA","Template":"AMTMAchine"},"CommonNamesOption":0,"CommonNames":null,"DesignatedSubjectCN":4},"RootCertificateSettings":{"Source":1,"Thumbprint":null,"CAName":"192.
168.
1.
2\\VPRODEMO-WIN-GUVUHKBNQ69-CA"}}IntelEMAAPIGuide–July2020174IntelAMTProfilesCreatetwoprofiles,oneforeachtypeofnetworkconnection.
WiredConnection1.
AccesstheIntelEMAWebAPIsampleAMTProfiles.
htmlandGetToken.
(YoucanalsousetheIntelEMAwebsiteGUItoperformthis.
SeetheIntelEMAAdministrationandUsageGuideforfurtherdetails.
)2.
GotothePOSTAMTProfilesection,setaNameandDescriptionfortheProfileandthefollowingvalues:Setup:SetupTLSsecurityPowerActiveOn:1PowerStateIdleTimeout:1ManagementInterfacesSettings:FqdnSettings:IPSettings:WiFiConnectionSettings:Wired802.
1XSettings.
SettheIDobtainedinthe802.
1XSetupsubsection:3.
ClickPostAMTProfiletocreatetheprofileandgetitscorrespondingID.
WirelessConnectionThisprofilerequirestheWiFiSetupIDcreatedintheprevioussubsection.
{"WebUIServiceEnabledState":2,"KVMInterfaceState":2,"UserConsentRequired":1,"UserConsentDisplayTimeout":60,"SOLEnabled":true,"IDEREnabled":true,"RedirectionServiceState":32771}{"FqdnSource":0}{"DHCPEnabled":true,"SharedStaticIp":false,"Source":0,"IP":"1.
1.
1.
1","SubnetMask":"255.
255.
255.
0","DefaultGateway":"1.
1.
1.
1","PrimaryDNS":"1.
1.
1.
1","SecondaryDNS":"1.
1.
1.
1"}{"AMTHostWiFiSyncEnabled":0,"WiFiConnectionEnabledConfiguration":0,"WiFiEnabledInPowerState":2,"WiFiSetups":[]}{"_802_1Setup_DBLookupKey":1}IntelEMAAPIGuide–July20201751.
AccesstheIntelEMAWebAPIsampleAMTProfiles.
htmlandGetToken.
(YoucanalsousetheIntelEMAwebsiteGUItoperformthis.
)2.
GotothePOSTAMTProfilesection,setaNameandDescriptionfortheProfileandthefollowingvalues:Setup:SetupTLSsecurityPowerActiveOn:1PowerStateIdleTimeout:1ManagementInterfacesSettings:FqdnSettings:IPSettings:WiFiConnectionSettings.
In"WiFiSetups"settheIDobtainedinWiFiSetupcreation:Wired802.
1XSettings:3.
ClickPostAMTProfiletocreatetheprofileandgetitscorrespondingID.
EndpointGroupCreatetwoendpointgroups,eachenabledwithIntelAMTautosetup,usingtherecentlycreatedtwoIntelAMTProfiles,respectively.
Weused"Host-basedprovision"astheprovisionapproach.
InstallIntelEMAAgentsUsetwoIntelAMTendpoints,whichareallnot-provisioned.
FollowthenormalIntelEMAstepstoregistereachendpointtoeachendpointgroupcreatedearly,respectively.
Note:Thedevicemustbeconnectedtoaregularport(no802.
1Xauthentication)duringinstallationinorderfortheprovisioningcanbecarriedout.
{"WebUIServiceEnabledState":2,"KVMInterfaceState":2,"UserConsentRequired":1,"UserConsentDisplayTimeout":60,"SOLEnabled":true,"IDEREnabled":true,"RedirectionServiceState":32771}{"FqdnSource":0}{"DHCPEnabled":true,"SharedStaticIp":false,"Source":0,"IP":"1.
1.
1.
1","SubnetMask":"255.
255.
255.
0","DefaultGateway":"1.
1.
1.
1","PrimaryDNS":"1.
1.
1.
1","SecondaryDNS":"1.
1.
1.
1"}{"AMTHostWiFiSyncEnabled":1,"WiFiConnectionEnabledConfiguration":1,"WiFiEnabledInPowerState":1,"WiFiSetups":[1]}{"_802_1Setup_DBLookupKey":null}IntelEMAAPIGuide–July2020176TestconnectionsWiredconnection1.
AtthewiredEthernetswitch,changetheEthernetcabletotheportconfiguredtouse802.
1XauthenticationintheWiredConnectionsubsection.
2.
RestarttheendpointtotheBIOSSetup3.
Onanothercomputer(e.
g.
,theserver)opentheMeshCommanderRemoteManagementConsole(download)4.
CreateanentrybyclickingAddComputer…a.
Hostname:SettheIPAddressfortheEthernetinterface(thisisthesameaddressasinano-802.
1Xconnection)b.
Auth/Security:Digest/TLSc.
Username:admind.
Password:ThepasswordsetintheIntelAMTProfilesubsection5.
ClickConnectfortheentry.
ThisshouldconnecttoIntelAMTandloaditsproperties.
ARemoteDesktopconnectionisalsopossiblefromthistool.
Wirelessconnection1.
UnplugtheEthernetcableandactivatethedevice'sWi-Fiinterfacewithoutbeingconnectedtoanynetwork2.
RestarttheendpointtotheBIOSSetup3.
Inanothercomputer(e.
g.
,theserver)opentheMeshCommanderRemoteManagementConsole(download)4.
CreateanentryclickingAddComputer…a.
Hostname:SettheIPAddressfortheWi-Fiinterface(thisisthesameaddressasinano-802.
1Xconnection)b.
Auth/Security:Digest/TLSc.
Username:admind.
Password:ThepasswordsetintheIntelAMTProfilesubsection5.
ClickConnectfortheentry.
ThisshouldconnecttoIntelAMTandloaditsproperties.
ARemoteDesktopconnectionisalsopossiblefromthistool.
ToverifytheaccessgrantedbytheRADIUSserver,gototheWindowsServer'sEventViewerinCustomViews>ServerRoles>NetworkPolicyandAccessServices.
Thelatesteventshouldbetherecentconnection,indicatingauserwasgranted,asshowninthefigurebelow.
IntelEMAAPIGuide–July2020177Also,therequesterRADIUSclientcanbeseenintheeventshowninthefigurebelow.
AddcertificatestoIntelEMAdatabaseThefollowinginstructionsindicatehowtomanuallygetbothrootandclientcertificatestobeuploadedtoIntelEMA'sdatabaseinordertobeusedby802.
1XSetup.
ThisisrequiredifthecertificateswillbeobtainedfromIntelEMAdatabase.
1.
OpentheWindowsCertificates–LocalComputerconsoleandgotothePersonal\Certificatesfolder.
2.
RightclickontheCertificatesfolderandselectAllTasks>RequestNewCertificate.
3.
ClickNextinthefirsttwopanels.
ThenselecttheCertificateTemplatecreatedfor802.
1Xduringenvironmentsetupandclickthebluemessagelinkbelowittosupplymoreinformation.
IntelEMAAPIGuide–July20201784.
OntheSubjecttabofCertificateProperties,addthefollowingvalues:Subjectname:oType:Commonname;Value:UserPrincipalNameoftheIntelAMTcomputer(e.
g.
,win10-amt11-lap-iME@vprodemo.
com).
Notethatyouneedtoappend-iME.
Alternativename:oType:DNS;Value:SAMAccountName(e.
g.
,win10-amt11-lap$iME).
Notethatyouneedtoappend$iME.
oType:DNS;Value:CommonName(e.
g.
,win10-amt11-lap-iME).
Notethatyouneedtoappend-iME.
oType:Userprincipalname;Value:UserPrincipalName(e.
g.
,win10-amt11-lap-iME@vprodemo.
com).
Notethatyouneedtoappend-iME.
5.
SavethepropertiesandclickEnrolltocreatethecertificate.
6.
Findthecertificate,right-clickit,andselectAllTasks>Export.
7.
ClickNextinthefirstpanelandselectYes,exporttheprivatekey.
IntelEMAAPIGuide–July20201798.
IntheExportFileFormatpanel,thePersonalInformationExchange(.
PFX)optionisselectedbydefault.
Underthat,selectbothIncludeallcertificatesinthecertificationpathifpossibleandExportallextendedproperties.
9.
Inthenextpanel,checkthePasswordoptionandindicateapasswordtoprotecttheprivatekey.
RememberthispasswordasmustbeindicatedwhenthecertificateisuploadedtoIntelEMA.
10.
IndicatethenameandpathtosavethecertificateandclickFinishtocompletetheexport.
11.
FollowIntelEMAUsageGuidetouploadthecertificateviaServerSettingsuserinterface.
Thisoperationwilladdtwocertificatestothedatabase:theclientcertificatewecreatedbyenrollmentandtherootcertificateoftheCertificateAuthoritythatprovidedit.
12.
Usethesameuserinterfacetoseethenewcertificatesthatwereputintothedatabase.
TherootcertificatehastheCAnameinNameandCommonNameproperties.
Then,youcandownloadthecertificateandcheckitsthumbprintvalue,tobeusedlater.
802.
1XSetupSettingsNote:YoumustbeloggedinasaTenantAdministratorusertoperformthestepsinthissection.
ThissectiondescribesallofthepropertiesthataresetintheIntelEMAWebAPI802.
1XSetupsample.
OnlyEAP-TLSAuthenticationprotocolisfullysupported.
Eachpropertyhasanannotationindicatingifitisneededforthisprotocolandthepossiblevalues.
SettingDescriptionPSKApre-sharedkeyusedforpre-sharedkeyEAPtypessuchasEAP-PSK,EAP-SIM,andEAP-AKA.
Valuetype:OctetString(willbeconvertedtobytearrayinternally)EAP-TLSProtocol:Thispropertyisnotevaluated,canbenullornotpresent.
ProtectedAccessCredentialAcredentialusedbythesupplicantandAAAservertoestablishamutuallyauthenticatedencryptedtunnelforconfidentialuserauthentication.
ThisfieldisrelevantforEAP-FASTonly.
Itisnotrequirediftheserverisconfiguredfor"PACprovisioning".
Valuetype:OctetString(willbeconvertedtobytearrayinternally)EAP-TLSProtocol:Thispropertyisnotevaluated,canbenullornotpresent.
IntelEMAAPIGuide–July2020180SettingDescriptionDomainThedomain(alsoknownasrealm)withinwhichUsernameisunique.
TheDomainstringshouldn'tcontainthesuffix,sotheusername(Domain\user)willbecorrect.
IftheDomainstringcontainsasuffix(e.
g.
Domain=intel.
com),theusertryingtoauthenticatewillbeoftheformintel.
com\user(insteadofintel\user)andthusauthenticationwillfail.
Valuetype:StringEAP-TLSProtocol:Thispropertyisnotevaluated,canbenullornotpresent.
UsernameIdentifiestheuserrequestingaccesstothenetwork.
Valuetype:StringEAP-TLSProtocol:Thispropertyisnotevaluated,canbenullornotpresent.
ServerCertificateNameComparisonOptionThecomparisonalgorithmthatshallbeusedbytheservertovalidatethesubjectnamefieldofthecertificatepresentedbytheAAAserveragainstthevalueoftheServerCertificateNameproperty.
ThisfieldismandatoryifServerCertificateNameisdefined.
Values(Int):2=FullName3=DomainSuffixEAP-TLSProtocol:ThispropertyisevaluatedifServerCertificateNameisdefined.
ServerCertificateNameThenamethatshallbecomparedagainstthesubjectnamefieldinthecertificateprovidedbytheAAAserver.
ShallcontaineitherthefullyqualifieddomainnameoftheAAAserver,inwhichcaseServerCertificateNameComparisonshallcontain"FullName",orthedomainsuffixoftheAAAserver,inwhichcaseServerCertificateNameComparisonshallcontain"DomainSuffix".
Thisfieldisoptional.
Ifnotdefined,thenameisnotchecked.
Theauthenticityofthecertificateisalwaysverified.
Valuetype:StringEAP-TLSProtocol:Thispropertyisevaluated,butcanbenullornotpresent.
IntelEMAAPIGuide–July2020181SettingDescriptionRoamingIdentityAstringpresentedtotheauthenticationserverin802.
1xprotocolexchange.
TheAAAserverdeterminestheformatofthisstring.
FormatssupportedbyAAAserversinclude:\,@.
Thisstring,ifdefined,issentinresponseto802.
1x"requestidentity"ascleartext.
Ifempty,theusernameissent.
WhenUseRoamingIdentityisfalse,thisshouldbenullornotpresent.
Valuetype:StringEAP-TLSProtocol:Thispropertyisnotevaluated,canbenullornotpresent.
AuthenticationProtocolAuthenticationProtocolshallindicatethedesiredEAP(ExtensibleAuthenticationProtocol)type.
EAP-TLS(0):shallindicatethatthedesiredEAPtypeistheTransportLayerSecurityEAPtypespecifiedinRFC2716.
IfAuthenticationProtocolcontains0,Usernameshouldnotbenull,ServerCertificateNameandServerCertificateNameComparisonmaybenullornotnull,andRoamingIdentity,Password,Domain,ProtectedAccessCredential,PACPassword,andPSKshouldbenull.
Values(Int):0=EAP-TLSPXETimeoutInSecondsTimeoutinseconds,inwhichtheIntelAMTwillholdanauthenticated802.
1Xsession.
Duringthedefinedperiod,IntelAMTmanagesthe802.
1XnegotiationwhileaPXEboottakesplace.
Afterthetimeout,controlofthenegotiationpassestothehost.
ThissettingappliestoWiredConnections.
Themaximumvalueis86400seconds(oneday);Avalueof0disablesthefeature;Ifthisoptionalvalueisomitted,IntelAMTsetsadefaultvalueof120seconds.
Valuetype:IntEAP-TLSProtocol:Thispropertyisevaluated.
Suggested120asthedefaultvalue.
IntelEMAAPIGuide–July2020182SettingDescriptionAvailableInS0Indicatestheactivitysettingofthe802.
1XmoduleinS0state.
Thedefaultvalueforthispropertyis'true'.
ThissettingappliestoWiredConnections.
Functionality:FALSE,AMTisnotaccessible(over802.
1xenabledport)incasethehostisinS0butfailstoauthenticatetotheserver.
TRUE,AMThandlestheauthenticationinthiscase(butthehoststillcan'tbeaccesseduntilitauthenticatessuccessfully).
If802.
1Xisnotconfigured,thisAPImaystillsucceedasthesettingmaybestoredforfutureuse.
Valuetype:BooleanEAP-TLSProtocol:ThispropertyisevaluatedEnabledIndicateswhetherthe802.
1xprofileisenabled.
IfthispropertyisnoprovidedthedefaultvalueisEnabled.
ThissettingappliestoWiredConnections.
Values(Int):2=Enabled3=DisabledForDisabledstatus,thewholeprocessisperformed(creationof:ADobject,certificate,802.
1Xprofile)butthe802.
1xprofileisdisabledsoitwillnotbeusedonauthentication.
EAP-TLSProtocol:Thispropertyisevaluated,butmaynotbepresent.
UseRoamingIdentityIfthisistrue,theuserwillconnecttotheRADIUSserverwithanidentitydefinedatRoamingIdentity.
Ifthisisfalse,RoamingIdentityshouldbenullornotpresent.
Valuetype:BooleanEAP-TLSProtocol:Thispropertyisnotevaluated.
Setittofalse.
ADIntegrationSettingsGroupsettingsusedtointegrateIntelAMTwiththesecurityinfrastructureofthedomain'sActiveDirectory(AD)OrganizationUnitOrganizationUnitinADwhichthecomputerobjectforAMTwillbecreated,mustbeindistinguisehedname(DN)formatValuetype:StringEAP-TLSProtocol:ThispropertyisevaluatedIntelEMAAPIGuide–July2020183SettingDescriptionSecurityGroupsTheADObjectcreatedfortheIntelAMTdeviceisbydefaultautomaticallyaddedtotheADSecuritygroupnamed"DomainComputers".
Ifnecessary,itisalsopossibletodefineadditionalSecuritygroupstowhichtheobjectwillbeaddedincasetheRADIUSserverrequiresobjectstobemembersofaspecificSecuritygroup.
Valuetype:ListofStrings.
EachoneshouldbetheDistinguishedNameofthatsecuritygroup.
EAP-TLSProtocol:ThispropertyisevaluatedClientAuthenticationSettingsGroupsettingsrelatedtoclientcertificategeneration/retrievalforuseinauthentication.
ClientCertificateSettingsGroupsettingstospecifytheinformationandentitiesinvolvedinrequestingandissuingclientcertificatestobeusedduringclientauthentication.
SourceForprotocolsthatsupportit,allowsspecifyinghowtoobtainthecertificateusedtoauthenticatetotheserver.
RequiredforEAP_TLSprotocol.
Values(Int):0=None1=RequestfromCA(theCANamesettingisrequiredforthistype)2=Pickfromdatabase(theThumbprintandTemplatesettingsarerequiredforthistype)EAP-TLSProtocol:Thispropertyisevaluated.
ThumbprintIndicatesthethumbprintpropertyofthecertificatethatisalreadyintheIntelEMAdatabase.
ThesecertificatesareuploadedtotheIntelEMA'sdatabasethroughtheIntelEMAWebAPIsampleAmtProvisioningCertificates.
htmlusingtheUploadAMTGeneralCertificatePFXendpoint.
ThecertificatewillbeuploadedtotheTenant'scertificatesandwillnotbemarkedasprovisioningcertificate.
ItisimportanttobesuretheindicatedcertificateisofthetyperequiredbyRADIUS.
ThisisrequiredonlyifClientAuthenticationSettings.
ClientCertificateSettings.
Source=2.
Valuetype:StringEAP-TLSProtocol:ThispropertyisevaluatedifyouusetousethecertificatefromDB.
IntelEMAAPIGuide–July2020184SettingDescriptionCANameThenameoftheCertificationAuthoritytobecontacted.
Itmustbeintheformat:hostname\CANameThisisrequiredonlyifClientAuthenticationSettings.
ClientCertificateSettings.
Source=1.
Valuetype:StringEAP-TLSProtocol:ThispropertyisevaluatedifyouusetousethecertificatefromCA.
TemplateThenameoftheCertificateTemplatetoberequired.
ItmustbeavailableandcomplywithEMArequirementsforrequestingandretrievingclientcertificates.
ThisisrequiredonlyifClientAuthenticationSettings.
ClientCertificateSettings.
Source=1.
Valuetype:StringEAP-TLSProtocol:ThispropertyisevaluatedifyouusetousethecertificatefromCA.
CommonNamesOptionIndicatesiftherequestedCertificate'sAlternativeNameswillbedefinedbydefaultoruserdefined.
ThisisrequiredonlyifClientAuthenticationSettings.
ClientCertificateSettings.
Source=1.
Values(Int):0=Default.
Whenselected,theclientcertificate'sSubjectAlternativeNameisconfiguredasfollows:oUserPrincipalNameoDNSHostName(FQDN)oHostNameoSAMAccountNameoUUIDofthenewADobjectrepresentingtheAMTsystemoDistinguishedName1=UserDefinedEAP-TLSProtocol:Thispropertyisevaluated,ifyourequestcertificatefromMicrosoft*CA.
Bothwaysaresupported.
IntelEMAAPIGuide–July2020185SettingDescriptionCommonNamesIftheCommonNamesOptionsettingissettoUserDefined,thecommonnamesindicatedinthissettingareaddedasthecertificate'sSubjectAlternativeName.
ThisisrequiredonlyifClientAuthenticationSettings.
ClientCertificateSettings.
Source=1.
AllowedCommonNameitems:0=DNSFQDN1=Hostname2=SAMAccountName3=UUID4=UserPrincipalName5=DistinguishedName6=AMTRMCP7=AMTSecureRMCP8=AMTHTTP9=AMTHTTPS10=AMTTCPRedirect11=AMTTLSRedirect12=AMTVNCKVMValuetype:ListofCommonNameID(Int)EAP-TLSProtocol:Thispropertyisevaluated,ifyourequestcertificatefromMicrosoft*CA.
DesignatedSubjectCNIndicatestherequestedcertificate'sSubjectName.
Ifthissettingisnotspecified,thedefaultvalueis4=UserPrincipalName.
ThisisrequiredonlyifClientAuthenticationSettings.
ClientCertificateSettings.
Source=1.
Valuetype:Int.
ACommonNameitem'sID.
EAP-TLSProtocol:Thispropertyisevaluated,ifyourequestcertificatefromMicrosoft*CA.
DesignatedUsernameCNOptional.
Ifspecified,thesystemwilloutputthevalueofthedesignatedcommonnameintotheUsernamefieldofthe802.
1Xsetup.
Ifthissettingisnotspecified,thedefaultvalueis4=UserPrincipalName.
Valuetype:Int.
ACommonNameitem'sID.
Note:ForNPS,theconfirmedvaluethatworksistheUserPrincipalName.
EAP-TLSProtocol:Thispropertyisevaluated,butmaynotbepresent.
IntelEMAAPIGuide–July2020186SettingDescriptionRootCertificateSettingsGroupsettingsforobtainingthetrustedrootcertificatetobeinstalledinIntelAMT.
IftheCAnameisnotknownbeforehand,itcanbeobtainedusingtheIntelEMAWebAPIsample802_1XSetup.
htmlintheGettheCertificateAuthoritiesIntheDomainsection,whichreturnsalistoftheCAfoundinthedomainanditsrespectiveCertificateTemplates.
TheusermustbesuretheindicatedCAisthecorrectrootCAthatprovidesthetrustedrootcertificateforthe802.
1Xauthentication.
RequiredforallauthenticationprotocolsexceptGTC.
SourceDesignateswherethetrustedrootcertificateusedtoauthenticatetheserverisobtainedfrom.
Values(Int):0=None1=RequestfromCA(theCANamesettingisrequiredforthistype)2=Pickfromdatabase(theThumbprintsettingisrequiredforthistype)EAP-TLSProtocol:Thispropertyisevaluated.
ThumbprintSpecifiesthethumbprintpropertyofthecertificatethatisalreadyintheIntelEMAdatabase.
ThesecertificatesareuploadedtotheIntelEMA'sdatabasethroughtheIntelWebAPIsampleAmtProvisioningCertificates.
htmlusingtheUploadAMTGeneralCertificatePFXendpoint.
ThecertificatewillbeuploadedtotheTenant'scertificatesandwillnotbemarkedasprovisioningcertificate.
ItisimportanttobesuretheindicatedcertificateisofthetyperequiredbyRADIUS.
ThisisonlyrequiredifRootCertificateSettings.
Source=2.
Valuetype:StringEAP-TLSProtocol:Thispropertyisevaluated.
CANameThenameoftherootCertificationAuthoritytobecontacted.
ThisisonlyrequiredifRootCertificateSettings.
Source=1.
EAP-TLSProtocol:Thispropertyisevaluated.