Update user

Update user information including name, email, groups, and permissions.

PATCH /api/users/{id}

Update user

cURL

curl --request PATCH \
  --url http://localhost/api/api/users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "email": "<string>",
  "groups": [
    123
  ],
  "permissions": [
    123
  ]
}
'

import requests

url = "http://localhost/api/api/users/{id}"

payload = {
    "name": "<string>",
    "email": "<string>",
    "groups": [123],
    "permissions": [123]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: '<string>', email: '<string>', groups: [123], permissions: [123]})
};

fetch('http://localhost/api/api/users/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://localhost/api/api/users/{id}",
  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([
    'name' => '<string>',
    'email' => '<string>',
    'groups' => [
        123
    ],
    'permissions' => [
        123
    ]
  ]),
  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 := "http://localhost/api/api/users/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"groups\": [\n    123\n  ],\n  \"permissions\": [\n    123\n  ]\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("http://localhost/api/api/users/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"groups\": [\n    123\n  ],\n  \"permissions\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost/api/api/users/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"groups\": [\n    123\n  ],\n  \"permissions\": [\n    123\n  ]\n}"

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

200

{
  "id": 123,
  "name": "<string>",
  "email": "[e-mail]",
  "is_active": true,
  "groups": [
    123
  ],
  "permissions": [
    123
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

CustomAuthenticationcookieAuth

Authorization · string · header · required

JWT token obtained from AWS Cognito or custom authentication service

Path Parameters

id · integer · required

A unique integer value identifying this user.

Body

application/json

name · string

email · string

groups · integer[]

permissions · integer[]

Response

200

application/json

User updated successfully

User object with all details

id · integer · required

User ID

name · string · required

User full name

email · string<email> · required

User email address

is_active · boolean · required

Whether the user is active

groups · integer[]

List of group IDs

permissions · integer[]

List of permission IDs

created_at · string<date-time>

User creation timestamp

updated_at · string<date-time>

User last update timestamp