User licenses (MS Graph API)
The MS Graph API connector lets you list the available licenses in your Azure data source and manage those licenses for specific users.
List available licenses in Azure
This command lists the values of the read-only subscribedSku object. For more information about this object class, refer to the corresponding Microsoft documentation:
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Accept-API-Version: resource=1.0" \
--request GET \
"http://localhost:8080/openidm/system/azuread/subscribedSku?_queryFilter=true"
{
"result": [
{
"_id": "5ee8xxxx-xxxx-xxxx-xxxx-76dc2c2c30bc_f245ecc8-xxxx-xxxx-xxxx-xxxx114de5f3",
"prepaidUnits": {
"warning": 0,
"enabled": 1,
"suspended": 0
},
"skuId": "f245ecc8-xxxx-xxxx-xxxx-xxxx114de5f3",
"skuPartNumber": "O365_BUSINESS_PREMIUM",
"capabilityStatus": "Enabled",
"appliesTo": "User",
"consumedUnits": 1,
"__NAME__": "O365_BUSINESS_PREMIUM",
"servicePlans": [
{
"servicePlanName": "RMS_S_BASIC",
"provisioningStatus": "PendingProvisioning",
"appliesTo": "Company",
"servicePlanId": "31cxxxxxxxxxxxxxxxxxxxxxxxxxxx122"
},
{
"servicePlanName": "POWER_VIRTUAL_AGENTS_O365_P2",
"provisioningStatus": "PendingProvisioning",
"appliesTo": "User",
"servicePlanId": "041xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxaee"
},
{
"servicePlanName": "CDS_O365_P2",
"provisioningStatus": "PendingProvisioning",
"appliesTo": "User",
"servicePlanId": "95bxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx95a"
},
...
]
}
],
...
}
List a user’s licenses
Each user object can include a read-only licenses property that contains an array of objects (maps).
This command lists a specific user’s licenses:
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Accept-API-Version: resource=1.0" \
--request GET \
"http://localhost:8080/openidm/system/azuread/user/c48be8cc-5846-4059-95e8-a7acbf6aec31?_fields=licenses"
{
"_id": "c48be8cc-5846-4059-95e8-a7acbf6aec31",
"licenses": [
{
"skuPartNumber": "O365_BUSINESS_PREMIUM",
"servicePlans": [
{
"servicePlanName": "RMS_S_BASIC",
"provisioningStatus": "PendingProvisioning",
"appliesTo": "Company",
"servicePlanId": "31cxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx122"
},
{
"servicePlanName": "POWER_VIRTUAL_AGENTS_O365_P2",
"provisioningStatus": "PendingProvisioning",
"appliesTo": "Company",
"servicePlanId": "041xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxaee"
},
{
"servicePlanName": "CDS_O365_P2",
"provisioningStatus": "PendingProvisioning",
"appliesTo": "Company",
"servicePlanId": "95bxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx95a"
},
...
],
"id": "c8noxxxxsEqoxxxxLCwwxxxxRfKvxxxxth8nxxxx5fM",
"skuId": "f24xxxxx-xxxx-xxxx-xxxx-xxxxxxxxx5f3"
}
]
}
Add and remove a user’s licenses
You cannot manipulate a user’s licenses property directly because it is read-only. To add or remove licenses for a user, set the addLicenses or removeLicenses properties when you create or update the user.
|
The connector does not currently support PATCH |
This command updates an existing user entry to add a license with the `skuId`f24xxxxx-xxxx-xxxx-xxxx-xxxxxxxxx5f3:
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Accept-API-Version: resource=1.0" \
--header "Content-Type: application/json" \
--header "If-None-Match: *" \
--request PUT \
--data '{
"addLicenses": [
{
"skuId": "f24xxxxx-xxxx-xxxx-xxxx-xxxxxxxxx5f3"
}
]
}' \
"http://localhost:8080/openidm/system/azuread/user/c48be8cc-5846-4059-95e8-a7acbf6aec31"
This command updates the user entry to remove the license with `skuId`f24xxxxx-xxxx-xxxx-xxxx-xxxxxxxxx5f3:
curl \
--header "X-OpenIDM-Username: openidm-admin" \
--header "X-OpenIDM-Password: openidm-admin" \
--header "Accept-API-Version: resource=1.0" \
--header "Content-Type: application/json" \
--header "If-Match: *" \
--request PUT \
--data '{
"removeLicenses": "f24xxxxx-xxxx-xxxx-xxxx-xxxxxxxxx5f3"
}' \
"http://localhost:8080/openidm/system/azuread/user/c48be8cc-5846-4059-95e8-a7acbf6aec31"