Tutoriel NerdGraph : Créer et gérer un utilisateur

Vous pouvez utiliser notre APINerdGraph pour visualiser et gérer les utilisateurs. Vous pouvez ajouter et supprimer un utilisateur, modifier l'adresse e-mail et le type d'utilisateur de votre utilisateur, et renvoyer d'autres types d'informations utilisateur.

Pour savoir comment procéder dans l'UI, consultez la documentation UI de gestion des utilisateurs.

Exigences

Quelques exigences pour la gestion des utilisateurs via NerdGraph :

• Ceci sert à gérer les utilisateurs sur notre nouveau modèle utilisateur. Autres exigences liées aux autorisations :

  • Type d'utilisateur requis : utilisateur principal ou utilisateur de la plateforme complète.
  • Paramètres d'administration requis : Pour afficher et modifier l'utilisateur, vous devez disposer de Authentication domain settings. Pour afficher et apporter des modifications au niveau de l’organisation, vous devez disposer de Organization settings.

Avant de commencer

Avant d'utiliser NerdGraph pour gérer les utilisateurs, quelques points importants :

• Assurez-vous d'avoir une bonne compréhension de nos concepts de gestion des utilisateurs
• L'explorateur NerdGraph dispose de documents intégrés qui définissent les champs utilisés dans ces requests.
• Vous pouvez suivre les modifications apportées à votre compte New Relic.

Vous trouverez ci-dessous quelques exemples d'interrogation des informations utilisateur et de modification de votre utilisateur.

Champs de type d'utilisateur

Les valeurs de type d'utilisateur disponibles sont :

• FULL_USER_TIER
• CORE_USER_TIER
• BASIC_USER_TIER

information de requête utilisateur

Voici un exemple de requête pour voir tous les types d'utilisateurs de votre organisation :

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

Voici un exemple de requête permettant d'obtenir la dernière date d'activité et le type d'utilisateur pour l'utilisateur dans un domaine d'authentification spécifique :

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

Créer un utilisateur

Voici un exemple de création d’un utilisateur de base :

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
      }
    }
  }
}

Voici un exemple de réponse d'erreur lors de la tentative de création d'un utilisateur dans un domaine d'authentification non défini pour un utilisateur provisionné manuellement :

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

Voici un exemple de réponse d'erreur lors de la tentative de création d'un utilisateur qui existe déjà dans un domaine d'authentification :

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

Mise à jour de l'utilisateur

Voici un exemple de mise à jour du type d'utilisateur d'un utilisateur pour qu'il soit un utilisateur de plateforme complète :

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

Voici un exemple de mise à jour de l'adresse e-mail d'un utilisateur :

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

Ajouter un utilisateur aux groupes

Pour savoir comment gérer les groupes et ajouter des utilisateurs aux groupes, consultez Gérer les groupes d'utilisateurs avec NerdGraph.

Supprimer l'utilisateur

Voici un exemple de suppression d’un utilisateur :

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

Voici un exemple de réponse d'erreur lors de la tentative de suppression d'un utilisateur dans un domaine d'authentification provisionné par SCIM :

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

Pagination

Par défaut, l'API ne renvoie qu'au maximum 500 utilisateurs ou 10 domaines d'authentification. Si vous en avez plus, vous pouvez utiliser des curseurs pour obtenir les 500 utilisateurs ou 10 domaines d'authentification suivants. Cet appel renverra nextCursor, qui peut être introduit dans un autre appel, en utilisant la saisie du curseur :

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

Voici un exemple de démarrage d'un retour paginé de tous les domaines d'authentification pour une organisation :

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

Gérer les groupes

Pour savoir comment gérer les groupes et ajouter et supprimer des utilisateurs des groupes, voir Gérer les groupes.