Como alocar licenças a um grupo com cota

Ponto de extremidade da API para alocar licenças a um grupo com cotas de consumo opcionais no Test Cloud, o qual rfequer o escopo PM.License.Write.

Como administrador de uma organização, use esse ponto de extremidade para alocar licenças a um grupo e, opcionalmente, configurar cotas para limitar o consumo de licenças. Requer um aplicativo externo com o escopo PM.License.Write.

Ponto de Extremidade da API

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

Substitua {accessURL} em todos os caminhos do ponto de extremidade pelo URL base para sua plataforma de nuvem:

Cloud Platform	URL de acesso
Test Cloud	https://cloud.uipath.com/
Test Cloud para o Setor Público	https://govcloud.uipath.us/
Test Cloud Dedicado	https://{customURL}.dedicated.uipath.com/

Cabeçalhos de solicitação.

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

Parâmetros do caminho

Parâmetro do caminho	Tipo de dados	Description
accountId (obrigatório)	Guid	A ID da organização na qual seu locatário reside.
groupId (obrigatório)	String	A ID do grupo ao qual você deseja alocar licenças. Você pode recuperar esse ID seguindo estas etapas.

Corpo da Solicitação

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

Observação:

• userBundleCodes: Array de códigos de licença a alocar (consulte os códigos de licença do usuário).
• quotas (opcional): configurações de cota. Cada userBundleCode nas cotas deve existir na matriz userBundleCodes .
• A cota limit deve ser de pelo menos 1 e não pode ser menor do que o uso atual.
• Se as cotas estiverem vazias, as licenças serão alocadas sem limites.

Resposta

200 OK

Retorna as licenças de grupos alocadas com cotas configuradas e uso atual.

404

A organização ou grupo não existe.

Exemplo de solicitação

A solicitação deve ser semelhante ao seguinte exemplo (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
        }
    ]
}'

Aqui está o corpo da resposta para uma alocação de licença bem-sucedida:

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