Users (API) | Documentación de Accountmaker

User resource management

DELETE/api/users/{user_id}

Delete a user and their credentials, preventing future access. The account is preserved even if this is the last user, maintaining historical data like payment history. More Authentication

Responses

200application/json

schemaobject

dataUserrequired

A user within an application who can authenticate and access resources. Users belong to an Application and access Accounts via memberships.

idstringrequired

Unique identifier for a user.

application_idstringrequired

Unique identifier for an application.

statusrequired

linksobjectrequired

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X DELETE \\
  "${BASE_URL}/api/users/uid0a1b2c3d4e5f" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "delete",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "delete",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/users/uid0a1b2c3d4e5f", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "DELETE", \
    "${BASE_URL}/api/users/uid0a1b2c3d4e5f", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "DELETE", \
        "${BASE_URL}/api/users/uid0a1b2c3d4e5f", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("DELETE", "${BASE_URL}/api/users/uid0a1b2c3d4e5f", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/users/uid0a1b2c3d4e5f")
request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("DELETE", "${BASE_URL}/api/users/uid0a1b2c3d4e5f", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "${BASE_URL}/api/users/uid0a1b2c3d4e5f");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/users/{user_id}

Retrieve a user by their ID. Returns the user’s profile, email credentials, and account memberships. Access is scoped by the caller’s permissions. More Authentication

Responses

200application/json

schemaobject

dataProfilerequired

A user's complete profile including their email credentials, account memberships, and identity information.

idstringrequired

Unique identifier for a user.

application_idstringrequired

Unique identifier for an application.

statusrequired

credentialsarrayrequired

itemEmailCredentialrequired

Nested fields truncated. Expand to continue inline, or use the model link.

Associates an email address with a user for authentication. Used to look up users during login flows and verify email ownership.

membershipsarrayrequired

itemallOfrequired

Variant

Links a user to an account with a specific role (owner, member, or viewer). Users can have memberships in multiple accounts.

MembershipMembership

Nested fields truncated. Expand to continue inline, or use the model link.

Links a user to an account with a specific role (owner, member, or viewer). Users can have memberships in multiple accounts.

Option 2object

Nested fields truncated. Expand to continue inline, or use the model link.

identityUserIdentity | nullUserIdentityrequired

Personal profile information for a user including name, avatar, and locale preferences. Stored separately from authentication data for GDPR compliance.

idstringrequired

Unique identifier for a user.

avatar_urlstring · uri | null

external_idstring | null

given_namestring | null

family_namestring | null

display_namestring | null

preferred_languagestring | null

localestring | null

timezonestring | null

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/users/uid0a1b2c3d4e5f" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/users/uid0a1b2c3d4e5f", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/users/uid0a1b2c3d4e5f", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/users/uid0a1b2c3d4e5f", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/users/uid0a1b2c3d4e5f", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/users/uid0a1b2c3d4e5f")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/users/uid0a1b2c3d4e5f", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/users/uid0a1b2c3d4e5f");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH/api/users/{user_id}

Update user properties using JSON Merge Patch (RFC 7396). Modify user status, profile fields, and account associations. More Authentication

Body application/json

status

Responses

200application/json

schemaobject

dataUserrequired

A user within an application who can authenticate and access resources. Users belong to an Application and access Accounts via memberships.

idstringrequired

Unique identifier for a user.

application_idstringrequired

Unique identifier for an application.

statusrequired

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X PATCH \\
  "${BASE_URL}/api/users/uid0a1b2c3d4e5f" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '"value"'

