Function matrix_sdk::oidc::requests::authorization_code::build_authorization_url

source · 
pub fn build_authorization_url(
    authorization_endpoint: Url,
    authorization_data: AuthorizationRequestData,
    rng: &mut impl Rng,
) -> Result<(Url, AuthorizationValidationData), AuthorizationError>
Available on crate feature experimental-oidc only.
Expand description

Build the URL for authenticating at the Authorization endpoint.

§Arguments

  • authorization_endpoint - The URL of the issuer’s authorization endpoint.

  • authorization_data - The data necessary to build the authorization request.

  • rng - A random number generator.

§Returns

A URL to be opened in a web browser where the end-user will be able to authorize the given scope, and the AuthorizationValidationData to validate this request.

The redirect URI will receive parameters in its query:

  • A successful response will receive a code and a state.

  • If the authorization fails, it should receive an error parameter with a ClientErrorCode and optionally an error_description.

§Errors

Returns an error if preparing the URL fails.