Introduction
Starting from EPM 2017.3, two news API are available : PatchAPI and DistributionAPi. This article intends to describe how to obtain an access token to be able to use them and how to query them. The present document doesn't apply to older EPM/LDMS versions or to legacy API (called MBSDK). We will describe one way to interact with APsI using the third party software Postman. Many different ways exist, including Powershell or C# scripting.
WARNING : Postman isn't a tool created nor managed by Ivanti. We are not liable for any malfunction when using it.
Get the token
First we will have to register our application in the IdentityServer with a client id and shared secret :
1. Go the core server and open C:\ProgramData\LANDesk\ServiceDesk\My.IdentityServer
2. Backup the file IdentityServer3.Core.Models.Client.json
3. Edit it and add at the beginning, after the first bracket :
{ "Enabled": true, "ClientId": "roclient", "ClientSecrets": [ { "Description": "roclient", "Value": "secret", "Expiration": null, "Type": "SharedSecret" } ], "Flow": 4, "AllowAccessToAllScopes": true, "AllowedScopes": [] },
Where secret will be your shared secret and roclient your client id.
4. Save the file.
5. Download the app Postman on the official website.
6. Install the software. You can install it on any device able to communicate with core server.
7. Open Postman.
8. Create a new request as prompted and save it wherever you want.
9. Type the following URL in front of the GET method : https://yourcoreserver/my.identityserver/identity/connect/token
10. Choose the authorization type "OAuth 2.0"
11. Click "Get New Access Token".
Token Name will be the name used by the token in Postman. Choose whatever you want.
Access Token URL is the same as previously : https://yourcoreserver/my.identityserver/identity/connect token
Username : username of an EPM admin
Password : password of an EPM admin
Client ID : defined previously in configuration file
secret : defined previously in configuration file
Scope : openid
12. Click Request Token.
You now have an access token for EPM API !
Use the token
A documentation regarding available API calls can be obtained there :
1. Copy the token obtained from previous step.
2. Go to Authorization, choose Bearer Token and paste it in Token field. Click Preview Request. The token is going to be inserted automatically in the header field.
3. Choose the HTTP method you want to use (i.e GET, POST, PUT ...).
4. Fill the URL you want to use as described in documentation. Make sure to use HTTP only, not HTTPS (as example : http://yourcoreserver/distributionapi/api/v1/DistributionAndPatchSettings).
5. If you are using a HTTP method that requires a body (POST as example), choose Body.
6. Make sure to select raw and JSON.
7. Paste the parameters to pass on the field below as described in documentation.
8. Click Send : API call is made.