Admin Update User

curl --request PATCH \
  --url https://{host}/api/admin/users/{username} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "<string>",
  "email": "<string>",
  "display_name": "<string>"
}
'

import requests

url = "https://{host}/api/admin/users/{username}"

payload = {
    "username": "<string>",
    "email": "<string>",
    "display_name": "<string>"
}
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({username: '<string>', email: '<string>', display_name: '<string>'})
};

fetch('https://{host}/api/admin/users/{username}', 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 => "https://{host}/api/admin/users/{username}",
  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([
    'username' => '<string>',
    'email' => '<string>',
    'display_name' => '<string>'
  ]),
  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}/api/admin/users/{username}"

	payload := strings.NewReader("{\n  \"username\": \"<string>\",\n  \"email\": \"<string>\",\n  \"display_name\": \"<string>\"\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}/api/admin/users/{username}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"username\": \"<string>\",\n  \"email\": \"<string>\",\n  \"display_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/admin/users/{username}")

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  \"username\": \"<string>\",\n  \"email\": \"<string>\",\n  \"display_name\": \"<string>\"\n}"

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

{
  "id": 123,
  "username": "<string>",
  "role": "<string>",
  "auth_source": "<string>",
  "disabled": true,
  "quota": {
    "max_concurrent_gpus": 123,
    "max_concurrent_jobs": 123,
    "daily_gpu_hours": 0,
    "max_storage_gb": 0,
    "allowed_profiles": [],
    "priority": 0,
    "per_series": {},
    "default": false
  },
  "email": "<string>",
  "avatar": "<string>",
  "display_name": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

PATCH

api

admin

users

{username}

Admin Update User

curl --request PATCH \
  --url https://{host}/api/admin/users/{username} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "<string>",
  "email": "<string>",
  "display_name": "<string>"
}
'

import requests

url = "https://{host}/api/admin/users/{username}"

payload = {
    "username": "<string>",
    "email": "<string>",
    "display_name": "<string>"
}
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({username: '<string>', email: '<string>', display_name: '<string>'})
};

fetch('https://{host}/api/admin/users/{username}', 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 => "https://{host}/api/admin/users/{username}",
  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([
    'username' => '<string>',
    'email' => '<string>',
    'display_name' => '<string>'
  ]),
  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}/api/admin/users/{username}"

	payload := strings.NewReader("{\n  \"username\": \"<string>\",\n  \"email\": \"<string>\",\n  \"display_name\": \"<string>\"\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}/api/admin/users/{username}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"username\": \"<string>\",\n  \"email\": \"<string>\",\n  \"display_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/api/admin/users/{username}")

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  \"username\": \"<string>\",\n  \"email\": \"<string>\",\n  \"display_name\": \"<string>\"\n}"

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

{
  "id": 123,
  "username": "<string>",
  "role": "<string>",
  "auth_source": "<string>",
  "disabled": true,
  "quota": {
    "max_concurrent_gpus": 123,
    "max_concurrent_jobs": 123,
    "daily_gpu_hours": 0,
    "max_storage_gb": 0,
    "allowed_profiles": [],
    "priority": 0,
    "per_series": {},
    "default": false
  },
  "email": "<string>",
  "avatar": "<string>",
  "display_name": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

授权

Authorization

string

header

必填

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

路径参数

username

string

必填

请求体

application/json

username

string | null

新登录名

Required string length: 1 - 128

string | null

邮箱；传 null 清空

Maximum string length: 256

display_name

string | null

显示昵称；传 null 清空

Maximum string length: 128

响应

Successful Response

integer

必填

username

string

必填

role

string

必填

auth_source

string

必填

disabled

boolean

必填

quota

QuotaOut · object

必填

Show child attributes

string | null

avatar

string | null

display_name

string | null

开始

接口

Admin Update User

授权

路径参数

请求体

响应