Vero OMS API

POST

https://api-gw.verolabs.co

api

authen

self-service

Submit password credentials to a login flow

curl --request POST \
  --url https://api-gw.verolabs.co/api/authen/self-service/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "password",
  "csrf_token": "<string>",
  "password_identifier": "jsmith@example.com",
  "password": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    method: 'password',
    csrf_token: '<string>',
    password_identifier: 'jsmith@example.com',
    password: '<string>'
  })
};

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

payload = {
    "method": "password",
    "csrf_token": "<string>",
    "password_identifier": "jsmith@example.com",
    "password": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"method\": \"password\",\n  \"csrf_token\": \"<string>\",\n  \"password_identifier\": \"jsmith@example.com\",\n  \"password\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	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/login");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"method\": \"password\",\n  \"csrf_token\": \"<string>\",\n  \"password_identifier\": \"jsmith@example.com\",\n  \"password\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);

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

false

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-gw.verolabs.co/api/authen/self-service/login");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n  \"method\": \"password\",\n  \"csrf_token\": \"<string>\",\n  \"password_identifier\": \"jsmith@example.com\",\n  \"password\": \"<string>\"\n}");

CURLcode ret = curl_easy_perform(hnd);

{
  "session_token": "<string>",
  "session": {
    "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>"
      }
    ]
  },
  "identity": {}
}

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

Query Parameters

flow

string

required

Flow identifier returned by the matching create-flow endpoint. Submit/update requests must use the same flow id.

Body

application/json

self-service flow update payload. Pass the flow id in the query string and include the fields required by the selected method.

JSON payload used to submit password credentials to an login flow.

method

enum<string>

required

Authentication method. The mobile/web client submits password for password login.

Available options:

password

csrf_token

string

required

CSRF token copied from the login flow UI node when required.

password_identifier

string<email>

required

User login identifier. The app sends the account email address.

password

string<password>

required

Plain-text password entered by the user. Send only over HTTPS.

Response

Successful login flow response. The app reads session_token from this payload and uses it as the authenticated session token.

Response returned after a successful API login flow.

session_token

string

Bearer/session token used by the client for authenticated API calls.

session

object

session object for the authenticated identity.

Hide child attributes

session.id

string

session id.

session.active

boolean

Whether the session is currently active.

session.identity

object

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

Hide child attributes

session.identity.id

string

identity id for the authenticated user.

session.identity.traits

object

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

session.identity.schema_id

string

identity schema id.

session.identity.schema_url

string

URL of the identity schema.

session.identity.state

string

identity state, for example active.

session.identity.state_changed_at

string<date-time>

Timestamp when the identity state last changed.

session.identity.recovery_addresses

object[]

Recovery addresses configured on the identity.

session.identity.metadata_public

object | null

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

session.identity.created_at

string<date-time>

Identity creation timestamp.

session.identity.updated_at

string<date-time>

Identity update timestamp.

session.identity.organization_id

string | null

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

session.tokenized

string

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

session.expires_at

string<date-time>

Timestamp when the session expires.

session.authenticated_at

string<date-time>

Timestamp when the user authenticated for this session.

session.authenticator_assurance_level

string

authenticator assurance level for the session, for example aal1.

session.authentication_methods

object[]

Authentication methods completed for the session.

Hide child attributes

session.authentication_methods.method

string

Authentication method name, for example password.

session.authentication_methods.aal

string

Assurance level completed by this method.

session.authentication_methods.completed_at

string<date-time>

Timestamp when this method completed.

session.issued_at

string<date-time>

Timestamp when issued the session.

session.devices

object[]

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

Hide child attributes

session.devices.id

string

device ID.

session.devices.ip_address

string

IP address observed for the session/device.

session.devices.user_agent

string

User agent observed for the session/device.

session.devices.location

string

Location string returned by the system when available.

identity

object

identity object. Includes identity id and traits when returned by the system.

Get current authenticated sessionReturns the current authenticated session and identity data for the supplied bearer or session credential.

Submit password credentials to a login flow

curl --request POST \
  --url https://api-gw.verolabs.co/api/authen/self-service/login \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "password",
  "csrf_token": "<string>",
  "password_identifier": "jsmith@example.com",
  "password": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    method: 'password',
    csrf_token: '<string>',
    password_identifier: 'jsmith@example.com',
    password: '<string>'
  })
};

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

payload = {
    "method": "password",
    "csrf_token": "<string>",
    "password_identifier": "jsmith@example.com",
    "password": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

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

func main() {

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

	payload := strings.NewReader("{\n  \"method\": \"password\",\n  \"csrf_token\": \"<string>\",\n  \"password_identifier\": \"jsmith@example.com\",\n  \"password\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	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/login");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"method\": \"password\",\n  \"csrf_token\": \"<string>\",\n  \"password_identifier\": \"jsmith@example.com\",\n  \"password\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);

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

false

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://api-gw.verolabs.co/api/authen/self-service/login");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\n  \"method\": \"password\",\n  \"csrf_token\": \"<string>\",\n  \"password_identifier\": \"jsmith@example.com\",\n  \"password\": \"<string>\"\n}");

CURLcode ret = curl_easy_perform(hnd);

{
  "session_token": "<string>",
  "session": {
    "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>"
      }
    ]
  },
  "identity": {}
}

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

Submit password credentials to a login flow

Query Parameters

Body

Response