Get user details.

Return a user object with details of the user specified by user ID in path.

GET /api/users/{userId}

Get user details.

cURL

curl --request GET \
  --url https://{tenant}/api/users/{userId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenant}/api/users/{userId}"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenant}/api/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://{tenant}/api/users/{userId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <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://{tenant}/api/users/{userId}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{tenant}/api/users/{userId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenant}/api/users/{userId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "access_key": "f4b94c64017043dc4d1918db7e3436dd",
  "active": true,
  "api_model": {},
  "created_at": "2024-05-19T08:23:29.034+03:00",
  "email_address": "[e-mail]",
  "first_name": "Admin",
  "group_id": "",
  "id": "363634393863643165326663643130303031383465636234",
  "last_login_date": "2024-05-19T08:42:22.659839+03:00",
  "last_name": "User",
  "org_id": "5e9d9544a1dcd60001d0ed20",
  "password_max_days": 0,
  "password_updated": "2024-05-19T08:23:29.146+03:00",
  "user_permissions": {
    "IsAdmin": "admin",
    "ResetPassword": "admin"
  }
}

{
  "Message": "Not authorised",
  "Meta": null,
  "Status": "Error"
}

{
  "Message": "access denied: You do not have permission to access  /api/users/{userId}",
  "Meta": null,
  "Status": "Error"
}

{
  "Message": "Could not retrieve user detail.",
  "Meta": null,
  "Status": "Error"
}

{
  "Message": "Attempted unauthorised access.",
  "Meta": null,
  "Status": "Error"
}

Authorizations

Authorization · string · header · required

The Tyk Dashboard API Access Credentials

Path Parameters

userId · string · required

User ID of the user to retrieve data for.

Response

200

application/json

User retrieved successfully.

email_address · string · required

Example:

"[e-mail]"

first_name · string · required

Example:

"itachi"

last_name · string · required

Example:

"sasuke"

user_permissions · object · required

Show child attributes

access_key · string

Example:

"d7ebef749e4348cb67fec3cfc81f0a50"

active · boolean

Example:

true

api_model · object

created_at · string<date-time>

Example:

"2024-05-19T08:23:29.034+03:00"

group_id · string

Example:

"5e9d9544a1dcd60001d0ed20"

id · string

Example:

"66498cd1e2fcd1000184ecb5"

last_login_date · string<date-time>

Example:

"2024-05-19T08:42:22.659839+03:00"

org_id · string

Example:

"5e9d9544a1dcd60001d0ed20"

password_max_days · integer

Example:

0

password_updated · string<date-time>

Example:

"2024-05-19T08:23:29.146+03:00"