Get user details

curl --request GET \
  --url https://{organization}.admin.credibledata.com/api/v0/users/{userName} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{organization}.admin.credibledata.com/api/v0/users/{userName}"

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

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

print(response.text)

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

fetch('https://{organization}.admin.credibledata.com/api/v0/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://{organization}.admin.credibledata.com/api/v0/users/{userName}",
  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://{organization}.admin.credibledata.com/api/v0/users/{userName}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://{organization}.admin.credibledata.com/api/v0/users/{userName}")

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

{
  "userName": "jsmith@example.com",
  "email": "jsmith@example.com",
  "firstName": "<string>",
  "lastName": "<string>",
  "businessRole": "<string>",
  "tutorialStatus": {
    "environmentTutorial": {
      "hasClickedCreateModel": false,
      "doNotShowModelIntro": false,
      "doNotShowSchemaExplorerTip": false,
      "doNotShowTutorialInHomePanel": false,
      "doNotShowConnectionOnboarding": false
    }
  }
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

GET

users

{userName}

Get user details

curl --request GET \
  --url https://{organization}.admin.credibledata.com/api/v0/users/{userName} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{organization}.admin.credibledata.com/api/v0/users/{userName}"

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

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

print(response.text)

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

fetch('https://{organization}.admin.credibledata.com/api/v0/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://{organization}.admin.credibledata.com/api/v0/users/{userName}",
  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://{organization}.admin.credibledata.com/api/v0/users/{userName}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://{organization}.admin.credibledata.com/api/v0/users/{userName}")

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

{
  "userName": "jsmith@example.com",
  "email": "jsmith@example.com",
  "firstName": "<string>",
  "lastName": "<string>",
  "businessRole": "<string>",
  "tutorialStatus": {
    "environmentTutorial": {
      "hasClickedCreateModel": false,
      "doNotShowModelIntro": false,
      "doNotShowSchemaExplorerTip": false,
      "doNotShowTutorialInHomePanel": false,
      "doNotShowConnectionOnboarding": false
    }
  }
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

{
  "code": "<string>",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

userName

string

required

The unique identifier of the user Valid email address pattern

Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$

Response

User details retrieved successfully

Represents a user account with profile information and tutorial status

userName

string<email>

The user's username — an email address used for authentication. Matches the path-parameter form on /users/{userName}. (Previously $ref'd IdentifierPattern, which disallowed '@' and '.'; that was never enforced at runtime so production data is all emails.)

string<email>

User's email address, used for authentication and notifications

firstName

string

User's first name. May be empty when the row was auto-created (e.g. Auth0 ensure-user path) before the user filled in their profile — UI flows that capture a name should PATCH this in.

Maximum string length: 64

lastName

string

User's last name. May be empty when the row was auto-created (e.g. Auth0 ensure-user path) before the user filled in their profile — UI flows that capture a name should PATCH this in.

Maximum string length: 64

businessRole

string

User's business role or job title

tutorialStatus

object

Represents the tutorial completion status and user preferences for onboarding

Show child attributes

Overview

organizations

organizationPermissions

packages

environments

environmentPermissions

packagePermissions

versions

connections

materializations

indexes

runs

workspaces

workspacePermissions

documents

documentPermissions

groups

bookmarks

attributes

users

demo

invites

permissions

Get user details

Authorizations

Path Parameters

Response