Vero OMS API

GET

https://api-gw.verolabs.co

api

authen

self-service

recovery

api

Create a recovery flow

curl --request GET \
  --url https://api-gw.verolabs.co/api/authen/self-service/recovery/api

const options = {method: 'GET'};

fetch('https://api-gw.verolabs.co/api/authen/self-service/recovery/api', 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/self-service/recovery/api"

response = requests.get(url)

print(response.text)

package main

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

func main() {

	url := "https://api-gw.verolabs.co/api/authen/self-service/recovery/api"

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

	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/self-service/recovery/api");
var client = new RestClient(options);
var request = new RestRequest("");
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/self-service/recovery/api");

CURLcode ret = curl_easy_perform(hnd);

{
  "id": "<string>",
  "type": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "issued_at": "2023-11-07T05:31:56Z",
  "ui": {},
  "state": "<string>",
  "request_url": "<string>",
  "organization_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "refresh": true,
  "requested_aal": "<string>",
  "identity": "<unknown>"
}

{
  "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
}

Response

self-service flow object.

self-service flow object returned by login, registration, recovery, and settings create/update endpoints.

string

Flow id. Use this value as the flow query parameter when submitting or updating the flow.

type

string

Flow type returned by the system, for example browser or api.

expires_at

string<date-time>

Timestamp when the flow expires. Submit the flow before this time.

issued_at

string<date-time>

Timestamp when created the flow.

object

UI payload containing action URL, method, nodes, messages, and CSRF node when required.

state

string

Current flow state, such as choose_method, sent_email, passed_challenge, or success.

request_url

string

Original request URL used to create the flow.

organization_id

string | null

organization id for organization-scoped flows, when supplied.

created_at

string<date-time>

Flow creation timestamp.

updated_at

string<date-time>

Flow update timestamp.

refresh

boolean

Whether the flow is a refresh flow.

requested_aal

string

Requested authenticator assurance level for the flow.

identity

any

Identity attached to settings flows when the system includes it.

Send or verify a recovery codeSend or verify a recovery code

Create a recovery flow

curl --request GET \
  --url https://api-gw.verolabs.co/api/authen/self-service/recovery/api

const options = {method: 'GET'};

fetch('https://api-gw.verolabs.co/api/authen/self-service/recovery/api', 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/self-service/recovery/api"

response = requests.get(url)

print(response.text)

package main

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

func main() {

	url := "https://api-gw.verolabs.co/api/authen/self-service/recovery/api"

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

	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/self-service/recovery/api");
var client = new RestClient(options);
var request = new RestRequest("");
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/self-service/recovery/api");

CURLcode ret = curl_easy_perform(hnd);

{
  "id": "<string>",
  "type": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "issued_at": "2023-11-07T05:31:56Z",
  "ui": {},
  "state": "<string>",
  "request_url": "<string>",
  "organization_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "refresh": true,
  "requested_aal": "<string>",
  "identity": "<unknown>"
}

{
  "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

Create a recovery flow

Response