Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-23 11:34:09 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

C2S: Annotate IdP icon spec with media auth implications

Browse source
This commit is contained in:
Travis Ralston 2024-06-10 16:50:05 -06:00
parent 3cef6f0479
commit 0617aced7c
1 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
data/api/client-server/definitions/sso_login_flow.yaml
View file

@ -53,6 +53,18 @@ properties:
description: |-
Optional `mxc://` URI to provide an image/icon representing the IdP.
Intended to be shown alongside the `name` if provided.
{{% boxes/note %}}
Clients will need to use the deprecated [`/download`](/client-server-api/#get_matrixmediav3downloadservernamemediaid)
and [`/thumbnail`](/client-server-api/#get_matrixmediav3thumbnailservernamemediaid)
endpoints to retrieve this media item because clients will not have
an access token they can authenticate with yet. Servers SHOULD ensure
media used for IdP icons is excluded from the freeze described by the
[Content Repository module's Client Behaviour section](/client-server-api/#content-repo-client-behaviour).
This may be addressed in the future with proposals like [MSC4148](https://github.com/matrix-org/matrix-spec-proposals/pull/4148),
or removed entirely through the transition to OIDC.
{{% /boxes/note %}}
example: "mxc://example.org/abc123"
brand:
type: string