Vero OMS API

GET

https://api-gw.verolabs.co

api

authen

sessions

whoami

Get current authenticated session

curl --request GET \
  --url https://api-gw.verolabs.co/api/authen/sessions/whoami \
  --header 'X-Session-Token: <api-key>'

const options = {method: 'GET', headers: {'X-Session-Token': '<api-key>'}};

fetch('https://api-gw.verolabs.co/api/authen/sessions/whoami', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api-gw.verolabs.co/api/authen/sessions/whoami"

headers = {"X-Session-Token": "<api-key>"}

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

print(response.text)

package main

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

func main() {

	url := "https://api-gw.verolabs.co/api/authen/sessions/whoami"

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

	req.Header.Add("X-Session-Token", "<api-key>")

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

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

	fmt.Println(string(body))

}

using RestSharp;


var options = new RestClientOptions("https://api-gw.verolabs.co/api/authen/sessions/whoami");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-Session-Token", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

false

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-gw.verolabs.co/api/authen/sessions/whoami");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "X-Session-Token: <api-key>");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

{
  "id": "<string>",
  "active": true,
  "identity": {
    "id": "<string>",
    "traits": {},
    "schema_id": "<string>",
    "schema_url": "<string>",
    "state": "<string>",
    "state_changed_at": "2023-11-07T05:31:56Z",
    "recovery_addresses": [
      {}
    ],
    "metadata_public": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "organization_id": "<string>"
  },
  "tokenized": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "authenticated_at": "2023-11-07T05:31:56Z",
  "authenticator_assurance_level": "<string>",
  "authentication_methods": [
    {
      "method": "<string>",
      "aal": "<string>",
      "completed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "issued_at": "2023-11-07T05:31:56Z",
  "devices": [
    {
      "id": "<string>",
      "ip_address": "<string>",
      "user_agent": "<string>",
      "location": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

Authorizations

X-Session-Token

string

header

required

Session token returned by authentication flows.

Query Parameters

tokenize_as

string

tokenizer template name used to request a tokenized (JWT) session response. The configured template on this environment is jwt_template_1. When supplied, the response includes a tokenized bearer token in the tokenized field.

Example:

"jwt_template_1"

Response

Current session.

session returned by whoami and login responses.

string

session id.

active

boolean

Whether the session is currently active.

identity

object

Authenticated identity object, including id, schema metadata, state, traits, recovery addresses, and timestamps.

Hide child attributes

identity.id

string

identity id for the authenticated user.

identity.traits

object

Identity profile attributes stored by, such as email and name.

identity.schema_id

string

identity schema id.

identity.schema_url

string

URL of the identity schema.

identity.state

string

identity state, for example active.

identity.state_changed_at

string<date-time>

Timestamp when the identity state last changed.

identity.recovery_addresses

object[]

Recovery addresses configured on the identity.

identity.metadata_public

object | null

Public identity metadata returned by the system; can be null.

identity.created_at

string<date-time>

Identity creation timestamp.

identity.updated_at

string<date-time>

Identity update timestamp.

identity.organization_id

string | null

organization id when the identity belongs to an organization; null otherwise.

tokenized

string

Bearer token returned when tokenize_as is supplied and returns a tokenized session.

expires_at

string<date-time>

Timestamp when the session expires.

authenticated_at

string<date-time>

Timestamp when the user authenticated for this session.

authenticator_assurance_level

string

authenticator assurance level for the session, for example aal1.

authentication_methods

object[]

Authentication methods completed for the session.

Hide child attributes

authentication_methods.method

string

Authentication method name, for example password.

authentication_methods.aal

string

Assurance level completed by this method.

authentication_methods.completed_at

string<date-time>

Timestamp when this method completed.

issued_at

string<date-time>

Timestamp when issued the session.

devices

object[]

Device/session metadata returned by the system, including device id, IP address, user agent, and location.

Hide child attributes

devices.id

string

device ID.

devices.ip_address

string

IP address observed for the session/device.

devices.user_agent

string

User agent observed for the session/device.

devices.location

string

Location string returned by the system when available.

Create a registration flowCreate a registration flow

Get current authenticated session

curl --request GET \
  --url https://api-gw.verolabs.co/api/authen/sessions/whoami \
  --header 'X-Session-Token: <api-key>'

const options = {method: 'GET', headers: {'X-Session-Token': '<api-key>'}};

fetch('https://api-gw.verolabs.co/api/authen/sessions/whoami', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api-gw.verolabs.co/api/authen/sessions/whoami"

headers = {"X-Session-Token": "<api-key>"}

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

print(response.text)

package main

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

func main() {

	url := "https://api-gw.verolabs.co/api/authen/sessions/whoami"

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

	req.Header.Add("X-Session-Token", "<api-key>")

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

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

	fmt.Println(string(body))

}

using RestSharp;


var options = new RestClientOptions("https://api-gw.verolabs.co/api/authen/sessions/whoami");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-Session-Token", "<api-key>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

false

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-gw.verolabs.co/api/authen/sessions/whoami");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "X-Session-Token: <api-key>");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

{
  "id": "<string>",
  "active": true,
  "identity": {
    "id": "<string>",
    "traits": {},
    "schema_id": "<string>",
    "schema_url": "<string>",
    "state": "<string>",
    "state_changed_at": "2023-11-07T05:31:56Z",
    "recovery_addresses": [
      {}
    ],
    "metadata_public": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "organization_id": "<string>"
  },
  "tokenized": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "authenticated_at": "2023-11-07T05:31:56Z",
  "authenticator_assurance_level": "<string>",
  "authentication_methods": [
    {
      "method": "<string>",
      "aal": "<string>",
      "completed_at": "2023-11-07T05:31:56Z"
    }
  ],
  "issued_at": "2023-11-07T05:31:56Z",
  "devices": [
    {
      "id": "<string>",
      "ip_address": "<string>",
      "user_agent": "<string>",
      "location": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

{
  "error": "<string>",
  "message": "<string>",
  "detail": "<string>",
  "details": "<string>",
  "status": 123
}

Overview

REST API

Streaming API

Integrations

Support

Get current authenticated session

Authorizations

Query Parameters

Response