Struct ruma::api::client::session::sso_login_with_provider::v3::Request

pub struct Request<'a> {
    pub idp_id: &'a str,
    pub redirect_url: &'a str,
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

Data for a request to the sso_login_with_provider API endpoint.

Get the SSO login identity provider url.

Fields

idp_id: &'a str

The ID of the provider to use for SSO login.

redirect_url: &'a str

URL to which the homeserver should return the user after completing authentication with the SSO identity provider.

Implementations

impl<'a> Request<'a>

pub fn new(idp_id: &'a str, redirect_url: &'a str) -> Request<'a>

Creates a new Request with the given identity provider ID and redirect URL.

Trait Implementations

impl<'a> Clone for Request<'a>

fn clone(&self) -> Request<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> OutgoingRequest for Request<'a>

Available on crate feature client only.

type EndpointError = Error

A type capturing the expected error conditions the server can return.

type IncomingResponse = Response

Response type returned when the request is successful.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

fn try_into_http_request<T>(
    self,
    base_url: &str,
    access_token: SendAccessToken<'_>,
    considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>where
    T: Default + BufMut,

Tries to convert this request into an http::Request.

impl<'a> OutgoingNonAuthRequest for Request<'a>

Available on crate feature client only.