Create an End User
curl --request POST \
--url https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "<string>",
"primaryConnection": {
"name": "<string>",
"credentials": {
"action": [
{
"authSchemeConfig": {
"id": "<string>",
"description": "<string>",
"schemeType": "<string>",
"validationMessages": [
{
"text": "<string>",
"detail": [
"<string>"
]
}
]
},
"credential": {
"name": "<string>",
"data": {}
}
}
],
"trigger": [
{
"authSchemeConfig": {
"id": "<string>",
"description": "<string>",
"schemeType": "<string>",
"validationMessages": [
{
"text": "<string>",
"detail": [
"<string>"
]
}
]
},
"credential": {
"name": "<string>",
"data": {}
}
}
]
},
"variables": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"displayName": "<string>"
}
'import requests
url = "https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/users"
payload = {
"externalId": "<string>",
"primaryConnection": {
"name": "<string>",
"credentials": {
"action": [
{
"authSchemeConfig": {
"id": "<string>",
"description": "<string>",
"schemeType": "<string>",
"validationMessages": [
{
"text": "<string>",
"detail": ["<string>"]
}
]
},
"credential": {
"name": "<string>",
"data": {}
}
}
],
"trigger": [
{
"authSchemeConfig": {
"id": "<string>",
"description": "<string>",
"schemeType": "<string>",
"validationMessages": [
{
"text": "<string>",
"detail": ["<string>"]
}
]
},
"credential": {
"name": "<string>",
"data": {}
}
}
]
},
"variables": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"displayName": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalId: '<string>',
primaryConnection: {
name: '<string>',
credentials: {
action: [
{
authSchemeConfig: {
id: '<string>',
description: '<string>',
schemeType: '<string>',
validationMessages: [{text: '<string>', detail: ['<string>']}]
},
credential: {name: '<string>', data: {}}
}
],
trigger: [
{
authSchemeConfig: {
id: '<string>',
description: '<string>',
schemeType: '<string>',
validationMessages: [{text: '<string>', detail: ['<string>']}]
},
credential: {name: '<string>', data: {}}
}
]
},
variables: [{name: '<string>', value: '<string>'}]
},
displayName: '<string>'
})
};
fetch('https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/users', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'externalId' => '<string>',
'primaryConnection' => [
'name' => '<string>',
'credentials' => [
'action' => [
[
'authSchemeConfig' => [
'id' => '<string>',
'description' => '<string>',
'schemeType' => '<string>',
'validationMessages' => [
[
'text' => '<string>',
'detail' => [
'<string>'
]
]
]
],
'credential' => [
'name' => '<string>',
'data' => [
]
]
]
],
'trigger' => [
[
'authSchemeConfig' => [
'id' => '<string>',
'description' => '<string>',
'schemeType' => '<string>',
'validationMessages' => [
[
'text' => '<string>',
'detail' => [
'<string>'
]
]
]
],
'credential' => [
'name' => '<string>',
'data' => [
]
]
]
]
],
'variables' => [
[
'name' => '<string>',
'value' => '<string>'
]
]
],
'displayName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/users"
payload := strings.NewReader("{\n \"externalId\": \"<string>\",\n \"primaryConnection\": {\n \"name\": \"<string>\",\n \"credentials\": {\n \"action\": [\n {\n \"authSchemeConfig\": {\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"schemeType\": \"<string>\",\n \"validationMessages\": [\n {\n \"text\": \"<string>\",\n \"detail\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"credential\": {\n \"name\": \"<string>\",\n \"data\": {}\n }\n }\n ],\n \"trigger\": [\n {\n \"authSchemeConfig\": {\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"schemeType\": \"<string>\",\n \"validationMessages\": [\n {\n \"text\": \"<string>\",\n \"detail\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"credential\": {\n \"name\": \"<string>\",\n \"data\": {}\n }\n }\n ]\n },\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"displayName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}HttpResponse<String> response = Unirest.post("https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/users")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"<string>\",\n \"primaryConnection\": {\n \"name\": \"<string>\",\n \"credentials\": {\n \"action\": [\n {\n \"authSchemeConfig\": {\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"schemeType\": \"<string>\",\n \"validationMessages\": [\n {\n \"text\": \"<string>\",\n \"detail\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"credential\": {\n \"name\": \"<string>\",\n \"data\": {}\n }\n }\n ],\n \"trigger\": [\n {\n \"authSchemeConfig\": {\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"schemeType\": \"<string>\",\n \"validationMessages\": [\n {\n \"text\": \"<string>\",\n \"detail\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"credential\": {\n \"name\": \"<string>\",\n \"data\": {}\n }\n }\n ]\n },\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"displayName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalId\": \"<string>\",\n \"primaryConnection\": {\n \"name\": \"<string>\",\n \"credentials\": {\n \"action\": [\n {\n \"authSchemeConfig\": {\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"schemeType\": \"<string>\",\n \"validationMessages\": [\n {\n \"text\": \"<string>\",\n \"detail\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"credential\": {\n \"name\": \"<string>\",\n \"data\": {}\n }\n }\n ],\n \"trigger\": [\n {\n \"authSchemeConfig\": {\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"schemeType\": \"<string>\",\n \"validationMessages\": [\n {\n \"text\": \"<string>\",\n \"detail\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"credential\": {\n \"name\": \"<string>\",\n \"data\": {}\n }\n }\n ]\n },\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"displayName\": \"<string>\"\n}"
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": "<string>",
"validationMessages": [
{
"text": "<string>",
"detail": [
"<string>"
]
}
]
},
"credential": {
"id": "<string>",
"organisationId": "<string>",
"name": "<string>",
"data": {},
"usages": [
{
"connection": {
"id": "<string>",
"name": "<string>",
"connector": {
"id": "<string>",
"organisationId": "<string>",
"name": "<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"
}
}
],
"errors": [
"<string>"
],
"expiresAt": "2023-11-07T05:31:56Z"
}
}
],
"trigger": [
{
"id": "<string>",
"authSchemeConfig": {
"id": "<string>",
"description": "<string>",
"schemeType": "<string>",
"validationMessages": [
{
"text": "<string>",
"detail": [
"<string>"
]
}
]
},
"credential": {
"id": "<string>",
"organisationId": "<string>",
"name": "<string>",
"data": {},
"usages": [
{
"connection": {
"id": "<string>",
"name": "<string>",
"connector": {
"id": "<string>",
"organisationId": "<string>",
"name": "<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"
}
}
],
"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>"
}End Users
Create an End User
CreateEndUser creates a new End User for the given Hub.
The end user requires a unique externalId which is recommended to be the same as the user’s ID on the
Primary Connector for the Hub. This is an immutable field so should not be set to something that may change
such as an email address.
Before an end user can activate an Integration, they must also have a Connection defined for the Primary Connector. This may be created as part of this request, a separate request to CreateConnection, or as part of the request in the first Activate call.
POST
/
hubs
/
{hub_id}
/
users
Create an End User
curl --request POST \
--url https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"externalId": "<string>",
"primaryConnection": {
"name": "<string>",
"credentials": {
"action": [
{
"authSchemeConfig": {
"id": "<string>",
"description": "<string>",
"schemeType": "<string>",
"validationMessages": [
{
"text": "<string>",
"detail": [
"<string>"
]
}
]
},
"credential": {
"name": "<string>",
"data": {}
}
}
],
"trigger": [
{
"authSchemeConfig": {
"id": "<string>",
"description": "<string>",
"schemeType": "<string>",
"validationMessages": [
{
"text": "<string>",
"detail": [
"<string>"
]
}
]
},
"credential": {
"name": "<string>",
"data": {}
}
}
]
},
"variables": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"displayName": "<string>"
}
'import requests
url = "https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/users"
payload = {
"externalId": "<string>",
"primaryConnection": {
"name": "<string>",
"credentials": {
"action": [
{
"authSchemeConfig": {
"id": "<string>",
"description": "<string>",
"schemeType": "<string>",
"validationMessages": [
{
"text": "<string>",
"detail": ["<string>"]
}
]
},
"credential": {
"name": "<string>",
"data": {}
}
}
],
"trigger": [
{
"authSchemeConfig": {
"id": "<string>",
"description": "<string>",
"schemeType": "<string>",
"validationMessages": [
{
"text": "<string>",
"detail": ["<string>"]
}
]
},
"credential": {
"name": "<string>",
"data": {}
}
}
]
},
"variables": [
{
"name": "<string>",
"value": "<string>"
}
]
},
"displayName": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalId: '<string>',
primaryConnection: {
name: '<string>',
credentials: {
action: [
{
authSchemeConfig: {
id: '<string>',
description: '<string>',
schemeType: '<string>',
validationMessages: [{text: '<string>', detail: ['<string>']}]
},
credential: {name: '<string>', data: {}}
}
],
trigger: [
{
authSchemeConfig: {
id: '<string>',
description: '<string>',
schemeType: '<string>',
validationMessages: [{text: '<string>', detail: ['<string>']}]
},
credential: {name: '<string>', data: {}}
}
]
},
variables: [{name: '<string>', value: '<string>'}]
},
displayName: '<string>'
})
};
fetch('https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/users', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'externalId' => '<string>',
'primaryConnection' => [
'name' => '<string>',
'credentials' => [
'action' => [
[
'authSchemeConfig' => [
'id' => '<string>',
'description' => '<string>',
'schemeType' => '<string>',
'validationMessages' => [
[
'text' => '<string>',
'detail' => [
'<string>'
]
]
]
],
'credential' => [
'name' => '<string>',
'data' => [
]
]
]
],
'trigger' => [
[
'authSchemeConfig' => [
'id' => '<string>',
'description' => '<string>',
'schemeType' => '<string>',
'validationMessages' => [
[
'text' => '<string>',
'detail' => [
'<string>'
]
]
]
],
'credential' => [
'name' => '<string>',
'data' => [
]
]
]
]
],
'variables' => [
[
'name' => '<string>',
'value' => '<string>'
]
]
],
'displayName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/users"
payload := strings.NewReader("{\n \"externalId\": \"<string>\",\n \"primaryConnection\": {\n \"name\": \"<string>\",\n \"credentials\": {\n \"action\": [\n {\n \"authSchemeConfig\": {\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"schemeType\": \"<string>\",\n \"validationMessages\": [\n {\n \"text\": \"<string>\",\n \"detail\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"credential\": {\n \"name\": \"<string>\",\n \"data\": {}\n }\n }\n ],\n \"trigger\": [\n {\n \"authSchemeConfig\": {\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"schemeType\": \"<string>\",\n \"validationMessages\": [\n {\n \"text\": \"<string>\",\n \"detail\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"credential\": {\n \"name\": \"<string>\",\n \"data\": {}\n }\n }\n ]\n },\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"displayName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}HttpResponse<String> response = Unirest.post("https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/users")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"<string>\",\n \"primaryConnection\": {\n \"name\": \"<string>\",\n \"credentials\": {\n \"action\": [\n {\n \"authSchemeConfig\": {\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"schemeType\": \"<string>\",\n \"validationMessages\": [\n {\n \"text\": \"<string>\",\n \"detail\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"credential\": {\n \"name\": \"<string>\",\n \"data\": {}\n }\n }\n ],\n \"trigger\": [\n {\n \"authSchemeConfig\": {\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"schemeType\": \"<string>\",\n \"validationMessages\": [\n {\n \"text\": \"<string>\",\n \"detail\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"credential\": {\n \"name\": \"<string>\",\n \"data\": {}\n }\n }\n ]\n },\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"displayName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.versori.com/api/embedded/v1/hubs/{hub_id}/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalId\": \"<string>\",\n \"primaryConnection\": {\n \"name\": \"<string>\",\n \"credentials\": {\n \"action\": [\n {\n \"authSchemeConfig\": {\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"schemeType\": \"<string>\",\n \"validationMessages\": [\n {\n \"text\": \"<string>\",\n \"detail\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"credential\": {\n \"name\": \"<string>\",\n \"data\": {}\n }\n }\n ],\n \"trigger\": [\n {\n \"authSchemeConfig\": {\n \"id\": \"<string>\",\n \"description\": \"<string>\",\n \"schemeType\": \"<string>\",\n \"validationMessages\": [\n {\n \"text\": \"<string>\",\n \"detail\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"credential\": {\n \"name\": \"<string>\",\n \"data\": {}\n }\n }\n ]\n },\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"displayName\": \"<string>\"\n}"
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": "<string>",
"validationMessages": [
{
"text": "<string>",
"detail": [
"<string>"
]
}
]
},
"credential": {
"id": "<string>",
"organisationId": "<string>",
"name": "<string>",
"data": {},
"usages": [
{
"connection": {
"id": "<string>",
"name": "<string>",
"connector": {
"id": "<string>",
"organisationId": "<string>",
"name": "<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"
}
}
],
"errors": [
"<string>"
],
"expiresAt": "2023-11-07T05:31:56Z"
}
}
],
"trigger": [
{
"id": "<string>",
"authSchemeConfig": {
"id": "<string>",
"description": "<string>",
"schemeType": "<string>",
"validationMessages": [
{
"text": "<string>",
"detail": [
"<string>"
]
}
]
},
"credential": {
"id": "<string>",
"organisationId": "<string>",
"name": "<string>",
"data": {},
"usages": [
{
"connection": {
"id": "<string>",
"name": "<string>",
"connector": {
"id": "<string>",
"organisationId": "<string>",
"name": "<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"
}
}
],
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Request to create a new End User
ExternalID is the identifier of the user as identified in the Hub's primary connector/system.
PrimaryConnection is the connection that the user will use to authenticate to the primary connector.
Show child attributes
Show child attributes
DisplayName is a human-readable name for the user
Response
Created
ID is the Versori identifier for the user. Most APIs will not use this field but instead reference users by their externalId.
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 is an optional human-readable name for the user. If not set, the default is an empty string.
The hub ID to which the user belongs to.
PrimaryConnection is the connection that the user will use to authenticate to the primary connector.
Show child attributes
Show child attributes
CreatedAt is the time the user was created.
UpdatedAt is the time the user was last updated.
⌘I