Objeto de usuario de API de asociación

Este documento explica cómo utilizar la API de asociación para agregar y administrar usuarios.

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.

Puede utilizar el objeto usuario solo si su organización tiene usuario en nuestro modelo de usuario original. Antes de utilizar la API, lea los requisitos de la API de asociación.

Atributo de objeto de usuario

El objeto usuario almacena información de los clientes. Se pueden asociar uno o más usuarios a una cuenta. Además, un usuario específico puede estar asociado con varias cuentas.

Esta es la lista de atributos en el objeto de usuario. Asegúrese de asignar el atributo owner a un usuario al crear una cuenta de New Relic.

Importante

New Relic recomienda un máximo de 1000 cuentas por usuario. Las cuentas adicionales pueden resultar en acceso limitado a algunas características de New Relic.

Tipo:	Cadena
Por defecto:	(ninguno)

Este atributo es required para nuevo usuario.

La dirección de correo electrónico del usuario. Si ya existe un registro de usuario para esta dirección de correo electrónico, se vinculará a esta cuenta. Se ignorará cualquier configuración en el proceso de creación de objetos de usuario actual.

Los nombres de correo electrónico que contienen caracteres especiales requieren codificación URL. Por ejemplo, en lugar de +, utilice la sustitución codificada en URL %2B.

Tipo:	Cadena
Por defecto:	(ninguno)

Este atributo es required para nuevo usuario.

La contraseña de este usuario se ignora si la dirección de correo electrónico coincide con un registro de usuario preexistente. A partir de la versión 2 de Partnership API, las contraseñas pasadas como parte de una llamada de creación de cuenta deben cumplir los requisitos.

Advertencia

Las contraseñas pasadas como parte de una llamada de aprovisionamiento de cuenta que no se ajusten a este formato generarán un error y provocarán que la operación falle.

Tipo:	Booleano
Por defecto:	FALSO

Llamadas de usuario

Estos son los patrones de URL para funciones API relacionadas con el usuario. Si utiliza este patrón de URL, envíe un encabezado HTTP que contenga la clave de API del socio junto con el cuerpo de la solicitud JSON. Por ejemplo:

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

{ JSON data }

Llamar	Patrón de URL de recurso
List (índice) todo usuario de una cuenta.	`GET /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/users`
Update el papel de una persona en la cuenta.	`PUT /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/users/ID`
Create (agregar) un usuario a una cuenta. Sólo se puede crear un usuario por operación POST.	`POST /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/users`
Delete un usuario de una cuenta. Al eliminar un usuario, se elimina a ese usuario de la cuenta especificada. Los propietarios no se pueden eliminar de las cuentas a través de la API de asociación.	`DELETE /api/v2/partners/PARTNER_ID/accounts/ACCOUNT_ID/users/ID`

Ejemplo JSON de objeto de usuario

Before using this API, read the requirements.

A continuación se muestra un ejemplo de una solicitud y respuesta JSON utilizando el objeto de usuario de Partnership API.

A continuación se muestra un ejemplo de una respuesta JSON que enumera el usuario de la cuenta.

{
  "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
    }
  ]
}

Ejemplos de API de objetos de usuario

A continuación se muestran ejemplos de llamada API utilizando el objeto de usuario de Partnership API .

Solicitud 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

Respuesta:

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

Las cuentas con más de 1000 usuarios devolverán una respuesta paginada.

Para especificar una página, agregue el parámetro ?page= a la consulta.

Importante

Solo se puede crear un único objeto users nuevo por comando POST.

Crear solicitud:

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

Respuesta (los saltos de línea son para facilitar la lectura):

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

Solicitud de actualización:

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

Respuesta (los saltos de línea son para facilitar la lectura)

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

Pedido:

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

Respuesta: Sin cuerpo de respuesta.

Te ofrecemos esta traducción automática para facilitar la lectura.

Objeto de usuario de API de asociación

Requisitos

Atributo de objeto de usuario

Importante

correo electrónico (REQUERIDO para nuevos usuarios)

contraseña (REQUERIDA para un nuevo usuario)

Advertencia

first_name (REQUERIDO para un nuevo usuario)

last_name (REQUERIDO para un nuevo usuario)

dueño

rol (REQUERIDO para un nuevo usuario)

Llamadas de usuario

Ejemplo JSON de objeto de usuario

Solicitud JSON de objeto de usuario

Respuesta JSON

Ejemplos de API de objetos de usuario

Lista

Crear

Importante

Actualizar

Borrar

Te ofrecemos esta traducción automática para facilitar la lectura.

Objeto de usuario de API de asociación

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

Atributo de objeto de usuario

Importante

contraseña (REQUERIDA para un nuevo usuario)

first_name (REQUERIDO para un nuevo usuario)

last_name (REQUERIDO para un nuevo usuario)

dueño

rol (REQUERIDO para un nuevo usuario)

Llamadas de usuario

Ejemplo JSON de objeto de usuario

Solicitud JSON de objeto de usuario

Respuesta JSON

Ejemplos de API de objetos de usuario

Lista

Crear

Actualizar

Borrar

Requisitos