Entitlement Insight - Get Tenant Users

Service:

Power Platform API

API Version:

2024-10-01

Get the list of tenant users entitlement snapshot for the specified entitlement.

GET https://api.powerplatform.com/licensing/entitlements/{entitlementId}/users?fromDate={fromDate}&toDate={toDate}&api-version=2024-10-01

With optional parameters:

GET https://api.powerplatform.com/licensing/entitlements/{entitlementId}/users?fromDate={fromDate}&toDate={toDate}&pageSize={pageSize}&searchRequest={searchRequest}&orderbyConsumed={orderbyConsumed}&continuationToken={continuationToken}&api-version=2024-10-01

URI Parameters

Name	In	Required	Type	Description
entitlementId	path	True	string	The entitlement ID.
api-version	query	True	string	The API version.
fromDate	query	True	string	The start date (inclusive) of the query range.
toDate	query	True	string	The end date (inclusive) of the query range.
continuationToken	query		string	Continuation token for pagination.
orderbyConsumed	query		string	Order by consumed field.
pageSize	query		integer (int32)	The page size for pagination.
searchRequest	query		string	Search request for filtering the users.

Responses

Name	Type	Description
200 OK	TenantUserResponseModelPagedResponse	Success
204 No Content		No Content
400 Bad Request		Bad Request
401 Unauthorized		Unauthorized
403 Forbidden		Forbidden
404 Not Found		Not Found

Security

oauth2

Microsoft Entra ID OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize?resource=https://api.powerplatform.com

Scopes

Name	Description
.default	.default

Definitions

Name	Description
TenantCapacityConsumptionUserSnapshotResponseModel
TenantUserResponseModel
TenantUserResponseModelPagedResponse	A paged response with a continuation token.

TenantCapacityConsumptionUserSnapshotResponseModel

Object

Name	Type	Description
asOfDate	string (date-time)
consumed	number (double)
environmentId	string
metadata	object
tenantId	string
unit	string
userId	string

TenantUserResponseModel

Object

Name	Type	Description
users	TenantCapacityConsumptionUserSnapshotResponseModel[]	The list of users associated with the tenant.

TenantUserResponseModelPagedResponse

Object

A paged response with a continuation token.

Name	Type	Description
@odata.count	integer (int32)
@odata.nextLink	string
continuationtoken	string
value	TenantUserResponseModel[]