Vero OMS API

GET

https://api-gw.verolabs.co

api

authen

sessions

whoami

Lấy phiên xác thực hiện tại

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
}

Ủy quyền

X-Session-Token

string

header

bắt buộc

Session token returned by authentication flows.

Tham số truy vấn

tokenize_as

string

Ten tokenizer template de yeu cau response dang tokenized (JWT). Template hien tai tren moi truong nay la jwt_template_1. Khi truyen gia tri nay, response se kem bearer token (JWT) trong field tokenized.

Ví dụ:

"jwt_template_1"

Phản hồi

Current session.

session tra ve boi whoami va login response.

string

Ma session.

active

boolean

Cho biet session hien co dang active hay khong.

identity

object

identity da dang nhap, gom id, schema metadata, state, traits, recovery addresses va timestamps.

Hide child attributes

identity.id

string

Ma identity cua user da dang nhap.

identity.traits

object

Thuoc tinh ho so identity luu tren he thong, vi du email va name.

identity.schema_id

string

Ma identity schema.

identity.schema_url

string

URL cua identity schema.

identity.state

string

Trang thai identity, vi du active.

identity.state_changed_at

string<date-time>

Thoi diem trang thai identity thay doi lan cuoi.

identity.recovery_addresses

object[]

Danh sach recovery address cau hinh tren identity.

identity.metadata_public

object | null

Metadata public cua identity do he thong tra ve; co the null.

identity.created_at

string<date-time>

Thoi diem tao identity.

identity.updated_at

string<date-time>

Thoi diem cap nhat identity.

identity.organization_id

string | null

Ma organization neu identity thuoc organization; null neu khong co.

tokenized

string

Bearer token tra ve khi truyen tokenize_as va tra tokenized session.

expires_at

string<date-time>

Thoi diem session het han.

authenticated_at

string<date-time>

Thoi diem user xac thuc cho session nay.

authenticator_assurance_level

string

Muc dam bao xac thuc cua session, vi du aal1.

authentication_methods

object[]

Cac phuong thuc xac thuc da hoan tat cho session.

Hide child attributes

authentication_methods.method

string

Ten phuong thuc xac thuc, vi du password.

authentication_methods.aal

string

Muc dam bao xac thuc cua phuong thuc nay.

authentication_methods.completed_at

string<date-time>

Thoi diem phuong thuc nay hoan tat.

issued_at

string<date-time>

Thoi diem he thong phat hanh session.

devices

object[]

Metadata thiet bi/session do he thong tra ve, gom device id, IP address, user agent va location.

Hide child attributes

devices.id

string

Ma thiet bi.

devices.ip_address

string

Dia chi IP cua session/thiet bi.

devices.user_agent

string

User agent cua session/thiet bi.

devices.location

string

Chuoi location do he thong tra ve khi co.

Tạo luồng đăng kýTạo luồng đăng ký

Lấy phiên xác thực hiện tại

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
}

Tổng quan

REST API

Streaming API

Tích hợp

Hỗ trợ

Lấy phiên xác thực hiện tại

Ủy quyền

Tham số truy vấn

Phản hồi