Actualizar un usuario por id

Actualizar un usuario.

Estos son los atributos que se pueden actualizar en el nivel raíz:

• app_metadata
• blocked
• email
• email_verified
• family_name
• given_name
• name
• nickname
• password
• phone_number
• phone_verified
• picture
• username
• user_metadata
• verify_email

Algunas consideraciones:

• Las propiedades del nuevo objeto reemplazarán las anteriores.
• Los campos de metadata son una excepción a esta regla (user_metadata y app_metadata). Estas propiedades se fusionan en lugar de reemplazarse, pero ten en cuenta que la fusión solo se produce en el primer nivel.
• Si estás actualizando email, email_verified, phone_number, phone_verified, username o password de una identidad secundaria, también debes especificar la propiedad connection.
• Si estás actualizando email o phone_number, puedes especificar opcionalmente la propiedad client_id.
• No se admite actualizar email_verified para conexiones empresariales ni conexiones SMS sin contraseña.
• Actualizar blocked a false no afecta el estado de bloqueo del usuario debido a un número excesivo de credenciales proporcionadas incorrectamente. Usa el endpoint “Unblock a user” de la API “User Blocks” para cambiar el estado del usuario.
• Los atributos compatibles se pueden desestablecer proporcionando null como valor.

Actualizar un campo (propiedad que no es metadata)

Para marcar la dirección de correo electrónico de un usuario como verificada, el cuerpo que se debe enviar debe ser:

{ "email_verified": true }

Actualizar una propiedad raíz de user metadata

Supongamos que nuestro usuario de prueba tiene el siguiente user_metadata:

{ "user_metadata" : { "profileCode": 1479 } }

Para agregar el campo addresses, el cuerpo que se debe enviar debe ser:

{ "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}

El objeto modificado queda con la siguiente propiedad user_metadata:

{
  "user_metadata": {
    "profileCode": 1479,
    "addresses": { "work_address": "100 Industrial Way" }
  }
}

Actualizar una propiedad interna de user metadata

Si hay metadata de usuario existente a la que queremos agregar "home_address": "742 Evergreen Terrace" (mediante la propiedad addresses), debemos enviar el objeto addresses completo. Como se trata de un objeto de primer nivel, el objeto se fusionará, pero sus propias propiedades no. El cuerpo que se debe enviar debe ser:

{
  "user_metadata": {
    "addresses": {
      "work_address": "100 Industrial Way",
      "home_address": "742 Evergreen Terrace"
    }
  }
}

El objeto modificado queda con la siguiente propiedad user_metadata:

{
  "user_metadata": {
    "profileCode": 1479,
    "addresses": {
      "work_address": "100 Industrial Way",
      "home_address": "742 Evergreen Terrace"
    }
  }
}

PATCH https://{tenantDomain}/api/v2/users/{id}

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.UpdateUserRequestContent{}
    client.Users.Update(
        context.TODO(),
        "id",
        request,
    )
}

200

{
  "app_metadata": {},
  "blocked": true,
  "created_at": "<string>",
  "email": "[e-mail]",
  "email_verified": false,
  "family_name": "<string>",
  "given_name": "<string>",
  "identities": [
    {
      "access_token": "<string>",
      "access_token_secret": "<string>",
      "connection": "<string>",
      "isSocial": true,
      "profileData": {
        "email": "<string>",
        "email_verified": true,
        "family_name": "<string>",
        "given_name": "<string>",
        "name": "<string>",
        "phone_number": "<string>",
        "phone_verified": true,
        "username": "johndoe"
      },
      "refresh_token": "<string>",
      "user_id": "<string>"
    }
  ],
  "last_ip": "<string>",
  "last_login": "<string>",
  "last_password_reset": "<string>",
  "logins_count": 123,
  "multifactor": [
    "<string>"
  ],
  "multifactor_last_modified": "<string>",
  "name": "<string>",
  "nickname": "<string>",
  "phone_number": "[phone]",
  "phone_verified": false,
  "picture": "<string>",
  "updated_at": "<string>",
  "user_id": "auth0|507f1f77bcf86cd799439020",
  "user_metadata": {},
  "username": "johndoe"
}

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Encabezados

auth0-custom-domain · string

Dominio personalizado que se usará para esta solicitud

Required string length: 3 - 255

Parámetros de ruta

id · string · requerido

ID del usuario que se va a actualizar.

Cuerpo

application/jsonapplication/x-www-form-urlencoded

app_metadata · object

Metadatos del usuario a los que este usuario tiene acceso de solo lectura.

blocked · boolean · predeterminado: false

Si este usuario fue bloqueado por un administrador (true) o no (false).

