license_details

Creates, updates, deletes, gets or lists a license_details resource.

Overview

Name	license_details
Type	Resource
Id	entra_id.users.license_details

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
servicePlans	array	Information about the service plans assigned with the license. Read-only. Not nullable.
skuId	string (uuid)	Unique identifier (GUID) for the service SKU. Equal to the skuId property on the related subscribedSku object. Read-only. (pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
skuPartNumber	string	Unique SKU display name. Equal to the skuPartNumber on the related subscribedSku object; for example, AAD_Premium. Read-only.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
servicePlans	array	Information about the service plans assigned with the license. Read-only. Not nullable.
skuId	string (uuid)	Unique identifier (GUID) for the service SKU. Equal to the skuId property on the related subscribedSku object. Read-only. (pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)
skuPartNumber	string	Unique SKU display name. Equal to the skuPartNumber on the related subscribedSku object; for example, AAD_Premium. Read-only.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	user_id, license_details_id		A collection of this user's license details. Read-only.
list	select	user_id		A collection of this user's license details. Read-only.
insert	insert	user_id
update	update	user_id, license_details_id
delete	delete	user_id, license_details_id	If-Match

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
license_details_id	string	The unique identifier of licenseDetails
user_id	string	The unique identifier of user
If-Match	string	ETag

SELECT examples

get

A collection of this user's license details. Read-only.

SELECT
id,
servicePlans,
skuId,
skuPartNumber
FROM entra_id.users.license_details
WHERE user_id = '{{ user_id }}' -- required
AND license_details_id = '{{ license_details_id }}' -- required
;

list

A collection of this user's license details. Read-only.

SELECT
id,
servicePlans,
skuId,
skuPartNumber
FROM entra_id.users.license_details
WHERE user_id = '{{ user_id }}' -- required
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.users.license_details (
id,
servicePlans,
skuId,
skuPartNumber,
user_id
)
SELECT 
'{{ id }}',
'{{ servicePlans }}',
'{{ skuId }}',
'{{ skuPartNumber }}',
'{{ user_id }}'
RETURNING
id,
servicePlans,
skuId,
skuPartNumber
;

Manifest

# Description fields are for documentation purposes
- name: license_details
props:
  - name: user_id
    value: "{{ user_id }}"
    description: Required parameter for the license_details resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: servicePlans
    description: |
      Information about the service plans assigned with the license. Read-only. Not nullable.
    value:
      - appliesTo: "{{ appliesTo }}"
        provisioningStatus: "{{ provisioningStatus }}"
        servicePlanId: "{{ servicePlanId }}"
        servicePlanName: "{{ servicePlanName }}"
  - name: skuId
    value: "{{ skuId }}"
    description: |
      Unique identifier (GUID) for the service SKU. Equal to the skuId property on the related subscribedSku object. Read-only.
  - name: skuPartNumber
    value: "{{ skuPartNumber }}"
    description: |
      Unique SKU display name. Equal to the skuPartNumber on the related subscribedSku object; for example, AAD_Premium. Read-only.

UPDATE examples

update

No description available.

UPDATE entra_id.users.license_details
SET 
id = '{{ id }}',
servicePlans = '{{ servicePlans }}',
skuId = '{{ skuId }}',
skuPartNumber = '{{ skuPartNumber }}'
WHERE 
user_id = '{{ user_id }}' --required
AND license_details_id = '{{ license_details_id }}' --required
RETURNING
id,
servicePlans,
skuId,
skuPartNumber;

DELETE examples

delete

No description available.

DELETE FROM entra_id.users.license_details
WHERE user_id = '{{ user_id }}' --required
AND license_details_id = '{{ license_details_id }}' --required
AND If-Match = '{{ If-Match }}'
;