const payload = "value";
const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = "value";
const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = "value";
const response = await axios({
  method: "patch",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = "value";
const response: AxiosResponse = await axios({
  method: "patch",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = "value";
const { body } = await request("${BASE_URL}/api/users/uid0a1b2c3d4e5f", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = "value"
response = requests.request( \
    "PATCH", \
    "${BASE_URL}/api/users/uid0a1b2c3d4e5f", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = "value"
with httpx.Client() as client:
    response = client.request( \
        "PATCH", \
        "${BASE_URL}/api/users/uid0a1b2c3d4e5f", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`"value"`))

req, err := http.NewRequest("PATCH", "${BASE_URL}/api/users/uid0a1b2c3d4e5f", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = "value"
uri = URI("${BASE_URL}/api/users/uid0a1b2c3d4e5f")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = "value";
$client = new Client();
$response = $client->request("PATCH", "${BASE_URL}/api/users/uid0a1b2c3d4e5f", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "${BASE_URL}/api/users/uid0a1b2c3d4e5f");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("\"value\"", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/users/{user_id}/files

List file metadata for a user by prefix.

Responses

200application/json

schemaobject

dataarrayrequired

itemS3FileMetadatarequired

Metadata for a file stored in object storage.

keystringrequired

pathstringrequired

size_bytesnumberrequired

etagstring | nullrequired

last_modifiedstring · date-timerequired

storage_classstring | nullrequired

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/users/uid0a1b2c3d4e5f/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/users/uid0a1b2c3d4e5f/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files?path=string&prefix=string&delimiter=string&limit=20&cursor=eyJpZCI6ImFjYzEyMyJ9");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/users/{user_id}/files/multipart/abort

Generate presigned URLs for file writes and coordinate multipart uploads.

Body application/json

pathstringrequired

upload_idstringrequired

Responses

200application/json

schemaobject

dataFileMultipartAbortResponserequired

Multipart upload abort response.

upload_idstringrequired

keystringrequired

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/abort" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"path":"string","upload_id":"string"}'

const payload = {"path":"string","upload_id":"string"};
const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/abort";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"path":"string","upload_id":"string"};
const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/abort";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"path":"string","upload_id":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/abort",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"path":"string","upload_id":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/abort",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"path":"string","upload_id":"string"};
const { body } = await request("${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/abort", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"path":"string","upload_id":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/abort", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"path":"string","upload_id":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/abort", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"path":"string","upload_id":"string"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/abort", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"path":"string","upload_id":"string"}
uri = URI("${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/abort")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"path":"string","upload_id":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/abort", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/abort");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"path\":\"string\",\"upload_id\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/users/{user_id}/files/multipart/complete

Generate presigned URLs for file writes and coordinate multipart uploads.

Body application/json

pathstringrequired

upload_idstringrequired

partsarrayrequired

itemobjectrequired

part_numberintegerrequired

etagstringrequired

Responses

200application/json

schemaobject

dataS3FileMultipartCompleteResponserequired

Multipart upload completion response.

upload_idstringrequired

keystringrequired

etagstring

locationstring

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/complete" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]}'

const payload = {"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]};
const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/complete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]};
const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/complete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/complete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/complete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]};
const { body } = await request("${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/complete", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/complete", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/complete", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/complete", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]}
uri = URI("${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/complete")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"path":"string","upload_id":"string","parts":[{"part_number":123,"etag":"string"}]};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/complete", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/complete");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"path\":\"string\",\"upload_id\":\"string\",\"parts\":[{\"part_number\":123,\"etag\":\"string\"}]}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/users/{user_id}/files/multipart/init

Generate presigned URLs for file writes and coordinate multipart uploads.

Body application/json

pathstringrequired

content_typestring

Responses

200application/json

schemaobject

dataS3FileMultipartInitResponserequired

Multipart upload initialization response.

upload_idstringrequired

keystringrequired

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/init" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"path":"string","content_type":"string"}'

const payload = {"path":"string","content_type":"string"};
const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/init";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"path":"string","content_type":"string"};
const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/init";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"path":"string","content_type":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/init",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"path":"string","content_type":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/init",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"path":"string","content_type":"string"};
const { body } = await request("${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/init", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"path":"string","content_type":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/init", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"path":"string","content_type":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/init", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"path":"string","content_type":"string"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/init", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"path":"string","content_type":"string"}
uri = URI("${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/init")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"path":"string","content_type":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/init", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/init");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"path\":\"string\",\"content_type\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/users/{user_id}/files/multipart/part

Generate presigned URLs for file writes and coordinate multipart uploads.

Body application/json

pathstringrequired

upload_idstringrequired

part_numberintegerrequired

content_lengthintegerrequired

content_typestring

Responses

200application/json

schemaobject

dataS3FilePresignResponserequired

Presigned URL response for direct storage access.

urlstring · urirequired

headersobject

expires_atstring · date-timerequired

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/part" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"}'

const payload = {"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"};
const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/part";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"};
const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/part";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/part",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/part",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"};
const { body } = await request("${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/part", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/part", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/part", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/part", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"}
uri = URI("${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/part")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"path":"string","upload_id":"string","part_number":123,"content_length":123,"content_type":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/part", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/multipart/part");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"path\":\"string\",\"upload_id\":\"string\",\"part_number\":123,\"content_length\":123,\"content_type\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/users/{user_id}/files/presign

