ICF 1.5.20.20

Service plans (MS Graph API)

Use the MS Graph API connector to list the service plans in your Azure data source, get details on service plans, and manage service plans for specific users.

List available service plans in Azure

This command lists the values of the read-only servicePlan object:

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/servicePlan?_queryFilter=true"
{
  "result": [
    {
      "_id": "4a82b400-a79f-41a4-b4e2-e94f5787b113",
      "__NAME__": "EXCHANGE_S_DESKLESS",
      "appliesTo": "User",
      "subscribedSkuId": "9xdl4ChCwk2okl0_8zYaEIRZWEsbZYpEnlM7EPBpz38",
      "provisioningStatus": "Disabled",
      "servicePlanId": "4a82b400-a79f-41a4-b4e2-e94f5787b113"
    }
  ],
  "resultCount": 1,
  "pagedResultsCookie": null,
  "totalPagedResultsPolicy": "NONE",
  "totalPagedResults": -1,
  "remainingPagedResults": -1
}

List service plans details

This command lists the details of a specific servicePlan:

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/servicePlan/4a82b400-a79f-41a4-b4e2-e94f5787b113"
{
  "_id": "4a82b400-a79f-41a4-b4e2-e94f5787b113",
  "__NAME__": "EXCHANGE_S_DESKLESS",
  "appliesTo": "User",
  "subscribedSkuId": "9xdl4ChCwk2okl0_8zYaEIRZWEsbZYpEnlM7EPBpz38",
  "provisioningStatus": "Disabled",
  "servicePlanId": "4a82b400-a79f-41a4-b4e2-e94f5787b113"
}

Add service plans to a user

Add service plans to a user by supplying the __servicePlanIds__ array of strings with the format skuId:servicePlanId. This command adds two service plans to a specific user:

