ユーザーにライセンスを割り当てる

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

API エンドポイント

https://{yourDomain}/lease_/api/account/{accountId}/user-license

要求ヘッダー

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

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

パス パラメーター

パス パラメーター	データ型	説明
accountId (必須)	文字列	ユーザーが存在する組織の ID です。

要求本文

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

{
  "userIds": ["string"],
  "userBundleCodes": ["string"],
  "useExternalLicense": true
}

注:

• 要求本文で使用できる利用可能なユーザー バンドル コードを確認するには、ユーザー ライセンス コードに関するこちらのページをご覧ください。
• 組織が購入した数のライセンスを割り当てることができます。
• 各ユーザーが 1 つずつライセンス ユニットを使用します。

応答

200 OK

割り当てられたグループ ライセンスを返します。

404

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

409

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

要求の例

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

• {baseURL} は https://music-server.com です。
• {access_token} は 1234 です (長さを考慮)。
• ライセンスの割り当てが必要なテナントの {accountId} は song-one です。
• ライセンスを必要とするユーザーは以下の 3 人です。
  • userId=singer-77 のユーザー 1
  • userId を持つユーザー 2 = singer-88
  • userId を持つユーザー 3 =singer-111
• 次のユーザー ライセンスを割り当てる必要があります。
  • RPA Developer - Named User (ライセンス コードは RPADEVNU)
  • Attended - Named User (ライセンス コードは ATTUNU)
  • Tester - Named User (ライセンス コードは TSTNU)

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

curl --location --request POST 'https://music-server.com/lease_/api/account/song_one/user-license' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
        "userIds": ["singer-77", "singer-88", "singer-111"]
    "userBundleCodes": ["RPADEVNU", "ATTUNU", "TSTNU"], 
    "useExternalLicense": true
}

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

[
  {
    "userId": "string",
    "organizationId": "string",
    "useExternalLicense": true,
    "userBundleCodes": [
      "string"
    ]
  }
]