client_id · string · predeterminado: DaM8bokEXBWrTUFCiJjWn50jei6ardyX

ID de cliente de Auth0. Solo válido al actualizar la dirección de correo electrónico.

Minimum string length: 1

connection · string · predeterminado: Initial-Connection

Nombre de la conexión de destino para actualizar este usuario.

Minimum string length: 1

email · string<email> | null · predeterminado: [e-mail]

Dirección de correo electrónico de este usuario.

email_verified · boolean · predeterminado: false

Si esta dirección de correo electrónico está verificada (true) o no verificada (false). Si se establece en false, el usuario no recibirá un correo electrónico de verificación a menos que verify_email se establezca en true.

family_name · string | null · predeterminado: Doe

Apellido de este usuario.

Required string length: 1 - 150

given_name · string | null · predeterminado: John

Nombre de pila de este usuario.

Required string length: 1 - 150

name · string | null · predeterminado: John Doe

Nombre de este usuario.

Required string length: 1 - 300

nickname · string | null · predeterminado: Johnny

Apodo o alias preferido de este usuario.

Required string length: 1 - 300

password · string | null · predeterminado: secret

Nueva contraseña para este usuario. Solo válido para conexiones de base de datos.

Minimum string length: 1

phone_number · string | null · predeterminado: [phone]

Número de teléfono de este usuario (según la recomendación E.164).

Pattern: ^\+[0-9]{1,15}$

phone_verified · boolean · predeterminado: false

Indica si este número de teléfono ha sido verificado (true) o no (false).

picture · string<strict-uri> | null · predeterminado: https://secure.gravatar.com/avatar/15626c5e0c749cb912f9d1ad48dba440?s=480&r=pg&d=https%3A%2F%2Fssl.gstatic.com%2Fs2%2Fprofiles%2Fimages%2Fsilhouette80.png

URL de la imagen, foto o avatar de este usuario.

user_metadata · object

Metadatos del usuario a los que este usuario tiene acceso de lectura y escritura.

username · string | null · predeterminado: johndoe

El username del usuario. Solo válido si la conexión requiere un username.

Required string length: 1 - 128

verify_email · boolean · predeterminado: false

Indica si este usuario recibirá un correo electrónico de verificación después de su creación (true) o no recibirá ningún correo electrónico (false). Sobrescribe el comportamiento del parámetro email_verified.

verify_phone_number · boolean · predeterminado: false

Indica si este usuario recibirá un mensaje de texto después de cambiar el número de teléfono (true) o no recibirá ningún mensaje (false). Solo es válido al cambiar el número de teléfono en conexiones SMS.

Respuesta

200

application/json

Usuario actualizado correctamente.

app_metadata · object

Metadatos de usuario a los que este usuario tiene acceso de solo lectura.

blocked · boolean

Indica si este usuario fue bloqueado por un administrador (true) o no (false).

created_at · string object

Fecha y hora en que se creó este usuario (formato ISO_8601).

email · string<email> · predeterminado: [e-mail]

Dirección de correo electrónico de este usuario.

email_verified · boolean · predeterminado: false

Indica si esta dirección de correo electrónico está verificada (true) o no verificada (false).

family_name · string

Apellido de este usuario.

given_name · string

Nombre de pila de este usuario.

identities · object[]

Array de objetos de identidad de usuario cuando las cuentas están vinculadas.

Show child attributes

last_ip · string

Última dirección IP desde la que este usuario inició sesión.

last_login · string object

Fecha y hora en que se creó este usuario (formato ISO_8601).

last_password_reset · string object

Fecha y hora en que se creó este usuario (formato ISO_8601).

logins_count · integer

Número total de inicios de sesión de este usuario.

multifactor · string[]

Lista de proveedores de autenticación multifactor en los que este usuario se ha inscrito.

multifactor_last_modified · string object

Fecha y hora en que se creó este usuario (formato ISO_8601).

name · string

Nombre de este usuario.

nickname · string

Apodo o alias preferido de este usuario.

phone_number · string · predeterminado: [phone]

Número de teléfono de este usuario. Sigue la recomendación E.164.

phone_verified · boolean · predeterminado: false

Indica si este número de teléfono ha sido verificado (true) o no (false).

picture · string

URL de la imagen, foto o avatar de este usuario.

updated_at · string object

Fecha y hora en que se creó este usuario (formato ISO_8601).

user_id · string · predeterminado: auth0|507f1f77bcf86cd799439020

ID del usuario que se puede utilizar al interactuar con otras API.

user_metadata · object

Metadatos del usuario a los que este usuario tiene acceso de lectura y escritura.

username · string · predeterminado: johndoe

Username de este usuario.