Get Available User Licenses

This request retrieves a list of available licenses for the tenant service.

URI

HTTP Method

GET

Request Parameters

Parameter	Type	Description
customerGuid	string($uuid) (path)	customerGuid' value created in the Live Platformcustomer tenant SQL database directory: ■ Operator Connect: A new OC Essentials service is created when a license is applied to the lead using Create Service from Lead Overview). If this field is null, a license has not yet been applied to the lead. ■ Direct Routing: A new Hosted Essentials service is created by Create Hosted Essentials Service. Extract this value using Get Services Brief Details (V3) or Get Customers Brief Details (V2) searching for the matching Short Name of the service.

Example Response

Response

■

200 OK

Parameter	Type	Description
availableUnits	integer	??
id	integer	??
friendlyName	string	The type of the license that is assigned to the tenant. For example, Microsoft 365 E5 EEA (no Teams)
guid	string($uuid) (path)	???
"needPhoneSystem": false,	boolean	???
"overridePhoneSystemSku": null		???

■

404 Not Found

The table below shows the full list of fields returned in this response. The actual fields returned may differ according to the request.

Parameter	Type	Description
type	string	Error type
title	string	Email title
status	integer	The status of the connection with M365 platform: ■ 0-Active ■ 1-Not Active ■ 2-OC Essential
detail	string	Additional error details.
instance	string	Error instance.
errorTicket	string	The error ticket string opened for this request.
errorCode	string	Error code output in the request
traceId	string	The trace id of the request
additionalProp1	string	Custom Script variable argument. For example IP-Network.
additionalProp2	string	Custom Script argument. For example, IP-SubnetBits.
additionalProp3	string	Custom Script argument. For example, Trusted-IP-Network.

■

500 Internal Server Error

See fields above