Create an entity user
curl --request POST \
--url https://api.sandbox.tesouro.com/finops/v1/entity-users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-finops-version: <x-finops-version>' \
--header 'x-organization-id: <x-organization-id>' \
--data '
{
"first_name": "<string>",
"login": "<string>",
"email": "jsmith@example.com",
"last_name": "Peters",
"phone": "<string>",
"title": "Finance Manager"
}
'import requests
url = "https://api.sandbox.tesouro.com/finops/v1/entity-users"
payload = {
"first_name": "<string>",
"login": "<string>",
"email": "jsmith@example.com",
"last_name": "Peters",
"phone": "<string>",
"title": "Finance Manager"
}
headers = {
"x-finops-version": "<x-finops-version>",
"x-organization-id": "<x-organization-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-finops-version': '<x-finops-version>',
'x-organization-id': '<x-organization-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
first_name: '<string>',
login: '<string>',
email: 'jsmith@example.com',
last_name: 'Peters',
phone: '<string>',
title: 'Finance Manager'
})
};
fetch('https://api.sandbox.tesouro.com/finops/v1/entity-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://api.sandbox.tesouro.com/finops/v1/entity-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([
'first_name' => '<string>',
'login' => '<string>',
'email' => 'jsmith@example.com',
'last_name' => 'Peters',
'phone' => '<string>',
'title' => 'Finance Manager'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-finops-version: <x-finops-version>",
"x-organization-id: <x-organization-id>"
],
]);
$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://api.sandbox.tesouro.com/finops/v1/entity-users"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"login\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"last_name\": \"Peters\",\n \"phone\": \"<string>\",\n \"title\": \"Finance Manager\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-finops-version", "<x-finops-version>")
req.Header.Add("x-organization-id", "<x-organization-id>")
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://api.sandbox.tesouro.com/finops/v1/entity-users")
.header("x-finops-version", "<x-finops-version>")
.header("x-organization-id", "<x-organization-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"login\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"last_name\": \"Peters\",\n \"phone\": \"<string>\",\n \"title\": \"Finance Manager\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.tesouro.com/finops/v1/entity-users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-finops-version"] = '<x-finops-version>'
request["x-organization-id"] = '<x-organization-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"login\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"last_name\": \"Peters\",\n \"phone\": \"<string>\",\n \"title\": \"Finance Manager\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"login": "<string>",
"email": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>",
"userpic_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": {
"message": "<string>"
}
}{
"error": {
"message": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"error": {
"message": "<string>"
}
}Entity users
Create an entity user
Create a new entity user from the specified values.
POST
/
finops
/
v1
/
entity-users
Create an entity user
curl --request POST \
--url https://api.sandbox.tesouro.com/finops/v1/entity-users \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'x-finops-version: <x-finops-version>' \
--header 'x-organization-id: <x-organization-id>' \
--data '
{
"first_name": "<string>",
"login": "<string>",
"email": "jsmith@example.com",
"last_name": "Peters",
"phone": "<string>",
"title": "Finance Manager"
}
'import requests
url = "https://api.sandbox.tesouro.com/finops/v1/entity-users"
payload = {
"first_name": "<string>",
"login": "<string>",
"email": "jsmith@example.com",
"last_name": "Peters",
"phone": "<string>",
"title": "Finance Manager"
}
headers = {
"x-finops-version": "<x-finops-version>",
"x-organization-id": "<x-organization-id>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-finops-version': '<x-finops-version>',
'x-organization-id': '<x-organization-id>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
first_name: '<string>',
login: '<string>',
email: 'jsmith@example.com',
last_name: 'Peters',
phone: '<string>',
title: 'Finance Manager'
})
};
fetch('https://api.sandbox.tesouro.com/finops/v1/entity-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://api.sandbox.tesouro.com/finops/v1/entity-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([
'first_name' => '<string>',
'login' => '<string>',
'email' => 'jsmith@example.com',
'last_name' => 'Peters',
'phone' => '<string>',
'title' => 'Finance Manager'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"x-finops-version: <x-finops-version>",
"x-organization-id: <x-organization-id>"
],
]);
$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://api.sandbox.tesouro.com/finops/v1/entity-users"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"login\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"last_name\": \"Peters\",\n \"phone\": \"<string>\",\n \"title\": \"Finance Manager\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-finops-version", "<x-finops-version>")
req.Header.Add("x-organization-id", "<x-organization-id>")
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://api.sandbox.tesouro.com/finops/v1/entity-users")
.header("x-finops-version", "<x-finops-version>")
.header("x-organization-id", "<x-organization-id>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"login\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"last_name\": \"Peters\",\n \"phone\": \"<string>\",\n \"title\": \"Finance Manager\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.tesouro.com/finops/v1/entity-users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-finops-version"] = '<x-finops-version>'
request["x-organization-id"] = '<x-organization-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"first_name\": \"<string>\",\n \"login\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"last_name\": \"Peters\",\n \"phone\": \"<string>\",\n \"title\": \"Finance Manager\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"login": "<string>",
"email": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>",
"phone": "<string>",
"userpic_file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"error": {
"message": "<string>"
}
}{
"error": {
"message": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"error": {
"message": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
The ID of the entity that owns the requested resource.
Example:
"9d2b4c8f-2087-4738-ba91-7359683c49a4"
Body
application/json
First name
Maximum string length:
255Example:
"Casey"
Maximum string length:
255An entity user business email
Last name
Maximum string length:
255Example:
"Peters"
An entity user phone number in the international format
Maximum string length:
20Title
Maximum string length:
255Example:
"Finance Manager"
Response
Successful Response
UUID entity user ID
UTC datetime
UTC datetime
Login
Example:
"caseyp"
record status, 'active' by default
Available options:
active, deleted An entity user business email
First name
Last name
An entity user phone number in the international format
Maximum string length:
20Was this page helpful?
⌘I