Skip to main content
PUT
/
v2
/
databases
/
{database}
/
tenants
/
{tenantId}
/
users
/
{userId}
update a user
curl --request PUT \
  --url https://api.example.com/v2/databases/{database}/tenants/{tenantId}/users/{userId} \
  --header 'Content-Type: application/json' \
  --cookie nile-auth.session-token= \
  --data '
{
  "name": "<string>",
  "givenName": "<string>",
  "familyName": "<string>",
  "picture": "<string>"
}
'
import requests

url = "https://api.example.com/v2/databases/{database}/tenants/{tenantId}/users/{userId}"

payload = {
"name": "<string>",
"givenName": "<string>",
"familyName": "<string>",
"picture": "<string>"
}
headers = {
"cookie": "nile-auth.session-token=",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PUT',
headers: {cookie: 'nile-auth.session-token=', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
givenName: '<string>',
familyName: '<string>',
picture: '<string>'
})
};

fetch('https://api.example.com/v2/databases/{database}/tenants/{tenantId}/users/{userId}', 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://api.example.com/v2/databases/{database}/tenants/{tenantId}/users/{userId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'givenName' => '<string>',
'familyName' => '<string>',
'picture' => '<string>'
]),
CURLOPT_COOKIE => "nile-auth.session-token=",
CURLOPT_HTTPHEADER => [
"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://api.example.com/v2/databases/{database}/tenants/{tenantId}/users/{userId}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"givenName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"picture\": \"<string>\"\n}")

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

req.Header.Add("cookie", "nile-auth.session-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.put("https://api.example.com/v2/databases/{database}/tenants/{tenantId}/users/{userId}")
.header("cookie", "nile-auth.session-token=")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"givenName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"picture\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/databases/{database}/tenants/{tenantId}/users/{userId}")

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

request = Net::HTTP::Put.new(url)
request["cookie"] = 'nile-auth.session-token='
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"givenName\": \"<string>\",\n \"familyName\": \"<string>\",\n \"picture\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "email": "<string>",
  "name": "<string>",
  "givenName": "<string>",
  "familyName": "<string>",
  "picture": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "emailVerified": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}
This response has no body data.
This response has no body data.

Authorizations

nile-auth.session-token
string
cookie
required

Session token stored in a cookie after user signs in, prefixed with __Secure if on https

Path Parameters

database
string
required
userId
string
required
tenantId
string
required

Body

application/json
name
string
givenName
string
familyName
string
picture
string

Response

Identified user

id
string
email
string
name
string
givenName
string
familyName
string
picture
string
created
string<date-time>
emailVerified
string<date-time>
updated
string<date-time>