Cómo actualizar masivamente los correos electrónicos de los usuarios a través de la API

Nuestra API RESTful no sólo le permite acceder a los datos de su empresa, sino que también puede utilizarse para gestionar usuarios a través de distintos puntos finales:

• Recuperar todos los registros de usuarios
• Crear usuarios
• Buscar usuarios
• Recuperar un único registro de usuario
• Eliminar usuarios
• Actualizar usuarios

En este artículo, repasaremos el punto final "Actualizar usuario" y le explicaremos cómo actualizar de forma masiva las direcciones de correo electrónico de los usuarios.

Actualizar usuarios

Este punto final le permite actualizar un usuario con los datos proporcionados.

NOTA: se sustituirán las etiquetas

Campos que se pueden actualizar:

• Correo electrónico
• Activado: true/false
• Rol
• Equipo
• Etiquetas
• PreferredDevLanguages

Sugerencia: Puede desactivar el cambio de la notificación por correo electrónico enviada a los usuarios estableciendo el campo skipNotifyIfSso en false.

Cómo actualizar masivamente los correos electrónicos de los usuarios

Hemos creado un script que se puede utilizar para actualizar las direcciones de correo electrónico de los usuarios.

• Obtenga la clave API
• Guarde el siguiente script en un archivo llamado update_email_addresses.sh
• Ejecute la siguiente línea de comandos en un shell posix: (sustituya xxxxxxx por la clave de API)
  
  

  SCW_API_KEY=xxxxxxx. ./update_email_addresses.sh 2log.txt

Aspectos a tener en cuenta:

• Te recomendamos encarecidamente que borres el comando del historial del shell cuando hayas terminado para proteger mejor la clave API.
• Dependiendo del número de usuarios que desee actualizar, la actualización de todos los usuarios puede tardar unos minutos.

/bin/sh

configure -e

[ -z "${SCW_API_KEY:-}" ] & &   echo  "Usage SCW_API_KEY=xxx $0 [--skipNotifyIfSso] 2log.txt"  & &   exit 1
api_key_header="X-API-Key: ${SCW_API_KEY}"

api_host="portal-api"
# api_host="portal-api.eu"
api_url="https:// ${api_host} .securecodewarrior.com/api/v2/users"

skip_notify_if_sso=false
[ "--skipNotifyIfSso"  = "$1" ] & &  skip_notify_if_sso=true

updateUserEmail() {
  old=$1
  nuevo=$2

  output=$(
   echo "${old} - ${new}"
    curl -s -X PATCH -H "Accept: application/json" -H "${api_key_header}" -H "Content-Type: application/json" \
     -d "{\"email\": \"${new}\"}" \
      "${api_url}/${old}?skipNotifyIfSso=${skip_notify_if_sso}& idtype=email"
   echo
  )
 echo "${output}"  & 2
}

# Ejemplos
#Uso básico
#updateUserEmail "foo@bar.com" "foo@baz.com"  # cambia parte del dominio
#actualizarCorreoUsuario "cat@bar.com" "dog@bar.com"  # cambia la parte del nombre

# Actualizaciones secuenciales. Espera a que se complete cada actualización antes de publicar la siguiente.
#updateUserEmail "alice@bar.com" "alice@baz.com"
#actualizarCorreoUsuario "bob@bar.com" "bob@baz.com"
#ActualizarCorreoUsuario "charlie@bar.com" "charlie@baz.com"

# Actualizaciones paralelas: utilice el símbolo de unión al final del texto para ejecutar varias actualizaciones al mismo tiempo. Éstas deben dividirse en lotes
# para evitar mecanismos de limitación de velocidad
#actualizarCorreoUsuario "alice@bar.com" "alice@baz.com" &
#updateUserEmail "bob@bar.com" "bob@baz.com" &
#actualizarCorreoUsuario "charlie@bar.com" "charlie@baz.com" &
#actualizarCorreoUsuario "ella@bar.com" "ella@baz.com" &
#esperar a que finalicen los trabajos en segundo plano que se ejecutan en paralelo
#Esperar
#actualizarCorreoUsuario "frank@bar.com" "frank@baz.com" &
#actualizarCorreoUsuario "george@bar.com" "george@baz.com" &
#actualizarCorreoUsuario "hugh@bar.com" "hugh@baz.com" &
#ActualizarCorreoUsuario "ivan@bar.com" "ivan@baz.com" &
#actualizarCorreoUsuario "joe@bar.com" "joe@baz.com" &
#esperar a que finalicen los trabajos en segundo plano que se ejecutan en paralelo
#Espera