Crear usuarios

Cree un nuevo usuario para una conexión de base de datos o sin contraseña.

Nota: connection es obligatorio, pero otros parámetros como email y password dependen del tipo de conexión.

POST https://{tenantDomain}/api/v2/users

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.CreateUserRequestContent{
        Connection: "connection",
    }
    client.Users.Create(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.users.create({
        connection: "connection",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.users.create({
        connection: "connection",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection": "Initial-Connection",
  "app_metadata": {},
  "blocked": false,
  "email": "[e-mail]",
  "email_verified": false,
  "family_name": "Doe",
  "given_name": "John",
  "name": "John Doe",
  "nickname": "Johnny",
  "password": "secret",
  "phone_number": "[phone]",
  "phone_verified": false,
  "picture": "https://secure.gravatar.com/avatar/15626c5e0c749cb912f9d1ad48dba440?s=480&r=pg&d=https%3A%2F%2Fssl.gstatic.com%2Fs2%2Fprofiles%2Fimages%2Fsilhouette80.png",
  "user_id": "abc",
  "user_metadata": {},
  "username": "johndoe",
  "verify_email": false
}
'

import requests

url = "https://{tenantDomain}/api/v2/users"

payload = {
    "connection": "Initial-Connection",
    "app_metadata": {},
    "blocked": False,
    "email": "[e-mail]",
    "email_verified": False,
    "family_name": "Doe",
    "given_name": "John",
    "name": "John Doe",
    "nickname": "Johnny",
    "password": "secret",
    "phone_number": "[phone]",
    "phone_verified": False,
    "picture": "https://secure.gravatar.com/avatar/15626c5e0c749cb912f9d1ad48dba440?s=480&r=pg&d=https%3A%2F%2Fssl.gstatic.com%2Fs2%2Fprofiles%2Fimages%2Fsilhouette80.png",
    "user_id": "abc",
    "user_metadata": {},
    "username": "johndoe",
    "verify_email": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'connection' => 'Initial-Connection',
    'app_metadata' => [
        
    ],
    'blocked' => false,
    'email' => '[e-mail]',
    'email_verified' => false,
    'family_name' => 'Doe',
    'given_name' => 'John',
    'name' => 'John Doe',
    'nickname' => 'Johnny',
    'password' => 'secret',
    'phone_number' => '[phone]',
    'phone_verified' => false,
    'picture' => 'https://secure.gravatar.com/avatar/15626c5e0c749cb912f9d1ad48dba440?s=480&r=pg&d=https%3A%2F%2Fssl.gstatic.com%2Fs2%2Fprofiles%2Fimages%2Fsilhouette80.png',
    'user_id' => 'abc',
    'user_metadata' => [
        
    ],
    'username' => 'johndoe',
    'verify_email' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/users")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connection\": \"Initial-Connection\",\n  \"app_metadata\": {},\n  \"blocked\": false,\n  \"email\": \"[e-mail]\",\n  \"email_verified\": false,\n  \"family_name\": \"Doe\",\n  \"given_name\": \"John\",\n  \"name\": \"John Doe\",\n  \"nickname\": \"Johnny\",\n  \"password\": \"secret\",\n  \"phone_number\": \"[phone]\",\n  \"phone_verified\": false,\n  \"picture\": \"https://secure.gravatar.com/avatar/15626c5e0c749cb912f9d1ad48dba440?s=480&r=pg&d=https%3A%2F%2Fssl.gstatic.com%2Fs2%2Fprofiles%2Fimages%2Fsilhouette80.png\",\n  \"user_id\": \"abc\",\n  \"user_metadata\": {},\n  \"username\": \"johndoe\",\n  \"verify_email\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connection\": \"Initial-Connection\",\n  \"app_metadata\": {},\n  \"blocked\": false,\n  \"email\": \"[e-mail]\",\n  \"email_verified\": false,\n  \"family_name\": \"Doe\",\n  \"given_name\": \"John\",\n  \"name\": \"John Doe\",\n  \"nickname\": \"Johnny\",\n  \"password\": \"secret\",\n  \"phone_number\": \"[phone]\",\n  \"phone_verified\": false,\n  \"picture\": \"https://secure.gravatar.com/avatar/15626c5e0c749cb912f9d1ad48dba440?s=480&r=pg&d=https%3A%2F%2Fssl.gstatic.com%2Fs2%2Fprofiles%2Fimages%2Fsilhouette80.png\",\n  \"user_id\": \"abc\",\n  \"user_metadata\": {},\n  \"username\": \"johndoe\",\n  \"verify_email\": false\n}"

response = http.request(request)
puts response.read_body

201

{
  "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 utilizará para esta solicitud

Required string length: 3 - 255

Cuerpo

application/jsonapplication/x-www-form-urlencoded

connection · string · predeterminado: Initial-Connection · requerido

Nombre de la conexión en la que se debe crear este usuario.

Minimum string length: 1

app_metadata · object

Datos relacionados con el usuario que afectan la funcionalidad principal de la aplicación.

blocked · boolean · predeterminado: false

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

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

El correo electrónico del usuario.

email_verified · boolean · predeterminado: false

Si esta dirección de correo electrónico está verificada (true) o no verificada (false). El usuario recibirá un correo electrónico de verificación después de su creación si email_verified es false o no se especifica

family_name · string · predeterminado: Doe

Los apellidos del usuario.

Required string length: 1 - 150

given_name · string · predeterminado: John

El nombre del usuario.

Required string length: 1 - 150

name · string · predeterminado: John Doe

El nombre completo del usuario.

Required string length: 1 - 300

nickname · string · predeterminado: Johnny

El nickname del usuario.

Required string length: 1 - 300

password · string · predeterminado: secret

Contraseña inicial para este usuario. Solo es válida para la strategy de conexión auth0.

Minimum string length: 1

phone_number · string · predeterminado: [phone]

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

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

phone_verified · boolean · predeterminado: false

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

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

Un URI que apunta a la picture del usuario.

user_id · string · predeterminado: abc

El id del usuario externo proporcionado por el Proveedor de identidad.

Maximum string length: 255

Pattern: ^\S*$

user_metadata · object

Datos relacionados con el usuario que no afectan a la funcionalidad principal de la aplicación.

username · string · predeterminado: johndoe

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

Required string length: 1 - 128

verify_email · boolean · predeterminado: false

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

Respuesta

201

application/json

Usuario creado correctamente.

app_metadata · object

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

blocked · boolean

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

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

family_name · string

Apellido, apellido paterno o nombre de familia de este usuario.

given_name · string

Nombre de pila, primer nombre o nombre propio de este usuario.

identities · object[]

Matriz de objetos de identidad del 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

Nickname 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

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

picture · string

URL de la picture, 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 puede usarse 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.