Get Licensed Users

This request retrieves a list of M365 users that are assigned with Live Platform licenses.

URI

Copy

{{baseUrl}}/api/v2/customer/{umpCustomerGuid}/licensedUsers

HTTP Method

GET

Request Parameters

Parameter

Type

Description

umpCustomerGuid

string($uuid)

(path)

umpCustomerGuid' value created in the Live Platform customer 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

Copy

[
    {
        "sipAddress": "alexw@m365x89839532.onmicrosoft.com",
        "licenseCriteria": "Managed Users - By User Interface"
    },
    {
        "sipAddress": "lidiah@m365x89839532.onmicrosoft.com",
        "licenseCriteria": "Managed Users - By LifeCycle Management"
    },
    {
        "sipAddress": "pattif@m365x89839532.onmicrosoft.com",
        "licenseCriteria": "Managed Users - By LifeCycle Management"
    },
    {
        "sipAddress": "debrab@m365x89839532.onmicrosoft.com",
        "licenseCriteria": "Managed Users - By LifeCycle Management"
    },
    {
        "sipAddress": "isaiahl@m365x89839532.onmicrosoft.com",
        "licenseCriteria": "Managed Users - By LifeCycle Management"
    },
    {
        "sipAddress": "diegos@m365x89839532.onmicrosoft.com",
        "licenseCriteria": "Managed Users - By LifeCycle Management"
    },
    {
        "sipAddress": "miriamg@m365x89839532.onmicrosoft.com",
        "licenseCriteria": "Managed Users - By LifeCycle Management"
    },
    {
        "sipAddress": "jonis@m365x89839532.onmicrosoft.com",
        "licenseCriteria": "Managed Users - By LifeCycle Management"
    },
    {
        "sipAddress": "meganb@m365x89839532.onmicrosoft.com",
        "licenseCriteria": "Managed Users - By LifeCycle Management"
    }
]

Response

■

200 OK

Parameter

Type

Description

sipAddress

string

The SIP address of the licensed user.

licenseCriteria

string

The details of the licensed factors:

■

managedUsersDirectRouting

■

managedUsersOperatorConnect

■

managedUsersByLifeCycleManagement

■

managedUsersUserInterface

■

managedServiceNumbers

■

400 Bad Request

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	StatusCodes.Status400BadRequest
detail	string	Additional error details.
instance	string	HttpContext.Request.Path
errorTicket	string	errId.ToString()
errorCode	string	Error code output in the request
traceId	string	HttpContext.TraceIdentifier
additionalProp1	string	TBD
additionalProp2	string	TBD
additionalProp3	string	TBD

■

500 Internal Server Error