mtx::responses::IdentityProvider struct
#include <include/mtx/responses/login.hpp>

Identity provider for SSO.

Public variables

std::string brand
Optional UI hint for what kind of common SSO provider is being described in this IdP. Matrix maintains a registry of identifiers in the matrix-doc repo to ensure clients and servers are aligned on major/common brands.
std::string icon
Optional MXC URI to provide an image/icon representing the IdP. Intended to be shown alongside the name if provided.
std::string id
Required: Opaque string chosen by the homeserver, uniquely identifying the IdP from other IdPs the homeserver might support. Should be between 1 and 255 characters in length, containing unreserved characters under RFC 3986 (ALPHA DIGIT "-" / "." / "_" / "~"). Clients are not intended to parse or infer meaning from opaque strings.
std::string name
Required: Human readable description for the IdP, intended to be shown to the user.

Variable documentation

std::string mtx::responses::IdentityProvider::brand

Optional UI hint for what kind of common SSO provider is being described in this IdP. Matrix maintains a registry of identifiers in the matrix-doc repo to ensure clients and servers are aligned on major/common brands.

Clients should prefer the brand over the icon, when both are provided. Clients are not required to support any particular brand, including those in the registry, though are expected to be able to present any IdP based off the name/icon to the user regardless.

Unregistered brands are permitted using the Common Namespaced Identifier Grammar, though excluding the namespace requirements. For example, examplesso is a valid brand which is not in the registry but still permitted. Servers should be mindful that clients might not support their unregistered brand usage as intended by the server.