Como alocar licenças a uma organização

Como administrador de host, você pode usar o endpoint para alocar licenças para uma organização com base no ID da organização.

Importante: Para alocar licenças para organizações e locatários, você precisa se autenticar usando as credenciais do host.

Ponto de Extremidade da API

https://{yourDomain}/lrm/api/host/{hostAccountID}/organization/{organizationId}/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 aqui.

Parâmetros do caminho

Parâmetro do caminho	Tipo de dados	Description
hostAccountID (obrigatório)	String	O ID da conta do host que aloca as licenças. AVISO: Sempre use o valor padrão: feb0dd79-85b6-483b-b297-0e49a1aa5b7d
organizationId (obrigatório)	String	A ID da organização para a qual você deseja alocar licenças.

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.

{
    "productQuantities": 
        [
          { "code": "string", "quantity": 0 } 
        ]
}

Observação:

• Para ver os códigos de licenças disponíveis que você pode usar no corpo da solicitação, verifique Códigos de licenças.
• Você pode alocar quantas licenças a organização comprou.

Resposta

200 OK

Retorna as licenças alocadas.

404

A licença do host não existe ou o sinalizador de recurso para fluxos locais está desativado.

409

A alocação de licenças não é permitida porque excede as quantidades de licenças de host.

Exemplo de solicitação

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

• Seu {baseURL} é: https://tom-jones-server.com
• Seu {access_token} é: 1234 (para considerações de comprimento).
• Seu {hostAccountId} é: j0ne5
• O {organizationId} que precisa de alocação de licença é: y-y-y-delilah
• Você deseja alocar licenças de produto para a organização acima da seguinte forma:
  • 2 Robôs Unattended (o código da licença é UNATT)
  • 1 licença do AI Center Pro (o código da licença é AIG)
  • 3 Licenças de teste (o código da licença é TAUNATT)

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

curl --location --request POST 'https://tom-jones-server.com/lrm/api/host/j0ne5/organization/y-y-y-delilah/license' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json' \
--data-raw '{
    "productQuantities": 
        [
          { "code": "UNATT", "quantity": 2 },
          { "code": "AIG", "quantity": 1 },
          { "code": "TAUNATT", "quantity": 3 }      
        ]
}'

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

{
  "accountId": "y-y-y-delilah",
  "bundleCode": "string",
  "endDate": 0,
  "gracePeriod": 0,
  "licenseCode": "string",
  "licenseStatus": "string",
  "products": [
    {
      "code": "string",
      "quantity": 0,
      "type": "string",
      "features": [
        {
          "code": "string",
          "type": "string",
          "value": "string"
        }
      ]
    }
  ],
  "templates": [
    {
      "productCode": "string",
      "products": [
        {
          "code": "string",
          "type": "string"
        }
      ]
    }
  ],
  "startDate": 0,
  "subscriptionCode": "string",
  "subscriptionPlan": "string",
  "payload": "string",
  "type": "string",
  "parentLicenseCode": "string"
}