Generate presigned URLs for file writes and coordinate multipart uploads.

Body application/json

pathstringrequired

content_typestringrequired

content_lengthintegerrequired

Responses

200application/json

schemaobject

dataS3FilePresignResponserequired

Presigned URL response for direct storage access.

urlstring · urirequired

headersobject

expires_atstring · date-timerequired

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"path":"string","content_type":"string","content_length":123}'

const payload = {"path":"string","content_type":"string","content_length":123};
const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"path":"string","content_type":"string","content_length":123};
const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"path":"string","content_type":"string","content_length":123};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"path":"string","content_type":"string","content_length":123};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"path":"string","content_type":"string","content_length":123};
const { body } = await request("${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"path":"string","content_type":"string","content_length":123}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"path":"string","content_type":"string","content_length":123}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"path":"string","content_type":"string","content_length":123}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"path":"string","content_type":"string","content_length":123}
uri = URI("${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"path":"string","content_type":"string","content_length":123};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"path\":\"string\",\"content_type\":\"string\",\"content_length\":123}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/users/{user_id}/files/presign/delete

Generate presigned URLs for file writes and coordinate multipart uploads.

Body application/json

pathstringrequired

Responses

200application/json

schemaobject

dataS3FilePresignResponserequired

Presigned URL response for direct storage access.

urlstring · urirequired

headersobject

expires_atstring · date-timerequired

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign/delete" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"path":"string"}'

const payload = {"path":"string"};
const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign/delete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"path":"string"};
const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign/delete";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"path":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign/delete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"path":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign/delete",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"path":"string"};
const { body } = await request("${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign/delete", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"path":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign/delete", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"path":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign/delete", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"path":"string"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign/delete", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"path":"string"}
uri = URI("${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign/delete")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"path":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign/delete", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/users/uid0a1b2c3d4e5f/files/presign/delete");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"path\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

DELETE/api/users/{user_id}/identity

Delete a user’s identity to remove all PII while preserving the user reference. Use for data regulation compliance like GDPR right-to-be-forgotten. More Privacy

Responses

200application/json

schemaobject

dataallOfrequired

Variant

Personal profile information for a user including name, avatar, and locale preferences. Stored separately from authentication data for GDPR compliance.

UserIdentityUserIdentity

Personal profile information for a user including name, avatar, and locale preferences. Stored separately from authentication data for GDPR compliance.

idstringrequired

Unique identifier for a user.

avatar_urlstring · uri | null

external_idstring | null

given_namestring | null

family_namestring | null

display_namestring | null

preferred_languagestring | null

localestring | null

timezonestring | null

Option 2object

userUserrequired

Nested fields truncated. Expand to continue inline, or use the model link.

A user within an application who can authenticate and access resources. Users belong to an Application and access Accounts via memberships.

linksobjectrequired

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X DELETE \\
  "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity";
