テナントにライセンスを割り当てる

ホスト管理者は、このエンドポイントを使用して、テナント ID に基づきライセンスをテナントに割り当てます。

重要: 組織とテナントにライセンスを割り当てるには、ホスト資格情報を使用して認証する必要があります。

API エンドポイント

https://{yourDomain}/lrm/api/account/{accountId}/service-license/{serviceScopeId}/{serviceType}

注: テナントのすべての有効なサービスにライセンスを割り当てるには、サービスごとに個別の API 呼び出しを行う必要があります。

要求ヘッダー

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

注: {access_token} を取得するには、必ずこちらで説明する ROPC の方法で認証を行ってください。

パス パラメーター

パス パラメーター	データ型	説明
accountId (必須)	文字列	テナントが存在する組織の ID。
serviceScopeId (必須)	文字列	ライセンスを割り当てるテナントの ID です。
serviceType (必須)	文字列	サービスの種類。

要求本文

要求本文には、さまざまな製品のライセンス コードの配列と、それらに対応する数量が含まれています。

{
      "tenantName": "string",
      "products": 
        [
          { "code": "string", "quantity": 0 } 
        ]
    }

注:

• 要求本文で使用できる利用可能なライセンス コードを確認するには、「ライセンス コード」をご覧ください。
• 組織が購入した数のライセンスを割り当てることができます。

応答

200 OK

割り当てられたサービス ライセンスを返します。

{
  "accountId": "string",
  "serviceScopeId": "string",
  "serviceType": "string",
  "license": {
    "licenseCode": "string",
    "bundleCode": "string",
    "subscriptionCode": "string",
    "licenseStatus": "string",
    "startDate": 0,
    "endDate": 0,
    "gracePeriod": 0,
    "products": [
      {
        "code": "string",
        "quantity": 0,
        "type": "string",
        "features": [
          {
            "code": "string",
            "type": "string",
            "value": "string"
          }
        ]
      }
    ],
    "templates": [
      {
        "productCode": "string",
        "products": [
          {
            "code": "string",
            "type": "string"
          }
        ]
      }
    ],
    "payload": "string",
    "boonLicenseCode": "string"
  },
  "userLicensingEnabled": true,
  "accountLicenseCode": "string"
}

404

指定した組織にアカウント ライセンスは割り当てられません。

409

アカウント ライセンスの数量を超えているため、ライセンスの割り当ては許可されません。

要求の例

API 呼び出しの構築に必要な情報をすべて収集したとします。

• {baseURL} は https://tom-jones-server.com です。
• {access_token} は 1234 です (長さを考慮)。
• ライセンスの割り当てが必要なテナントの {accountId} は y-y-y-delilah です。
• {serviceScopeId} は y1968 です。テナントで Document Understanding サービスが有効化されています。
• 上記の組織に次の様に製品ライセンスを割り当てます。
  • 5 個の Unattended Robot (ライセンス コードは UNATT)
  • 4 個の NonProduction ロボット (ライセンス コードは NONPR)
  • 2 個の Document Understanding ライセンス (ライセンス コードは TIE)

呼び出しは以下のようになります (cURL)。

curl --location --request POST 'https://tom-jones-server.com/lrm/api/account/y-y-y-delilah/service-license/y1968/?????' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
    "productQuantities": 
        [
          { "code": "UNATT", "quantity": 5 },
          { "code": "NONPR", "quantity": 4 },
          { "code": "TIE", "quantity": 2 }      
        ]
}'

ライセンス割り当てに成功した場合の応答本文は次のとおりです。

{
  "accountId": "y-y-y-delilah",
  "serviceScopeId": "y1968",
  "serviceType": "string",
  "license": {
    "licenseCode": "string",
    "bundleCode": "string",
    "subscriptionCode": "string",
    "licenseStatus": "string",
    "startDate": 0,
    "endDate": 0,
    "gracePeriod": 0,
    "products": [
      {
        "code": "string",
        "quantity": 0,
        "type": "string",
        "features": [
          {
            "code": "string",
            "type": "string",
            "value": "string"
          }
        ]
      }
    ],
    "templates": [
      {
        "productCode": "string",
        "products": [
          {
            "code": "string",
            "type": "string"
          }
        ]
      }
    ],
    "payload": "string",
    "boonLicenseCode": "string"
  },
  "userLicensingEnabled": true,
  "accountLicenseCode": "string"
}