Import an external IDP user into the platform
Import an IDP user into the platform database and optionally add them to an organization with a specified role
post
https://localhost:8080/api/v1/external-users/importbash
curl --request POST \
--url 'https://localhost:8080/api/v1/external-users/import' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{"externalUserId":"string","organizationId":0,"role":"string"}'javascript
const response = await fetch("https://localhost:8080/api/v1/external-users/import", {
method: "POST",
headers: {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"externalUserId": "string",
"organizationId": 0,
"role": "string"
})
});
const data = await response.json();typescript
interface ImportExternalUserResponse {
addedToOrganization?: number;
displayName?: string;
email?: string;
importedAt?: string;
importedFrom?: string;
organizationRole?: string;
userId?: string;
}
const response = await fetch("https://localhost:8080/api/v1/external-users/import", {
method: "POST",
headers: {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"externalUserId": "string",
"organizationId": 0,
"role": "string"
})
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);
const data: ImportExternalUserResponse = await response.json();python
import requests
response = requests.post(
"https://localhost:8080/api/v1/external-users/import",
headers={
"Authorization": "Bearer <token>",
"Content-Type": "application/json",
},
json={
"externalUserId": "string",
"organizationId": 0,
"role": "string",
},
)
response.raise_for_status()
print(response.json())go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
body := strings.NewReader(`{
"externalUserId": "string",
"organizationId": 0,
"role": "string"
}`)
req, err := http.NewRequest(http.MethodPost, "https://localhost:8080/api/v1/external-users/import", body)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <token>")
req.Header.Set("Content-Type", "application/json")
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/import"))
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("""
{
"externalUserId": "string",
"organizationId": 0,
"role": "string"
}
"""))
.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 System.Text;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://localhost:8080/api/v1/external-users/import");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Content = new StringContent("""
{
"externalUserId": "string",
"organizationId": 0,
"role": "string"
}
""", Encoding.UTF8, "application/json");
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/import');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer <token>',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"externalUserId": "string",
"organizationId": 0,
"role": "string"
}
JSON,
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/import")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
{
"externalUserId": "string",
"organizationId": 0,
"role": "string"
}
JSON
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 (features "json"), serde_json, tokio (features "full")
use serde_json::json;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let response = reqwest::Client::new()
.post("https://localhost:8080/api/v1/external-users/import")
.header("Authorization", "Bearer <token>")
.json(&json!({
"externalUserId": "string",
"organizationId": 0,
"role": "string"
}))
.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
Request bodyrequired
Import user request
application/json
externalUserIdstringrequiredorganizationIdintegerOmit to import without membership
rolestringOnly applies with organizationId
Examplejson
{
"externalUserId": "string",
"organizationId": 0,
"role": "string"
}Responses
200User imported successfully
application/json
addedToOrganizationintegerdisplayNamestringemailstringimportedAtstring<date-time>importedFromstringorganizationRolestringuserIdstring
Examplejson
{
"addedToOrganization": 0,
"displayName": "string",
"email": "string",
"importedAt": "2025-01-01T00:00:00Z",
"importedFrom": "string",
"organizationRole": "string",
"userId": "string"
}400Bad Request - Invalid input, or the IDP user is a service account
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"
}404User not found in IDP
application/json
errorstringerror_descriptionstring
Examplejson
{
"error": "Unauthorized",
"error_description": "Invalid token"
}409Conflict - User already exists in platform
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"
}