Request
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 '{
  "__servicePlanIds__": [
    "4b585984-651b-448a-9e53-3b10f069cf7f:a82fbf69-b4d7-49f4-83a6-915b2cf354f4",
    "4b585984-651b-448a-9e53-3b10f069cf7f:b76fb638-6ba6-402a-b9f9-83d28acb3d86"
  ]
}
"http://localhost:8080/openidm/system/azuread/user/5e85a7a1-2e57-4be2-b912-3e50bc26c856"
Response
{
  "_id": "5e85a7a1-2e57-4be2-b912-3e50bc26c856",
  "__NAME__": "mciowixxlrcnbob@{AZURE_DOMAIN}",
  "__servicePlanIds__": [
    "4b585984-651b-448a-9e53-3b10f069cf7f:a82fbf69-b4d7-49f4-83a6-915b2cf354f4",
    "4b585984-651b-448a-9e53-3b10f069cf7f:b76fb638-6ba6-402a-b9f9-83d28acb3d86"
  ],
  "country": "US",
  "givenName": "mciowixx",
  "userPrincipalName": "mciowixxlrcnbob@{AZURE_DOMAIN}",
  "licenses": [
    {
      "skuPartNumber": "DESKLESSPACK",
      "servicePlans": [
        {
          "servicePlanName": "VIVAENGAGE_CORE",
          "provisioningStatus": "Success",
          "appliesTo": "User",
          "servicePlanId": "a82fbf69-b4d7-49f4-83a6-915b2cf354f4"
        },
        {
          "servicePlanName": "VIVA_LEARNING_SEEDED",
          "provisioningStatus": "Success",
          "appliesTo": "User",
          "servicePlanId": "b76fb638-6ba6-402a-b9f9-83d28acb3d86"
        },
        {
          "servicePlanName": "Nucleus",
          "provisioningStatus": "Success",
          "appliesTo": "Company",
          "servicePlanId": "db4d623d-b514-490b-b7ef-8885eee514de"
        },
        {
          "servicePlanName": "MICROSOFTBOOKINGS",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "199a5c09-e0ca-4e37-8f7c-b05d533e1ea2"
        },
        {
          "servicePlanName": "RMS_S_BASIC",
          "provisioningStatus": "Success",
          "appliesTo": "Company",
          "servicePlanId": "31cf2cfc-6b0d-4adc-a336-88b724ed8122"
        },
        {
          "servicePlanName": "POWER_VIRTUAL_AGENTS_O365_F1",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "ba2fdb48-290b-4632-b46a-e4ecc58ac11a"
        },
        {
          "servicePlanName": "CDS_O365_F1",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "90db65a7-bf11-4904-a79f-ef657605145b"
        },
        {
          "servicePlanName": "PROJECT_O365_F3",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "7f6f28c2-34bb-4d4b-be36-48ca2e77e1ec"
        },
        {
          "servicePlanName": "DYN365_CDS_O365_F1",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "ca6e61ec-d4f4-41eb-8b88-d96e0e14323f"
        },
        {
          "servicePlanName": "PROJECTWORKMANAGEMENT",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "b737dad2-2f6c-4c65-90e3-ca563267e8b9"
        },
        {
          "servicePlanName": "KAIZALA_O365_P1",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "73b2a583-6a59-42e3-8e83-54db46bc3278"
        },
        {
          "servicePlanName": "MICROSOFT_SEARCH",
          "provisioningStatus": "Success",
          "appliesTo": "Company",
          "servicePlanId": "94065c59-bc8e-4e8b-89e5-5138d471eaff"
        },
        {
          "servicePlanName": "WHITEBOARD_FIRSTLINE1",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "36b29273-c6d0-477a-aca6-6fbe24f538e3"
        },
        {
          "servicePlanName": "OFFICEMOBILE_SUBSCRIPTION",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "c63d4d19-e8cb-460e-b37c-4d6c34603745"
        },
        {
          "servicePlanName": "BPOS_S_TODO_FIRSTLINE",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "80873e7a-cd2a-4e67-b061-1b5381a676a5"
        },
        {
          "servicePlanName": "FORMS_PLAN_K",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "f07046bd-2a3c-4b96-b0be-dea79d7cbfb8"
        },
        {
          "servicePlanName": "STREAM_O365_K",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "3ffba0d2-38e5-4d5e-8ec0-98f2b05c09d9"
        },
        {
          "servicePlanName": "FLOW_O365_S1",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "bd91b1a4-9f94-4ecf-b45b-3a65e5c8128a"
        },
        {
          "servicePlanName": "POWERAPPS_O365_S1",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "e0287f9f-e222-4f98-9a83-f379e249159a"
        },
        {
          "servicePlanName": "TEAMS1",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "57ff2da0-773e-42df-b2af-ffb7a2317929"
        },
        {
          "servicePlanName": "Deskless",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "8c7d2df8-86f0-4902-b2ed-a0458298f3b3"
        },
        {
          "servicePlanName": "MCOIMP",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "afc06cb0-b4f4-4473-8286-d644f70d8faf"
        },
        {
          "servicePlanName": "SHAREPOINTWAC",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "e95bec33-7c88-4a70-8e19-b10bd9d0c014"
        },
        {
          "servicePlanName": "SWAY",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "a23b959c-7ce8-4e57-9140-b90eb88a9e97"
        },
        {
          "servicePlanName": "INTUNE_O365",
          "provisioningStatus": "PendingActivation",
          "appliesTo": "Company",
          "servicePlanId": "882e1d05-acd1-4ccb-8708-6ee03664b117"
        },
        {
          "servicePlanName": "YAMMER_ENTERPRISE",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "7547a3fe-08ee-4ccb-b430-5077c5041653"
        },
        {
          "servicePlanName": "SHAREPOINTDESKLESS",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "902b47e5-dcb2-4fdc-858b-c63a90a2bdb9"
        },
        {
          "servicePlanName": "EXCHANGE_S_DESKLESS",
          "provisioningStatus": "Disabled",
          "appliesTo": "User",
          "servicePlanId": "4a82b400-a79f-41a4-b4e2-e94f5787b113"
        }
      ],
      "id": "9xdl4ChCwk2okl0_8zYaEIRZWEsbZYpEnlM7EPBpz38",
      "skuId": "4b585984-651b-448a-9e53-3b10f069cf7f"
    }
  ],
  "usageLocation": "US"
}
Copyright © 2010-2024 ForgeRock, all rights reserved.