Asignar licencias a un usuario

Como administrador de organización, utiliza este punto de conexión para asignar licencias a un usuario en función del ID de usuario.

Punto final de API

PUT {accessURL}/lease_/api/account/{accountId}/user-license

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'

Nota:

Para obtener el {access_token}, asegúrate de autenticarte a través del método ROPC descrito.

Parámetros de ruta

Parámetros de ruta	Tipo de datos	Descripción
accountId (obligatorio)	Cadena	El ID de organización en el que reside el usuario.

Solicitar cuerpo

El cuerpo de la solicitud contiene la matriz de códigos de licencia para varios productos y su cantidad correspondiente.

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

Nota:

• Para ver los códigos de paquete de usuario disponibles que puedes utilizar en el cuerpo de la solicitud, consulta los códigos de licencia de usuario.
• Puede asignar tantas licencias como haya adquirido la organización.
• Cada usuario consume una unidad de licencia.

Respuesta

200 OK

Devuelve las licencias de grupo asignadas.

404

No se asigna ninguna licencia de cuenta para la organización indicada.

409

La asignación de licencias no está permitida porque supera las cantidades de licencias de la cuenta.

Solicitud de ejemplo

Supongamos que has recopilado toda la información necesaria para crear la llamada a la API.

• Su {baseURL} es: https://cloud.uipath.com//{organizationName}.
• Tu {access_token} es: 1234 (para consideraciones de longitud)
• El {accountId} del tenant que necesita asignación de licencia es: song-one
• Tiene tres usuarios que necesitan licencias:
  • Usuario 1 con userId=singer-77
  • Uusario 2 con userId=singer-88
  • Usuario 3 con userId=singer-111
• Quiere asignar las siguientes licencias de usuario:
  • Desarrollador de RPA: usuario designado (el código de licencia es RPADEVNU)
  • Attended - Named user (el código de licencia es ATTUNU)
  • Tester - Named user (el código de licencia es TSTNU)

La llamada debe parecerse al siguiente ejemplo (cURL):

curl --location --request POST 'https://https://cloud.uipath.com/{organizationName}/lease_/api/account/1234/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
}

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

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