List external users from IDP
Get a list of users from the configured identity provider (e.g., Keycloak, Auth0), showing which users exist in the IDP but may not yet exist in the platform
get
https://localhost:8080/api/v1/external-usersbash
curl --request GET \
--url 'https://localhost:8080/api/v1/external-users' \
--header 'Authorization: Bearer <token>'javascript
const response = await fetch("https://localhost:8080/api/v1/external-users", {
method: "GET",
headers: {
"Authorization": "Bearer <token>"
}
});
const data = await response.json();typescript
interface ListExternalUsersResponse {
pagination?: Record<string, unknown>;
provider?: Record<string, unknown>;
total?: number;
users?: Record<string, unknown>[];
}
const response = await fetch("https://localhost:8080/api/v1/external-users", {
method: "GET",
headers: {
"Authorization": "Bearer <token>"
}
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);
const data: ListExternalUsersResponse = await response.json();python
import requests
response = requests.get(
"https://localhost:8080/api/v1/external-users",
headers={
"Authorization": "Bearer <token>",
},
)
response.raise_for_status()
print(response.json())go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, err := http.NewRequest(http.MethodGet, "https://localhost:8080/api/v1/external-users", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <token>")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
data, err := io.ReadAll(res.Body)
if err != nil {
panic(err)
}
fmt.Println(res.Status, string(data))
}java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://localhost:8080/api/v1/external-users"))
.header("Authorization", "Bearer <token>")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}csharp
using System.Net.Http.Headers;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://localhost:8080/api/v1/external-users");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");php
<?php
$ch = curl_init('https://localhost:8080/api/v1/external-users');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer <token>',
],
CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;ruby
require "net/http"
uri = URI("https://localhost:8080/api/v1/external-users")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer <token>"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"rust
// Cargo.toml dependencies: reqwest, tokio (features "full")
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let response = reqwest::Client::new()
.get("https://localhost:8080/api/v1/external-users")
.header("Authorization", "Bearer <token>")
.send()
.await?;
println!("{} {}", response.status(), response.text().await?);
Ok(())
}Authorizations
BearerAuth· API key in header "Authorization" — Type "Bearer" followed by a space and JWT tokenApiKeyAuth· API key in header "Authorization" — Type "Bearer" followed by a space and API key
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
limit | integer | Number of users to return (default: 100, max: 100) |
offset | integer | Number of users to skip |
email | string | Filter by email address |
username | string | Filter by username |
Responses
200List of external users
application/json
paginationcore.PaginationInfoThe limit and offset slice a list response was built from, with the total available
Show core.PaginationInfo
limitintegeroffsetinteger
providerhandlers.ProviderInfoThe identity provider that produced the surrounding response
Show handlers.ProviderInfo
namestringtypestring
totalintegerusershandlers.ExternalUserResponse[]Show properties
Array of
handlers.ExternalUserResponseactivebooleancreatedAtstring<date-time>displayNamestringemailstringemailVerifiedbooleanexistsInPlatformbooleanfirstNamestringgroupsstring[]idstringisServiceAccountbooleanlastLoginAtstring<date-time>lastNamestringmetadataobjectShow properties
Map of
anypictureUrlstringplatformUserIdstringrolesstring[]updatedAtstring<date-time>usernamestring
Examplejson
{
"pagination": {
"limit": 0,
"offset": 0
},
"provider": {
"name": "string",
"type": "string"
},
"total": 0,
"users": [
{
"active": true,
"createdAt": "2025-01-01T00:00:00Z",
"displayName": "string",
"email": "string",
"emailVerified": true,
"existsInPlatform": true,
"firstName": "string",
"groups": [
"string"
],
"id": "string",
"isServiceAccount": true,
"lastLoginAt": "2025-01-01T00:00:00Z",
"lastName": "string",
"metadata": {
"key": null
},
"pictureUrl": "string",
"platformUserId": "string",
"roles": [
"string"
],
"updatedAt": "2025-01-01T00:00:00Z",
"username": "string"
}
]
}400Bad request - Invalid user listing parameters
application/json
errorstringerror_descriptionstring
Examplejson
{
"error": "Unauthorized",
"error_description": "Invalid token"
}401Unauthorized
application/json
errorstringerror_descriptionstring
Examplejson
{
"error": "Unauthorized",
"error_description": "Invalid token"
}403Forbidden - requires Organization Owner role
application/json
errorstringerror_descriptionstring
Examplejson
{
"error": "Unauthorized",
"error_description": "Invalid token"
}500Internal server error
application/json
errorstringerror_descriptionstring
Examplejson
{
"error": "Unauthorized",
"error_description": "Invalid token"
}501Not Implemented - IDP does not support user listing
application/json
errorstringerror_descriptionstring
Examplejson
{
"error": "Unauthorized",
"error_description": "Invalid token"
}