organisations

Set the account's avatar

Store the picture a console renders for the account, replacing any current one. Gateway-native: the registry holds the bytes and serves them; nothing is forwarded to the control plane. Send the raw image bytes as the request body: a PNG, JPEG, WebP or GIF, at most 2 MiB. The format is read from the bytes, so Content-Type is optional — send application/octet-stream, or omit it, and the type is detected; a specific type that disagrees with the bytes is rejected rather than corrected. SVG is not accepted. Account admins only (settings_manage). The org_id in the path must be the caller's token org: another account's id is a 404.

Read it back with GET /organisations/{org_id}/avatar, whose path this response reports as avatar_url; the ?v= on it is the image's content digest, a client cache key the server ignores.

put/registry/v1/organisations/{org_id}/avatar

Request

  • Base URL: https://api.atlan.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.atlan.com/registry/v1/organisations/{org_id}/avatar
  • Auth: HTTP bearer

Path parameters

org_idstring required

Stable identifier of the related org resource.

Headers

Content-Encoding'base64' | 'gzip, base64'

Codings applied to the request body, outermost last. Send base64, or gzip, base64 to compress first; the body is decoded before it is read and Content-Type still names the inner media type. Omit for an unencoded body.

Response

The avatar was set; avatar_url is where to read it.

avatar_urlstring required

The read route's path with the image's content digest as ?v=, so the address changes exactly when the picture does. Fetch it with the caller's bearer; it is not an <img src>.

Changes

No recorded changes to this operation across all 1 revision of this API.