Como alocar licenças a um usuário

Referência de API para alocar licenças para um usuário no Test Cloud Privado, incluindo pontos de extremidade, campos de solicitação e respostas.

Como admin da organização, use esse ponto de extremidade para alocar licenças a um usuário, com base na ID do usuário.

Ponto de Extremidade da API

PUT https://{yourDomain}/lease_/api/account/{accountId}/user-license

Cabeçalhos de solicitação.

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

Observação:

Para obter o {access_token}, certifique-se de se autenticar por meio do método ROPC, descrito em Autenticação ROPC.

Parâmetros do caminho

Parâmetro do caminho	Tipo de dados	Description
accountId (obrigatório)	String	A ID da organização na qual seu usuário reside.

Corpo da Solicitação

O corpo da solicitação contém a matriz de códigos de licença para vários produtos e sua quantidade correspondente.

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

Observação:

• Para ver os códigos de pacote de usuário disponíveis que você pode usar no corpo da solicitação, verifique os códigos de licença de usuário.
• Você pode alocar quantas licenças a organização comprou.
• Cada usuário consome uma unidade de licença.

Resposta

200 OK

Retorna as licenças de grupo alocadas.

404

Nenhuma licença de conta é alocada para a organização indicada.

409

A alocação de licença não é permitida porque excede as quantidades de licença da conta.

Exemplo de solicitação

Digamos que você reuniu todas as informações necessárias para criar a chamada de API.

• Seu {baseURL} é: https://{yourDomain}//{organizationName}.
• Seu {access_token} é: 1234 (para considerações de comprimento).
• O {accountId} do locatário que precisa de alocação de licença é: song-one
• Você tem três usuários que precisam de licenças:
  • Usuário 1 com o userId=singer-77
  • Usuário 2 com o userId=singer-88
  • Usuário 3 com o userId=singer-111
• Você deseja alocar as seguintes licenças de usuário:
  • Desenvolvedor de RPA - Usuário Nomeado (o código de licença é RPADEVNU)
  • Attended - Named user (o código de licença é ATTUNU)
  • Tester - Named User (o código de licença é TSTNU)

A chamada deve ser semelhante ao seguinte exemplo (cURL):

curl --location --request POST 'https://https://{yourDomain}/{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
}

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

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