Struct matrix_sdk::oidc::registrations::OidcRegistrations

pub struct OidcRegistrations { /* private fields */ }

Available on crate feature experimental-oidc only.

The data needed to restore an OpenID Connect session.

Implementations

impl OidcRegistrations

Manages the storage of OIDC registrations.

pub fn new( registrations_file: &Path, metadata: VerifiedClientMetadata, static_registrations: HashMap<Url, ClientId>, ) -> Result<Self, OidcRegistrationsError>

Creates a new registration store.

Arguments

• registrations_file - A file path where the registrations will be stored. This previously took a directory and stored the registrations with the path supplied_directory/oidc/registrations.json.

• metadata - The metadata used to register the client. If this changes, any stored registrations will be lost so the client can re-register with the new data.

• static_registrations - Pre-configured registrations for use with issuers that don’t support dynamic client registration.

pub fn client_id(&self, issuer: &Url) -> Option<ClientId>

Returns the client ID registered for a particular issuer or None if a registration hasn’t been made.

pub fn set_and_write_client_id( &self, client_id: ClientId, issuer: Url, ) -> Result<(), OidcRegistrationsError>

Stores a new client ID registration for a particular issuer. If a client ID has already been stored, this will overwrite the old value.

Trait Implementations

impl Debug for OidcRegistrations

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.