Objeto de usuário da API de parceria

Este documento explica como usar a API Partnership para adicionar e gerenciar usuários.

Requisitos

The Partnership API is not available to your organization unless you're specifically instructed by your New Relic representative that you should use it.

Você poderá usar o objeto usuário somente se sua organização tiver usuário em nosso modelo de usuário original. Antes de usar a API, leia os requisitos da API de Parceria.

Usuário objeto atributo

O objeto usuário armazena informações dos clientes. Um ou mais usuários podem estar associados a uma conta. Além disso, um usuário específico pode estar associado a várias contas.

Esta é a lista de atributos no objeto usuário. Certifique-se de atribuir o atributo owner a um usuário ao criar uma conta New Relic.

Importante

A New Relic recomenda um máximo de 1.000 contas por usuário. Contas adicionais podem resultar em acesso limitado a alguns recursos da New Relic.

Tipo:	Corda
Padrão:	(nenhum)

Este atributo é required para novo usuário.

O endereço de e-mail do usuário. Se já existir um registro de usuário para este endereço de e-mail, ele será vinculado a esta conta. Quaisquer configurações no processo atual de criação de objeto de usuário serão ignoradas.

Os nomes de e-mail que contêm caracteres especiais requerem codificação de URL. Por exemplo, em vez de +, use a substituição codificada de URL %2B.

Tipo:	Corda
Padrão:	(nenhum)

Este atributo é required para novo usuário.

A senha deste usuário será ignorada se o endereço de e-mail corresponder a um registro de usuário pré-existente. A partir da versão 2 da API de Parceria, as senhas transmitidas como parte de uma chamada de criação de conta devem atender aos requisitos.

Cuidado

Senhas passadas como parte de uma chamada de provisionamento de conta que não estejam em conformidade com esse formato gerarão um erro e causarão falha na operação.

Tipo:	Boleano
Padrão:	Falso

Chamadas de usuário

Aqui estão os padrões de URL para funções de API relacionadas ao usuário. Se estiver usando esse padrão de URL, envie um cabeçalho HTTP contendo a chave de API do parceiro junto com o corpo da solicitação JSON. Por exemplo:

GET .../api/v2/partners/PARTNER_ID/accounts/ID
x-api-key:PARTNER_ACCOUNT_KEY
Content-Type: application/json

{ JSON data }

Chamar	Padrão de URL de recurso
List (índice) todos os usuários de uma conta.	`GET /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/users`
Update o papel de uma pessoa na conta.	`PUT /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/users/ID`
Create (adicionar) um usuário a uma conta. Apenas um usuário pode ser criado por operação POST.	`POST /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/users`
Delete um usuário de uma conta. A exclusão de um usuário remove esse usuário da conta especificada. Os proprietários não podem ser removidos das contas por meio da API de Parceria.	`DELETE /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/users/ID`

Exemplo JSON de objeto de usuário

Before using this API, read the requirements.

Aqui está um exemplo de solicitação e resposta JSON usando o objeto de usuário da API de parceria.

Aqui está um exemplo de uma resposta JSON listando o usuário da conta.

{
  "users": [
    {
      "id": 164814,
      "email": "user-name1@company.com",
      "role": "admin",
      "owner": 0
    },
    {
      "id": 208797,
      "email": "user-name2@company.com",
      "role": "admin",
      "owner": 0
    },
    {
      "id": 208804,
      "email": "user-name3@company.com",
      "role": "user",
      "owner": 1
    }
  ]
}

Exemplos de API de objeto de usuário

Aqui estão exemplos de chamada de API usando o objeto usuário API de parceria.

Solicitação de lista:

curl -X GET \
    -H 'x-api-key:PARTNER_ACCOUNT_KEY' \
    -H 'Content-Type:application/json' \
    https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/12345/users

Resposta:

{"users":[{"id":12345,"email":"xx@newrelic.com","role":"admin","owner":1}]}

Contas com mais de 1.000 usuários retornarão uma resposta paginada.

Para especificar uma página, adicione o parâmetro ?page= à consulta.

Importante

Somente um novo objeto users pode ser criado por comando POST.

Criar solicitação:

curl -X POST \
    -H 'x-api-key:PARTNER_ACCOUNT_KEY' \
    -H 'Content-Type:application/json' \
    -d '{"users":[{"email": "foobar@newrelic.com", "password":"password1", "first_name":"John", "last_name":"Doe", "role":"admin" }]}' \
    https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/12345/users

Resposta (quebras de linha são para facilitar a leitura):

{"users":[{"id":12345,"email":"xx@newrelic.com","role":"admin","owner":1},
  {"id":23456,"email":"foobar@newrelic.com","role":"admin","owner":0}]}

Solicitação de atualização:

curl -X PUT \
    -H 'x-api-key:PARTNER_ACCOUNT_KEY' \
    -H 'Content-Type:application/json' \
    -d '{"users":[{"role": "restricted"}]}' \
    https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/12345/users/23456

Resposta (quebras de linha são para facilitar a leitura)

{"users":[{"id":12345,"email":"xx@newrelic.com","role":"admin","owner":1},
  {"id":23456,"email":"foobar@newrelic.com","role":"restricted","owner":0}]}

Solicitar:

curl -X DELETE \
    -H 'x-api-key:PARTNER_ACCOUNT_KEY' \
    -H 'Content-Type:application/json' \
    https://rpm.newrelic.com/api/v2/partners/PARTNER_ID/accounts/12345/users/23456

Resposta: Nenhum corpo de resposta.

Esta tradução de máquina é fornecida para sua comodidade.

Requisitos

Usuário objeto atributo

Importante

e-mail (OBRIGATÓRIO para novo usuário)

senha (OBRIGATÓRIA para novo usuário)

Cuidado

first_name (OBRIGATÓRIO para novo usuário)

last_name (OBRIGATÓRIO para novo usuário)

proprietário

função (OBRIGATÓRIA para novo usuário)

Chamadas de usuário

Exemplo JSON de objeto de usuário

Solicitação JSON de objeto de usuário

Resposta JSON

Exemplos de API de objeto de usuário

Lista

Criar

Importante

Atualizar

Excluir

Esta tradução de máquina é fornecida para sua comodidade.

Objeto de usuário da API de parceria

Requisitos .css-21sua1{background:none;border:none;width:0;padding:0;}

Usuário objeto atributo

Importante

senha (OBRIGATÓRIA para novo usuário)

first_name (OBRIGATÓRIO para novo usuário)

last_name (OBRIGATÓRIO para novo usuário)

proprietário

função (OBRIGATÓRIA para novo usuário)

Chamadas de usuário

Exemplo JSON de objeto de usuário

Solicitação JSON de objeto de usuário

Resposta JSON

Exemplos de API de objeto de usuário

Lista

Criar

Atualizar

Excluir

Requisitos