Skip to content
Omniglass Omniglass Omniglass

Set a principal's profile picture

POST
/principals/{id}:setAvatar
 
curl --request POST \
  --url https://example.com/api/v1/principals/example:setAvatar \
  --header 'Content-Type: application/json' \
  --data '{ "image_base64": "example" }'

Sets another human principal’s profile picture (an administrator action). Gated by principal:set-avatar (all-scope). The image (JPEG, PNG, or WebP, base64-encoded) is normalized server-side to a 256x256 JPEG; a bad or oversize image is a 422. Audited with the administrator as the actor.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required

The principal, addressed by its uuid or a human username

string

The principal, addressed by its uuid or a human username

Request Body required

Section titled “Request Body required ”
Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
image_base64
required

The image (JPEG, PNG, or WebP), base64-encoded; normalized server-side to a 256x256 JPEG

string

Responses

Section titled “ Responses ”

204

Section titled “204 ”

No Content

default

Section titled “default ”

Error

Media type application/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank
Example 
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}