Get User Avatar

GET

/iam/v1/users/{id}/avatar

curl --request GET \
  --url https://example.com/iam/v1/users/example/avatar

Returns another user’s avatar image bytes with their content type.

The administrative counterpart of GetCurrentUserAvatar: the bytes live in a private platform bucket, so they are served here rather than referenced — no client can resolve a storage reference itself.

Parameters

Path Parameters

id

required

string

The unique identifier of the user whose avatar to retrieve

Query Parameters

scope_type

string

The scope the caller is acting at: ORGANISATION, WORKSPACE, or GROUP.

Supplied, the caller is authorized at that scope, so whoever administers one organisation or workspace can read the avatars of the people in it. Omitted, the request resolves at the platform scope.

scope_id

string

The unique identifier of the scope. Supplied together with scope_type.

Responses

200

OK

Media type */*

default

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}