Como alocar licenças a um grupo

Como admin da organização, use esse ponto de extremidade para alocar licenças a um grupo. Para fazer isso, você precisa criar um aplicativo externo, com o escopo PM.License.Write.

Descubra como criar um aplicativo externo.

Ponto de Extremidade da API

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

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 aqui.

Parâmetros do caminho

Parâmetro do caminho	Tipo de dados	Description
accountId (obrigatório)	String	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

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

{
    "userBundleCodes": ["string"]
}

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.

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
• O {groupId} é: group-01.
• Você deseja alocar licenças de usuário para o grupo acima da seguinte forma:
  • Automation Developers - Named user (o código de licença é RPADEVPRONU)
  • Insights Designer (o código de licença é IDU)
  • Citizen Developer - Multiuser (o código de licença é CTZDEVCU)

A chamada deve ter a seguinte aparência (cURL):

curl --location --request POST 'https://https://{yourDomain}/{organizationName}/lease_/api/account/1234/user-license/group/group-01' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userBundleCodes": ["RPADEVPRONU", "IDU", "CTZDEVCU"], 
    "useExternalLicense": false
}'

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

{
  "groupId": "string",
  "organizationId": "string",
  "useExternalLicense": false,
  "userBundleCodes": [
    "string"
  ]
}