REST APIリファレンス > プラットフォームREST APIバージョン3リソース > ライセンス
  

ライセンス

リソースを使用して、組織のライセンス情報を取得し、ライセンスをサブ組織に割り当てます。ライセンスをサブ組織に割り当てるには、管理者として親組織にログインする必要があります。
ライセンスリソースを使用して、次の要求を送信できます。

ライセンスの詳細の取得

GET要求を使用して、組織のエディション、カスタムライセンス、カスタム制限を取得します。

GET要求

組織またはサブ組織のライセンス情報を要求するには、次のURIを使用します。
/public/core/v3/license/org/<orgId>

GET応答

成功したら要求されたライセンス情報を、エラーが発生したらエラーオブジェクトを返します。
成功すると、指定した組織IDの次のライセンス情報を返します。
フィールド
タイプ
説明
customLicenses
リスト
組織のカスタムライセンスに関する情報。
licenseDef
String
customLicensesオブジェクトに含まれています。
カスタムライセンスの一意の識別子。
expirationDate
String
customLicensesオブジェクトに含まれています。
ライセンスの有効期限が切れる時刻。
licenseType
カスタムライセンスオブジェクトに含まれています。
ライセンスのタイプ。
次の値が含まれます。
  • - TRIAL
  • - SUBSCRIPTION
  • - FREE
  • - NONE
assignedEditions
リスト
エディションオブジェクトの組織のエディションに関する情報。
edition
String
エディションオブジェクトに含まれています。
制限の一意の識別子。
expirationDate
String
エディションオブジェクトに含まれています。
エディションの期限日。
customLimits
リスト
組織のカスタム制限に関する情報。
limitDefinition
String
customLimitオブジェクトに含まれています。
制限の一意の識別子。
value
Integer
customLimitオブジェクトに含まれています。
制限の最大使用回数。
最大制限数がない場合は、-1を使用します。

GETの例

次の例で、組織のライセンス情報に関する要求を示します。
GET <baseApiUrl>/public/core/v3/license/org/1ax3wad2FEsz35asd2892s
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
応答には、次の例のような組織のライセンス情報が含まれます。
{
"id": "1ax3wad2FEsz35asd2892s",
"parentOrg": null,
"customLicenses": [
{
"licenseType": "SUBSCRIPTION",
"expirationDate": "2017-11-05T18:01:24Z",
"licenseDef": "a5Xjp3VF3sjcyZUDa6UaWh"
}
],
"assignedEditions": [
{
"expirationDate": "2017-11-05T18:01:24Z",
"edition": "4sdvnCrYEjfcKjTvAoigEF"
},
{
"expirationDate": "2018-10-06T18:00:08Z",
"edition": "5SPzPwEFvBEds8LzVwXX4K"
}
],
"customLimits": [
{
"value": -1,
"limitDefinition": "09cX4Tmi1qSfrS997ORMYl"
}
]
}

サブ組織のライセンスの更新

PUT要求を使用して、サブ組織のライセンス情報を更新します。

PUT要求

サブ組織のライセンスを更新するには、管理者として親組織にログインする必要があります。
この要求によって、サブ組織のライセンスを要求のライセンスで上書きします。サブ組織のライセンスを変更するには、まずサブ組織のライセンス情報を要求し、オブジェクトに変更を加えてから、それを要求本文として使用します。
サブ組織のライセンス情報を更新するには、次のURIを使用します。
/public/core/v3/license/org/<orgId>

PUT応答

成功したら成功コードを、エラーが発生したらエラーオブジェクトを返します。

PUTの例

サブ組織のライセンスを変更するには、次の要求を使用できます。
PUT <baseApiUrl>/public/core/v3/license/org/<orgId>
Accept:application/json
INFA-SESSION-ID: <sessionId>

{
"customLicenses": [
{
"licenseType": "SUBSCRIPTION",
"expirationDate": "2017-11-05T18:01:24Z",
"licenseDef": "a5Xjp3VF3sjcyZUDa6UaWh"
}
],
"assignedEditions": [
{
"expirationDate": "2017-11-05T18:01:24Z",
"edition": "4sdvnCrYEjfcKjTvAoigEF"
},
{
"expirationDate": "2018-10-06T18:00:08Z",
"edition": "5SPzPwEFvBEds8LzVwXX4K"
}
],
"customLimits": [
{
"value": -1,
"limitDefinition": "09cX4Tmi1qSfrS997ORMYl"
}
]
}