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

組織管理者がグループにライセンスを割り当て、必要に応じてクォータを設定してライセンスの消費を制限するには、以下のエンドポイントを使用します。PM.License.Write のスコープを持つ外部アプリケーションが必要です。

API エンドポイント

PUT {accessURL}/{organizationName}/lease_/api/account/{accountId}/user-license/group/{groupId}/with-quota

すべてのエンドポイント パスの {accessURL} は、ご使用のクラウド プラットフォームのベース URL に置き換えてください。

Cloud Platform	アクセス URL
Automation Cloud	https://cloud.uipath.com/
Automation Cloud (公共部門向け)	https://govcloud.uipath.us/
Automation Cloud (専有型)	https://{customURL}.dedicated.uipath.com/

要求ヘッダー

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

パス パラメーター

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

要求本文

{
    "userBundleCodes": ["string"],
    "quotas": [
        {
            "userBundleCode": "string",
            "limit": 10
        }
    ]
}

注:

• userBundleCodes: 割り当てるライセンス コードの配列です ( 「ユーザー ライセンス コード」をご覧ください)。
• quotas (任意): クォータの設定です。クォータ内の各 userBundleCode が userBundleCodes 配列内に存在している必要があります。
• クォータの limit は 1 以上にする必要があります。また、現在の使用量よりも小さくすることはできません。
• クォータが空の場合、ライセンスは無制限に割り当てられます。

応答

200 OK

割り当てられているグループ ライセンス、および設定されているクォータと現在の使用状況が返されます。

404

組織またはグループが存在しません。

要求の例

要求は次の例のようになります (cURL)。

curl --location --request PUT 'https://https://cloud.uipath.com/{organizationName}/lease_/api/account/1234/user-license/group/group-01/with-quota' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userBundleCodes": ["RPADEVPRONU", "IDU"],
    "quotas": [
        {
            "userBundleCode": "RPADEVPRONU",
            "limit": 10
        }
    ]
}'

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

{
  "groupRule": {
    "groupId": "group-01",
    "organizationId": "1234",
    "userBundleCodes": ["RPADEVPRONU", "IDU"]
  },
  "quotas": [
    {
      "userBundleCode": "RPADEVPRONU",
      "limit": 10,
      "currentUsage": 3
    }
  ]
}