curl --request GET \
--url https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/users/reportimport requests
url = "https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/users/report"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/users/report', 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.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/users/report",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/users/report"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/users/report")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/users/report")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body"<string>"{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "INVALID_TYPE",
"origin": "IDENTITY",
"message": "Invalid type"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "INSUFFICIENT_PERMISSIONS",
"origin": "IDENTITY",
"message": "insufficient permissions"
}Export organization users
Exports the organization’s users as a CSV or XLSX file.
curl --request GET \
--url https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/users/reportimport requests
url = "https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/users/report"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/users/report', 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.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/users/report",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/users/report"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/users/report")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/users/report")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body"<string>"{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "INVALID_TYPE",
"origin": "IDENTITY",
"message": "Invalid type"
}{
"traceId": "1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b",
"code": "INSUFFICIENT_PERMISSIONS",
"origin": "IDENTITY",
"message": "insufficient permissions"
}type query parameter: ?type=csv answers a UTF-8 CSV file, ?type=xlsx an Excel workbook returned base64-encoded. The organization user list’s filters apply here too (status, level, name, …; a list filter takes its values comma-separated, ?status=ACTIVE,IN_ONBOARDING). The file lists up to 1,000 users, newest first, with their name, e-mail, status, access level, creation date and whether they set up multi-factor authentication and a PIN.Query Parameters
The file format: csv for a UTF-8 CSV file, xlsx for an Excel workbook returned base64-encoded.
csv, xlsx Only the users with these IDs.
Format: UUID
Example (comma-separated list): ?ids=8f1c2d3e-4b5a-4c6d-9e7f-a1b2c3d4e5f6,29bfc458-6d62-4e37-9a89-dc620926bae5
100Only users whose first or last name contains each word of this text (case-insensitive), or whose e-mail contains the whole text.
200Only users whose e-mail contains this text (case-insensitive).
200Only users whose document (CPF) contains these characters. Punctuation is ignored, so 123.456 and 123456 match the same users.
32Only users in one of these statuses.
Example (comma-separated list): ?status=ACTIVE,IN_ONBOARDING
IN_ONBOARDING, CREATING, ACTIVE, DEACTIVATED, BLOCKED Only users with one of these access levels in the organization.
Example: ?level=ADMIN
ADMIN, USER Only users with one of these access levels in the realm.
Example: ?realmLevel=ADMIN
ADMIN, USER Only users who set up a transaction PIN (true) or did not (false).
Example: ?hasPin=true
Only users who enabled multi-factor authentication (true) or did not (false).
Example: ?hasMfa=true
Cursor returned as next by the previous page of the organization user list. Omit to export from the first user.
Field to sort by. Defaults to createdAt.
64Sort direction, ASC or DESC. Defaults to DESC (newest first).
8Response
application/csv — The users as a UTF-8 CSV file, when ?type=csv (served with that Content-Type).
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet — The Excel workbook, base64-encoded, when ?type=xlsx.
The users as a UTF-8 CSV file, when ?type=csv (served with that Content-Type).