links an existing user to a tenant

A user that already exists is added to a tenant

PUT /v2/databases/{database}/tenants/{tenantId}/users/{userId}/link

links an existing user to a tenant

cURL

curl --request PUT \
  --url https://api.example.com/v2/databases/{database}/tenants/{tenantId}/users/{userId}/link \
  --cookie nile-auth.session-token=

import requests

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

headers = {"cookie": "nile-auth.session-token="}

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

print(response.text)

const options = {method: 'PUT', headers: {cookie: 'nile-auth.session-token='}};

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

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

curl_close($curl);

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

package main

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

func main() {

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

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

	req.Header.Add("cookie", "nile-auth.session-token=")

	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}/link")
  .header("cookie", "nile-auth.session-token=")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["cookie"] = 'nile-auth.session-token='

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

201

{
  "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"
}

"<string>"

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

tenantId · string · required

userId · string · required

Response

201

application/json

update an existing tenant

id · string

email · string

name · string

givenName · string

familyName · string

picture · string

created · string<date-time>

emailVerified · string<date-time>

updated · string<date-time>