Support
 
Phone Live Chat
 
Support
 
US: +1 888 720 9500
US: +1 800 443 6694
Intl: +1 925 924 9500
Aus: +1 800 631 268
UK: 0800 028 6590
CN: +86 400 660 8680

Direct Inward Dialing: +1 408 916 9393

 
 
 
 
 
Remove license
 

Remove o365 licenses API

This API helps you raise a workflow request to remove the Office 365 licenses of users using your application.

Request URL (JSON) Format: http://<hostname>:<port>/RestAPI/CreateWorkFlowRequest

Request Parameters:

Parameters Mandatory Description
AuthToken Yes Authentication token that is generated either from the Delegation tab (Delegation > Configuration > Technician Authtokens) or from the My account tab (My Account > Active Authtokens) in the top right corner of the product.
domainName Yes Domain in which this operation has to be performed. 
inputData Details about the workflow request to be raised. It must also contain the details about the user accounts for which the Office 365 licenses need to be removed. 
Yes Specify the title of the request under Subject. 
Yes Specify the action as REMOVE_O365_LICENSES under RequestAction. 
Yes Specify the displayNames of the users whose O365 licenses have to be revoked.
Optional Specify the priority of the task. 
Optional Provide a suitable Description.
Yes Specify the value of isRemoveAllO365License value as true or false based on your requirements. 
Optional, if the value of RemoveAllO365LicenO365License is true. Specify the Office 365 licenses to be removed using the selectedO365Licenses attribute. 
Optional, if the value of RemoveAllO365License is true. Provide the Office 365 domain names 
Optional if the value of IsAutoReplyTimeBased is false. Specify the duration for which the auto replies must be sent with the help of ReplyStartDate, ReplyEndDate, StartHr, StartMin, EndHr, EndMin attributes. 
PRODUCT_NAME Yes Product name/module name from which the request is being sent; will be needed for auditing.

Response Parameters:

Parameters Description
Subject Subject of the request
requestId RequestId of the request raised. This is not displayed in the response, if the operation has failed.
status Status of the operation, where 1 stands for Success and 0 stands for Failure.
statusMessage The response message to be displayed in case of success or failure.

Sample Input / Output

Request 1:

http://admanager:8080/RestAPI/CreateWorkFlowRequest?AuthToken=244f8f17-041d-4c85-9924-02f7351a6fbb&domainName=admp.local&PRODUCT_NAME=RESTAPI&inputData=[{"RequestAction":"REMOVE_O365_LICENSES", "Subject":"Remove O365 licenses", "accounts":[{"displayName":"john"}], "isRemoveAllO365License":"true"}]

Request 2:

http://admanager:8080/RestAPI/CreateWorkFlowRequest?AuthToken=244f8f17-041d-4c85-9924-02f7351a6fbb&domainName=admp.local&PRODUCT_NAME=RESTAPI&inputData=[{"RequestAction":"REMOVE_O365_LICENSES", "Subject":"Remove O365 licenses", "accounts":[{"displayName":"john"}], "isRemoveAllO365License":"false", "selectedO365Licenses": 
{"accountSKUDetailsList":[{"ACCOUNT_SKU_ID":"ENTERPRISEPACK", "ACCOUNT_SKU_DISP_VAL":"Office 365 Enterprise E3", "IS_SELECTED":true, "ServicePlans": 
[{"SERVICE_NAME":"KAIZALA_O365_P3","IS_SELECTED":true,"TYPE":"User", "SERVICE_NAME_DISP_VAL":"KAIZALA_O365_P3"}]}]}}]

Response:

[{"Subject":"Remove O365 licenses","requestId":7501,"statusMessage":"Successfully created the request.","status":"1"}]

ADManager Plus Trusted By

The one-stop solution to Active Directory Management and Reporting
Email Download Link