Tutorial de NerdGraph: crear y administrar usuarios

Puede utilizar nuestra API NerdGraph para ver y administrar usuarios. Puede agregar y eliminar usuarios, editar la dirección de correo electrónico y el tipo de usuario de sus usuarios y devolver otros tipos de información de usuario.

Para saber cómo hacer esto en la UI, consulte los documentos de la UI de usuario de administración de usuarios.

Requisitos

Algunos requisitos para gestionar usuarios a través de NerdGraph:

• Esto es para administrar usuarios en nuestro modelo de usuario más nuevo. Otros requisitos relacionados con los permisos:

  • Tipo de usuario requerido: usuario principal o usuario de plataforma completa.

  • Configuración de administración requerida: para ver y realizar cambios en el usuario se requiere

    Authentication domain settings

    . Para ver y realizar cambios a nivel de organización se requiere

    Organization settings

    .

Antes de que empieces

Antes de utilizar NerdGraph para gestionar usuarios, algunos puntos importantes:

• Asegúrese de tener una comprensión adecuada de nuestros conceptos de gestión de usuarios.
• El explorador NerdGraph tiene documentos integrados que definen los campos utilizados en estas solicitudes.
• Puede realizar un seguimiento de los cambios en su cuenta New Relic.

A continuación se muestran algunos ejemplos de cómo consultar información de usuario y realizar cambios en sus usuarios.

Campos de tipo de usuario

Los valores de tipo de usuario disponibles son:

• FULL_USER_TIER
• CORE_USER_TIER
• BASIC_USER_TIER

Consultar información del usuario

Aquí hay una consulta de ejemplo para ver todos los tipos de usuarios en su organización:

{
  actor {
    organization {
      userManagement {
        types {
          displayName
          id
        }
      }
    }
  }
}

A continuación se muestra una consulta de ejemplo para obtener la última fecha activa y el tipo de usuario para los usuarios en un dominio de autenticación específico:

{
  actor {
    organization {
      userManagement {
        authenticationDomains(id: "YOUR_AUTH_DOMAIN_ID") {
          authenticationDomains {
            users {
              users {
                id
                name
                email
                lastActive
                type {
                  displayName
                  id
                }
              }
            }
          }
        }
      }
    }
  }
}

Crear usuario

A continuación se muestra un ejemplo de cómo crear un usuario básico:

mutation {
  userManagementCreateUser(
    createUserOptions: {
      authenticationDomainId: "YOUR_AUTH_DOMAIN_ID"
      email: "EMAIL_OF_YOUR_USER"
      name: "NAME_OF_YOUR_USER"
      userType: BASIC_USER_TIER
    }
  ) {
    createdUser {
      authenticationDomainId
      email
      id
      name
      type {
        displayName
        id
      }
    }
  }
}

A continuación se muestra un ejemplo de respuesta de error al intentar crear un usuario dentro de un dominio de autenticación no configurado para usuarios aprovisionados manualmente:

{
  "data": {
    "userManagementCreateUser": null
  },
  "errors": [
    {
      "message": "This API can only be used to create users within Authentication Domains set for manually provisioned users."
    }
  ]
}

A continuación se muestra un ejemplo de respuesta de error al intentar crear un usuario que ya existe en un dominio de autenticación:

{
  "data": {
    "userManagementCreateUser": null
  },
  "errors": [
    {
      "message": "User with email: <USER_EMAIL> and authentication domain: <AUTH_DOMAIN_ID> already exists."
    }
  ]
}

Actualizar usuario

A continuación se muestra un ejemplo de cómo actualizar el tipo de usuario de un usuario para que sea usuario de plataforma completa:

mutation {
  userManagementUpdateUser(
    updateUserOptions: { id: "ID_OF_YOUR_USER", userType: FULL_USER_TIER }
  ) {
    user {
      id
      type {
        displayName
        id
      }
    }
  }
}

A continuación se muestra un ejemplo de cómo actualizar la dirección de correo electrónico de un usuario:

mutation {
  userManagementUpdateUser(
    updateUserOptions: { id: "ID_OF_YOUR_USER", email: "EMAIL_OF_YOUR_USER" }
  ) {
    user {
      id
      email
    }
  }
}

Agregar usuario a grupos

Para saber cómo administrar grupos y agregar usuarios a los grupos, consulte Administrar grupos de usuarios con NerdGraph.

Eliminar usuario

A continuación se muestra un ejemplo de eliminación de un usuario:

mutation {
  userManagementDeleteUser(deleteUserOptions: {id: "ID_OF_YOUR_USER"}) {
    deletedUser {
      id
    }
  }
}

A continuación se muestra un ejemplo de respuesta de error al intentar eliminar un usuario en un dominio de autenticación proporcionado por SCIM:

{
  "data": {
    "userManagementDeleteuser": null
  },
  "errors": [
    {
      "message": "This API can only be used to delete users within Authentication Domains set for manually provisioned users."
    }
  ]
}

Paginación

De forma predeterminada, la API solo devuelve como máximo 500 usuarios o 10 dominios de autenticación. Si tiene más que eso, puede usar los cursores para obtener los siguientes 500 usuarios o 10 dominios de autenticación. Esta llamada devolverá nextCursor, que se puede introducir en otra llamada, utilizando la entrada del cursor:

{
  actor {
    organization {
      userManagement {
        authenticationDomains(id: "YOUR_AUTH_DOMAIN_ID") {
          authenticationDomains {
            users(cursor: "=abcdEFGH2356X") {
              nextCursor
              totalCount
              users {
                email
                id
                lastActive
                name
                type {
                  displayName
                  id
                }
              }
            }
          }
        }
      }
    }
  }
}

A continuación se muestra un ejemplo de cómo iniciar una devolución paginada de todos los dominios de autenticación de una organización:

{
  actor {
    organization {
      userManagement {
        authenticationDomains(cursor: "=123xyzABCx") {
          nextCursor
          totalCount
          authenticationDomains {
            id
            name
          }
        }
      }
    }
  }
}

Administrar grupos

Para saber cómo administrar grupos y agregar y eliminar usuarios de los grupos, consulte Administrar grupos.