グループにライセンスを割り当てる

組織管理者は、このエンドポイントを使用してグループにライセンスを割り当てます。 そのためには、スコープを PM.License.Writeの外部アプリケーションを作成する必要があります。

外部アプリケーションの作成方法については、こちらをご覧ください。

API エンドポイント

PUT https://{yourDomain}/{organizationName}/lease_/api/account/{accountId}/user-license/group/{groupId}

要求ヘッダー

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

注:

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

パス パラメーター

パス パラメーター	データ型	説明
accountId (必須)	文字列	テナントが存在する組織の ID。
groupId (必須)	文字列	ライセンスを割り当てるグループの ID です。 この ID は、 次の手順に従って取得できます。

要求本文

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

{
    "userBundleCodes": ["string"]
}

注:

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

応答

200 OK

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

404

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

409

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

要求の例

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

• あなたの {baseURL} は: https://{yourDomain}/{organizationName}です。
• {access_token} は 1234 です (長さを考慮)。
• ライセンスの割り当てが必要なテナントの {accountId} は song-one です。
• {groupId} group-01 です。
• 次のようにユーザー ライセンスをグループに割り当てます。
  • Automation Developers - Named user ( ライセンス コードは RPADEVPRONUです。)
  • Insights Designer ( ライセンス コードは IDUです)
  • Citizen Developer - Multiuser ( ライセンス コードは CTZDEVCUです)

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

curl --location --request POST 'https://https://{yourDomain}/{organizationName}/lease_/api/account/1234/user-license/group/group-01' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userBundleCodes": ["RPADEVPRONU", "IDU", "CTZDEVCU"], 
    "useExternalLicense": false
}'

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

{
  "groupId": "string",
  "organizationId": "string",
  "useExternalLicense": false,
  "userBundleCodes": [
    "string"
  ]
}