Tutorial NerdGraph: Criar e gerenciar usuário

Você pode usar nossa API NerdGraph para visualizar e gerenciar usuários. Você pode adicionar e excluir usuários, editar o endereço de e-mail e o tipo de usuário dos usuários e retornar outros tipos de informações do usuário.

Para saber como fazer isso na interface, consulte a documentação da interface de gerenciamento de usuários.

Requisitos

Alguns requisitos para gerenciamento de usuários via NerdGraph:

• Isto é para gerenciar usuários em nosso modelo de usuário mais recente. Outros requisitos relacionados a permissões:

  • Tipo de usuário necessário: usuário principal ou usuário completo da plataforma.
  • Configurações de administração necessárias: para visualizar e fazer alterações no usuário, é necessário Authentication domain settings. Para visualizar e fazer alterações no nível da organização é necessário Organization settings.

Antes que você comece

Antes de utilizar o NerdGraph para gerenciar usuários, alguns pontos importantes:

• Certifique-se de ter uma compreensão adequada de nossos conceitos de gerenciamento de usuários
• O explorador NerdGraph possui documentos integrados que definem os campos usados nessas solicitações.
• Você pode acompanhar as alterações em sua conta New Relic.

Abaixo estão alguns exemplos de consulta de informações do usuário e realização de alterações em seus usuários.

Campos de tipo de usuário

Os valores de tipo de usuário disponíveis são:

• FULL_USER_TIER
• CORE_USER_TIER
• BASIC_USER_TIER

Consultar informações do usuário

Aqui está um exemplo de consulta para ver todos os tipos de usuário em sua organização:

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

Aqui está um exemplo de consulta para obter a última data ativa e o tipo de usuário para os usuários em um domínio de autenticação específico:

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

Criar usuário

Aqui está um exemplo de criação de um usuário 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
      }
    }
  }
}

Aqui está um exemplo de resposta de erro ao tentar criar um usuário dentro de um domínio de autenticação não definido para usuários provisionados manualmente:

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

Aqui está um exemplo de resposta de erro ao tentar criar um usuário que já existe em um domínio de autenticação:

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

Atualizar usuário

Aqui está um exemplo de atualização do tipo de usuário de um usuário para usuário completo da plataforma:

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

Aqui está um exemplo de atualização do endereço de e-mail de um usuário:

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

Adicionar usuário aos grupos

Para saber como gerenciar grupos e adicionar usuários a grupos, consulte Gerenciar grupos de usuários com NerdGraph.

Excluir usuário

Aqui está um exemplo de exclusão de um usuário:

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

Aqui está um exemplo de resposta de erro ao tentar excluir um usuário em um domínio de autenticação provisionado por SCIM:

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

Paginação

Por padrão, a API retorna no máximo 500 usuários ou 10 domínios de autenticação. Se você tiver mais do que isso, poderá usar cursores para obter os próximos 500 usuários ou 10 domínios de autenticação. Esta chamada retornará nextCursor, que pode ser alimentada em outra chamada, usando a entrada do cursor:

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

Aqui está um exemplo de como iniciar um retorno paginado de todos os domínios de autenticação de uma organização:

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

Gerenciar grupos

Para saber como gerenciar grupos e adicionar e remover usuários de grupos, consulte Gerenciar grupos.