Retrieve an End User - Versori User Documentation

GET

hubs

{hub_id}

users

{user_id}

Retrieve an End User

curl --request GET \
  --url https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/users/{user_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/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://platform.versori.com/api/embedded/v1/hubs/{hub_id}/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://platform.versori.com/api/embedded/v1/hubs/{hub_id}/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://platform.versori.com/api/embedded/v1/hubs/{hub_id}/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))

}

require 'uri'
require 'net/http'

url = URI("https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/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

{
  "id": "<string>",
  "externalId": "<string>",
  "displayName": "<string>",
  "hubId": "<string>",
  "primaryConnection": {
    "id": "<string>",
    "name": "<string>",
    "credentials": {
      "action": [
        {
          "id": "<string>",
          "authSchemeConfig": {
            "id": "<string>",
            "description": "<string>",
            "schemeType": "none",
            "validationMessages": [
              {
                "text": "<string>",
                "severity": "info",
                "detail": [
                  "<string>"
                ]
              }
            ]
          },
          "credential": {
            "id": "<string>",
            "organisationId": "<string>",
            "type": "none",
            "name": "<string>",
            "data": {},
            "usages": [
              {
                "connection": {
                  "id": "<string>",
                  "name": "<string>",
                  "connector": {
                    "id": "<string>",
                    "organisationId": "<string>",
                    "name": "<string>",
                    "protocol": "http",
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  },
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z"
                }
              }
            ],
            "errors": [
              "<string>"
            ],
            "expiresAt": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "trigger": [
        {
          "id": "<string>",
          "authSchemeConfig": {
            "id": "<string>",
            "description": "<string>",
            "schemeType": "none",
            "validationMessages": [
              {
                "text": "<string>",
                "severity": "info",
                "detail": [
                  "<string>"
                ]
              }
            ]
          },
          "credential": {
            "id": "<string>",
            "organisationId": "<string>",
            "type": "none",
            "name": "<string>",
            "data": {},
            "usages": [
              {
                "connection": {
                  "id": "<string>",
                  "name": "<string>",
                  "connector": {
                    "id": "<string>",
                    "organisationId": "<string>",
                    "name": "<string>",
                    "protocol": "http",
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  },
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z"
                }
              }
            ],
            "errors": [
              "<string>"
            ],
            "expiresAt": "2023-11-07T05:31:56Z"
          }
        }
      ]
    },
    "variables": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "details": "<string>"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

hub_id

string<ulid>

required

user_id

string

required

UserID references an End User in the Hub.

Most APIs support setting this value to either the internal Versori identifier or their external ID as determined by the organisation. The identifier_type query parameter is used to indicate which type of ID is being used.

Query Parameters

identifier_type

enum<string>

default:external

IdentifierType indicates whether the user_id path parameter is a internal identifier created by Versori, or an external identifier. If the value is external, some endpoints also require the hub query parameter to identify the correct Hub.

Available options:

internal,

external

Response

string<ulid>

required

ID is the Versori identifier for the user. Most APIs will not use this field but instead reference users by their externalId.

externalId

string

required

ExternalID is the identifier for the user as determined by the organisation. This typically should be the same as the user's ID on the Primary Connector for the Hub. Regardless of the value, it must be unique within the Hub.

displayName

string

required

DisplayName is an optional human-readable name for the user. If not set, the default is an empty string.

hubId

string<ulid>

required

The hub ID to which the user belongs to.

primaryConnection

object

required

PrimaryConnection is the connection that the user will use to authenticate to the primary connector.

Show child attributes

createdAt

string<date-time>

required

CreatedAt is the time the user was created.

updatedAt

string<date-time>

required

UpdatedAt is the time the user was last updated.

⌘I

Retrieve an End User

curl --request GET \
  --url https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/users/{user_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/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://platform.versori.com/api/embedded/v1/hubs/{hub_id}/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://platform.versori.com/api/embedded/v1/hubs/{hub_id}/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://platform.versori.com/api/embedded/v1/hubs/{hub_id}/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))

}

require 'uri'
require 'net/http'

url = URI("https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/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

{
  "id": "<string>",
  "externalId": "<string>",
  "displayName": "<string>",
  "hubId": "<string>",
  "primaryConnection": {
    "id": "<string>",
    "name": "<string>",
    "credentials": {
      "action": [
        {
          "id": "<string>",
          "authSchemeConfig": {
            "id": "<string>",
            "description": "<string>",
            "schemeType": "none",
            "validationMessages": [
              {
                "text": "<string>",
                "severity": "info",
                "detail": [
                  "<string>"
                ]
              }
            ]
          },
          "credential": {
            "id": "<string>",
            "organisationId": "<string>",
            "type": "none",
            "name": "<string>",
            "data": {},
            "usages": [
              {
                "connection": {
                  "id": "<string>",
                  "name": "<string>",
                  "connector": {
                    "id": "<string>",
                    "organisationId": "<string>",
                    "name": "<string>",
                    "protocol": "http",
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  },
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z"
                }
              }
            ],
            "errors": [
              "<string>"
            ],
            "expiresAt": "2023-11-07T05:31:56Z"
          }
        }
      ],
      "trigger": [
        {
          "id": "<string>",
          "authSchemeConfig": {
            "id": "<string>",
            "description": "<string>",
            "schemeType": "none",
            "validationMessages": [
              {
                "text": "<string>",
                "severity": "info",
                "detail": [
                  "<string>"
                ]
              }
            ]
          },
          "credential": {
            "id": "<string>",
            "organisationId": "<string>",
            "type": "none",
            "name": "<string>",
            "data": {},
            "usages": [
              {
                "connection": {
                  "id": "<string>",
                  "name": "<string>",
                  "connector": {
                    "id": "<string>",
                    "organisationId": "<string>",
                    "name": "<string>",
                    "protocol": "http",
                    "createdAt": "2023-11-07T05:31:56Z",
                    "updatedAt": "2023-11-07T05:31:56Z"
                  },
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z"
                }
              }
            ],
            "errors": [
              "<string>"
            ],
            "expiresAt": "2023-11-07T05:31:56Z"
          }
        }
      ]
    },
    "variables": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "fields": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ],
  "details": "<string>"
}