const response = await fetch(url, {
  method: "DELETE",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "delete",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "delete",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", {
  method: "DELETE",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "DELETE", \
    "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "DELETE", \
        "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("DELETE", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity")
request = Net::HTTP::Delete.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("DELETE", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/users/{user_id}/identity

Retrieve a user’s identity containing PII like name and locale. Identity data can be deleted separately from the user to comply with data regulations. More Privacy

Responses

200application/json

schemaobject

dataallOfrequired

Variant

Personal profile information for a user including name, avatar, and locale preferences. Stored separately from authentication data for GDPR compliance.

UserIdentityUserIdentity

Personal profile information for a user including name, avatar, and locale preferences. Stored separately from authentication data for GDPR compliance.

idstringrequired

Unique identifier for a user.

avatar_urlstring · uri | null

external_idstring | null

given_namestring | null

family_namestring | null

display_namestring | null

preferred_languagestring | null

localestring | null

timezonestring | null

Option 2object

userUserrequired

Nested fields truncated. Expand to continue inline, or use the model link.

A user within an application who can authenticate and access resources. Users belong to an Application and access Accounts via memberships.

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PATCH/api/users/{user_id}/identity

Update identity properties using JSON Merge Patch (RFC 7396). Modify profile attributes or clear PII for data regulation compliance. More Privacy

Body application/json

avatar_urlstring · uri | null

external_idstring | null

given_namestring | null

family_namestring | null

display_namestring | null

preferred_languagestring | null

localestring | null

timezonestring | null

Responses

200application/json

schemaobject

dataallOfrequired

Variant

Personal profile information for a user including name, avatar, and locale preferences. Stored separately from authentication data for GDPR compliance.

UserIdentityUserIdentity

Personal profile information for a user including name, avatar, and locale preferences. Stored separately from authentication data for GDPR compliance.

idstringrequired

Unique identifier for a user.

avatar_urlstring · uri | null

external_idstring | null

given_namestring | null

family_namestring | null

display_namestring | null

preferred_languagestring | null

localestring | null

timezonestring | null

Option 2object

userUserrequired

Nested fields truncated. Expand to continue inline, or use the model link.

A user within an application who can authenticate and access resources. Users belong to an Application and access Accounts via memberships.

linksobjectrequired

selfstringrequired

URL of the current resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X PATCH \\
  "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '"value"'

const payload = "value";
const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = "value";
const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity";
const response = await fetch(url, {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = "value";
const response = await axios({
  method: "patch",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = "value";
const response: AxiosResponse = await axios({
  method: "patch",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = "value";
const { body } = await request("${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", {
  method: "PATCH",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = "value"
response = requests.request( \
    "PATCH", \
    "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = "value"
with httpx.Client() as client:
    response = client.request( \
        "PATCH", \
        "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`"value"`))

req, err := http.NewRequest("PATCH", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = "value"
uri = URI("${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = "value";
$client = new Client();
$response = $client->request("PATCH", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Patch, "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("\"value\"", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

POST/api/users/{user_id}/identity

Recreate a user identity that was previously deleted. Useful for restoring PII after compliance-related deletion. More Privacy

Body application/json

avatar_urlstring · uri

external_idstring

given_namestring

family_namestring

display_namestring

preferred_languagestring

localestring

timezonestring

Responses

200application/json

schemaobject

dataallOfrequired

Variant

Personal profile information for a user including name, avatar, and locale preferences. Stored separately from authentication data for GDPR compliance.

UserIdentityUserIdentity

Personal profile information for a user including name, avatar, and locale preferences. Stored separately from authentication data for GDPR compliance.

idstringrequired

Unique identifier for a user.

avatar_urlstring · uri | null

external_idstring | null

given_namestring | null

family_namestring | null

display_namestring | null

preferred_languagestring | null

localestring | null

timezonestring | null

Option 2object

userUserrequired

Nested fields truncated. Expand to continue inline, or use the model link.

A user within an application who can authenticate and access resources. Users belong to an Application and access Accounts via memberships.

linksobjectrequired

selfstringrequired

URL of the created resource

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X POST \\
  "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity" \\
  -H "Authorization: Bearer ${API_TOKEN}" \\
  -H "Content-Type: application/json" \\
  -d '{"avatar_url":"string","external_id":"string","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string"}'

const payload = {"avatar_url":"string","external_id":"string","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string"};
const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
});

console.log(await response.json());

const payload = {"avatar_url":"string","external_id":"string","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string"};
const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity";
const response = await fetch(url, {
  method: "POST",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
} as RequestInit);

console.log(await response.json());

const payload = {"avatar_url":"string","external_id":"string","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string"};
const response = await axios({
  method: "post",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

const payload = {"avatar_url":"string","external_id":"string","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string"};
const response: AxiosResponse = await axios({
  method: "post",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
    "Content-Type": "application/json",
  },
  data: payload,
});

console.log(response.data);

import { request } from "undici";

const bodyData = {"avatar_url":"string","external_id":"string","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string"};
const { body } = await request("${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", {
  method: "POST",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
      "Content-Type": "application/json",
  },
    body: JSON.stringify(bodyData),
});

console.log(await body.json());

import requests

payload = {"avatar_url":"string","external_id":"string","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string"}
response = requests.request( \
    "POST", \
    "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = {"avatar_url":"string","external_id":"string","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string"}
with httpx.Client() as client:
    response = client.request( \
        "POST", \
        "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := bytes.NewBuffer([]byte(`{"avatar_url":"string","external_id":"string","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string"}`))

req, err := http.NewRequest("POST", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = {"avatar_url":"string","external_id":"string","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string"}
uri = URI("${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
request.body = payload.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = {"avatar_url":"string","external_id":"string","given_name":"string","family_name":"string","display_name":"string","preferred_language":"string","locale":"string","timezone":"string"};
$client = new Client();
$response = $client->request("POST", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
  'json' => $payload,
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "${BASE_URL}/api/users/uid0a1b2c3d4e5f/identity");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
request.Content = new StringContent("{\"avatar_url\":\"string\",\"external_id\":\"string\",\"given_name\":\"string\",\"family_name\":\"string\",\"display_name\":\"string\",\"preferred_language\":\"string\",\"locale\":\"string\",\"timezone\":\"string\"}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

GET/api/users/{user_id}/memberships

List all memberships for a user across accounts. Returns the accounts and roles associated with each membership. More Applications

Responses

200application/json

schemaobject

dataarrayrequired

itemallOfrequired

Variant

Links a user to an account with a specific role (owner, member, or viewer). Users can have memberships in multiple accounts.

MembershipMembership

Nested fields truncated. Expand to continue inline, or use the model link.

Links a user to an account with a specific role (owner, member, or viewer). Users can have memberships in multiple accounts.

Option 2object

Nested fields truncated. Expand to continue inline, or use the model link.

linksobjectrequired

selfstringrequired

URL of the current page

nextstring

URL of the next page

400application/problem+jsonValidationProblemDetails

Bad Request

schemaValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

defaultapplication/problem+jsonProblemDetails

HTTP Error

schemaProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

curl -X GET \\
  "${BASE_URL}/api/users/uid0a1b2c3d4e5f/memberships" \\
  -H "Authorization: Bearer ${API_TOKEN}"

const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/memberships";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
});

console.log(await response.json());

const url = "${BASE_URL}/api/users/uid0a1b2c3d4e5f/memberships";
const response = await fetch(url, {
  method: "GET",
  headers: {
    "Authorization": "Bearer ${API_TOKEN}",
  },
} as RequestInit);

console.log(await response.json());

const response = await axios({
  method: "get",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/memberships",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

const response: AxiosResponse = await axios({
  method: "get",
  url: "${BASE_URL}/api/users/uid0a1b2c3d4e5f/memberships",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(response.data);

import { request } from "undici";

const { body } = await request("${BASE_URL}/api/users/uid0a1b2c3d4e5f/memberships", {
  method: "GET",
  headers: {
    Authorization: "Bearer ${API_TOKEN}",
  },
});

console.log(await body.json());

import requests

payload = None
response = requests.request( \
    "GET", \
    "${BASE_URL}/api/users/uid0a1b2c3d4e5f/memberships", \
    headers={"Authorization": "Bearer ${API_TOKEN}"}, \
    json=payload,
)
print(response.json())

import httpx

payload = None
with httpx.Client() as client:
    response = client.request( \
        "GET", \
        "${BASE_URL}/api/users/uid0a1b2c3d4e5f/memberships", \
        headers={"Authorization": "Bearer ${API_TOKEN}"}, \
        json=payload,
    )
print(response.json())

payload := http.NoBody

req, err := http.NewRequest("GET", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/memberships", payload)
if err != nil {
  panic(err)
}
req.Header.Set("Authorization", "Bearer ${API_TOKEN}")
if payload != http.NoBody {
  req.Header.Set("Content-Type", "application/json")
}

res, err := (&http.Client{}).Do(req)
if err != nil {
  panic(err)
}
defer res.Body.Close()

require "json"
require "net/http"

payload = nil
uri = URI("${BASE_URL}/api/users/uid0a1b2c3d4e5f/memberships")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer ${API_TOKEN}"
request["Content-Type"] = "application/json"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") { |http| \
  http.request(request) \
}
puts response.body

<?php

use GuzzleHttp\Client;

$payload = null;
$client = new Client();
$response = $client->request("GET", "${BASE_URL}/api/users/uid0a1b2c3d4e5f/memberships", [
  'headers' => [
    'Authorization' => 'Bearer ${API_TOKEN}',
  ],
]);

echo $response->getBody();

using System.Net.Http;
using System.Text;

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "${BASE_URL}/api/users/uid0a1b2c3d4e5f/memberships");
request.Headers.Add("Authorization", "Bearer ${API_TOKEN}");
var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Account

idstringrequired

Unique identifier for an account.

parent_idstring | nullrequired

Parent resource ID (application ID for accounts).

Variant

Unique identifier for an account.

Option 1string

Unique identifier for an account.

Unique identifier for an application.

Option 2string

Unique identifier for an application.

namestring | null

Display name for the account.

avatar_urlstring · uri | null

URL to the account's avatar image.

EmailAddress

string · email

A valid, normalized email address.

EmailCredential

idstringrequired

user_idstringrequired

Unique identifier for a user.

emailEmailAddress | nullEmailAddress

A valid, normalized email address.

hashed_emailstring | null

email_verified_atstring | null

FileMultipartAbortResponse

upload_idstringrequired

keystringrequired

Membership

idstringrequired

Unique identifier for a membership.

account_idstringrequired

Unique identifier for an account.

user_idstringrequired

Unique identifier for a user.

rolerequired

ProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

Profile

idstringrequired

Unique identifier for a user.

application_idstringrequired

Unique identifier for an application.

statusrequired

credentialsarrayrequired

itemEmailCredentialrequired

Associates an email address with a user for authentication. Used to look up users during login flows and verify email ownership.

idstringrequired

user_idstringrequired

Unique identifier for a user.

emailEmailAddress | nullEmailAddress

A valid, normalized email address.

hashed_emailstring | null

email_verified_atstring | null

membershipsarrayrequired

itemallOfrequired

Variant

Links a user to an account with a specific role (owner, member, or viewer). Users can have memberships in multiple accounts.

MembershipMembership

Links a user to an account with a specific role (owner, member, or viewer). Users can have memberships in multiple accounts.

idstringrequired

Unique identifier for a membership.

account_idstringrequired

Unique identifier for an account.

user_idstringrequired

Unique identifier for a user.

rolerequired

Option 2object

accountAccountrequired

Nested fields truncated. Expand to continue inline, or use the model link.

Represents a billing container with domains and billing settings. Accounts form a hierarchy with applications where types alternate.

identityUserIdentity | nullUserIdentityrequired

Personal profile information for a user including name, avatar, and locale preferences. Stored separately from authentication data for GDPR compliance.

idstringrequired

Unique identifier for a user.

avatar_urlstring · uri | null

external_idstring | null

given_namestring | null

family_namestring | null

display_namestring | null

preferred_languagestring | null

localestring | null

timezonestring | null

S3FileMetadata

keystringrequired

pathstringrequired

size_bytesnumberrequired

etagstring | nullrequired

last_modifiedstring · date-timerequired

storage_classstring | nullrequired

S3FileMultipartCompleteResponse

upload_idstringrequired

keystringrequired

etagstring

locationstring

S3FileMultipartInitResponse

upload_idstringrequired

keystringrequired

S3FilePresignResponse

urlstring · urirequired

headersobject

expires_atstring · date-timerequired

User

idstringrequired

Unique identifier for a user.

application_idstringrequired

Unique identifier for an application.

statusrequired

UserIdentity

idstringrequired

Unique identifier for a user.

avatar_urlstring · uri | null

external_idstring | null

given_namestring | null

family_namestring | null

display_namestring | null

preferred_languagestring | null

localestring | null

timezonestring | null

ValidationProblemDetails

typestring · urirequired

titlestringrequired

statusintegerrequired

detailstring

instancestring · uri

codestring

invalid_paramsarray

itemobjectrequired

instring

pathstring

typestring

expectedstring

receivedstring

Users

Contents

Delete User

Get User

Update User

List User Files

Abort User Multipart Upload

Complete User Multipart Upload

Init User Multipart Upload

Presign User Multipart Part

Presign User File Upload

Presign User File Delete

Delete User Identity

Get User Identity

Update User Identity

Recreate User Identity

Get User Memberships

Models

Features

Types

Contents

Models

Related Features and Types

Features

Types