Asignar licencias a un grupo con cuota

PuntoFinal de API para asignar licencias a un grupo con cuotas de consumo opcionales en Test Cloud, que requiere el ámbito PM.License.Write.

Como administrador de la organización, utiliza este punto final para asignar licencias a un grupo y, opcionalmente, configurar cuotas para limitar el consumo de licencias. Requiere una aplicación externa con el ámbito PM.License.Write.

Punto final de API

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

Sustituye {accessURL} en todas las rutas de los puntos finales por la URL base de tu plataforma en la nube:

Cloud Platform	URL de acceso
Test Cloud	https://cloud.uipath.com/
Test Cloud Sector Público	https://govcloud.uipath.us/
Test Cloud Dedicado	https://{customURL}.dedicated.uipath.com/

Solicitar encabezados.

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

Parámetros de ruta

Parámetros de ruta	Tipo de datos	Descripción
accountId (obligatorio)	GUID	El ID de la organización en la que reside su tenant.
groupId (obligatorio)	Cadena	El ID del grupo al que desea asignar licencias. Puedes recuperar este ID siguiendo estos pasos.

Solicitar cuerpo

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

Nota:

• userBundleCodes: matriz de códigos de licencia para asignar (consulta los códigos de licencia de usuario).
• quotas (opcional): configuraciones de cuota. Cada userBundleCode en cuotas debe existir en la matriz userBundleCodes .
• La cuota limit debe ser al menos 1 y no puede ser inferior al uso actual.
• Si las cuotas están vacías, las licencias se asignan sin límites.

Respuesta

200 OK

Devuelve las licencias de grupo asignadas con las cuotas configuradas y el uso actual.

404

La organización o el grupo no existe.

Solicitud de ejemplo

La solicitud debe parecerse al siguiente ejemplo (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
        }
    ]
}'

Este es el cuerpo de respuesta para una asignación de licencia exitosa:

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