GET /v2/users/:user-id

Get the user data of a specific user or the authenticated user.

GET /v2/users/{user-id}

GET /v2/users/:user-id

cURL

curl --request GET \
  --url https://api.example.com/v2/users/{user-id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.example.com/v2/users/{user-id}"

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

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

print(response.text)

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

fetch('https://api.example.com/v2/users/{user-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 => "https://api.example.com/v2/users/{user-id}",
  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://api.example.com/v2/users/{user-id}"

	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://api.example.com/v2/users/{user-id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/users/{user-id}")

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

{
  "user": {
    "id": "<string>",
    "primaryParty": "<string>",
    "isDeactivated": true,
    "metadata": {
      "resourceVersion": "<string>",
      "annotations": {}
    },
    "identityProviderId": "<string>",
    "primaryPartyAuthentication": true
  }
}

"<string>"

{
  "code": "<string>",
  "cause": "<string>",
  "context": {},
  "errorCategory": 123,
  "correlationId": "<string>",
  "traceId": "<string>",
  "resources": [
    [
      "<string>"
    ]
  ],
  "grpcCodeValue": 123,
  "retryInfo": "<string>",
  "definiteAnswer": true
}

Authorizations

httpAuthapiKeyAuth

Authorization · string · header · required

Ledger API standard JWT token

Path Parameters

user-id · string · required

Query Parameters

identity-provider-id · string

Response

200

application/json

user · User · object · required

Retrieved user.

Required

Show child attributes