Mettre à jour le profil utilisateur de l’utilisateur authentifié.

TypeScript

import { MyAccountClient } from "@auth0/myaccount-js";

async function main() {
    const client = new MyAccountClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.profile.patch({});
}
main();

import { MyAccountClient } from "@auth0/myaccount-js";

async function main() {
    const client = new MyAccountClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.profile.patch({});
}
main();

curl --request PATCH \
  --url https://{host}/me/v1/profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "given_name": "<string>",
  "family_name": "<string>",
  "name": "<string>",
  "nickname": "<string>",
  "picture": "<string>",
  "user_metadata": {}
}
'

import requests

url = "https://{host}/me/v1/profile"

payload = {
    "given_name": "<string>",
    "family_name": "<string>",
    "name": "<string>",
    "nickname": "<string>",
    "picture": "<string>",
    "user_metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/me/v1/profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'given_name' => '<string>',
    'family_name' => '<string>',
    'name' => '<string>',
    'nickname' => '<string>',
    'picture' => '<string>',
    'user_metadata' => [
        
    ]
  ]),
  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;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/me/v1/profile"

	payload := strings.NewReader("{\n  \"given_name\": \"<string>\",\n  \"family_name\": \"<string>\",\n  \"name\": \"<string>\",\n  \"nickname\": \"<string>\",\n  \"picture\": \"<string>\",\n  \"user_metadata\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{host}/me/v1/profile")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"given_name\": \"<string>\",\n  \"family_name\": \"<string>\",\n  \"name\": \"<string>\",\n  \"nickname\": \"<string>\",\n  \"picture\": \"<string>\",\n  \"user_metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/me/v1/profile")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"given_name\": \"<string>\",\n  \"family_name\": \"<string>\",\n  \"name\": \"<string>\",\n  \"nickname\": \"<string>\",\n  \"picture\": \"<string>\",\n  \"user_metadata\": {}\n}"

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

{
  "given_name": "<string>",
  "family_name": "<string>",
  "name": "<string>",
  "nickname": "<string>",
  "picture": "<string>",
  "email": "jsmith@example.com",
  "phone_number": "<string>",
  "username": "<string>",
  "user_metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "profile_policy": {}
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

PATCH

https://{host}/me/v1

profile

TypeScript

import { MyAccountClient } from "@auth0/myaccount-js";

async function main() {
    const client = new MyAccountClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.profile.patch({});
}
main();

import { MyAccountClient } from "@auth0/myaccount-js";

async function main() {
    const client = new MyAccountClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.profile.patch({});
}
main();

curl --request PATCH \
  --url https://{host}/me/v1/profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "given_name": "<string>",
  "family_name": "<string>",
  "name": "<string>",
  "nickname": "<string>",
  "picture": "<string>",
  "user_metadata": {}
}
'

import requests

url = "https://{host}/me/v1/profile"

payload = {
    "given_name": "<string>",
    "family_name": "<string>",
    "name": "<string>",
    "nickname": "<string>",
    "picture": "<string>",
    "user_metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/me/v1/profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'given_name' => '<string>',
    'family_name' => '<string>',
    'name' => '<string>',
    'nickname' => '<string>',
    'picture' => '<string>',
    'user_metadata' => [
        
    ]
  ]),
  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;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/me/v1/profile"

	payload := strings.NewReader("{\n  \"given_name\": \"<string>\",\n  \"family_name\": \"<string>\",\n  \"name\": \"<string>\",\n  \"nickname\": \"<string>\",\n  \"picture\": \"<string>\",\n  \"user_metadata\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://{host}/me/v1/profile")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"given_name\": \"<string>\",\n  \"family_name\": \"<string>\",\n  \"name\": \"<string>\",\n  \"nickname\": \"<string>\",\n  \"picture\": \"<string>\",\n  \"user_metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/me/v1/profile")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"given_name\": \"<string>\",\n  \"family_name\": \"<string>\",\n  \"name\": \"<string>\",\n  \"nickname\": \"<string>\",\n  \"picture\": \"<string>\",\n  \"user_metadata\": {}\n}"

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

{
  "given_name": "<string>",
  "family_name": "<string>",
  "name": "<string>",
  "nickname": "<string>",
  "picture": "<string>",
  "email": "jsmith@example.com",
  "phone_number": "<string>",
  "username": "<string>",
  "user_metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "profile_policy": {}
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

Autorisations

Authorization

string

header

requis

Les jetons Bearer et DPoP sont pris en charge selon la configuration de l’API

En-têtes

x-correlation-id

string

Un identifiant unique fourni par le client pour une opération donnée, utilisé pour corréler la requête dans les systèmes Auth0. La valeur apparaît sous references.correlation_id dans les journaux du locataire et est renvoyée dans l’en-tête x-correlation-id de la réponse. Les valeurs non valides ou trop longues sont ignorées silencieusement et remplacées par un UUID v4 généré. Évitez d’inclure des renseignements personnels identifiables (RPI).

traceparent

string

Un en-tête W3C Trace Context utilisé pour corréler la requête dans les traces distribuées. Lorsqu’il est fourni, la trace entrante est poursuivie et un nouveau span enfant est renvoyé dans l’en-tête traceparent de la réponse ; l’ID de trace apparaît aussi sous references.trace_id dans les journaux du locataire. Les valeurs malformées sont ignorées.

Corps

application/json

given_name

string

Required string length: 1 - 150

Pattern: \S

family_name

string

Required string length: 1 - 150

Pattern: \S

name

string

Required string length: 1 - 300

Pattern: \S

nickname

string

Required string length: 1 - 300

Pattern: \S

picture

string<uri>

Required string length: 1 - 2048

Pattern: ^https://

user_metadata

object

Données relatives à l’utilisateur qui n’ont aucune incidence sur les fonctionnalités de base de l’application. Seul le sous-ensemble de clés accessible en libre-service est renvoyé.

Réponse

Profil mis à jour avec succès.

Les attributs mis à jour du profil utilisateur de l’utilisateur authentifié, accompagnés d’une politique d’accès pour chaque champ indiquant les droits de lecture et d’écriture.

given_name

string

Prénom de cet utilisateur.

family_name

string

Nom de famille de cet utilisateur.

name

string

Nom de cet utilisateur.

nickname

string

Pseudonyme ou alias préféré de cet utilisateur.

picture

string

URL de l’image de profil, de la photo ou de l’avatar de cet utilisateur.

string<email>

read-only

Lecture seule. Pour gérer l’adresse courriel, utiliser /me/v1/identifiers.

phone_number

string

read-only

Lecture seule. Pour gérer le numéro de téléphone, utiliser /me/v1/identifiers.

username

string

read-only

Lecture seule. Pour gérer le nom d’utilisateur, utiliser /me/v1/identifiers.

user_metadata

object

Métadonnées définies par l’utilisateur. Lors de l’écriture, les clés de premier niveau sont fusionnées avec les métadonnées existantes.

created_at

string<date-time>

read-only

Date et heure de création de cet utilisateur.

updated_at

string<date-time>

read-only

Date et heure de la dernière mise à jour ou modification de cet utilisateur.

profile_policy

object

read-only

Droits d’écriture par champ, définis par un pointeur JSON RFC 6901 (p. ex. /email).

Show child attributes